Skip to content

feat: nuanced exit codes #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eddie-knight merged 2 commits into from
Jan 28, 2025
Merged

feat: nuanced exit codes #84

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a8f4a9
feat: nuanced exit codes
eddie-knight Jan 28, 2025
bf1e9d8
changed to enum for exit codes
eddie-knight Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 26 additions & 15 deletions cmd/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,27 @@ When everything is battoned down, it is time to run forth.`,
logger.Error(fmt.Sprintf(
"Unknown args: %v", args))
} else {
Run()
exitCode := Run()
os.Exit(int(exitCode))
}
},
}

const (
TestPass = iota
TestFail
Aborted
InternalError
BadUsage
NoTests
)

func init() {
rootCmd.AddCommand(runCmd)
}

// Run executes all plugins with handling for the command line
func Run() (err error) {
func Run() (exitCode int) {

// Setup for handling SIGTERM (Ctrl+C)
setupCloseHandler()
Expand All @@ -45,8 +55,8 @@ func Run() (err error) {

plugins := GetPlugins()
if len(plugins) == 0 {
logger.Error("no requested plugins were found in " + viper.GetString("binaries-path"))
return
logger.Error(fmt.Sprintf("no plugins were requested in config: %s", viper.GetString("binaries-path")))
return NoTests
}

// Run all plugins
Expand All @@ -55,39 +65,40 @@ func Run() (err error) {
for _, pluginPkg := range plugins {
if pluginPkg.Name == servicePluginName {
if !pluginPkg.Available {
logger.Error("Requested plugin that is not installed: " + pluginPkg.Name)
continue
logger.Error(fmt.Sprintf("requested plugin that is not installed: " + pluginPkg.Name))
return BadUsage
}
client := newClient(pluginPkg.Command)
defer closeClient(pluginPkg, client)

// Connect via RPC
var rpcClient hcplugin.ClientProtocol
rpcClient, err = client.Client()
rpcClient, err := client.Client()
if err != nil {
return err
logger.Error(fmt.Sprintf("internal error while initializing RPC client: %s", err))
return InternalError
}
// Request the plugin
var rawPlugin interface{}
rawPlugin, err = rpcClient.Dispense(shared.PluginName)
if err != nil {
logger.Error(err.Error())
logger.Error(fmt.Sprintf("internal error while dispensing RPC client: %s", err.Error()))
return InternalError
}
// Execute plugin
plugin := rawPlugin.(shared.Pluginer)

// Execute
logger.Trace("Starting Plugin: " + pluginPkg.Name)
response := plugin.Start()
if response != nil {
pluginPkg.Error = fmt.Errorf("Error running plugin for %s: %v", serviceName, response)
pluginPkg.Error = fmt.Errorf("tests failed in plugin %s: %v", serviceName, response)
exitCode = TestFail
} else {
pluginPkg.Successful = true
}
}
}
}
return
return exitCode
}

func closeClient(pluginPkg *PluginPkg, client *hcplugin.Client) {
Expand All @@ -110,8 +121,8 @@ func setupCloseHandler() {
signal.Notify(c, os.Interrupt, syscall.SIGTERM)
go func() {
<-c
logger.Error("Execution aborted - SIGTERM")
os.Exit(0)
logger.Error("Test execution was aborted by user")
os.Exit(int(Aborted))
}()
}

Expand Down
Loading