address some minor inconsistencies and add more test cases on the

schedule commands

Author: Davidonium

internal/cmd/backup/restore_trigger.go

@@ -54,6 +54,7 @@ func newRestoreTriggerCommand(s *state.State) *cobra.Command {
 			}
 
 			fmt.Fprintf(cmd.OutOrStdout(), "Restore of backup %s started.\n", backupID)
+			fmt.Fprintln(cmd.OutOrStdout(), "Run 'qcloud backup restore list' to track progress.")
 			return nil
 		},
 	}.CobraCommand(s)

internal/cmd/backup/restore_trigger_test.go

@@ -26,8 +26,21 @@ func TestRestoreTrigger_WithForce(t *testing.T) {
 	stdout, _, err := testutil.Exec(t, env, "backup", "restore", "trigger", "backup-abc", "--force")
 	require.NoError(t, err)
 	assert.Equal(t, "backup-abc", capturedBackupID)
-	assert.Contains(t, stdout, "backup-abc")
-	assert.Contains(t, stdout, "started")
+	assert.Contains(t, stdout, "Restore of backup backup-abc started.")
+	assert.Contains(t, stdout, "Run 'qcloud backup restore list' to track progress.")
+}
+
+func TestRestoreTrigger_Aborted(t *testing.T) {
+	env := testutil.NewTestEnv(t)
+	t.Cleanup(env.Cleanup)
+
+	env.BackupServer.RestoreBackupFunc = func(_ context.Context, _ *backupv1.RestoreBackupRequest) (*backupv1.RestoreBackupResponse, error) {
+		panic("RestoreBackup must not be called when aborted")
+	}
+
+	stdout, _, err := testutil.Exec(t, env, "backup", "restore", "trigger", "backup-abc")
+	require.NoError(t, err)
+	assert.Contains(t, stdout, "Aborted.")
 }
 
 func TestRestoreTrigger_APIError(t *testing.T) {

internal/cmd/backup/schedule_create_test.go

@@ -91,3 +91,21 @@ func TestScheduleCreate_MissingFlags(t *testing.T) {
 	_, _, err := testutil.Exec(t, env, "backup", "schedule", "create", "--cluster-id=cluster-abc")
 	require.Error(t, err)
 }
+
+func TestScheduleCreate_MissingClusterID(t *testing.T) {
+	env := testutil.NewTestEnv(t)
+	t.Cleanup(env.Cleanup)
+
+	_, _, err := testutil.Exec(t, env, "backup", "schedule", "create",
+		"--schedule=0 2 * * *", "--retention-days=30")
+	require.Error(t, err)
+}
+
+func TestScheduleCreate_MissingRetentionDays(t *testing.T) {
+	env := testutil.NewTestEnv(t)
+	t.Cleanup(env.Cleanup)
+
+	_, _, err := testutil.Exec(t, env, "backup", "schedule", "create",
+		"--cluster-id=cluster-abc", "--schedule=0 2 * * *")
+	require.Error(t, err)
+}

internal/cmd/backup/schedule_describe.go

@@ -27,8 +27,11 @@ func nextScheduleRun(cronExpr string) (time.Time, bool) {
 
 func newScheduleDescribeCommand(s *state.State) *cobra.Command {
 	cmd := base.DescribeCmd[*backupv1.BackupSchedule]{
-		Use:               "describe <schedule-id>",
-		Short:             "Describe a backup schedule",
+		Use:   "describe <schedule-id>",
+		Short: "Describe a backup schedule",
+		Long: `Describe a backup schedule.
+
+The --cluster-id flag is required because the API requires the cluster ID to look up a schedule by ID.`,
 		Args:              util.ExactArgs(1, "a schedule ID"),
 		ValidArgsFunction: scheduleIDCompletion(s),
 		Fetch: func(s *state.State, cmd *cobra.Command, args []string) (*backupv1.BackupSchedule, error) {

internal/cmd/backup/schedule_describe_test.go

@@ -38,6 +38,7 @@ func TestScheduleDescribe_TextOutput(t *testing.T) {
 	assert.Contains(t, stdout, "schedule-1")
 	assert.Contains(t, stdout, "cluster-abc")
 	assert.Contains(t, stdout, "0 2 * * *")
+	assert.Contains(t, stdout, "Next Run:")
 	assert.Contains(t, stdout, "ACTIVE")
 }
 

internal/cmd/backup/schedule_list_test.go

@@ -39,6 +39,7 @@ func TestScheduleList_TableOutput(t *testing.T) {
 	assert.Contains(t, stdout, "CLUSTER")
 	assert.Contains(t, stdout, "SCHEDULE")
 	assert.Contains(t, stdout, "STATUS")
+	assert.Contains(t, stdout, "NEXT RUN")
 	assert.Contains(t, stdout, "schedule-1")
 	assert.Contains(t, stdout, "cluster-abc")
 	assert.Contains(t, stdout, "0 2 * * *")

internal/cmd/backup/schedule_update.go

@@ -22,7 +22,10 @@ func newScheduleUpdateCommand(s *state.State) *cobra.Command {
 			cmd := &cobra.Command{
 				Use:   "update <schedule-id>",
 				Short: "Update a backup schedule",
-				Args:  util.ExactArgs(1, "a schedule ID"),
+				Long: `Update a backup schedule.
+
+The --cluster-id flag is required because the API requires the cluster ID to look up a schedule by ID.`,
+				Args: util.ExactArgs(1, "a schedule ID"),
 			}
 			cmd.Flags().String("cluster-id", "", "Cluster ID (required)")
 			cmd.Flags().String("schedule", "", "New cron schedule expression in UTC, e.g. '0 2 * * *'")

internal/cmd/backup/schedule_update_test.go

@@ -87,6 +87,32 @@ func TestScheduleUpdate_InvalidRetention(t *testing.T) {
 	require.Error(t, err)
 }
 
+func TestScheduleUpdate_WithRetention(t *testing.T) {
+	env := testutil.NewTestEnv(t)
+	t.Cleanup(env.Cleanup)
+
+	env.BackupServer.GetBackupScheduleFunc = func(_ context.Context, _ *backupv1.GetBackupScheduleRequest) (*backupv1.GetBackupScheduleResponse, error) {
+		return &backupv1.GetBackupScheduleResponse{
+			BackupSchedule: &backupv1.BackupSchedule{Id: "schedule-1", Schedule: "0 2 * * *"},
+		}, nil
+	}
+
+	var capturedRetentionDays int64
+	env.BackupServer.UpdateBackupScheduleFunc = func(_ context.Context, req *backupv1.UpdateBackupScheduleRequest) (*backupv1.UpdateBackupScheduleResponse, error) {
+		if req.GetBackupSchedule().GetRetentionPeriod() != nil {
+			capturedRetentionDays = int64(req.GetBackupSchedule().GetRetentionPeriod().AsDuration().Hours()) / 24
+		}
+		return &backupv1.UpdateBackupScheduleResponse{
+			BackupSchedule: &backupv1.BackupSchedule{Id: "schedule-1"},
+		}, nil
+	}
+
+	_, _, err := testutil.Exec(t, env, "backup", "schedule", "update", "schedule-1",
+		"--cluster-id=cluster-abc", "--retention-days=14")
+	require.NoError(t, err)
+	assert.Equal(t, int64(14), capturedRetentionDays)
+}
+
 func TestScheduleUpdate_MissingClusterID(t *testing.T) {
 	env := testutil.NewTestEnv(t)
 	t.Cleanup(env.Cleanup)

internal/cmd/base/describe.go

@@ -13,6 +13,7 @@ import (
 type DescribeCmd[T any] struct {
 	Use               string
 	Short             string
+	Long              string
 	Args              cobra.PositionalArgs
 	Fetch             func(s *state.State, cmd *cobra.Command, args []string) (T, error)
 	PrintText         func(cmd *cobra.Command, out io.Writer, resource T) error
@@ -24,6 +25,7 @@ func (dc DescribeCmd[T]) CobraCommand(s *state.State) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   dc.Use,
 		Short: dc.Short,
+		Long:  dc.Long,
 		Args:  dc.Args,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			resource, err := dc.Fetch(s, cmd, args)