[#403] Add cli command to generate a retrospective template file

So that we can experiment that the --commit-failure is worth its cost
- add a 'retro' command line command
- add a Retro RunMode
- add a GenerateRetro method to tcr, throwing a notimplemented yet exception
- add test to make sure that we call tcr.GenerateRetro

src/cli/terminal_ui.go

@@ -427,6 +427,11 @@ func (term *TerminalUI) Start() {
 		// we directly ask TCR engine to print the stats and quit when done
 		term.tcr.PrintStats(term.params)
 		term.tcr.Quit()
+	case runmode.Retro{}:
+		// When running TCR in retro mode, there's no selection menu:
+		// we directly ask TCR engine to generate the retrospective file and quit when done
+		term.tcr.GenerateRetro(term.params)
+		term.tcr.Quit()
 	default:
 		term.printError("Unknown run mode: ", term.params.Mode)
 	}

src/cli/terminal_ui_test.go

@@ -945,6 +945,13 @@ func Test_start_terminal(t *testing.T) {
 				engine.TCRCallQuit,
 			},
 		},
+		{
+			"retro mode", runmode.Retro{}, []byte{},
+			[]engine.TCRCall{
+				engine.TCRCallGenerateRetro,
+				engine.TCRCallQuit,
+			},
+		},
 	}
 	for _, tt := range testFlags {
 		t.Run(tt.desc, func(t *testing.T) {

src/cmd/retro.go

@@ -0,0 +1,46 @@
+/*
+Copyright (c) 2023 Murex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package cmd
+
+import (
+	"github.com/murex/tcr/cli"
+	"github.com/murex/tcr/engine"
+	"github.com/murex/tcr/runmode"
+	"github.com/spf13/cobra"
+)
+
+// retroCmd represents the retro command
+var retroCmd = &cobra.Command{
+	Use:   "retro",
+	Short: "Generates a retrospective template using stats",
+	Long:  `TODO`,
+	Run: func(cmd *cobra.Command, args []string) {
+		parameters.Mode = runmode.Retro{}
+		u := cli.New(parameters, engine.NewTCREngine())
+		u.Start()
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(retroCmd)
+}

src/engine/tcr.go

@@ -74,6 +74,7 @@ type (
 		VCSPull()
 		VCSPush()
 		Quit()
+		GenerateRetro(p params.Params)
 	}
 
 	// TCREngine is the engine running all TCR operations
@@ -227,6 +228,12 @@ func (tcr *TCREngine) PrintStats(p params.Params) {
 	stats.Print(tcr.vcs.SessionSummary(), tcrLogsToEvents(tcrLogs))
 }
 
+// GenerateRetro generates a retrospective markdown file template using stats
+func (tcr *TCREngine) GenerateRetro(_p params.Params) {
+	//TODO implement me
+	panic("implement me")
+}
+
 func tcrLogsToEvents(tcrLogs vcs.LogItems) (tcrEvents events.TcrEvents) {
 	tcrEvents = *events.NewTcrEvents()
 	for _, log := range tcrLogs {

src/engine/tcr_test_fake.go

@@ -52,6 +52,7 @@ const (
 	TCRCallPrintStats        TCRCall = "print-stats"
 	TCRCallVCSPull           TCRCall = "vcs-pull"
 	TCRCallVCSPush           TCRCall = "vcs-push"
+	TCRCallGenerateRetro     TCRCall = "generate-retro"
 )
 
 var NoTCRCall []TCRCall
@@ -185,3 +186,8 @@ func (fake *FakeTCREngine) VCSPull() {
 func (fake *FakeTCREngine) VCSPush() {
 	fake.recordCall(TCRCallVCSPush)
 }
+
+// GenerateRetro Generates a retrospective file using stats
+func (fake *FakeTCREngine) GenerateRetro(_ params.Params) {
+	fake.recordCall(TCRCallGenerateRetro)
+}

src/runmode/retro.go

@@ -0,0 +1,52 @@
+/*
+Copyright (c) 2023 Murex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package runmode
+
+// Retro is a type of run mode allowing to generate a retrospective template
+type Retro struct {
+}
+
+// Name returns the name of this run mode
+func (Retro) Name() string {
+	return "retro"
+}
+
+// AutoPushDefault returns the default value of VCS auto-push option with this run mode
+func (Retro) AutoPushDefault() bool {
+	return false
+}
+
+// NeedsCountdownTimer indicates if a countdown timer is needed with this run mode
+func (Retro) NeedsCountdownTimer() bool {
+	return false
+}
+
+// IsInteractive indicates if this run mode allows user interaction
+func (Retro) IsInteractive() bool {
+	return false
+}
+
+// IsActive indicates if this run mode is actively running TCR
+func (Retro) IsActive() bool {
+	return false
+}

src/runmode/runmode.go

@@ -32,7 +32,7 @@ type RunMode interface {
 }
 
 var (
-	allModes = []RunMode{Mob{}, Solo{}, OneShot{}, Check{}, Log{}, Stats{}}
+	allModes = []RunMode{Mob{}, Solo{}, OneShot{}, Check{}, Log{}, Stats{}, Retro{}}
 )
 
 // InteractiveModes returns the list of names of available interactive run modes