aws-lite-rs 0.1.1

Lightweight HTTP client for AWS APIs
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
//! Amazon CloudWatch Logs API client.
//!
//! Thin wrapper over generated ops. All URL construction and HTTP methods
//! are in `ops::logs::LogsOps`. This layer adds:
//! - Ergonomic method signatures
//! - Pagination stream helpers

use crate::{
    AwsHttpClient, Result,
    ops::logs::LogsOps,
    types::logs::{
        DeleteLogStreamRequest, DescribeLogGroupsRequest, DescribeLogGroupsResponse,
        DescribeLogStreamsRequest, DescribeLogStreamsResponse, DescribeMetricFiltersRequest,
        DescribeMetricFiltersResponse, ListTagsForResourceRequest, ListTagsForResourceResponse,
        LogGroup, MetricFilter, PutRetentionPolicyRequest,
    },
};

/// Client for the Amazon CloudWatch Logs API
pub struct LogsClient<'a> {
    ops: LogsOps<'a>,
}

impl<'a> LogsClient<'a> {
    /// Create a new Amazon CloudWatch Logs API client
    pub(crate) fn new(client: &'a AwsHttpClient) -> Self {
        Self {
            ops: LogsOps::new(client),
        }
    }

    /// Lists the specified log groups.
    pub async fn describe_log_groups(
        &self,
        body: &DescribeLogGroupsRequest,
    ) -> Result<DescribeLogGroupsResponse> {
        self.ops.describe_log_groups(body).await
    }

