kafrust-protocol 0.2.9

Kafka wire protocol primitives for kafrust.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use crate::codec::{Decoder, Encoder};
use crate::error::Result;
use crate::header::RequestHeader;

pub const API_KEY: i16 = 50;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescribeUserScramCredentialsRequestV0 {
    pub correlation_id: i32,
    pub client_id: Option<String>,
    pub users: Option<Vec<String>>,
}

impl DescribeUserScramCredentialsRequestV0 {
    pub fn encode(&self) -> Result<Vec<u8>> {
        let mut encoder = Encoder::new();
        RequestHeader {
            api_key: API_KEY,
            api_version: 0,
            correlation_id: self.correlation_id,
            client_id: self.client_id.clone(),
        }
        .encode_v2(&mut encoder)?;
        encoder.write_compact_array(self.users.as_deref(), |encoder, user| {
            encoder.write_compact_string(user)?;
            encoder.write_empty_tagged_fields();
            Ok(())
        })?;
        encoder.write_empty_tagged_fields();
        Ok(encoder.into_bytes())
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescribeUserScramCredentialsResponseV0 {
    pub throttle_time_ms: i32,
    pub error_code: i16,
    pub error_message: Option<String>,
    pub results: Vec<DescribeUserScramCredentialsResultV0>,
}

impl DescribeUserScramCredentialsResponseV0 {
    pub fn decode_body(decoder: &mut Decoder<'_>) -> Result<Self> {
        let throttle_time_ms = decoder.read_i32()?;
        let error_code = decoder.read_i16()?;
        let error_message = decoder.read_compact_nullable_string()?;
        let results = decoder
            .read_compact_array(
                "describe user SCRAM credential results",
                DescribeUserScramCredentialsResultV0::decode,
            )?
            .unwrap_or_default();
        decoder.read_tagged_fields()?;
        Ok(Self {
            throttle_time_ms,
            error_code,
            error_message,
            results,
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescribeUserScramCredentialsResultV0 {
    pub user: String,
    pub error_code: i16,
    pub error_message: Option<String>,
    pub credential_infos: Vec<ScramCredentialInfoV0>,
}

impl DescribeUserScramCredentialsResultV0 {
    fn decode(decoder: &mut Decoder<'_>) -> Result<Self> {
        let user = decoder.read_compact_string()?;
        let error_code = decoder.read_i16()?;
        let error_message = decoder.read_compact_nullable_string()?;
        let credential_infos = decoder
            .read_compact_array(
                "described SCRAM credential infos",
                ScramCredentialInfoV0::decode,
            )?
            .unwrap_or_default();
        decoder.read_tagged_fields()?;
        Ok(Self {
            user,
            error_code,
            error_message,
            credential_infos,
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ScramCredentialInfoV0 {
    pub mechanism: i8,
    pub iterations: i32,
}

impl ScramCredentialInfoV0 {
    fn decode(decoder: &mut Decoder<'_>) -> Result<Self> {
        let mechanism = decoder.read_i8()?;
        let iterations = decoder.read_i32()?;
        decoder.read_tagged_fields()?;
        Ok(Self {
            mechanism,
            iterations,
        })
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::{
        DescribeUserScramCredentialsRequestV0, DescribeUserScramCredentialsResponseV0, API_KEY,
    };
    use crate::codec::{Decoder, Encoder};

    #[test]
    fn encodes_describe_all_user_scram_credentials_v0_request() {
        let request = DescribeUserScramCredentialsRequestV0 {
            correlation_id: 23,
            client_id: Some("kafrust".to_owned()),
            users: None,
        };

        let bytes = request.encode().unwrap();
        assert_eq!(&bytes[0..4], &[0, API_KEY as u8, 0, 0]);
        assert_eq!(&bytes[4..8], &[0, 0, 0, 23]);
        assert_eq!(&bytes[bytes.len() - 2..], &[0, 0]);
    }

    #[test]
    fn decodes_describe_user_scram_credentials_v0_response() {
        let mut bytes = Encoder::new();
        bytes.write_i32(9);
        bytes.write_i16(0);
        bytes.write_compact_nullable_string(None).unwrap();
        bytes.write_unsigned_varint(2); // one result
        bytes.write_compact_string("alice").unwrap();
        bytes.write_i16(0);
        bytes.write_compact_nullable_string(None).unwrap();
        bytes.write_unsigned_varint(3); // two credential infos
        bytes.write_i8(1);
        bytes.write_i32(4096);
        bytes.write_empty_tagged_fields();
        bytes.write_i8(2);
        bytes.write_i32(8192);
        bytes.write_empty_tagged_fields();
        bytes.write_empty_tagged_fields();
        bytes.write_empty_tagged_fields();
        let bytes = bytes.into_bytes();
        let mut decoder = Decoder::new(&bytes);

        let response = DescribeUserScramCredentialsResponseV0::decode_body(&mut decoder).unwrap();

        assert_eq!(response.throttle_time_ms, 9);
        assert_eq!(response.results[0].user, "alice");
        assert_eq!(response.results[0].credential_infos[0].mechanism, 1);
        assert_eq!(response.results[0].credential_infos[1].iterations, 8192);
        assert!(decoder.is_empty());
    }
}