fix: Include git repo external state in state dump output

gchkhikvadze · Oct 24, 2022 · d30c50c · d30c50c
1 parent 90a5ce5
commit d30c50c
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 12 deletions.
diff --git a/pkg/chezmoi/persistentstate.go b/pkg/chezmoi/persistentstate.go
@@ -7,14 +7,14 @@ var (
 	// EntryStateBucket is the bucket for recording the entry states.
 	EntryStateBucket = []byte("entryState")
 
+	// gitRepoExternalState is the bucket for recording the state of commands
+	// that modify directories.
+	gitRepoExternalState = []byte("gitRepoExternalState")
+
 	// scriptStateBucket is the bucket for recording the state of run once
 	// scripts.
 	scriptStateBucket = []byte("scriptState")
 
-	// modifyDirWithCmdStateBucket is the bucket for recording the state of
-	// commands that modify directories.
-	modifyDirWithCmdStateBucket = []byte("gitRepoExternalState")
-
 	stateFormat = formatJSON{}
 )
 
@@ -56,18 +56,24 @@ func PersistentStateData(s PersistentState) (any, error) {
 	if err != nil {
 		return nil, err
 	}
+	gitRepoExternalData, err := PersistentStateBucketData(s, gitRepoExternalState)
+	if err != nil {
+		return nil, err
+	}
 	scriptStateData, err := PersistentStateBucketData(s, scriptStateBucket)
 	if err != nil {
 		return nil, err
 	}
 	return struct {
-		ConfigState any `json:"configState" yaml:"configState"`
-		EntryState  any `json:"entryState" yaml:"entryState"`
-		ScriptState any `json:"scriptState" yaml:"scriptState"`
+		ConfigState         any `json:"configState" yaml:"configState"`
+		EntryState          any `json:"entryState" yaml:"entryState"`
+		GitRepoExternalData any `json:"gitRepoExternalState" yaml:"gitRepoExternalState"`
+		ScriptState         any `json:"scriptState" yaml:"scriptState"`
 	}{
-		ConfigState: configStateData,
-		EntryState:  entryStateData,
-		ScriptState: scriptStateData,
+		ConfigState:         configStateData,
+		EntryState:          entryStateData,
+		GitRepoExternalData: gitRepoExternalData,
+		ScriptState:         scriptStateData,
 	}, nil
 }
 

diff --git a/pkg/chezmoi/targetstateentry.go b/pkg/chezmoi/targetstateentry.go
@@ -90,7 +90,7 @@ func (t *TargetStateModifyDirWithCmd) Apply(
 
 	modifyDirWithCmdStateKey := []byte(actualStateEntry.Path().String())
 	if err := persistentStateSet(
-		persistentState, modifyDirWithCmdStateBucket, modifyDirWithCmdStateKey, &modifyDirWithCmdState{
+		persistentState, gitRepoExternalState, modifyDirWithCmdStateKey, &modifyDirWithCmdState{
 			Name:  actualStateEntry.Path(),
 			RunAt: runAt,
 		}); err != nil {
@@ -119,7 +119,7 @@ func (t *TargetStateModifyDirWithCmd) SkipApply(persistentState PersistentState,
 		return false, nil
 	}
 	modifyDirWithCmdKey := []byte(targetAbsPath.String())
-	switch modifyDirWithCmdStateBytes, err := persistentState.Get(modifyDirWithCmdStateBucket, modifyDirWithCmdKey); {
+	switch modifyDirWithCmdStateBytes, err := persistentState.Get(gitRepoExternalState, modifyDirWithCmdKey); {
 	case err != nil:
 		return false, err
 	case modifyDirWithCmdStateBytes == nil:

diff --git a/pkg/cmd/testdata/scripts/configstate.txtar b/pkg/cmd/testdata/scripts/configstate.txtar
@@ -67,6 +67,7 @@ configState:
     configState:
         configTemplateContentsSHA256: af43121a524340707b84e390f510c949731177e6f2a25b3b6b11b2fc656cf8f2
 entryState: {}
+gitRepoExternalState: {}
 scriptState: {}
 -- home/user/.local/share/chezmoi/.chezmoi.toml.tmpl --
 [data]

diff --git a/pkg/cmd/testdata/scripts/state_unix.txtar b/pkg/cmd/testdata/scripts/state_unix.txtar
@@ -40,6 +40,7 @@ stdout runAt:
 -- golden/dump.yaml --
 configState: {}
 entryState: {}
+gitRepoExternalState: {}
 scriptState: {}
 -- home/user/.local/share/chezmoi/run_once_script.sh --
 #!/bin/sh

diff --git a/pkg/cmd/testdata/scripts/state_windows.txtar b/pkg/cmd/testdata/scripts/state_windows.txtar
@@ -21,6 +21,7 @@ exec chezmoi --force state reset
 -- golden/dump.yaml --
 configState: {}
 entryState: {}
+gitRepoExternalState: {}
 scriptState: {}
 -- home/user/.local/share/chezmoi/run_once_script.cmd --
 :: don't need to actually do anything