Skip to content

Commit

Permalink
refactor: remove unused debug attribute from managers
Browse files Browse the repository at this point in the history
This appears to be a vestigial; there's a logger object available
everywhere, and checking the log level is easier than setting this
flag everywhere
  • Loading branch information
nisimond authored and retr0h committed Jan 4, 2024
1 parent 9e87b6a commit 12a8c9d
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 22 deletions.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ require (
github.com/stretchr/testify v1.8.4
go.hein.dev/go-version v0.1.0
golang.org/x/term v0.15.0
gopkg.in/yaml.v3 v3.0.1
)

require (
Expand Down Expand Up @@ -43,6 +44,5 @@ require (
golang.org/x/text v0.14.0 // indirect
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
sigs.k8s.io/yaml v1.4.0 // indirect
)
2 changes: 0 additions & 2 deletions internal/exec/exec.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,9 @@ import (

// New factory to create a new Exec instance.
func New(
debug bool,
logger *slog.Logger,
) *Exec {
return &Exec{
debug: debug,
logger: logger,
}
}
Expand Down
21 changes: 9 additions & 12 deletions internal/exec/exec_public_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,16 @@ type ExecManagerPublicTestSuite struct {
suite.Suite
}

func (suite *ExecManagerPublicTestSuite) NewTestExecManager(
debug bool,
) internal.ExecManager {
func (suite *ExecManagerPublicTestSuite) NewTestExecManager() internal.ExecManager {
return exec.New(
debug,
slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{
Level: slog.LevelDebug,
})),
)
}

func (suite *ExecManagerPublicTestSuite) TestRunCmdOk() {
em := suite.NewTestExecManager(false)
em := suite.NewTestExecManager()

err := em.RunCmd("ls", []string{})
assert.NoError(suite.T(), err)
Expand All @@ -57,22 +54,22 @@ func (suite *ExecManagerPublicTestSuite) TestRunCmdOk() {
func (suite *ExecManagerPublicTestSuite) TestRunCmdWithDebug() {
suite.T().Skip("cannot seem to capture Stdout when logging in em")

em := suite.NewTestExecManager(true)
em := suite.NewTestExecManager()

err := em.RunCmd("echo", []string{"-n", "foo"})
assert.NoError(suite.T(), err)
}

func (suite *ExecManagerPublicTestSuite) TestRunCmdReturnsError() {
em := suite.NewTestExecManager(false)
em := suite.NewTestExecManager()

err := em.RunCmd("invalid", []string{"foo"})
assert.Error(suite.T(), err)
assert.Contains(suite.T(), err.Error(), "not found")
}

func (suite *ExecManagerPublicTestSuite) TestRunCmdInDirOk() {
em := suite.NewTestExecManager(false)
em := suite.NewTestExecManager()

err := em.RunCmdInDir("ls", []string{}, "/tmp")
assert.NoError(suite.T(), err)
Expand All @@ -81,22 +78,22 @@ func (suite *ExecManagerPublicTestSuite) TestRunCmdInDirOk() {
func (suite *ExecManagerPublicTestSuite) TestRunCmdInDirWithDebug() {
suite.T().Skip("cannot seem to capture Stdout when logging in em")

em := suite.NewTestExecManager(true)
em := suite.NewTestExecManager()

err := em.RunCmdInDir("echo", []string{"-n", "foo"}, "/tmp")
assert.NoError(suite.T(), err)
}

func (suite *ExecManagerPublicTestSuite) TestRunCmdInDirReturnsError() {
em := suite.NewTestExecManager(false)
em := suite.NewTestExecManager()

err := em.RunCmdInDir("invalid", []string{"foo"}, "/tmp")
assert.Error(suite.T(), err)
assert.Contains(suite.T(), err.Error(), "not found")
}

func (suite *ExecManagerPublicTestSuite) TestRunInTempDirOk() {
em := suite.NewTestExecManager(false)
em := suite.NewTestExecManager()

dir := ""
pattern := "test"
Expand All @@ -107,7 +104,7 @@ func (suite *ExecManagerPublicTestSuite) TestRunInTempDirOk() {
}

func (suite *ExecManagerPublicTestSuite) TestRunInTempDirError() {
em := suite.NewTestExecManager(false)
em := suite.NewTestExecManager()

dir := "\x00" // Null character is invalid in a filepath
pattern := "test"
Expand Down
1 change: 0 additions & 1 deletion internal/exec/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,5 @@ import (

// Exec disk implementation.
type Exec struct {
debug bool
logger *slog.Logger
}
2 changes: 0 additions & 2 deletions internal/git/git.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,11 @@ import (
// New factory to create a new Git instance.
func New(
appFs afero.Fs,
debug bool,
execManager internal.ExecManager,
logger *slog.Logger,
) *Git {
return &Git{
appFs: appFs,
debug: debug,
execManager: execManager,
logger: logger,
}
Expand Down
1 change: 0 additions & 1 deletion internal/git/git_public_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ type GitManagerPublicTestSuite struct {
func (suite *GitManagerPublicTestSuite) NewTestGitManager() internal.GitManager {
return git.New(
afero.NewMemMapFs(),
false,
suite.mockExec,
slog.New(slog.NewTextHandler(os.Stdout, nil)),
)
Expand Down
1 change: 0 additions & 1 deletion internal/git/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ import (
// Git implementation responsible for Git operations.
type Git struct {
appFs afero.Fs
debug bool
execManager internal.ExecManager
logger *slog.Logger
}
2 changes: 0 additions & 2 deletions pkg/repositories/repositories.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,11 @@ func New(
)

execManager := exec.New(
c.Debug,
logger,
)

gitManager := git.New(
appFs,
c.Debug,
execManager,
logger,
)
Expand Down

0 comments on commit 12a8c9d

Please sign in to comment.