redisctl 0.10.1

Unified CLI for Redis Cloud and Enterprise
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
use crate::error::RedisCtlError;
use anyhow::Context;
use clap::Subcommand;

use crate::cli::OutputFormat;
use crate::connection::ConnectionManager;
use crate::error::Result as CliResult;

#[derive(Debug, Clone, Subcommand)]
pub enum JobSchedulerCommands {
    /// List all scheduled jobs
    List,

    /// Get a specific scheduled job
    Get {
        /// Job ID
        job_id: String,
    },

    /// Create a new scheduled job
    #[command(after_help = "EXAMPLES:
    # Create a backup job running daily at 2am
    redisctl enterprise job-scheduler create --name daily-backup --job-type backup --schedule '0 2 * * *'

    # Create an enabled cleanup job
    redisctl enterprise job-scheduler create --name cleanup --job-type cleanup --schedule '0 0 * * 0' --enabled

    # Create job with parameters
    redisctl enterprise job-scheduler create --name rotation --job-type rotation --schedule '0 3 * * *' \\
        --params '{\"retain_days\": 30}'

    # Using JSON for advanced configuration
    redisctl enterprise job-scheduler create --data @job.json")]
    Create {
        /// Job name (required unless using --data)
        #[arg(long)]
        name: Option<String>,

        /// Job type (backup, cleanup, rotation, etc.)
        #[arg(long)]
        job_type: Option<String>,

        /// Cron-style schedule expression (e.g., '0 2 * * *' for daily at 2am)
        #[arg(long)]
        schedule: Option<String>,

        /// Enable the job immediately
        #[arg(long)]
        enabled: bool,

        /// Job-specific parameters as JSON
        #[arg(long)]
        params: Option<String>,

        /// JSON data for advanced configuration (overridden by other flags)
        #[arg(long)]
        data: Option<String>,
    },

    /// Update a scheduled job
    #[command(after_help = "EXAMPLES:
    # Update job schedule
    redisctl enterprise job-scheduler update my-job --schedule '0 4 * * *'

    # Enable/disable a job
    redisctl enterprise job-scheduler update my-job --enabled false

    # Update job name
    redisctl enterprise job-scheduler update my-job --name new-job-name

    # Update job parameters
    redisctl enterprise job-scheduler update my-job --params '{\"retain_days\": 60}'

    # Using JSON for advanced configuration
    redisctl enterprise job-scheduler update my-job --data @updates.json")]
    Update {
        /// Job ID
        job_id: String,

        /// New job name
        #[arg(long)]
        name: Option<String>,

        /// New job type
        #[arg(long)]
        job_type: Option<String>,

        /// New cron-style schedule expression
        #[arg(long)]
        schedule: Option<String>,

        /// Enable/disable the job
        #[arg(long)]
        enabled: Option<bool>,

        /// Job-specific parameters as JSON
        #[arg(long)]
        params: Option<String>,

        /// JSON data for advanced configuration (overridden by other flags)
        #[arg(long)]
        data: Option<String>,
    },

    /// Delete a scheduled job
    Delete {
        /// Job ID
        job_id: String,

        /// Skip confirmation prompt
        #[arg(long)]
        force: bool,
    },

    /// Trigger immediate execution of a scheduled job
    Trigger {
        /// Job ID
        job_id: String,
    },

    /// Get execution history for a job
    History {
        /// Job ID
        job_id: String,
    },
}

