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

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

pub const API_KEY: i16 = 29;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescribeAclsRequestV1 {
    pub correlation_id: i32,
    pub client_id: Option<String>,
    pub resource_type_filter: i8,
    pub resource_name_filter: Option<String>,
    pub pattern_type_filter: i8,
    pub principal_filter: Option<String>,
    pub host_filter: Option<String>,
    pub operation: i8,
    pub permission_type: i8,
}

impl DescribeAclsRequestV1 {
    pub fn encode(&self) -> Result<Vec<u8>> {
        let mut encoder = Encoder::new();
        RequestHeader {
            api_key: API_KEY,
            api_version: 1,
            correlation_id: self.correlation_id,
            client_id: self.client_id.clone(),
        }
        .encode_v1(&mut encoder)?;
        encoder.write_i8(self.resource_type_filter);
        encoder.write_nullable_string(self.resource_name_filter.as_deref())?;
        encoder.write_i8(self.pattern_type_filter);
        encoder.write_nullable_string(self.principal_filter.as_deref())?;
        encoder.write_nullable_string(self.host_filter.as_deref())?;
        encoder.write_i8(self.operation);
        encoder.write_i8(self.permission_type);
        Ok(encoder.into_bytes())
    }
}

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

impl DescribeAclsResponseV1 {
    pub fn decode_body(decoder: &mut Decoder<'_>) -> Result<Self> {
        Ok(Self {
            throttle_time_ms: decoder.read_i32()?,
            error_code: decoder.read_i16()?,
            error_message: decoder.read_nullable_string()?,
            resources: decoder
                .read_array("describe ACL resources", DescribeAclsResourceV1::decode)?
                .unwrap_or_default(),
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescribeAclsResourceV1 {
    pub resource_type: i8,
    pub resource_name: String,
    pub pattern_type: i8,
    pub acls: Vec<DescribeAclsEntryV1>,
}

impl DescribeAclsResourceV1 {
    fn decode(decoder: &mut Decoder<'_>) -> Result<Self> {
        Ok(Self {
            resource_type: decoder.read_i8()?,
            resource_name: decoder.read_string()?,
            pattern_type: decoder.read_i8()?,
            acls: decoder
                .read_array("describe ACL entries", DescribeAclsEntryV1::decode)?
                .unwrap_or_default(),
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescribeAclsEntryV1 {
    pub principal: String,
    pub host: String,
    pub operation: i8,
    pub permission_type: i8,
}

impl DescribeAclsEntryV1 {
    fn decode(decoder: &mut Decoder<'_>) -> Result<Self> {
        Ok(Self {
            principal: decoder.read_string()?,
            host: decoder.read_string()?,
            operation: decoder.read_i8()?,
            permission_type: decoder.read_i8()?,
        })
    }
}

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

    #[test]
    fn encodes_describe_acls_v1_request() {
        let request = DescribeAclsRequestV1 {
            correlation_id: 17,
            client_id: Some("kafrust".to_owned()),
            resource_type_filter: 2,
            resource_name_filter: Some("orders".to_owned()),
            pattern_type_filter: 3,
            principal_filter: Some("User:alice".to_owned()),
            host_filter: Some("*".to_owned()),
            operation: 3,
            permission_type: 1,
        };

        let bytes = request.encode().unwrap();
        assert_eq!(&bytes[0..4], &[0, API_KEY as u8, 0, 1]);
        assert_eq!(&bytes[4..8], &[0, 0, 0, 17]);
        assert_eq!(bytes.last(), Some(&1));
    }

    #[test]
    fn decodes_describe_acls_v1_response() {
        let mut bytes = Encoder::new();
        bytes.write_i32(7);
        bytes.write_i16(0);
        bytes.write_nullable_string(None).unwrap();
        bytes.write_i32(1);
        bytes.write_i8(2);
        bytes.write_string("orders").unwrap();
        bytes.write_i8(3);
        bytes.write_i32(1);
        bytes.write_string("User:alice").unwrap();
        bytes.write_string("*").unwrap();
        bytes.write_i8(3);
        bytes.write_i8(1);
        let bytes = bytes.into_bytes();
        let mut decoder = Decoder::new(&bytes);

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

        assert_eq!(response.throttle_time_ms, 7);
        assert_eq!(response.resources[0].resource_name, "orders");
        assert_eq!(response.resources[0].pattern_type, 3);
        assert_eq!(response.resources[0].acls[0].principal, "User:alice");
        assert_eq!(response.resources[0].acls[0].operation, 3);
        assert!(decoder.is_empty());
    }
}