[#694] Add toolchain command abort shortcut in CLI

- Shortcut: 'A' (abort)

Author: mengdaming

src/cli/terminal_ui.go

@@ -62,6 +62,7 @@ const (
 	enterNavigatorRoleMenuHelper = "Navigator role"
 	openBrowserMenuHelper        = "Open in browser"
 	gitAutoPushMenuHelper        = "Turn on/off git auto-push"
+	abortCommandMenuHelper       = "Abort current command"
 	quitMenuHelper               = "Quit"
 	optionsMenuHelper            = "List available options"
 	timerStatusMenuHelper        = "Timer status"
@@ -290,6 +291,10 @@ func (term *TerminalUI) vcsPush() {
 	term.tcr.VCSPush()
 }
 
+func (term *TerminalUI) abortCommand() {
+	term.tcr.AbortCommand()
+}
+
 func (term *TerminalUI) whatShallWeDo() {
 	if term.params.Mode.IsMultiRole() {
 		term.listMenuOptions(term.mobMenu, "What shall we do?")
@@ -444,6 +449,9 @@ func (term *TerminalUI) initSoloMenu() *menu {
 		newMenuOption('Y', syncMenuHelper,
 			term.p4MenuEnabler(),
 			term.vcsPullMenuAction(), false),
+		newMenuOption('A', abortCommandMenuHelper,
+			term.abortCommandEnabler(),
+			term.abortCommandMenuAction(), false),
 		newMenuOption('Q', quitTCRMenuHelper,
 			term.quitRoleMenuEnabler(role.Driver{}),
 			term.quitRoleMenuAction(), true),
@@ -480,6 +488,9 @@ func (term *TerminalUI) initMobMenu() *menu {
 		newMenuOption('Y', syncMenuHelper,
 			term.p4MenuEnabler(),
 			term.vcsPullMenuAction(), false),
+		newMenuOption('A', abortCommandMenuHelper,
+			term.abortCommandEnabler(),
+			term.abortCommandMenuAction(), false),
 		newMenuOption('Q', quitMenuHelper,
 			term.quitRoleMenuEnabler(nil),
 			term.quitMenuAction(), true),
@@ -554,6 +565,12 @@ func (term *TerminalUI) vcsPushMenuAction() menuAction {
 	}
 }
 
+func (term *TerminalUI) abortCommandMenuAction() menuAction {
+	return func() {
+		term.abortCommand()
+	}
+}
+
 func (term *TerminalUI) optionsMenuAction(m *menu) menuAction {
 	return func() {
 		term.listMenuOptions(m, "Available Options:")
@@ -579,6 +596,14 @@ func (term *TerminalUI) timerStatusMenuAction() menuAction {
 	}
 }
 
+func (term *TerminalUI) abortCommandEnabler() menuEnabler {
+	return func() bool {
+		// For now we only enable this shortcut when in driver role.
+		// We may need to enable it more widely when we extend abort to VCS commands as well
+		return term.tcr.GetCurrentRole() == role.Driver{}
+	}
+}
+
 func (term *TerminalUI) quitRoleMenuEnabler(r role.Role) menuEnabler {
 	return func() bool {
 		return term.tcr.GetCurrentRole() == r

src/cli/terminal_ui_test.go

@@ -219,6 +219,7 @@ func Test_list_role_menu_options(t *testing.T) {
 				asCyanTrace("\tP "+menuArrow+" "+gitAutoPushMenuHelper) +
 				asCyanTrace("\tL "+menuArrow+" "+pullMenuHelper) +
 				asCyanTrace("\tS "+menuArrow+" "+pushMenuHelper) +
+				asCyanTrace("\tA "+menuArrow+" "+abortCommandMenuHelper) +
 				asCyanTrace("\tQ "+menuArrow+" "+quitTCRMenuHelper) +
 				asCyanTrace("\t? "+menuArrow+" "+optionsMenuHelper),
 		},
@@ -231,6 +232,7 @@ func Test_list_role_menu_options(t *testing.T) {
 				asCyanTrace("\tP "+menuArrow+" "+gitAutoPushMenuHelper) +
 				asCyanTrace("\tL "+menuArrow+" "+pullMenuHelper) +
 				asCyanTrace("\tS "+menuArrow+" "+pushMenuHelper) +
+				asCyanTrace("\tA "+menuArrow+" "+abortCommandMenuHelper) +
 				asCyanTrace("\tQ "+menuArrow+" "+quitDriverRoleMenuHelper) +
 				asCyanTrace("\t? "+menuArrow+" "+optionsMenuHelper),
 		},

src/engine/tcr.go

@@ -62,6 +62,7 @@ type (
 		RunAsNavigator()
 		Stop()
 		RunTCRCycle()
+		AbortCommand()
 		GetSessionInfo() SessionInfo
 		GetMobTimerStatus() timer.CurrentState
 		SetRunMode(m runmode.RunMode)
@@ -521,6 +522,12 @@ func (tcr *TCREngine) RunTCRCycle() {
 	}
 }
 
+// AbortCommand triggers interruption of an ongoing TCR cycle operation
+func (tcr *TCREngine) AbortCommand() {
+	//report.PostWarning("Aborting current command")
+	tcr.toolchain.AbortExecution()
+}
+
 func (tcr *TCREngine) createTCREvent(testResult toolchain.TestCommandResult) (event events.TCREvent) {
 	diffs, err := tcr.vcs.Diff()
 	if err != nil {

src/toolchain/command.go

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2021 Murex
+Copyright (c) 2024 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

src/toolchain/command_runner.go

@@ -121,3 +121,15 @@ func (*CommandRunner) reportCommandTrace(readCloser io.ReadCloser) {
 		}
 	}()
 }
+
+// AbortRunningCommand triggers aborting of any command that is currently running
+func (r *CommandRunner) AbortRunningCommand() {
+	if r.command == nil || r.command.Process == nil {
+		report.PostWarning("There is no command running at this time")
+		return
+	}
+	report.PostWarning("Aborting command: \"", r.command.String(), "\"")
+	_ = r.command.Process.Kill()
+	// Calling Kill() may be a bit too brutal (may leave children process alive)
+	//_ = r.command.Process.Signal(os.Kill)
+}

src/toolchain/toolchain.go

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2023 Murex
+Copyright (c) 2024 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
@@ -70,6 +70,7 @@ type (
 		checkTestCommand() error
 		runsOnPlatform(osName OsName, archName ArchName) bool
 		CheckCommandAccess(cmdPath string) (string, error)
+		AbortExecution()
 	}
 )
 
@@ -162,6 +163,11 @@ func (tchn Toolchain) RunTests() TestCommandResult {
 	return TestCommandResult{result, testStats}
 }
 
+// AbortExecution asks the toolchain to abort any command currently executing
+func (Toolchain) AbortExecution() {
+	commandRunner.AbortRunningCommand()
+}
+
 // BuildCommandPath returns the build command path for this toolchain
 func (tchn Toolchain) BuildCommandPath() string {
 	return findCompatibleCommand(tchn.buildCommands).Path