impl JobSchedulerCommands {
    #[allow(dead_code)]
    pub async fn execute(
        &self,
        conn_mgr: &ConnectionManager,
        profile_name: Option<&str>,
        output_format: OutputFormat,
        query: Option<&str>,
    ) -> CliResult<()> {
        let client = conn_mgr.create_enterprise_client(profile_name).await?;

        match self {
            JobSchedulerCommands::List => {
                let response: serde_json::Value = client
                    .get("/v1/job_scheduler")
                    .await
                    .map_err(RedisCtlError::from)?;

                let output_data = if let Some(q) = query {
                    super::utils::apply_jmespath(&response, q)?
                } else {
                    response
                };
                super::utils::print_formatted_output(output_data, output_format)?;
            }

            JobSchedulerCommands::Get { job_id } => {
                let response: serde_json::Value = client
                    .get(&format!("/v1/job_scheduler/{}", job_id))
                    .await
                    .context(format!("Failed to get job '{}'", job_id))?;

                let output_data = if let Some(q) = query {
                    super::utils::apply_jmespath(&response, q)?
                } else {
                    response
                };
                super::utils::print_formatted_output(output_data, output_format)?;
            }

            JobSchedulerCommands::Create {
                name,
                job_type,
                schedule,
                enabled,
                params,
                data,
            } => {
                // Start with JSON data if provided, otherwise empty object
                let mut request_obj: serde_json::Map<String, serde_json::Value> =
                    if let Some(json_data) = data {
                        let parsed = super::utils::read_json_data(json_data)?;
                        parsed
                            .as_object()
                            .cloned()
                            .unwrap_or_else(serde_json::Map::new)
                    } else {
                        serde_json::Map::new()
                    };

                // Override with first-class parameters if provided
                if let Some(n) = name {
                    request_obj.insert("name".to_string(), serde_json::json!(n));
                }
                if let Some(jt) = job_type {
                    request_obj.insert("job_type".to_string(), serde_json::json!(jt));
                }
                if let Some(s) = schedule {
                    request_obj.insert("schedule".to_string(), serde_json::json!(s));
                }
                if *enabled {
                    request_obj.insert("enabled".to_string(), serde_json::json!(true));
                }
                if let Some(p) = params {
                    let params_value: serde_json::Value =
                        serde_json::from_str(p).context("Invalid JSON for --params")?;
                    request_obj.insert("params".to_string(), params_value);
                }

                // Validate required fields for create
                if !request_obj.contains_key("name") {
                    return Err(RedisCtlError::InvalidInput {
                        message: "--name is required when not using --data".to_string(),
                    });
                }
                if !request_obj.contains_key("job_type") {
                    return Err(RedisCtlError::InvalidInput {
                        message: "--job-type is required when not using --data".to_string(),
                    });
                }
                if !request_obj.contains_key("schedule") {
                    return Err(RedisCtlError::InvalidInput {
                        message: "--schedule is required when not using --data".to_string(),
                    });
                }

                let payload = serde_json::Value::Object(request_obj);
                let response: serde_json::Value = client
                    .post("/v1/job_scheduler", &payload)
                    .await
                    .map_err(RedisCtlError::from)?;

                let output_data = if let Some(q) = query {
                    super::utils::apply_jmespath(&response, q)?
                } else {
                    response
                };
                super::utils::print_formatted_output(output_data, output_format)?;
            }

            JobSchedulerCommands::Update {
                job_id,
                name,
                job_type,
                schedule,
                enabled,
                params,
                data,
            } => {
                // Start with JSON data if provided, otherwise empty object
                let mut request_obj: serde_json::Map<String, serde_json::Value> =
                    if let Some(json_data) = data {
                        let parsed = super::utils::read_json_data(json_data)?;
                        parsed
                            .as_object()
                            .cloned()
                            .unwrap_or_else(serde_json::Map::new)
                    } else {
                        serde_json::Map::new()
                    };

                // Override with first-class parameters if provided
                if let Some(n) = name {
                    request_obj.insert("name".to_string(), serde_json::json!(n));
                }
                if let Some(jt) = job_type {
                    request_obj.insert("job_type".to_string(), serde_json::json!(jt));
                }
                if let Some(s) = schedule {
                    request_obj.insert("schedule".to_string(), serde_json::json!(s));
                }
                if let Some(e) = enabled {
                    request_obj.insert("enabled".to_string(), serde_json::json!(e));
                }
                if let Some(p) = params {
                    let params_value: serde_json::Value =
                        serde_json::from_str(p).context("Invalid JSON for --params")?;
                    request_obj.insert("params".to_string(), params_value);
                }

                // Validate at least one update field is provided
                if request_obj.is_empty() {
                    return Err(RedisCtlError::InvalidInput {
                        message: "At least one update field is required (--name, --job-type, --schedule, --enabled, --params, or --data)".to_string(),
                    });
                }

                let payload = serde_json::Value::Object(request_obj);
                let response: serde_json::Value = client
                    .put(&format!("/v1/job_scheduler/{}", job_id), &payload)
                    .await
                    .context(format!("Failed to update job '{}'", job_id))?;

                let output_data = if let Some(q) = query {
                    super::utils::apply_jmespath(&response, q)?
                } else {
                    response
                };
                super::utils::print_formatted_output(output_data, output_format)?;
            }

            JobSchedulerCommands::Delete { job_id, force } => {
                if !force
                    && !super::utils::confirm_action(&format!(
                        "Delete scheduled job '{}'?",
                        job_id
                    ))?
                {
                    return Ok(());
                }

                client
                    .delete(&format!("/v1/job_scheduler/{}", job_id))
                    .await
                    .context(format!("Failed to delete job '{}'", job_id))?;

                println!("Scheduled job '{}' deleted successfully", job_id);
            }

            JobSchedulerCommands::Trigger { job_id } => {
                let response: serde_json::Value = client
                    .post(
                        &format!("/v1/job_scheduler/{}/trigger", job_id),
                        &serde_json::Value::Null,
                    )
                    .await
                    .context(format!("Failed to trigger job '{}'", job_id))?;

                let output_data = if let Some(q) = query {
                    super::utils::apply_jmespath(&response, q)?
                } else {
                    response
                };
                super::utils::print_formatted_output(output_data, output_format)?;
            }

            JobSchedulerCommands::History { job_id } => {
                let response: serde_json::Value = client
                    .get(&format!("/v1/job_scheduler/{}/history", job_id))
                    .await
                    .context(format!("Failed to get history for job '{}'", job_id))?;

                let output_data = if let Some(q) = query {
                    super::utils::apply_jmespath(&response, q)?
                } else {
                    response
                };
                super::utils::print_formatted_output(output_data, output_format)?;
            }
        }

        Ok(())
    }
}