    /// Stream all log groups, automatically handling pagination.
    pub fn describe_log_groups_stream(
        &self,
    ) -> impl futures_core::Stream<Item = Result<LogGroup>> + '_ {
        async_stream::try_stream! {
            let mut next_token: Option<String> = None;
            loop {
                let request = DescribeLogGroupsRequest {
                    next_token: next_token.clone(),
                    ..Default::default()
                };
                let response = self.ops.describe_log_groups(&request).await?;
                for group in response.log_groups {
                    yield group;
                }
                match response.next_token {
                    Some(token) if !token.is_empty() => next_token = Some(token),
                    _ => break,
                }
            }
        }
    }

    /// Displays the tags associated with a CloudWatch Logs resource.
    pub async fn list_tags_for_resource(
        &self,
        body: &ListTagsForResourceRequest,
    ) -> Result<ListTagsForResourceResponse> {
        self.ops.list_tags_for_resource(body).await
    }

    /// Lists the log streams for the specified log group.
    pub async fn describe_log_streams(
        &self,
        body: &DescribeLogStreamsRequest,
    ) -> Result<DescribeLogStreamsResponse> {
        self.ops.describe_log_streams(body).await
    }

    /// Sets the retention of the specified log group.
    pub async fn put_retention_policy(
        &self,
        log_group_name: &str,
        retention_in_days: i32,
    ) -> Result<()> {
        let body = PutRetentionPolicyRequest {
            log_group_name: log_group_name.into(),
            retention_in_days,
        };
        self.ops.put_retention_policy(&body).await
    }

    /// Deletes the specified log stream.
    pub async fn delete_log_stream(
        &self,
        log_group_name: &str,
        log_stream_name: &str,
    ) -> Result<()> {
        let body = DeleteLogStreamRequest {
            log_group_name: log_group_name.into(),
            log_stream_name: log_stream_name.into(),
        };
        self.ops.delete_log_stream(&body).await
    }

    // ── Metric Filters ─────────────────────────────────────────────────

    /// Return the first page of metric filters.
    ///
    /// Optionally filter by `log_group_name` or `filter_name_prefix`.
    /// Pass `next_token` from a previous response to paginate.
    ///
    /// CIS 5.1–5.15: check whether a metric filter with the expected pattern
    /// exists before checking the corresponding CloudWatch alarm.
    pub async fn describe_metric_filters(
        &self,
        log_group_name: Option<&str>,
        filter_name_prefix: Option<&str>,
        next_token: Option<&str>,
    ) -> Result<DescribeMetricFiltersResponse> {
        let body = DescribeMetricFiltersRequest {
            log_group_name: log_group_name.map(str::to_string),
            filter_name_prefix: filter_name_prefix.map(str::to_string),
            next_token: next_token.map(str::to_string),
            ..Default::default()
        };
        self.ops.describe_metric_filters(&body).await
    }

    /// Return all metric filters, following pagination.
    ///
    /// Optionally scope to a specific `log_group_name`.
    ///
    /// CIS 5.1–5.15: collect all metric filters, then search for the
    /// expected `filterPattern` values for each alarm check.
    pub async fn list_all_metric_filters(
        &self,
        log_group_name: Option<&str>,
    ) -> Result<Vec<MetricFilter>> {
        let mut all = Vec::new();
        let mut next_token: Option<String> = None;
        loop {
            let body = DescribeMetricFiltersRequest {
                log_group_name: log_group_name.map(str::to_string),
                next_token: next_token.clone(),
                ..Default::default()
            };
            let resp = self.ops.describe_metric_filters(&body).await?;
            all.extend(resp.metric_filters);
            match resp.next_token {
                Some(t) if !t.is_empty() => next_token = Some(t),
                _ => break,
            }
        }
        Ok(all)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::mock_client::MockClient;
    use tokio_stream::StreamExt;

    #[tokio::test]
    async fn describe_log_groups_stream_paginates() {
        let mut mock = MockClient::new();

        // Single expectation with two sequential responses
        mock.expect_post("/")
            .returning_json_sequence(vec![
                serde_json::json!({
                    "logGroups": [{"logGroupName": "/aws/lambda/page1"}],
                    "nextToken": "token-abc"
                }),
                serde_json::json!({
                    "logGroups": [{"logGroupName": "/aws/lambda/page2"}]
                }),
            ])
            .times(2);

        let client = AwsHttpClient::from_mock(mock);
        let logs = client.logs();

        let groups: Vec<LogGroup> = logs
            .describe_log_groups_stream()
            .map(|r| r.unwrap())
            .collect()
            .await;

        assert_eq!(groups.len(), 2);
        assert_eq!(
            groups[0].log_group_name,
            Some("/aws/lambda/page1".to_string())
        );
        assert_eq!(
            groups[1].log_group_name,
            Some("/aws/lambda/page2".to_string())
        );
    }

    #[tokio::test]
    async fn describe_log_groups_stream_single_page() {
        let mut mock = MockClient::new();

        mock.expect_post("/").returning_json(serde_json::json!({
            "logGroups": [
                {"logGroupName": "/aws/lambda/one"},
                {"logGroupName": "/aws/lambda/two"}
            ]
        }));

        let client = AwsHttpClient::from_mock(mock);
        let logs = client.logs();

        let groups: Vec<LogGroup> = logs
            .describe_log_groups_stream()
            .map(|r| r.unwrap())
            .collect()
            .await;

        assert_eq!(groups.len(), 2);
    }

    #[tokio::test]
    async fn describe_log_groups_stream_empty() {
        let mut mock = MockClient::new();

        mock.expect_post("/").returning_json(serde_json::json!({
            "logGroups": []
        }));

        let client = AwsHttpClient::from_mock(mock);
        let logs = client.logs();

        let groups: Vec<LogGroup> = logs
            .describe_log_groups_stream()
            .map(|r| r.unwrap())
            .collect()
            .await;

        assert_eq!(groups.len(), 0);
    }

    #[tokio::test]
    async fn describe_log_streams_returns_parsed_response() {
        let mut mock = MockClient::new();
        mock.expect_post("/").returning_json(serde_json::json!({
            "logStreams": [
                {
                    "logStreamName": "stream-1",
                    "creationTime": 1700000000000_i64,
                    "arn": "arn:aws:logs:us-east-1:123:log-group:/test:log-stream:stream-1"
                }
            ]
        }));

        let client = AwsHttpClient::from_mock(mock);
        let result = client
            .logs()
            .describe_log_streams(&DescribeLogStreamsRequest {
                log_group_name: Some("/test".into()),
                ..Default::default()
            })
            .await
            .unwrap();
        assert_eq!(result.log_streams.len(), 1);
        assert_eq!(
            result.log_streams[0].log_stream_name.as_deref(),
            Some("stream-1")
        );
        assert!(result.log_streams[0].creation_time.is_some());
    }

    #[tokio::test]
    async fn put_retention_policy_succeeds() {
        let mut mock = MockClient::new();
        mock.expect_post("/")
            .returning_json(serde_json::json!(null));

        let client = AwsHttpClient::from_mock(mock);
        client
            .logs()
            .put_retention_policy("/test-group", 7)
            .await
            .unwrap();
    }

    #[tokio::test]
    async fn delete_log_stream_succeeds() {
        let mut mock = MockClient::new();
        mock.expect_post("/")
            .returning_json(serde_json::json!(null));

        let client = AwsHttpClient::from_mock(mock);
        client
            .logs()
            .delete_log_stream("/test-group", "test-stream")
            .await
            .unwrap();
    }

    // ── Metric Filters ─────────────────────────────────────────────────

    #[tokio::test]
    async fn describe_metric_filters_returns_filters() {
        let mut mock = MockClient::new();
        mock.expect_post("/").returning_json(serde_json::json!({
            "metricFilters": [
                {
                    "filterName": "UnauthorizedApiCalls",
                    "filterPattern": "{ ($.errorCode = \"*UnauthorizedOperation\") || ($.errorCode = \"AccessDenied*\") }",
                    "logGroupName": "CloudTrail/DefaultLogGroup",
                    "creationTime": 1700000000000_i64,
                    "metricTransformations": [
                        {
                            "metricName": "UnauthorizedApiCallCount",
                            "metricNamespace": "CISBenchmark",
                            "metricValue": "1"
                        }
                    ]
                }
            ]
        }));

        let client = AwsHttpClient::from_mock(mock);
        let resp = client
            .logs()
            .describe_metric_filters(Some("CloudTrail/DefaultLogGroup"), None, None)
            .await
            .unwrap();

        assert_eq!(resp.metric_filters.len(), 1);
        let f = &resp.metric_filters[0];
        assert_eq!(f.filter_name.as_deref(), Some("UnauthorizedApiCalls"));
        assert!(
            f.filter_pattern
                .as_deref()
                .unwrap_or("")
                .contains("UnauthorizedOperation")
        );
        assert_eq!(
            f.log_group_name.as_deref(),
            Some("CloudTrail/DefaultLogGroup")
        );
        assert_eq!(f.metric_transformations.len(), 1);
        assert_eq!(
            f.metric_transformations[0].metric_name,
            "UnauthorizedApiCallCount"
        );
        assert_eq!(f.metric_transformations[0].metric_namespace, "CISBenchmark");
    }

    #[tokio::test]
    async fn describe_metric_filters_handles_empty() {
        let mut mock = MockClient::new();
        mock.expect_post("/")
            .returning_json(serde_json::json!({"metricFilters": []}));

        let client = AwsHttpClient::from_mock(mock);
        let resp = client
            .logs()
            .describe_metric_filters(None, None, None)
            .await
            .unwrap();
        assert!(resp.metric_filters.is_empty());
    }

    #[tokio::test]
    async fn list_all_metric_filters_paginates() {
        let mut mock = MockClient::new();
        mock.expect_post("/")
            .returning_json_sequence(vec![
                serde_json::json!({
                    "metricFilters": [{
                        "filterName": "Filter1",
                        "filterPattern": "{ $.errorCode = \"*\" }",
                        "logGroupName": "/aws/cloudtrail",
                        "metricTransformations": [{"metricName": "M1", "metricNamespace": "NS", "metricValue": "1"}]
                    }],
                    "nextToken": "page2"
                }),
                serde_json::json!({
                    "metricFilters": [{
                        "filterName": "Filter2",
                        "filterPattern": "{ $.eventName = \"ConsoleLogin\" }",
                        "logGroupName": "/aws/cloudtrail",
                        "metricTransformations": [{"metricName": "M2", "metricNamespace": "NS", "metricValue": "1"}]
                    }]
                }),
            ])
            .times(2);

        let client = AwsHttpClient::from_mock(mock);
        let filters = client
            .logs()
            .list_all_metric_filters(Some("/aws/cloudtrail"))
            .await
            .unwrap();

        assert_eq!(filters.len(), 2);
        assert_eq!(filters[0].filter_name.as_deref(), Some("Filter1"));
        assert_eq!(filters[1].filter_name.as_deref(), Some("Filter2"));
    }
}