Skip to content

refactor: Simplify #65

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 4 commits into from
Mar 24, 2026
Merged

refactor: Simplify #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7dced6
refactor: Simplify Configuration
jdehaan Mar 24, 2026
065fe90
refactor: introduce resolveFields
jdehaan Mar 24, 2026
9c6f315
refactor: eliminate Path
jdehaan Mar 24, 2026
703a087
refactor: AllJobs() flattening
jdehaan Mar 24, 2026
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
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ backup/
| `JobCommand` | interface | `Run(job Job) JobStatus` + `GetVersionInfo()` — implemented by `ListCommand`, `SimulateCommand`, `SyncCommand` | `Exec` via constructors |
| `SharedCommand` | struct | Base for all commands — holds `BinPath`, `BaseLogPath`, `Shell Exec`, `Output io.Writer` | `io.Writer`, `Exec` |
| `CoverageChecker` | struct | Analyzes path coverage | `*log.Logger`, `afero.Fs` |
| `Config` | struct | YAML config (`Config`, `Job`, `Path`, `${var}` substitution); custom `UnmarshalYAML` for job defaults | `*log.Logger` in `Apply()` |
| `Config` | struct | YAML config (`Config`, `Mapping`, `Job`, `Path`, `${var}` substitution); custom `UnmarshalYAML` for job defaults | `*log.Logger` in `Apply()` |

Additional injection points: `afero.Fs` into `BuildRootCommandWithFs()` → `buildCheckCoverageCommand(fs)`; commands use `cmd.OutOrStdout()` for testable output.

