feat: add --no-commands switch

Fixes: Issue #205
retr0h · May 26, 2024 · 160355a · 160355a
1 parent 3d62646
commit 160355a
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 3 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -67,13 +67,15 @@ func Execute() {
 func init() {
 	rootCmd.PersistentFlags().BoolP("debug", "d", false, "Enable or disable debug mode")
 	rootCmd.PersistentFlags().BoolP("parallel", "p", true, "Fetch clones in parallel")
+	rootCmd.PersistentFlags().Bool("no-commands", false, "Skip post-commands when overlaying")
 	rootCmd.PersistentFlags().
 		StringP("gilt-dir", "c", "~/.gilt/clone", "Path to Gilt's clone dir")
 	rootCmd.PersistentFlags().
 		StringP("gilt-file", "f", "Giltfile.yaml", "Path to config file")
 
 	_ = viper.BindPFlag("debug", rootCmd.PersistentFlags().Lookup("debug"))
 	_ = viper.BindPFlag("parallel", rootCmd.PersistentFlags().Lookup("parallel"))
+	_ = viper.BindPFlag("skipCommands", rootCmd.PersistentFlags().Lookup("no-commands"))
 	_ = viper.BindPFlag("giltFile", rootCmd.PersistentFlags().Lookup("gilt-file"))
 	_ = viper.BindPFlag("giltDir", rootCmd.PersistentFlags().Lookup("gilt-dir"))
 	_ = viper.BindPFlag("repositories", rootCmd.PersistentFlags().Lookup("repositories"))

diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md
@@ -60,8 +60,8 @@ should have an 80 character line wrap limit (enforced by Prettier).
 
 ### Writing tests
 
-When making a changes, consider whether new tests are required. These tests
-should ensure that the functionality you are adding will continue to work in the
+When making changes, consider whether new tests are required. These tests should
+ensure that the functionality you are adding will continue to work in the
 future. Existing tests may also need updating if you have changed Gilt's
 behavior.
 

diff --git a/docs/docs/usage.md b/docs/docs/usage.md
@@ -30,6 +30,14 @@ Display the git commands being executed.
 gilt --debug overlay
 ```
 
+### Skipping post-commands
+
+Overlay files only, but run no other commands.
+
+```bash
+gilt overlay --no-commands
+```
+
 ## Package
 
 ### Overlay Repository

diff --git a/internal/repositories/repositories.go b/internal/repositories/repositories.go
@@ -97,6 +97,10 @@ func (r *Repositories) Overlay() error {
 		}
 
 		// run post commands
+		if r.config.SkipCommands {
+			r.logger.Info("skipping running post-commands")
+			continue
+		}
 		if err := r.runCommands(c); err != nil {
 			return err
 		}

diff --git a/internal/repositories/repositories_public_test.go b/internal/repositories/repositories_public_test.go
@@ -53,6 +53,7 @@ type RepositoriesPublicTestSuite struct {
 	gitURL           string
 	gitVersion       string
 	repoConfigDstDir []config.Repository
+	SkipCommands     bool
 	logger           *slog.Logger
 }
 
@@ -62,6 +63,7 @@ func (suite *RepositoriesPublicTestSuite) NewTestRepositoriesManager(
 	reposConfig := config.Repositories{
 		Debug:        false,
 		Parallel:     true,
+		SkipCommands: suite.SkipCommands,
 		GiltFile:     "Giltfile.yaml",
 		GiltDir:      suite.giltDir,
 		Repositories: repoConfig,
@@ -93,7 +95,7 @@ func (suite *RepositoriesPublicTestSuite) SetupTest() {
 			DstDir:  suite.dstDir,
 		},
 	}
-
+	suite.SkipCommands = false
 	suite.logger = slog.New(slog.NewTextHandler(os.Stdout, nil))
 }
 
@@ -300,6 +302,33 @@ func (suite *RepositoriesPublicTestSuite) TestOverlayReturnsErrorWhenCommandErro
 	assert.Error(suite.T(), err)
 }
 
+func (suite *RepositoriesPublicTestSuite) TestOverlaySkipsCommands() {
+	suite.SkipCommands = true
+	repoConfig := []config.Repository{
+		{
+			Git:     suite.gitURL,
+			Version: suite.gitVersion,
+			DstDir:  suite.dstDir,
+			Commands: []config.Command{
+				{
+					Cmd:  "touch",
+					Args: []string{"/tmp/foo"},
+				},
+			},
+		},
+	}
+
+	repos := suite.NewTestRepositoriesManager(repoConfig)
+
+	suite.mockRepo.EXPECT().Clone(gomock.Any(), gomock.Any()).Return("", nil)
+	suite.mockRepo.EXPECT().Worktree(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil)
+	// Explicitly check that RunCmd is never called
+	suite.mockExec.EXPECT().RunCmd(gomock.Any(), gomock.Any()).Times(0)
+
+	err := repos.Overlay()
+	assert.NoError(suite.T(), err)
+}
+
 // In order for `go test` to run this suite, we need to create
 // a normal test function and pass our suite to suite.Run.
 func TestRepositoriesPublicTestSuite(t *testing.T) {

diff --git a/pkg/config/types.go b/pkg/config/types.go
@@ -26,6 +26,8 @@ type Repositories struct {
 	Debug bool `mapstruture:"debug"`
 	// Parallel enable or disable concurrent clone fetches.
 	Parallel bool `                           mapstructure:"parallel"`
+	// SkipCommands run post-commands as part of the overlay process
+	SkipCommands bool
 	// GiltFile path to Gilt's config file option set from CLI.
 	GiltFile string `                           mapstructure:"giltFile" validate:"required"`
 	// GiltDir path to Gilt's clone dir option set from CLI.