test: add unit tests for cli and snapshot packages

Author: fullstackjam

internal/cli/edit_helpers_test.go

@@ -0,0 +1,58 @@
+package cli
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// ---------------------------------------------------------------------------
+// splitBefore (edit.go) — pure string utility
+// ---------------------------------------------------------------------------
+
+func TestSplitBefore_WithSeparator(t *testing.T) {
+	result := splitBefore("my-config — My Config Name", " — ")
+	assert.Equal(t, "my-config", result)
+}
+
+func TestSplitBefore_NoSeparator(t *testing.T) {
+	result := splitBefore("my-config", " — ")
+	assert.Equal(t, "my-config", result)
+}
+
+func TestSplitBefore_EmptyString(t *testing.T) {
+	result := splitBefore("", " — ")
+	assert.Equal(t, "", result)
+}
+
+func TestSplitBefore_SeparatorAtStart(t *testing.T) {
+	result := splitBefore(" — rest", " — ")
+	assert.Equal(t, "", result)
+}
+
+func TestSplitBefore_SeparatorAtEnd(t *testing.T) {
+	// " — " is at the very end — nothing after separator, but before is the slug.
+	result := splitBefore("slug — ", " — ")
+	assert.Equal(t, "slug", result)
+}
+
+func TestSplitBefore_MultipleSeparators(t *testing.T) {
+	// Should split at the FIRST occurrence.
+	result := splitBefore("a — b — c", " — ")
+	assert.Equal(t, "a", result)
+}
+
+func TestSplitBefore_SingleCharSeparator(t *testing.T) {
+	result := splitBefore("hello:world", ":")
+	assert.Equal(t, "hello", result)
+}
+
+func TestSplitBefore_StringShorterThanSeparator(t *testing.T) {
+	result := splitBefore("ab", "abcd")
+	assert.Equal(t, "ab", result)
+}
+
+func TestSplitBefore_IdenticalToSeparator(t *testing.T) {
+	result := splitBefore(" — ", " — ")
+	assert.Equal(t, "", result)
+}

internal/snapshot/capture_exec_test.go