#[allow(dead_code)]
pub async fn handle_job_scheduler_command(
    conn_mgr: &ConnectionManager,
    profile_name: Option<&str>,
    job_scheduler_cmd: JobSchedulerCommands,
    output_format: OutputFormat,
    query: Option<&str>,
) -> CliResult<()> {
    job_scheduler_cmd
        .execute(conn_mgr, profile_name, output_format, query)
        .await
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_job_scheduler_command_parsing() {
        use clap::Parser;

        #[derive(Parser)]
        struct TestCli {
            #[command(subcommand)]
            cmd: JobSchedulerCommands,
        }

        // Test list command
        let cli = TestCli::parse_from(["test", "list"]);
        assert!(matches!(cli.cmd, JobSchedulerCommands::List));

        // Test get command
        let cli = TestCli::parse_from(["test", "get", "my-job"]);
        if let JobSchedulerCommands::Get { job_id } = cli.cmd {
            assert_eq!(job_id, "my-job");
        } else {
            panic!("Expected Get command");
        }

        // Test create command with first-class params
        let cli = TestCli::parse_from([
            "test",
            "create",
            "--name",
            "backup-job",
            "--job-type",
            "backup",
            "--schedule",
            "0 2 * * *",
            "--enabled",
        ]);
        if let JobSchedulerCommands::Create {
            name,
            job_type,
            schedule,
            enabled,
            params,
            data,
        } = cli.cmd
        {
            assert_eq!(name, Some("backup-job".to_string()));
            assert_eq!(job_type, Some("backup".to_string()));
            assert_eq!(schedule, Some("0 2 * * *".to_string()));
            assert!(enabled);
            assert!(params.is_none());
            assert!(data.is_none());
        } else {
            panic!("Expected Create command");
        }

        // Test update command
        let cli = TestCli::parse_from([
            "test",
            "update",
            "my-job",
            "--schedule",
            "0 3 * * *",
            "--enabled",
            "false",
        ]);
        if let JobSchedulerCommands::Update {
            job_id,
            schedule,
            enabled,
            ..
        } = cli.cmd
        {
            assert_eq!(job_id, "my-job");
            assert_eq!(schedule, Some("0 3 * * *".to_string()));
            assert_eq!(enabled, Some(false));
        } else {
            panic!("Expected Update command");
        }

        // Test delete command
        let cli = TestCli::parse_from(["test", "delete", "my-job", "--force"]);
        if let JobSchedulerCommands::Delete { job_id, force } = cli.cmd {
            assert_eq!(job_id, "my-job");
            assert!(force);
        } else {
            panic!("Expected Delete command");
        }

        // Test trigger command
        let cli = TestCli::parse_from(["test", "trigger", "my-job"]);
        if let JobSchedulerCommands::Trigger { job_id } = cli.cmd {
            assert_eq!(job_id, "my-job");
        } else {
            panic!("Expected Trigger command");
        }

        // Test history command
        let cli = TestCli::parse_from(["test", "history", "my-job"]);
        if let JobSchedulerCommands::History { job_id } = cli.cmd {
            assert_eq!(job_id, "my-job");
        } else {
            panic!("Expected History command");
        }
    }
}