Add --print-actions

Signed-off-by: Vadim Markovtsev <vadim@sourced.tech>

internal/core/forks.go

@@ -161,28 +161,33 @@ func prepareRunPlan(commits []*object.Commit, hibernationDistance int,
 	}
 	if printResult {
 		for _, p := range plan {
-			firstItem := p.Items[0]
-			switch p.Action {
-			case runActionCommit:
-				planPrintFunc("C", firstItem, p.Commit.Hash.String())
-			case runActionFork:
-				planPrintFunc("F", p.Items)
-			case runActionMerge:
-				planPrintFunc("M", p.Items)
-			case runActionEmerge:
-				planPrintFunc("E", p.Items)
-			case runActionDelete:
-				planPrintFunc("D", p.Items)
-			case runActionHibernate:
-				planPrintFunc("H", firstItem)
-			case runActionBoot:
-				planPrintFunc("B", firstItem)
-			}
+			printAction(p)
 		}
 	}
 	return plan
 }
 
+// printAction prints the specified action to stderr.
+func printAction(p runAction) {
+	firstItem := p.Items[0]
+	switch p.Action {
+	case runActionCommit:
+		planPrintFunc("C", firstItem, p.Commit.Hash.String())
+	case runActionFork:
+		planPrintFunc("F", p.Items)
+	case runActionMerge:
+		planPrintFunc("M", p.Items)
+	case runActionEmerge:
+		planPrintFunc("E", p.Items)
+	case runActionDelete:
+		planPrintFunc("D", p.Items)
+	case runActionHibernate:
+		planPrintFunc("H", firstItem)
+	case runActionBoot:
+		planPrintFunc("B", firstItem)
+	}
+}
+
 // buildDag generates the raw commit DAG and the commit hash map.
 func buildDag(commits []*object.Commit) (
 	map[string]*object.Commit, map[plumbing.Hash][]*object.Commit) {

internal/core/pipeline.go

@@ -258,6 +258,9 @@ type Pipeline struct {
 	// DumpPlan indicates whether to print the execution plan to stderr.
 	DumpPlan bool
 
+	// PrintActions indicates whether to print the taken actions during the execution.
+	PrintActions bool
+
 	// Repository points to the analysed Git repository struct from go-git.
 	repository *git.Repository
 
@@ -291,6 +294,9 @@ const (
 	// which is the minimum number of actions between two sequential usages of
 	// a branch to activate the hibernation optimization (cpu-memory trade-off). 0 disables.
 	ConfigPipelineHibernationDistance = "Pipeline.HibernationDistance"
+	// ConfigPipelinePrintActions is the name of the Pipeline configuration option (Pipeline.Initialize())
+	// which enables printing the taken actions of the execution plan to stderr.
+	ConfigPipelinePrintActions = "Pipeline.PrintActions"
 	// DependencyCommit is the name of one of the three items in `deps` supplied to PipelineItem.Consume()
 	// which always exists. It corresponds to the currently analyzed commit.
 	DependencyCommit = "commit"
@@ -630,6 +636,7 @@ func (pipeline *Pipeline) Initialize(facts map[string]interface{}) error {
 			log.Panicf("failed to list the commits: %v", err)
 		}
 	}
+	pipeline.PrintActions = facts[ConfigPipelinePrintActions].(bool)
 	if val, exists := facts[ConfigPipelineHibernationDistance].(int); exists {
 		if val < 0 {
 			log.Panicf("--hibernation-distance cannot be negative (got %d)", val)
@@ -727,6 +734,10 @@ func (pipeline *Pipeline) Run(commits []*object.Commit) (map[LeafPipelineItem]in
 		if pipeline.DryRun {
 			continue
 		}
+		if pipeline.PrintActions {
+			fmt.Fprintln(os.Stderr)
+			printAction(step)
+		}
 		if index > 0 && index%100 == 0 && pipeline.HibernationDistance > 0 {
 			debug.FreeOSMemory()
 		}

internal/core/pipeline_test.go

@@ -852,6 +852,7 @@ func TestPipelineRunHibernation(t *testing.T) {
 			t.Fatal(err)
 		}
 	}
+	pipeline.PrintActions = true
 	_, err := pipeline.Run(commits)
 	assert.Nil(t, err)
 	assert.True(t, item.Hibernated)

internal/core/registry.go

@@ -262,6 +262,10 @@ func (registry *PipelineItemRegistry) AddFlags(flagSet *pflag.FlagSet) (
 			"Minimum number of actions between two sequential usages of a branch to activate "+
 				"the hibernation optimization (cpu-memory trade-off). 0 disables.")
 		flags[ConfigPipelineHibernationDistance] = iface
+		iface = interface{}(true)
+		ptr5 := (**bool)(unsafe.Pointer(uintptr(unsafe.Pointer(&iface)) + unsafe.Sizeof(&iface)))
+		*ptr5 = flagSet.Bool("print-actions", false, "Print the executed actions to stderr.")
+		flags[ConfigPipelinePrintActions] = iface
 	}
 	var features []string
 	for f := range registry.featureFlags.Choices {