@@ -0,0 +1,214 @@
+package snapshot
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+// ---------------------------------------------------------------------------
+// isBrewInstalled
+// ---------------------------------------------------------------------------
+
+// TestIsBrewInstalled_ReturnsBool verifies the function returns a bool without panicking.
+func TestIsBrewInstalled_ReturnsBool(t *testing.T) {
+	result := isBrewInstalled()
+	// We don't know whether brew is installed in the CI environment, but the
+	// function must not panic and must return a bool.
+	_ = result
+}
+
+// ---------------------------------------------------------------------------
+// captureBrewList — when brew is absent, returns empty list
+// ---------------------------------------------------------------------------
+
+// TestCaptureBrewList_NoPanic verifies the function does not panic regardless of brew availability.
+func TestCaptureBrewList_NoPanic(t *testing.T) {
+	list, err := captureBrewList("leaves")
+	// When brew is absent this returns ([]string{}, nil).
+	// When brew is present and succeeds it returns (names, nil).
+	// When brew fails it returns ([]string{}, err).
+	// In all cases the function must not panic.
+	_ = list
+	_ = err
+}
+
+// ---------------------------------------------------------------------------
+// CaptureFormulae / CaptureCasks / CaptureTaps
+// ---------------------------------------------------------------------------
+
+// TestCaptureFormulae_NoPanic ensures CaptureFormulae does not panic.
+func TestCaptureFormulae_NoPanic(t *testing.T) {
+	formulae, err := CaptureFormulae()
+	// Returns empty slice when brew is absent — never an error.
+	if !isBrewInstalled() {
+		require.NoError(t, err)
+		assert.NotNil(t, formulae)
+	} else {
+		// With brew installed the list may or may not be empty but must not panic.
+		_ = formulae
+		_ = err
+	}
+}
+
+// TestCaptureCasks_NoPanic ensures CaptureCasks does not panic.
+func TestCaptureCasks_NoPanic(t *testing.T) {
+	casks, err := CaptureCasks()
+	if !isBrewInstalled() {
+		require.NoError(t, err)
+		assert.NotNil(t, casks)
+	} else {
+		_ = casks
+		_ = err
+	}
+}
+
+// TestCaptureTaps_NoPanic ensures CaptureTaps does not panic.
+func TestCaptureTaps_NoPanic(t *testing.T) {
+	taps, err := CaptureTaps()
+	if !isBrewInstalled() {
+		require.NoError(t, err)
+		assert.NotNil(t, taps)
+	} else {
+		_ = taps
+		_ = err
+	}
+}
+
+// ---------------------------------------------------------------------------
+// CaptureNpm
+// ---------------------------------------------------------------------------
+
+// TestCaptureNpm_NoPanic ensures CaptureNpm does not panic.
+func TestCaptureNpm_NoPanic(t *testing.T) {
+	packages, err := CaptureNpm()
+	// On a machine without npm this returns ([]string{}, nil).
+	// On a machine with npm this returns installed globals.
+	// In both cases: must not panic and err must be nil (best-effort capture).
+	require.NoError(t, err)
+	assert.NotNil(t, packages)
+}
+
+// ---------------------------------------------------------------------------
+// CaptureMacOSPrefs
+// ---------------------------------------------------------------------------
+
+// TestCaptureMacOSPrefs_NoPanic verifies CaptureMacOSPrefs does not panic.
+func TestCaptureMacOSPrefs_NoPanic(t *testing.T) {
+	prefs, err := CaptureMacOSPrefs()
+	// On macOS with defaults(1) available this may return real prefs.
+	// In both cases must not return an error and must not panic.
+	require.NoError(t, err)
+	assert.NotNil(t, prefs)
+}
+
+// ---------------------------------------------------------------------------
+// CaptureGit
+// ---------------------------------------------------------------------------
+
+// TestCaptureGit_ReturnsSnap verifies CaptureGit returns a non-nil snapshot.
+func TestCaptureGit_ReturnsSnap(t *testing.T) {
+	snap, err := CaptureGit()
+	require.NoError(t, err)
+	require.NotNil(t, snap)
+	// UserName and UserEmail may be empty strings on a machine with no git config —
+	// that is valid. The function must not error.
+}
+
+// TestCaptureGit_FieldsAreStrings verifies the returned fields are strings (not nil).
+func TestCaptureGit_FieldsAreStrings(t *testing.T) {
+	snap, err := CaptureGit()
+	require.NoError(t, err)
+
+	// These are plain string fields — no nil check needed, but we assert they
+	// don't contain unexpected whitespace from mis-trimmed output.
+	assert.NotContains(t, snap.UserName, "\n")
+	assert.NotContains(t, snap.UserEmail, "\n")
+}
+
+// ---------------------------------------------------------------------------
+// CaptureDevTools
+// ---------------------------------------------------------------------------
+
+// TestCaptureDevTools_ReturnsSlice verifies CaptureDevTools returns a slice (possibly empty).
+func TestCaptureDevTools_ReturnsSlice(t *testing.T) {
+	tools, err := CaptureDevTools()
+	require.NoError(t, err)
+	assert.NotNil(t, tools)
+}
+
+// TestCaptureDevTools_VersionsNotEmpty verifies any captured tool has a non-empty name.
+func TestCaptureDevTools_VersionsNotEmpty(t *testing.T) {
+	tools, err := CaptureDevTools()
+	require.NoError(t, err)
+	for _, dt := range tools {
+		assert.NotEmpty(t, dt.Name, "captured DevTool must have a name")
+	}
+}
+
+// ---------------------------------------------------------------------------
+// CaptureDotfiles — isolation scenarios
+// ---------------------------------------------------------------------------
+
+// TestCaptureDotfiles_EmptyHome verifies empty snapshot when HOME has no .dotfiles.
+func TestCaptureDotfiles_EmptyHome(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	snap, err := CaptureDotfiles()
+	require.NoError(t, err)
+	require.NotNil(t, snap)
+	// No .dotfiles directory → RepoURL should be empty.
+	assert.Empty(t, snap.RepoURL)
+}
+
+// TestCaptureDotfiles_DotfilesDirMissingGitSubdir verifies empty snapshot when .dotfiles has no .git.
+func TestCaptureDotfiles_DotfilesDirMissingGitSubdir(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	// Create .dotfiles directory without a .git subdirectory.
+	require.NoError(t, os.MkdirAll(filepath.Join(tmpDir, ".dotfiles"), 0755))
+
+	snap, err := CaptureDotfiles()
+	require.NoError(t, err)
+	require.NotNil(t, snap)
+	// No .git → RepoURL should be empty.
+	assert.Empty(t, snap.RepoURL)
+}
+
+// ---------------------------------------------------------------------------
+// Capture — top-level function
+// ---------------------------------------------------------------------------
+
+// TestCapture_ReturnsSnapshotWithoutError verifies the top-level Capture function
+// returns a complete Snapshot and does not error in a normal environment.
+func TestCapture_ReturnsSnapshotWithoutError(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	snap, err := Capture()
+	require.NoError(t, err)
+	require.NotNil(t, snap)
+	assert.Equal(t, 1, snap.Version)
+	assert.NotEmpty(t, snap.Hostname)
+	// Packages may be empty in CI but must not be nil.
+	assert.NotNil(t, snap.Packages.Formulae)
+	assert.NotNil(t, snap.Packages.Casks)
+	assert.NotNil(t, snap.Packages.Npm)
+	assert.NotNil(t, snap.DevTools)
+}
+
+// TestCapture_CapturedAtIsRecent verifies CapturedAt is set to a recent time.
+func TestCapture_CapturedAtIsRecent(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	snap, err := Capture()
+	require.NoError(t, err)
+
+	assert.False(t, snap.CapturedAt.IsZero(), "CapturedAt must be set")
+}