Expand Down
88 changes: 44 additions & 44 deletions backup/cmd/test/commands_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ func executeCommandWithDeps(t *testing.T, fs afero.Fs, shell internal.Exec, args

func TestConfigShow_ValidConfig(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("docs", "/home/docs/", "/backup/docs/").
AddMapping("m", "/home", "/backup").
AddJobToMapping("docs", "docs", "docs").
Build())

stdout, err := executeCommand(t, "config", "show", "--config", cfgPath)
Expand Down Expand Up @@ -116,8 +116,8 @@ func TestCreateLoggerError(t *testing.T) {
for _, command := range commands {
t.Run(command, func(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("docs", "/home/docs/", "/backup/docs/").
AddMapping("m", "/home", "/backup").
AddJobToMapping("docs", "docs", "docs").
Build())

fs := afero.NewReadOnlyFs(afero.NewMemMapFs())
Expand Down Expand Up @@ -145,8 +145,8 @@ func TestConfigShow_InvalidYAML(t *testing.T) {

func TestConfigValidate_ValidConfig(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("docs", "/home/docs/", "/backup/docs/").
AddMapping("m", "/home", "/backup").
AddJobToMapping("docs", "docs", "docs").
Build())

stdout, err := executeCommand(t, "config", "validate", "--config", cfgPath)
Expand All @@ -164,9 +164,9 @@ func TestConfigValidate_MissingFile(t *testing.T) {

func TestConfigValidate_DuplicateJobNames(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("same", "/home/a/", "/backup/a/").
AddJob("same", "/home/b/", "/backup/b/").
AddMapping("m", "/home", "/backup").
AddJobToMapping("same", "a", "a").
AddJobToMapping("same", "b", "b").
Build())

_, err := executeCommand(t, "config", "validate", "--config", cfgPath)
Expand All @@ -179,8 +179,8 @@ func TestConfigValidate_DuplicateJobNames(t *testing.T) {

func TestRun_ValidConfig(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("docs", "/home/docs/", "/backup/docs/", testutil.Enabled(true), testutil.Delete(true)).
AddMapping("m", "/home", "/backup").
AddJobToMapping("docs", "docs", "docs", testutil.Enabled(true), testutil.Delete(true)).
Build())

shell := &stubExec{output: []byte("rsync version 3.2.7 protocol version 31\n")}
Expand All @@ -196,8 +196,8 @@ func TestRun_ValidConfig(t *testing.T) {

func TestSimulate_ValidConfig(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("docs", "/home/docs/", "/backup/docs/", testutil.Enabled(true)).
AddMapping("m", "/home", "/backup").
AddJobToMapping("docs", "docs", "docs", testutil.Enabled(true)).
Build())

shell := &stubExec{output: []byte("rsync version 3.2.7 protocol version 31\n")}
Expand Down Expand Up @@ -240,8 +240,8 @@ func TestCheckCoverage_MissingConfig(t *testing.T) {

func TestCheckCoverage_WithUncoveredPaths(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/src").Target("/dst").
AddJob("docs", "/src/docs/", "/dst/docs/").
AddMapping("m", "/src", "/dst").
AddJobToMapping("docs", "docs", "docs").
Build())

fs := afero.NewMemMapFs()
Expand All @@ -257,8 +257,8 @@ func TestCheckCoverage_WithUncoveredPaths(t *testing.T) {

func TestCheckCoverage_ValidConfig(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/src").Target("/dst").
AddJob("docs", "/src/docs/", "/dst/docs/").
AddMapping("m", "/src", "/dst").
AddJobToMapping("docs", "docs", "docs").
Build())

fs := afero.NewMemMapFs()
Expand Down Expand Up @@ -300,8 +300,8 @@ func TestVersion_WithMockExec(t *testing.T) {

func TestList_ValidConfig(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("docs", "/home/docs/", "/backup/docs/", testutil.Enabled(true)).
AddMapping("m", "/home", "/backup").
AddJobToMapping("docs", "docs", "docs", testutil.Enabled(true)).
Build())

shell := &stubExec{output: []byte("rsync version 3.2.7 protocol version 31\n")}
Expand All @@ -318,8 +318,8 @@ func TestList_ValidConfig(t *testing.T) {

func TestRun_LoggerOpenDuringApply(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home").Target("/backup").
AddJob("docs", "/home/docs/", "/backup/docs/", testutil.Enabled(true)).
AddMapping("m", "/home", "/backup").
AddJobToMapping("docs", "docs", "docs", testutil.Enabled(true)).
Build())

shell := &stubExec{output: []byte("rsync version 3.2.7 protocol version 31\n")}
Expand Down Expand Up @@ -364,24 +364,24 @@ func TestRun_LoggerOpenDuringApply(t *testing.T) {

func TestConfigShow_WithSetFlag(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home/${user}").Target("/backup/${user}").
Variable("user", "default").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build())

stdout, err := executeCommand(t, "config", "show", "--config", cfgPath, "--set", "user=alice")

require.NoError(t, err)
assert.Contains(t, stdout, "alice_docs")
assert.Contains(t, stdout, "/home/alice/docs/")
assert.Contains(t, stdout, "/backup/alice/docs/")
assert.Contains(t, stdout, "/home/alice/docs")
assert.Contains(t, stdout, "/backup/alice/docs")
assert.NotContains(t, stdout, "${user}")
}

func TestConfigValidate_WithSetFlag(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home/${user}").Target("/backup/${user}").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build())

stdout, err := executeCommand(t, "config", "validate", "--config", cfgPath, "--set", "user=bob")
Expand All @@ -392,8 +392,8 @@ func TestConfigValidate_WithSetFlag(t *testing.T) {

func TestList_WithSetFlag(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
Source("/home/${user}").Target("/backup/${user}").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build())

shell := &stubExec{output: []byte("rsync version 3.2.7 protocol version 31\n")}
Expand All @@ -410,8 +410,8 @@ func TestList_WithSetFlag(t *testing.T) {
func TestConfigValidate_TemplateVarsMissing(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
TemplateVar("user").TemplateVar("user_cap").
Source("/home/${user}").Target("/backup/${user}").
AddJob("docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("docs", "docs", "docs").
Build())

_, err := executeCommand(t, "config", "validate", "--config", cfgPath)
Expand All @@ -423,8 +423,8 @@ func TestConfigValidate_TemplateVarsMissing(t *testing.T) {
func TestConfigValidate_TemplateVarsProvidedViaSet(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
TemplateVar("user").
Source("/home/${user}").Target("/backup/${user}").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build())

stdout, err := executeCommand(t, "config", "validate", "--config", cfgPath, "--set", "user=alice")
Expand All @@ -436,8 +436,8 @@ func TestConfigValidate_TemplateVarsProvidedViaSet(t *testing.T) {
func TestConfigShow_TemplateVarsResolved(t *testing.T) {
cfgPath := testutil.WriteConfigFile(t, testutil.NewConfigBuilder().
TemplateVar("user").
Source("/home/${user}").Target("/backup/${user}").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build())

stdout, err := executeCommand(t, "config", "show", "--config", cfgPath, "--set", "user=alice")
Expand All @@ -454,8 +454,8 @@ func TestConfigShow_WithInclude(t *testing.T) {

template := testutil.NewConfigBuilder().
TemplateVar("user").
Source("/home/${user}").Target("/backup/${user}").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build()
testutil.WriteConfigFileInDir(t, dir, "template.yaml", template)

Expand All @@ -468,16 +468,16 @@ func TestConfigShow_WithInclude(t *testing.T) {

require.NoError(t, err)
assert.Contains(t, stdout, "alice_docs")
assert.Contains(t, stdout, "/home/alice/docs/")
assert.Contains(t, stdout, "/home/alice/docs")
}

func TestConfigValidate_WithInclude(t *testing.T) {
dir := t.TempDir()

template := testutil.NewConfigBuilder().
TemplateVar("user").
Source("/home/${user}").Target("/backup/${user}").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build()
testutil.WriteConfigFileInDir(t, dir, "template.yaml", template)

Expand All @@ -497,8 +497,8 @@ func TestConfigValidate_IncludeMissingVars(t *testing.T) {

template := testutil.NewConfigBuilder().
TemplateVar("user").TemplateVar("user_cap").
Source("/home/${user}").Target("/backup/${user}").
AddJob("docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("docs", "docs", "docs").
Build()
testutil.WriteConfigFileInDir(t, dir, "template.yaml", template)

Expand All @@ -518,8 +518,8 @@ func TestList_WithInclude(t *testing.T) {

template := testutil.NewConfigBuilder().
TemplateVar("user").
Source("/home/${user}").Target("/backup/${user}").
AddJob("${user}_docs", "/home/${user}/docs/", "/backup/${user}/docs/").
AddMapping("home", "/home/${user}", "/backup/${user}").
AddJobToMapping("${user}_docs", "docs", "docs").
Build()
testutil.WriteConfigFileInDir(t, dir, "template.yaml", template)

Expand Down
Loading
Loading