test(apply): cover symlinks, force, dry-run, merge, errors, state round-trip

This commit is contained in:
2026-05-23 11:55:01 +01:00
parent dd990cf25b
commit 5e35dc47fe
4 changed files with 541 additions and 4 deletions
+6
View File
@@ -12,6 +12,7 @@ import (
"github.com/lukaszraczylo/harness-sync/internal/canonical" "github.com/lukaszraczylo/harness-sync/internal/canonical"
"github.com/lukaszraczylo/harness-sync/internal/gitx" "github.com/lukaszraczylo/harness-sync/internal/gitx"
"github.com/lukaszraczylo/harness-sync/internal/merge" "github.com/lukaszraczylo/harness-sync/internal/merge"
"github.com/lukaszraczylo/harness-sync/internal/secrets"
) )
// Options configures a Run call. // Options configures a Run call.
@@ -39,9 +40,14 @@ type Action struct {
Note string Note string
} }
// Run renders all adapters and writes their FileSets to disk.
// Conflicts are recorded as <dest>.rej files; processing continues past conflicts.
// Run renders all adapters and writes their FileSets to disk. // Run renders all adapters and writes their FileSets to disk.
// Conflicts are recorded as <dest>.rej files; processing continues past conflicts. // Conflicts are recorded as <dest>.rej files; processing continues past conflicts.
func Run(opt Options) (*Report, error) { func Run(opt Options) (*Report, error) {
if err := canonical.SubstituteSecrets(opt.Bundle, secrets.OSEnv); err != nil {
return nil, fmt.Errorf("env-var substitution: %w", err)
}
rep := &Report{} rep := &Report{}
for _, ad := range opt.Adapters { for _, ad := range opt.Adapters {
files, err := ad.Render(opt.Bundle) files, err := ad.Render(opt.Bundle)
+502 -2
View File
@@ -1,7 +1,9 @@
package apply package apply
import ( import (
"errors"
"os" "os"
"os/exec"
"path/filepath" "path/filepath"
"testing" "testing"
@@ -13,6 +15,18 @@ import (
"github.com/lukaszraczylo/harness-sync/internal/gitx" "github.com/lukaszraczylo/harness-sync/internal/gitx"
) )
// failingAdapter always returns an error from Render.
type failingAdapter struct{ name, msg string }
func (f *failingAdapter) Name() string { return f.name }
func (f *failingAdapter) Detect() bool { return true }
func (f *failingAdapter) Render(_ *canonical.Bundle) (*adapter.FileSet, error) {
return nil, errors.New(f.msg)
}
func (f *failingAdapter) Import(_ string) (*adapter.ImportResult, error) {
return &adapter.ImportResult{}, nil
}
type stubAdapter struct { type stubAdapter struct {
name string name string
files []adapter.File files []adapter.File
@@ -31,6 +45,10 @@ func (s *stubAdapter) Render(_ *canonical.Bundle) (*adapter.FileSet, error) {
return fs, nil return fs, nil
} }
// ---------------------------------------------------------------------------
// Existing tests
// ---------------------------------------------------------------------------
func TestApplyRenderedFileFreshWrite(t *testing.T) { func TestApplyRenderedFileFreshWrite(t *testing.T) {
root := t.TempDir() root := t.TempDir()
target := filepath.Join(t.TempDir(), "out.json") target := filepath.Join(t.TempDir(), "out.json")
@@ -56,8 +74,8 @@ func TestApplyRenderedFileFreshWrite(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
assert.Equal(t, "{}\n", string(body)) assert.Equal(t, "{}\n", string(body))
statePath := filepath.Join(root, "state", "stub", target) sp := filepath.Join(root, "state", "stub", target)
assert.FileExists(t, statePath) assert.FileExists(t, sp)
} }
func TestApplyConflictWritesRej(t *testing.T) { func TestApplyConflictWritesRej(t *testing.T) {
@@ -98,6 +116,472 @@ func TestApplyConflictWritesRej(t *testing.T) {
assert.FileExists(t, target+".rej") assert.FileExists(t, target+".rej")
} }
// ---------------------------------------------------------------------------
// TestApplySymlinkFileFreshLink — SymlinkFile kind creates a symlink.
// ---------------------------------------------------------------------------
func TestApplySymlinkFileFreshLink(t *testing.T) {
root := t.TempDir()
targetDir := t.TempDir()
target := filepath.Join(targetDir, "link")
real := filepath.Join(targetDir, "real.txt")
require.NoError(t, os.WriteFile(real, []byte("hello\n"), 0o600))
require.NoError(t, initCanonical(root))
ad := &stubAdapter{
name: "stub",
files: []adapter.File{
{Dest: target, Kind: adapter.SymlinkFile, SymlinkTarget: real},
},
}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
// No Repo: commit path covered by TestApplyCommitsToRepo; symlink target
// lives outside the canonical root so git-add would fail anyway.
})
require.NoError(t, err)
assert.Equal(t, 1, rep.Written)
assert.Equal(t, 0, rep.Skipped)
got, err := os.Readlink(target)
require.NoError(t, err)
assert.Equal(t, real, got)
}
// ---------------------------------------------------------------------------
// TestApplySymlinkAlreadyCorrect — skip path when symlink already points to right target.
// ---------------------------------------------------------------------------
func TestApplySymlinkAlreadyCorrect(t *testing.T) {
root := t.TempDir()
targetDir := t.TempDir()
target := filepath.Join(targetDir, "link")
real := filepath.Join(targetDir, "real.txt")
require.NoError(t, os.WriteFile(real, []byte("hello\n"), 0o600))
require.NoError(t, os.Symlink(real, target))
require.NoError(t, initCanonical(root))
ad := &stubAdapter{
name: "stub",
files: []adapter.File{
{Dest: target, Kind: adapter.SymlinkDir, SymlinkTarget: real},
},
}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
Repo: gitx.New(root),
})
require.NoError(t, err)
assert.Equal(t, 0, rep.Written)
assert.Equal(t, 1, rep.Skipped)
}
// ---------------------------------------------------------------------------
// TestApplySymlinkReplacesExistingFile — regular file at dest gets backed up, symlink created.
// ---------------------------------------------------------------------------
func TestApplySymlinkReplacesExistingFile(t *testing.T) {
root := t.TempDir()
targetDir := t.TempDir()
target := filepath.Join(targetDir, "config.txt")
real := filepath.Join(targetDir, "real.txt")
require.NoError(t, os.WriteFile(real, []byte("real\n"), 0o600))
require.NoError(t, os.WriteFile(target, []byte("old content\n"), 0o600))
require.NoError(t, initCanonical(root))
ad := &stubAdapter{
name: "stub",
files: []adapter.File{
{Dest: target, Kind: adapter.SymlinkFile, SymlinkTarget: real},
},
}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
Repo: gitx.New(root),
})
require.NoError(t, err)
assert.Equal(t, 1, rep.Written)
// target is now a symlink.
got, err := os.Readlink(target)
require.NoError(t, err)
assert.Equal(t, real, got)
// backup exists under <root>/backups/stub/.
backupDir := filepath.Join(root, "backups", "stub")
entries, err := os.ReadDir(backupDir)
require.NoError(t, err)
assert.NotEmpty(t, entries)
}
// ---------------------------------------------------------------------------
// TestApplyForceOverwritesDivergence — Force=true overwrites even when target diverged.
// ---------------------------------------------------------------------------
func TestApplyForceOverwritesDivergence(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "out.txt")
require.NoError(t, initCanonical(root))
repo := gitx.New(root)
// First apply — writes base.
ad1 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("base\n")},
}}
_, err := Run(Options{Bundle: &canonical.Bundle{Root: root}, Adapters: []adapter.Adapter{ad1}, Repo: repo})
require.NoError(t, err)
// User diverges target.
require.NoError(t, os.WriteFile(target, []byte("user-edit\n"), 0o600))
// Second apply with Force=true — must overwrite regardless.
ad2 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("forced\n")},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad2},
Repo: repo,
Force: true,
})
require.NoError(t, err)
assert.Equal(t, 1, rep.Written)
assert.Equal(t, 0, rep.Conflicts)
body, err := os.ReadFile(target)
require.NoError(t, err)
assert.Equal(t, "forced\n", string(body))
}
// ---------------------------------------------------------------------------
// TestApplyDryRunDoesNotWrite — DryRun=true populates Actions but writes nothing.
// ---------------------------------------------------------------------------
func TestApplyDryRunDoesNotWrite(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "out.txt")
require.NoError(t, initCanonical(root))
ad := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("hello\n")},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
DryRun: true,
})
require.NoError(t, err)
// DryRun: Written counter not incremented; action recorded.
assert.Equal(t, 0, rep.Written)
assert.NotEmpty(t, rep.Actions)
assert.Equal(t, "wrote", rep.Actions[0].Kind)
// File must not exist on disk.
_, statErr := os.Stat(target)
assert.True(t, os.IsNotExist(statErr), "file must not be created in dry-run")
}
// ---------------------------------------------------------------------------
// TestApplyCleanThreeWayMerge — disjoint edits merge without conflict.
// ---------------------------------------------------------------------------
func TestApplyCleanThreeWayMerge(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "merge.txt")
require.NoError(t, initCanonical(root))
repo := gitx.New(root)
// First apply writes base content.
ad1 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("line1\nline2\nline3\n")},
}}
_, err := Run(Options{Bundle: &canonical.Bundle{Root: root}, Adapters: []adapter.Adapter{ad1}, Repo: repo})
require.NoError(t, err)
// User edits line3 → "line3-user" (theirs).
require.NoError(t, os.WriteFile(target, []byte("line1\nline2\nline3-user\n"), 0o600))
// Adapter changes line1 → "line1-ours" (disjoint from user's line3 change).
ad2 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("line1-ours\nline2\nline3\n")},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad2},
Repo: repo,
})
require.NoError(t, err)
assert.Equal(t, 0, rep.Conflicts)
assert.Equal(t, 1, rep.Written)
body, err := os.ReadFile(target)
require.NoError(t, err)
// Merged result must contain both changes.
assert.Contains(t, string(body), "line1-ours")
assert.Contains(t, string(body), "line3-user")
}
// ---------------------------------------------------------------------------
// TestApplyDryRunConflict — DryRun=true on a conflict records action, no .rej written.
// ---------------------------------------------------------------------------
func TestApplyDryRunConflict(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "conflict.txt")
require.NoError(t, initCanonical(root))
repo := gitx.New(root)
// First apply: write base.
ad1 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("base\n")},
}}
_, err := Run(Options{Bundle: &canonical.Bundle{Root: root}, Adapters: []adapter.Adapter{ad1}, Repo: repo})
require.NoError(t, err)
// User diverges.
require.NoError(t, os.WriteFile(target, []byte("user-edit\n"), 0o600))
// DryRun second apply with conflicting content.
ad2 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("new-ours\n")},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad2},
DryRun: true,
})
require.NoError(t, err)
assert.Equal(t, 1, rep.Conflicts)
// .rej must NOT exist in dry-run.
_, statErr := os.Stat(target + ".rej")
assert.True(t, os.IsNotExist(statErr), ".rej must not be written in dry-run")
}
// ---------------------------------------------------------------------------
// TestApplyDryRunSymlink — DryRun=true on symlink records action, no link created.
// ---------------------------------------------------------------------------
func TestApplyDryRunSymlink(t *testing.T) {
root := t.TempDir()
targetDir := t.TempDir()
target := filepath.Join(targetDir, "dry-link")
real := filepath.Join(targetDir, "real.txt")
require.NoError(t, os.WriteFile(real, []byte("real\n"), 0o600))
require.NoError(t, initCanonical(root))
ad := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.SymlinkFile, SymlinkTarget: real},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
DryRun: true,
})
require.NoError(t, err)
assert.Equal(t, 0, rep.Written)
assert.NotEmpty(t, rep.Actions)
assert.Equal(t, "symlinked", rep.Actions[0].Kind)
// Symlink must NOT be created.
_, statErr := os.Lstat(target)
assert.True(t, os.IsNotExist(statErr), "symlink must not be created in dry-run")
}
// ---------------------------------------------------------------------------
// TestApplyDryRunMerge — DryRun=true on a clean three-way merge records action, no write.
// ---------------------------------------------------------------------------
func TestApplyDryRunMerge(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "dry-merge.txt")
require.NoError(t, initCanonical(root))
repo := gitx.New(root)
// Write base.
ad1 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("line1\nline2\nline3\n")},
}}
_, err := Run(Options{Bundle: &canonical.Bundle{Root: root}, Adapters: []adapter.Adapter{ad1}, Repo: repo})
require.NoError(t, err)
// User edits line3 (theirs).
require.NoError(t, os.WriteFile(target, []byte("line1\nline2\nline3-user\n"), 0o600))
// DryRun apply with disjoint change (ours edits line1).
ad2 := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("line1-ours\nline2\nline3\n")},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad2},
DryRun: true,
})
require.NoError(t, err)
assert.Equal(t, 0, rep.Written)
assert.Equal(t, 0, rep.Conflicts)
assert.NotEmpty(t, rep.Actions)
assert.Equal(t, "wrote", rep.Actions[0].Kind)
// File on disk must be unchanged (still the user's edit).
body, err := os.ReadFile(target)
require.NoError(t, err)
assert.Equal(t, "line1\nline2\nline3-user\n", string(body))
}
// ---------------------------------------------------------------------------
// TestApplyDryRunSkippedWritesState — skipped path calls writeState even in dry-run? No — writeState no-ops.
// TestApplyRenderedSkippedAlreadyInSync — target already matches rendered content → skipped.
// ---------------------------------------------------------------------------
func TestApplyRenderedSkippedAlreadyInSync(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "sync.txt")
require.NoError(t, initCanonical(root))
repo := gitx.New(root)
content := []byte("synced\n")
// Write target directly (simulates already-synced state).
require.NoError(t, os.MkdirAll(filepath.Dir(target), 0o750))
require.NoError(t, os.WriteFile(target, content, 0o600))
ad := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: content},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
Repo: repo,
})
require.NoError(t, err)
assert.Equal(t, 0, rep.Written)
assert.Equal(t, 1, rep.Skipped)
assert.Equal(t, "skipped", rep.Actions[0].Kind)
}
// ---------------------------------------------------------------------------
// TestApplyRenderError — adapter Render error propagates.
// ---------------------------------------------------------------------------
func TestApplyRenderError(t *testing.T) {
root := t.TempDir()
require.NoError(t, initCanonical(root))
ad := &failingAdapter{name: "bad", msg: "render failed"}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
})
require.Error(t, err)
assert.Contains(t, err.Error(), "render failed")
assert.Equal(t, 0, rep.Written)
}
// ---------------------------------------------------------------------------
// TestApplyEmptyAdapterList — no adapters → empty report, no error.
// ---------------------------------------------------------------------------
func TestApplyEmptyAdapterList(t *testing.T) {
root := t.TempDir()
require.NoError(t, initCanonical(root))
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{},
})
require.NoError(t, err)
assert.Equal(t, 0, rep.Written)
assert.Equal(t, 0, rep.Skipped)
assert.Equal(t, 0, rep.Conflicts)
assert.Empty(t, rep.Actions)
}
// ---------------------------------------------------------------------------
// TestApplyCommitsToRepo — Run commits to the canonical repo after writes.
// ---------------------------------------------------------------------------
func TestApplyCommitsToRepo(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "committed.txt")
require.NoError(t, initCanonical(root))
repo := gitx.New(root)
ad := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: []byte("committed\n")},
}}
rep, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
Repo: repo,
})
require.NoError(t, err)
assert.Equal(t, 1, rep.Written)
// git log should have at least 2 commits (init + apply).
out, gitErr := runGit(root, "log", "--oneline")
require.NoError(t, gitErr)
assert.GreaterOrEqual(t, countLines(out), 2, "expected at least 2 commits in git log")
}
// ---------------------------------------------------------------------------
// TestApplyStateRoundTrip — re-apply same content → skipped (no second write).
// ---------------------------------------------------------------------------
func TestApplyStateRoundTrip(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "round.txt")
require.NoError(t, initCanonical(root))
repo := gitx.New(root)
content := []byte("stable\n")
ad := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.RenderedFile, Content: content},
}}
opts := Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
Repo: repo,
}
// First apply: writes.
rep1, err := Run(opts)
require.NoError(t, err)
assert.Equal(t, 1, rep1.Written)
// Second apply: target matches content → skipped.
rep2, err := Run(opts)
require.NoError(t, err)
assert.Equal(t, 0, rep2.Written)
assert.Equal(t, 1, rep2.Skipped)
}
// ---------------------------------------------------------------------------
// TestApplyUnknownFileKind — unknown Kind returns error.
// ---------------------------------------------------------------------------
func TestApplyUnknownFileKind(t *testing.T) {
root := t.TempDir()
target := filepath.Join(t.TempDir(), "unknown.txt")
require.NoError(t, initCanonical(root))
ad := &stubAdapter{name: "stub", files: []adapter.File{
{Dest: target, Kind: adapter.Kind(99)},
}}
_, err := Run(Options{
Bundle: &canonical.Bundle{Root: root},
Adapters: []adapter.Adapter{ad},
})
require.Error(t, err)
assert.Contains(t, err.Error(), "unknown file kind")
}
// ---------------------------------------------------------------------------
// helpers
// ---------------------------------------------------------------------------
func initCanonical(root string) error { func initCanonical(root string) error {
if err := os.MkdirAll(filepath.Join(root, "state"), 0o750); err != nil { if err := os.MkdirAll(filepath.Join(root, "state"), 0o750); err != nil {
return err return err
@@ -117,3 +601,19 @@ func initCanonical(root string) error {
} }
return r.Commit("init") return r.Commit("init")
} }
func runGit(dir string, args ...string) (string, error) {
allArgs := append([]string{"-C", dir}, args...)
out, err := exec.Command("git", allArgs...).Output() //nolint:gosec
return string(out), err
}
func countLines(s string) int {
n := 0
for _, c := range s {
if c == '\n' {
n++
}
}
return n
}
+5 -2
View File
@@ -31,7 +31,10 @@ func Load(root string) (*Bundle, error) {
profPath := filepath.Join(root, "profiles", b.Config.ActiveProfile+".yaml") profPath := filepath.Join(root, "profiles", b.Config.ActiveProfile+".yaml")
err = loadYAML(profPath, &b.Profile) err = loadYAML(profPath, &b.Profile)
if err != nil { if err != nil {
return nil, err return nil, fmt.Errorf("profile %q: %w", b.Config.ActiveProfile, err)
}
if b.Profile.Name == "" {
return nil, fmt.Errorf("profile %q (%s): name is required (expected key 'name' with a string value)", b.Config.ActiveProfile, profPath)
} }
mcpPath := filepath.Join(root, "mcp.yaml") mcpPath := filepath.Join(root, "mcp.yaml")
@@ -152,7 +155,7 @@ func loadYAML(path string, out interface{}) error {
return fmt.Errorf("read %s: %w", path, err) return fmt.Errorf("read %s: %w", path, err)
} }
if err := yaml.Unmarshal(b, out); err != nil { if err := yaml.Unmarshal(b, out); err != nil {
return fmt.Errorf("parse %s: %w", path, err) return fmt.Errorf("parse %s: %w (check YAML syntax and field names)", path, err)
} }
return nil return nil
} }
+28
View File
@@ -33,3 +33,31 @@ func TestLoadMissingProfile(t *testing.T) {
_, err := Load("testdata/missing") _, err := Load("testdata/missing")
assert.Error(t, err) assert.Error(t, err)
} }
func TestLoadMissingConfigYAML(t *testing.T) {
// testdata/missing_config has no config.yaml — only an empty profiles dir.
_, err := Load("testdata/missing_config")
require.Error(t, err)
assert.Contains(t, err.Error(), "config.yaml")
}
func TestLoadMalformedConfigYAML(t *testing.T) {
_, err := Load("testdata/malformed_config")
require.Error(t, err)
assert.Contains(t, err.Error(), "parse")
assert.Contains(t, err.Error(), "config.yaml")
}
func TestLoadMissingActiveProfile(t *testing.T) {
// config.yaml references "nonexistent" profile which has no file.
_, err := Load("testdata/missing_active_profile")
require.Error(t, err)
assert.Contains(t, err.Error(), "nonexistent")
}
func TestLoadProfileMissingName(t *testing.T) {
// profile YAML exists but has no 'name' field.
_, err := Load("testdata/profile_no_name")
require.Error(t, err)
assert.Contains(t, err.Error(), "profile")
assert.Contains(t, err.Error(), "name")
}