Skip to content

feat: Implement a list command #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdehaan merged 1 commit into from
Nov 12, 2025
Merged

feat: Implement a list command #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion backup/cmd/backup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,18 @@ func executeSyncJobs(cfg internal.Config, simulate bool) {
defer logFile.Close()
jobLogger := log.New(logFile, "", log.LstdFlags)

status := internal.ExecuteJob(job, simulate, jobLogger)
status := internal.ExecuteJob(job, simulate, false, jobLogger)
overallLogger.Printf("STATUS [%s]: %s", job.Name, status)
fmt.Printf("Status [%s]: %s\n", job.Name, status)
}
}

func listCommands(cfg internal.Config, simulate bool) {
for _, job := range cfg.Jobs {
internal.ExecuteJob(job, simulate, true, nil)
}
}

var runCmd = &cobra.Command{
Use: "run",
Short: "Execute the sync jobs",
Expand All @@ -60,7 +66,17 @@ var simulateCmd = &cobra.Command{
},
}

var listCmd = &cobra.Command{
Use: "list",
Short: "List the commands that will be executed",
Run: func(cmd *cobra.Command, args []string) {
cfg := loadResolvedConfig(configPath)
listCommands(cfg, true)
},
}

func init() {
RootCmd.AddCommand(runCmd)
RootCmd.AddCommand(simulateCmd)
RootCmd.AddCommand(listCmd)
}
28 changes: 20 additions & 8 deletions backup/internal/job.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (

var execCommand = exec.Command

func buildRsyncCmd(job Job, simulate bool) *exec.Cmd {
func buildRsyncCmd(job Job, simulate bool) []string {
args := []string{"-aiv", "--info=progress2"}
if job.Delete == nil || *job.Delete {
args = append(args, "--delete")
Expand All @@ -21,23 +21,35 @@ func buildRsyncCmd(job Job, simulate bool) *exec.Cmd {
if simulate {
args = append([]string{"--dry-run"}, args...)
}
return execCommand("rsync", args...)
return args
}

func ExecuteJob(job Job, simulate bool, logger *log.Logger) string {
func ExecuteJob(job Job, simulate bool, show bool, logger *log.Logger) string {
if job.Enabled != nil && !*job.Enabled {
logger.Printf("SKIPPED [%s]: Job is disabled", job.Name)
if logger != nil {
logger.Printf("SKIPPED [%s]: Job is disabled", job.Name)
}
return "SKIPPED"
}

cmd := buildRsyncCmd(job, simulate)
args := buildRsyncCmd(job, simulate)
fmt.Printf("Job: %s\n", job.Name)
fmt.Printf("Command: %s\n", strings.Join(cmd.Args, " "))
fmt.Printf("Command: rsync %s\n", strings.Join(args, " "))

if show {
return "SUCCESS"
}

cmd := execCommand("rsync", args...)
out, err := cmd.CombinedOutput()
if err != nil {
logger.Printf("ERROR [%s]: %v\nOutput: %s", job.Name, err, string(out))
if logger != nil {
logger.Printf("ERROR [%s]: %v\nOutput: %s", job.Name, err, string(out))
}
return "FAILURE"
}
logger.Printf("SUCCESS [%s]: %s", job.Name, string(out))
if logger != nil {
logger.Printf("SUCCESS [%s]: %s", job.Name, string(out))
}
return "SUCCESS"
}
39 changes: 21 additions & 18 deletions backup/internal/job_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,15 @@ func boolPtr(b bool) *bool {
var capturedArgs []string

var mockExecCommand = func(name string, args ...string) *exec.Cmd {
capturedArgs = args // Capture arguments for assertions
if name == "rsync" {
capturedArgs = append(capturedArgs, args...) // Append arguments for assertions
if strings.Contains(strings.Join(args, " "), "--dry-run") {
return exec.Command("echo", "mocked rsync success") // Simulate success for dry-run
}
if strings.Contains(strings.Join(args, " "), "/invalid/source/path") {
cmd := exec.Command("false") // Simulate failure for invalid paths
cmd.Args = append([]string{name}, args...)
return cmd
return exec.Command("false") // Simulate failure for invalid paths
}
cmd := exec.Command("echo")
cmd.Args = append([]string{name}, args...)
return cmd
return exec.Command("echo", "mocked rsync success") // Simulate general success
}
return exec.Command(name, args...)
}
Expand All @@ -42,16 +41,16 @@ func TestBuildRsyncCmd(t *testing.T) {
Exclusions: []string{"*.tmp", "node_modules/"},
}
simulate := true
cmd := buildRsyncCmd(job, simulate)
args := buildRsyncCmd(job, simulate)

expectedArgs := []string{
"rsync", "--dry-run", "-aiv", "--info=progress2", "--delete",
"--dry-run", "-aiv", "--info=progress2", "--delete",
"--exclude=*.tmp", "--exclude=node_modules/",
"/home/user/Music/", "/target/user/music/home",
}

if strings.Join(cmd.Args, " ") != strings.Join(expectedArgs, " ") {
t.Errorf("Expected %v, got %v", expectedArgs, cmd.Args)
if strings.Join(args, " ") != strings.Join(expectedArgs, " ") {
t.Errorf("Expected %v, got %v", expectedArgs, args)
}
}

Expand All @@ -66,7 +65,7 @@ func TestExecuteJob(t *testing.T) {
simulate := true
logger := log.New(&bytes.Buffer{}, "", log.LstdFlags)

status := ExecuteJob(job, simulate, logger)
status := ExecuteJob(job, simulate, false, logger)
if status != "SUCCESS" {
t.Errorf("Expected status SUCCESS, got %s", status)
}
Expand All @@ -78,7 +77,7 @@ func TestExecuteJob(t *testing.T) {
Enabled: boolPtr(false),
}

status = ExecuteJob(disabledJob, simulate, logger)
status = ExecuteJob(disabledJob, simulate, false, logger)
if status != "SKIPPED" {
t.Errorf("Expected status SKIPPED, got %s", status)
}
Expand All @@ -90,7 +89,7 @@ func TestExecuteJob(t *testing.T) {
Target: "/mnt/backup1/invalid/",
}

status = ExecuteJob(invalidJob, false, logger)
status = ExecuteJob(invalidJob, false, false, logger)
if status != "FAILURE" {
t.Errorf("Expected status FAILURE, got %s", status)
}
Expand All @@ -106,7 +105,7 @@ func TestJobSkippedEnabledTrue(t *testing.T) {
simulate := true
logger := log.New(&bytes.Buffer{}, "", log.LstdFlags)

status := ExecuteJob(job, simulate, logger)
status := ExecuteJob(job, simulate, false, logger)
if status != "SUCCESS" {
t.Errorf("Expected status SUCCESS, got %s", status)
}
Expand All @@ -122,7 +121,7 @@ func TestJobSkippedEnabledFalse(t *testing.T) {
simulate := true
logger := log.New(&bytes.Buffer{}, "", log.LstdFlags)

status := ExecuteJob(disabledJob, simulate, logger)
status := ExecuteJob(disabledJob, simulate, false, logger)
if status != "SKIPPED" {
t.Errorf("Expected status SKIPPED, got %s", status)
}
Expand All @@ -137,7 +136,7 @@ func TestJobSkippedEnabledOmitted(t *testing.T) {
simulate := true
logger := log.New(&bytes.Buffer{}, "", log.LstdFlags)

status := ExecuteJob(job, simulate, logger)
status := ExecuteJob(job, simulate, false, logger)
if status != "SUCCESS" {
t.Errorf("Expected status SUCCESS, got %s", status)
}
Expand All @@ -157,7 +156,11 @@ func TestExecuteJobWithMockedRsync(t *testing.T) {
simulate := true
logger := log.New(&bytes.Buffer{}, "", log.LstdFlags)

_ = ExecuteJob(job, simulate, logger)
status := ExecuteJob(job, simulate, false, logger)

if status != "SUCCESS" {
t.Errorf("Expected status SUCCESS, got %s", status)
}

if len(capturedArgs) == 0 || capturedArgs[0] != "--dry-run" {
t.Errorf("Expected --dry-run flag, got %v", capturedArgs)
Expand Down