Move NewDummyCommon to pkg/common

stefanhaller · stefanhaller · commit a6a68778ea66 · 2025-05-06T09:43:26.000+02:00
It's too special for a utils package, and it als makes sense to put it right
next to the thing that it is a dummy for.
diff --git a/pkg/commands/git_commands/commit_loader_test.go b/pkg/commands/git_commands/commit_loader_test.go
@@ -8,6 +8,7 @@ import (
 	"github.com/go-errors/errors"
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/jesseduffield/lazygit/pkg/config"
 	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/samber/lo"
@@ -296,7 +297,7 @@ func TestGetCommits(t *testing.T) {
 
 	for _, scenario := range scenarios {
 		t.Run(scenario.testName, func(t *testing.T) {
-			common := utils.NewDummyCommon()
+			common := common.NewDummyCommon()
 			common.AppState = &config.AppState{}
 			common.AppState.GitLogOrder = scenario.logOrder
 			cmd := oscommands.NewDummyCmdObjBuilder(scenario.runner)
@@ -516,7 +517,7 @@ func TestCommitLoader_getConflictedCommitImpl(t *testing.T) {
 	}
 	for _, scenario := range scenarios {
 		t.Run(scenario.testName, func(t *testing.T) {
-			common := utils.NewDummyCommon()
+			common := common.NewDummyCommon()
 
 			builder := &CommitLoader{
 				Common:              common,
diff --git a/pkg/commands/git_commands/deps_test.go b/pkg/commands/git_commands/deps_test.go
@@ -9,7 +9,6 @@ import (
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
 	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/jesseduffield/lazygit/pkg/config"
-	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/spf13/afero"
 )
 
@@ -32,7 +31,7 @@ func buildGitCommon(deps commonDeps) *GitCommon {
 
 	gitCommon.Common = deps.common
 	if gitCommon.Common == nil {
-		gitCommon.Common = utils.NewDummyCommonWithUserConfigAndAppState(deps.userConfig, deps.appState)
+		gitCommon.Common = common.NewDummyCommonWithUserConfigAndAppState(deps.userConfig, deps.appState)
 	}
 
 	if deps.fs != nil {
diff --git a/pkg/commands/git_commands/reflog_commit_loader_test.go b/pkg/commands/git_commands/reflog_commit_loader_test.go
@@ -7,6 +7,7 @@ import (
 
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/samber/lo"
 	"github.com/sanity-io/litter"
@@ -181,7 +182,7 @@ func TestGetReflogCommits(t *testing.T) {
 	for _, scenario := range scenarios {
 		t.Run(scenario.testName, func(t *testing.T) {
 			builder := &ReflogCommitLoader{
-				Common: utils.NewDummyCommon(),
+				Common: common.NewDummyCommon(),
 				cmd:    oscommands.NewDummyCmdObjBuilder(scenario.runner),
 			}
 
diff --git a/pkg/commands/git_commands/stash_loader_test.go b/pkg/commands/git_commands/stash_loader_test.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
-	"github.com/jesseduffield/lazygit/pkg/utils"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -50,7 +50,7 @@ func TestGetStashEntries(t *testing.T) {
 		t.Run(s.testName, func(t *testing.T) {
 			cmd := oscommands.NewDummyCmdObjBuilder(s.runner)
 
-			loader := NewStashLoader(utils.NewDummyCommon(), cmd)
+			loader := NewStashLoader(common.NewDummyCommon(), cmd)
 
 			assert.EqualValues(t, s.expectedStashEntries, loader.GetStashEntries(s.filterPath))
 		})
diff --git a/pkg/commands/git_commands/tag_loader_test.go b/pkg/commands/git_commands/tag_loader_test.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
-	"github.com/jesseduffield/lazygit/pkg/utils"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -46,7 +46,7 @@ func TestGetTags(t *testing.T) {
 	for _, scenario := range scenarios {
 		t.Run(scenario.testName, func(t *testing.T) {
 			loader := &TagLoader{
-				Common: utils.NewDummyCommon(),
+				Common: common.NewDummyCommon(),
 				cmd:    oscommands.NewDummyCmdObjBuilder(scenario.runner),
 			}
 
diff --git a/pkg/commands/oscommands/dummies.go b/pkg/commands/oscommands/dummies.go
@@ -8,7 +8,7 @@ import (
 
 // NewDummyOSCommand creates a new dummy OSCommand for testing
 func NewDummyOSCommand() *OSCommand {
-	osCmd := NewOSCommand(utils.NewDummyCommon(), config.NewDummyAppConfig(), dummyPlatform, NewNullGuiIO(utils.NewDummyLog()))
+	osCmd := NewOSCommand(common.NewDummyCommon(), config.NewDummyAppConfig(), dummyPlatform, NewNullGuiIO(utils.NewDummyLog()))
 
 	return osCmd
 }
@@ -23,9 +23,9 @@ type OSCommandDeps struct {
 }
 
 func NewDummyOSCommandWithDeps(deps OSCommandDeps) *OSCommand {
-	common := deps.Common
-	if common == nil {
-		common = utils.NewDummyCommon()
+	cmn := deps.Common
+	if cmn == nil {
+		cmn = common.NewDummyCommon()
 	}
 
 	platform := deps.Platform
@@ -34,7 +34,7 @@ func NewDummyOSCommandWithDeps(deps OSCommandDeps) *OSCommand {
 	}
 
 	return &OSCommand{
-		Common:       common,
+		Common:       cmn,
 		Platform:     platform,
 		getenvFn:     deps.GetenvFn,
 		removeFileFn: deps.RemoveFileFn,
@@ -59,7 +59,7 @@ var dummyPlatform = &Platform{
 }
 
 func NewDummyOSCommandWithRunner(runner *FakeCmdObjRunner) *OSCommand {
-	osCommand := NewOSCommand(utils.NewDummyCommon(), config.NewDummyAppConfig(), dummyPlatform, NewNullGuiIO(utils.NewDummyLog()))
+	osCommand := NewOSCommand(common.NewDummyCommon(), config.NewDummyAppConfig(), dummyPlatform, NewNullGuiIO(utils.NewDummyLog()))
 	osCommand.Cmd = NewDummyCmdObjBuilder(runner)
 
 	return osCommand
diff --git a/pkg/common/dummies.go b/pkg/common/dummies.go
@@ -0,0 +1,33 @@
+package common
+
+import (
+	"github.com/jesseduffield/lazygit/pkg/config"
+	"github.com/jesseduffield/lazygit/pkg/i18n"
+	"github.com/jesseduffield/lazygit/pkg/utils"
+	"github.com/spf13/afero"
+)
+
+func NewDummyCommon() *Common {
+	tr := i18n.EnglishTranslationSet()
+	cmn := &Common{
+		Log: utils.NewDummyLog(),
+		Tr:  tr,
+		Fs:  afero.NewOsFs(),
+	}
+	cmn.SetUserConfig(config.GetDefaultConfig())
+	return cmn
+}
+
+func NewDummyCommonWithUserConfigAndAppState(userConfig *config.UserConfig, appState *config.AppState) *Common {
+	tr := i18n.EnglishTranslationSet()
+	cmn := &Common{
+		Log:      utils.NewDummyLog(),
+		Tr:       tr,
+		AppState: appState,
+		// TODO: remove dependency on actual filesystem in tests and switch to using
+		// in-memory for everything
+		Fs: afero.NewOsFs(),
+	}
+	cmn.SetUserConfig(userConfig)
+	return cmn
+}
diff --git a/pkg/gui/dummies.go b/pkg/gui/dummies.go
@@ -3,20 +3,20 @@ package gui
 import (
 	"github.com/jesseduffield/lazygit/pkg/commands/git_commands"
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/jesseduffield/lazygit/pkg/config"
 	"github.com/jesseduffield/lazygit/pkg/updates"
-	"github.com/jesseduffield/lazygit/pkg/utils"
 )
 
 func NewDummyUpdater() *updates.Updater {
 	newAppConfig := config.NewDummyAppConfig()
-	dummyUpdater, _ := updates.NewUpdater(utils.NewDummyCommon(), newAppConfig, oscommands.NewDummyOSCommand())
+	dummyUpdater, _ := updates.NewUpdater(common.NewDummyCommon(), newAppConfig, oscommands.NewDummyOSCommand())
 	return dummyUpdater
 }
 
 // NewDummyGui creates a new dummy GUI for testing
 func NewDummyGui() *Gui {
 	newAppConfig := config.NewDummyAppConfig()
-	dummyGui, _ := NewGui(utils.NewDummyCommon(), newAppConfig, &git_commands.GitVersion{Major: 2, Minor: 0, Patch: 0}, NewDummyUpdater(), false, "", nil)
+	dummyGui, _ := NewGui(common.NewDummyCommon(), newAppConfig, &git_commands.GitVersion{Major: 2, Minor: 0, Patch: 0}, NewDummyUpdater(), false, "", nil)
 	return dummyGui
 }
diff --git a/pkg/gui/presentation/branches_test.go b/pkg/gui/presentation/branches_test.go
@@ -8,9 +8,9 @@ import (
 
 	"github.com/gookit/color"
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/jesseduffield/lazygit/pkg/gui/presentation/icons"
 	"github.com/jesseduffield/lazygit/pkg/gui/types"
-	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/samber/lo"
 	"github.com/stretchr/testify/assert"
 	"github.com/xo/terminfo"
@@ -320,7 +320,7 @@ func Test_getBranchDisplayStrings(t *testing.T) {
 	oldColorLevel := color.ForceSetColorLevel(terminfo.ColorLevelNone)
 	defer color.ForceSetColorLevel(oldColorLevel)
 
-	c := utils.NewDummyCommon()
+	c := common.NewDummyCommon()
 	SetCustomBranches(c.UserConfig().Gui.BranchColorPatterns, true)
 
 	for i, s := range scenarios {
diff --git a/pkg/gui/presentation/commits_test.go b/pkg/gui/presentation/commits_test.go
@@ -10,6 +10,7 @@ import (
 	"github.com/jesseduffield/generics/set"
 	"github.com/jesseduffield/lazygit/pkg/commands/git_commands"
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/samber/lo"
 	"github.com/stefanhaller/git-todo-parser/todo"
@@ -539,7 +540,7 @@ func TestGetCommitListDisplayStrings(t *testing.T) {
 		}
 	}
 
-	common := utils.NewDummyCommon()
+	common := common.NewDummyCommon()
 
 	for _, s := range scenarios {
 		if !focusing || s.focus {
diff --git a/pkg/gui/services/custom_commands/menu_generator_test.go b/pkg/gui/services/custom_commands/menu_generator_test.go
@@ -3,7 +3,7 @@ package custom_commands
 import (
 	"testing"
 
-	"github.com/jesseduffield/lazygit/pkg/utils"
+	"github.com/jesseduffield/lazygit/pkg/common"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -82,7 +82,7 @@ func TestMenuGenerator(t *testing.T) {
 
 	for _, s := range scenarios {
 		t.Run(s.testName, func(t *testing.T) {
-			s.test(NewMenuGenerator(utils.NewDummyCommon()).call(s.cmdOut, s.filter, s.valueFormat, s.labelFormat))
+			s.test(NewMenuGenerator(common.NewDummyCommon()).call(s.cmdOut, s.filter, s.valueFormat, s.labelFormat))
 		})
 	}
 }
diff --git a/pkg/utils/dummies.go b/pkg/utils/dummies.go
@@ -3,11 +3,7 @@ package utils
 import (
 	"io"
 
-	"github.com/jesseduffield/lazygit/pkg/common"
-	"github.com/jesseduffield/lazygit/pkg/config"
-	"github.com/jesseduffield/lazygit/pkg/i18n"
 	"github.com/sirupsen/logrus"
-	"github.com/spf13/afero"
 )
 
 // NewDummyLog creates a new dummy Log for testing
@@ -16,28 +12,3 @@ func NewDummyLog() *logrus.Entry {
 	log.Out = io.Discard
 	return log.WithField("test", "test")
 }
-
-func NewDummyCommon() *common.Common {
-	tr := i18n.EnglishTranslationSet()
-	cmn := &common.Common{
-		Log: NewDummyLog(),
-		Tr:  tr,
-		Fs:  afero.NewOsFs(),
-	}
-	cmn.SetUserConfig(config.GetDefaultConfig())
-	return cmn
-}
-
-func NewDummyCommonWithUserConfigAndAppState(userConfig *config.UserConfig, appState *config.AppState) *common.Common {
-	tr := i18n.EnglishTranslationSet()
-	cmn := &common.Common{
-		Log:      NewDummyLog(),
-		Tr:       tr,
-		AppState: appState,
-		// TODO: remove dependency on actual filesystem in tests and switch to using
-		// in-memory for everything
-		Fs: afero.NewOsFs(),
-	}
-	cmn.SetUserConfig(userConfig)
-	return cmn
-}

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ import (`
`9`	`9`	`"github.com/jesseduffield/lazygit/pkg/commands/oscommands"`
`10`	`10`	`"github.com/jesseduffield/lazygit/pkg/common"`
`11`	`11`	`"github.com/jesseduffield/lazygit/pkg/config"`
`12`		`- "github.com/jesseduffield/lazygit/pkg/utils"`
`13`	`12`	`"github.com/spf13/afero"`
`14`	`13`	`)`
`15`	`14`
`@@ -32,7 +31,7 @@ func buildGitCommon(deps commonDeps) *GitCommon {`
`32`	`31`
`33`	`32`	`gitCommon.Common = deps.common`
`34`	`33`	`if gitCommon.Common == nil {`
`35`		`- gitCommon.Common = utils.NewDummyCommonWithUserConfigAndAppState(deps.userConfig, deps.appState)`
	`34`	`+ gitCommon.Common = common.NewDummyCommonWithUserConfigAndAppState(deps.userConfig, deps.appState)`
`36`	`35`	`}`
`37`	`36`
`38`	`37`	`if deps.fs != nil {`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`
`6`	`6`	`"github.com/jesseduffield/lazygit/pkg/commands/models"`
`7`	`7`	`"github.com/jesseduffield/lazygit/pkg/commands/oscommands"`
`8`		`- "github.com/jesseduffield/lazygit/pkg/utils"`
	`8`	`+ "github.com/jesseduffield/lazygit/pkg/common"`
`9`	`9`	`"github.com/stretchr/testify/assert"`
`10`	`10`	`)`
`11`	`11`
`@@ -46,7 +46,7 @@ func TestGetTags(t *testing.T) {`
`46`	`46`	`for _, scenario := range scenarios {`
`47`	`47`	`t.Run(scenario.testName, func(t *testing.T) {`
`48`	`48`	`loader := &TagLoader{`
`49`		`- Common: utils.NewDummyCommon(),`
	`49`	`+ Common: common.NewDummyCommon(),`
`50`	`50`	`cmd: oscommands.NewDummyCmdObjBuilder(scenario.runner),`
`51`	`51`	`}`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ import (`
`10`	`10`	`"github.com/jesseduffield/generics/set"`
`11`	`11`	`"github.com/jesseduffield/lazygit/pkg/commands/git_commands"`
`12`	`12`	`"github.com/jesseduffield/lazygit/pkg/commands/models"`
	`13`	`+ "github.com/jesseduffield/lazygit/pkg/common"`
`13`	`14`	`"github.com/jesseduffield/lazygit/pkg/utils"`
`14`	`15`	`"github.com/samber/lo"`
`15`	`16`	`"github.com/stefanhaller/git-todo-parser/todo"`
`@@ -539,7 +540,7 @@ func TestGetCommitListDisplayStrings(t *testing.T) {`
`539`	`540`	`}`
`540`	`541`	`}`
`541`	`542`
`542`		`- common := utils.NewDummyCommon()`
	`543`	`+ common := common.NewDummyCommon()`
`543`	`544`
`544`	`545`	`for _, s := range scenarios {`
`545`	`546`	`if !focusing \|\| s.focus {`