cli support for alternate exec (#200)

cli support for alternate exec --------- Co-authored-by: housekeeping-bot <[email protected]>
sha1n · Jun 1, 2023 · 6f4a936 · 6f4a936
1 parent 9c6b09f
commit 6f4a936
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 11 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,7 +3,14 @@ updates:
 - package-ecosystem: gomod
   directory: "/"
   schedule:
-    interval: daily
+    interval: weekly
+  open-pull-requests-limit: 10
+  assignees:
+  - sha1n
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
   open-pull-requests-limit: 10
   assignees:
   - sha1n
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -28,7 +28,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -39,7 +39,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -53,4 +53,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@
     - [Report Formats](#report-formats)
     - [Accumulating Data](#accumulating-data)
     - [Labelling Data](#labelling-data)
-    - [Understanding User & System Time Measurements](#understanding-user--system-time-measurements)
+    - [Understanding User \& System Time Measurements](#understanding-user--system-time-measurements)
     - [Examples](#examples)
       - [Text Example](#text-example)
       - [JSON Example](#json-example)
@@ -119,6 +119,9 @@ bert 'command -opt' --executions 100
 
 # Multiple commands
 bert 'command -optA' 'command -optB' 'anotherCommand' --executions 100
+
+# Multiple commands with alternate execution
+bert 'command -optA' 'command -optB' 'anotherCommand' --executions 100 --alternate
 ```
 
 ### Using a Configuration File

diff --git a/docs/README.md b/docs/README.md
@@ -22,7 +22,7 @@
     - [Report Formats](#report-formats)
     - [Accumulating Data](#accumulating-data)
     - [Labelling Data](#labelling-data)
-    - [Understanding User & System Time Measurements](#understanding-user--system-time-measurements)
+    - [Understanding User \& System Time Measurements](#understanding-user--system-time-measurements)
     - [Examples](#examples)
       - [Text Example](#text-example)
       - [JSON Example](#json-example)
@@ -119,12 +119,15 @@ bert 'command -opt' --executions 100
 
 # Multiple commands
 bert 'command -optA' 'command -optB' 'anotherCommand' --executions 100
+
+# Multiple commands with alternate execution
+bert 'command -optA' 'command -optB' 'anotherCommand' --executions 100 --alternate
 ```
 
 ### Using a Configuration File
 In order to gain full control over benchmark configuration `bert` uses a configuration file. The configuration file can be either in YAML or JSON format. `bert` treats files with the `.json` extension as JSON, otherwise it assumes YAML. You may create a configuration file manually or use the `config` command to interactively generate your configuration.
 
-**Why use a config files?**
+**Why use a config file?**
 
 - unlock advanced features such as alternate execution, custom environment variables, working directories and setup commands per scenario
 - easily share elaborate benchmark configurations, store them in VCS and reuse them on different environments and over time

diff --git a/internal/cli/args.go b/internal/cli/args.go
@@ -16,6 +16,8 @@ const (
 	ArgNameConfig = "config"
 	// ArgNameExecutions : program arg name
 	ArgNameExecutions = "executions"
+	// ArgNameAlternate : program arg name
+	ArgNameAlternate = "alternate"
 	// ArgNameOutputFile : program arg name
 	ArgNameOutputFile = "out-file"
 	// ArgNameConfigExample : program arg name

diff --git a/internal/cli/main_runner.go b/internal/cli/main_runner.go
@@ -60,6 +60,7 @@ Build label: %s`, version, build),
 	rootCmd.Flags().IntP(ArgNameExecutions, "e", 0, `the number of executions per scenario.
 required when no configuration file is provided. 
 when specified with a configuration file, this argument has priority.`)
+	rootCmd.Flags().BoolP(ArgNameAlternate, "a", false, `whether to use alternate executions or finish one scenario before commencing to the next one.`)
 
 	// Reporting
 	rootCmd.Flags().StringP(ArgNameOutputFile, "o", "", `output file path. Optional. Writes to stdout by default.`)
@@ -130,6 +131,7 @@ func runFn(ctx api.IOContext) func(*cobra.Command, []string) {
 
 func loadSpec(cmd *cobra.Command, args []string) (spec api.BenchmarkSpec, err error) {
 	executions := GetInt(cmd, ArgNameExecutions)
+	alternate := GetBool(cmd, ArgNameAlternate)
 
 	if len(args) > 0 { // positional args are used for ad-hoc config
 		commands := []api.CommandSpec{}
@@ -138,7 +140,7 @@ func loadSpec(cmd *cobra.Command, args []string) (spec api.BenchmarkSpec, err er
 				Cmd: parseCommand(strings.Trim(args[i], "'\"")),
 			})
 		}
-		spec, err = specs.CreateSpecFrom(executions, false, commands...)
+		spec, err = specs.CreateSpecFrom(executions, alternate, commands...)
 
 	} else {
 		var filePath string
@@ -165,6 +167,8 @@ func loadSpec(cmd *cobra.Command, args []string) (spec api.BenchmarkSpec, err er
 		spec.Executions = executions
 	}
 
+	spec.Alternate = alternate
+
 	return spec, err
 }
 

diff --git a/internal/cli/main_runner_test.go b/internal/cli/main_runner_test.go
@@ -130,11 +130,22 @@ func Test_loadSpecWithExecutionsOverride(t *testing.T) {
 	assert.Equal(t, expectedSpec, spec)
 }
 
+func Test_loadSpecWithAlternateOverride(t *testing.T) {
+	expectedSpec, _ := specs.LoadSpec(itConfigFilePath)
+	expectedSpec.Alternate = true
+	command := newDummyCommandWith("-c", itConfigFilePath, "--alternate")
+
+	spec, err := loadSpec(command, []string{})
+
+	assert.NoError(t, err)
+	assert.Equal(t, expectedSpec, spec)
+}
+
 func Test_loadSpecFromPositionalArguments(t *testing.T) {
 	expectedExecutions := rand.Intn(100)
 	expectedValidSpec, _ := specs.CreateSpecFrom(
 		expectedExecutions,
-		false,
+		true,
 		api.CommandSpec{Cmd: []string{"cmd", "-a"}},
 		api.CommandSpec{Cmd: []string{"cmd", "-b"}},
 		api.CommandSpec{Cmd: []string{"cmd", "a string"}},
@@ -153,7 +164,7 @@ func Test_loadSpecFromPositionalArguments(t *testing.T) {
 		{
 			name: "call with positional single-quote framed commands",
 			args: args{
-				cmd:  newDummyCommandWith("--executions", fmt.Sprint(expectedExecutions)),
+				cmd:  newDummyCommandWith("--alternate", "--executions", fmt.Sprint(expectedExecutions)),
 				args: []string{"'cmd -a'", "'cmd -b'", "'cmd \"a string\"'"},
 			},
 			wantSpec: expectedValidSpec,
@@ -162,7 +173,7 @@ func Test_loadSpecFromPositionalArguments(t *testing.T) {
 		{
 			name: "call with positional double-quote framed commands",
 			args: args{
-				cmd:  newDummyCommandWith("--executions", fmt.Sprint(expectedExecutions)),
+				cmd:  newDummyCommandWith("--alternate", "--executions", fmt.Sprint(expectedExecutions)),
 				args: []string{"\"cmd -a\"", "\"cmd -b\"", "\"cmd 'a string'\""},
 			},
 			wantSpec: expectedValidSpec,

diff --git a/test/data/integration.yaml b/test/data/integration.yaml
@@ -1,4 +1,5 @@
 executions: 1
+alternate: false
 scenarios:
 - name: NAME
   command: