cc-lb-plugin-conformance 0.1.1

cc-lb plugin conformance suite — in-process protocol verification helpers for external plugin authors.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use thiserror::Error;

use cc_lb_plugin_wire::wire_function::FallbackPolicy;

use crate::{handshake, identity, self_check};

#[non_exhaustive]
#[derive(Debug, Error)]
pub enum VerifyError {
    #[error("identity verification failed: {0}")]
    Identity(#[from] identity::IdentityError),
    #[error("handshake verification failed: {0}")]
    Handshake(#[from] handshake::HandshakeError),
    #[error("self-check verification failed: {0}")]
    SelfCheck(#[from] self_check::SelfCheckError),
    #[error("dispatch verification failed: {0}")]
    Dispatch(#[from] DispatchError),
}

#[non_exhaustive]
#[derive(Debug, Clone)]
pub struct VerifyReport {
    pub identity: LayerResult,
    pub handshake: LayerResult,
    pub self_check: LayerResult,
    pub dispatch: Vec<LayerResult>,
    pub extras: Vec<ExtraInfo>,
}

#[non_exhaustive]
#[derive(Debug, Clone)]
pub struct LayerResult {
    pub layer: &'static str,
    pub passed: bool,
    pub detail: Option<String>,
}

#[non_exhaustive]
#[derive(Debug, Clone)]
pub struct ExtraInfo {
    pub kind: &'static str,
    pub message: String,
}

#[doc(hidden)]
#[non_exhaustive]
#[derive(Debug, Clone, Error)]
pub enum DispatchError {
    #[error("{function} dispatch fell back with policy {policy:?}")]
    Fallback {
        function: &'static str,
        policy: FallbackPolicy,
    },
    #[error("{function} response failed conformance check: {reason}")]
    InvalidResponse {
        function: &'static str,
        reason: String,
    },
}