ironflow_cli/commands/
audit_log.rs

1//! Audit log subcommands: list.
2
3use anyhow::Result;
4use chrono::{DateTime, Utc};
5use clap::{Args, Subcommand};
6use ironflow_sdk::IronflowClient;
7use ironflow_sdk::client::ListAuditLogsFilter;
8use ironflow_sdk::types::EventKind;
9use uuid::Uuid;
10
11use crate::commands::parse_enum;
12use crate::output;
13
14/// Arguments for the `audit-log` command group.
15#[derive(Debug, Args)]
16pub struct AuditLogArgs {
17    /// Audit log subcommand.
18    #[command(subcommand)]
19    pub command: AuditLogCommands,
20}
21
22/// Available audit log subcommands.
23#[derive(Debug, Subcommand)]
24pub enum AuditLogCommands {
25    /// List audit log entries with optional filters.
26    List {
27        /// Only entries attached to this run.
28        #[arg(long = "run", value_name = "UUID")]
29        run: Option<Uuid>,
30        /// Only entries of this event type (e.g. `run_created`).
31        #[arg(long = "type", value_name = "KIND", value_parser = parse_event_kind)]
32        event_type: Option<EventKind>,
33        /// Only entries recorded at or after this instant (RFC 3339).
34        #[arg(long)]
35        from: Option<DateTime<Utc>>,
36        /// Only entries recorded at or before this instant (RFC 3339).
37        #[arg(long)]
38        to: Option<DateTime<Utc>>,
39        /// Page number (1-based).
40        #[arg(long)]
41        page: Option<u32>,
42        /// Items per page.
43        #[arg(long)]
44        per_page: Option<u32>,
45    },
46}
47
48/// Every event kind the API records, in the order the enum declares them.
49const ALL_EVENT_KINDS: [EventKind; 18] = [
50    EventKind::RunCreated,
51    EventKind::RunStatusChanged,
52    EventKind::RunFailed,
53    EventKind::RunBudgetExceeded,
54    EventKind::StepCompleted,
55    EventKind::StepFailed,
56    EventKind::ApprovalRequested,
57    EventKind::ApprovalGranted,
58    EventKind::ApprovalRejected,
59    EventKind::ApprovalEscalated,
60    EventKind::LogLine,
61    EventKind::UserSignedIn,
62    EventKind::UserSignedUp,
63    EventKind::UserSignedOut,
64    EventKind::ProviderAccountUpdated,
65    EventKind::SignalAwaited,
66    EventKind::SignalReceived,
67    EventKind::ScheduleOccurrencesMissed,
68];
69
70/// Parse a `--type` value, listing the accepted values on failure.
71///
72/// # Errors
73///
74/// Returns the list of accepted event kinds when `raw` is not one of them.
75fn parse_event_kind(raw: &str) -> Result<EventKind, String> {
76    parse_enum(raw, &ALL_EVENT_KINDS, "event type")
77}
78
79/// Execute an audit log subcommand.
80///
81/// # Errors
82///
83/// Returns an error on API failure, including 403 for non-admin callers.
84pub async fn execute(client: &IronflowClient, args: &AuditLogArgs, json_mode: bool) -> Result<()> {
85    match &args.command {
86        AuditLogCommands::List {
87            run,
88            event_type,
89            from,
90            to,
91            page,
92            per_page,
93        } => {
94            let event_type = event_type.as_ref().map(ToString::to_string);
95            let filter = ListAuditLogsFilter {
96                run_id: *run,
97                event_type: event_type.as_deref(),
98                from: *from,
99                to: *to,
100                page: *page,
101                per_page: *per_page,
102            };
103
104            let response = client.list_audit_logs_filtered(&filter).await?;
105            output::print_output(json_mode, &response, || {
106                output::audit_logs_table(&response.data)
107            })?;
108        }
109    }
110    Ok(())
111}
112
113#[cfg(test)]
114mod tests {
115    use super::*;
116
117    #[test]
118    fn parse_event_kind_accepts_every_declared_kind() {
119        for kind in ALL_EVENT_KINDS {
120            let raw = kind.to_string();
121            assert_eq!(parse_event_kind(&raw).unwrap(), kind);
122        }
123    }
124
125    #[test]
126    fn parse_event_kind_rejects_an_unknown_value_and_lists_the_valid_ones() {
127        let err = parse_event_kind("run_exploded").unwrap_err();
128        assert!(err.contains("unknown event type 'run_exploded'"), "{err}");
129        assert!(err.contains("run_created"), "{err}");
130    }
131}
ironflow_cli/commands/audit_log.rs

ironflow_cli/commands/
audit_log.rs
