Merge pull request #158 from commander-cli/add-workdir-cmdline-arg

Add workdir cmdline arg

Author: dylanhitt

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v2.5.0
+  
+ - Add `--workdir` flag to change the wokring directory of commander `test` execution 
+
 # v2.4.0
 
  - Add ability to test suite from a url

README.md

@@ -213,6 +213,9 @@ $ ./commander test https://your-url/commander_test.yaml
 
 # Execute suites within a test directory
 $ ./commander test --dir /tmp
+
+# Execute suites in a different working directory 
+$ ./commander test --workdir /examples minimal_test.yaml
 ```
 
 ### Adding tests

cmd/commander/commander.go

@@ -87,6 +87,10 @@ commander test commander.yaml --filter="^filter1$"
 				Name:  "dir",
 				Usage: "Execute all test files in a directory sorted by file name, this is not recursive - e.g. /path/to/test_files/",
 			},
+			cli.StringFlag{
+				Name:  "workdir",
+				Usage: "Set the working directory of commander's execution",
+			},
 			cli.StringSliceFlag{
 				Name:  "filter",
 				Usage: `Filter tests by a given regex pattern. Tests are filtered by its title.`,

commander_unix.yaml

@@ -140,4 +140,11 @@ tests:
     stdout:
       contains:
         - ✓ [local] hello world
+    exit-code: 0
+
+  test workdir flag:
+    command: ./commander test --workdir integration/unix/ workdir.yaml
+    stdout:
+      contains:
+        - ✓ [local] echo hello
     exit-code: 0

examples/commander.yaml

@@ -29,4 +29,4 @@ tests:
   it should match file output:
     command: printf "line one\nline two"
     stdout:
-      file: ../../examples/_fixtures/output.txt
+      file: _fixtures/output.txt

integration/unix/_fixtures/workdir.txt

@@ -0,0 +1 @@
+hello

integration/unix/workdir.yaml

@@ -0,0 +1,4 @@
+tests:
+  echo hello:
+    stdout: 
+      file: _fixtures/workdir.txt

pkg/app/app.go

@@ -16,6 +16,7 @@ type TestCommandContext struct {
 	Verbose    bool
 	NoColor    bool
 	Dir        bool
+	Workdir    string
 	Concurrent int
 	Filters    []string
 }
@@ -26,6 +27,7 @@ func NewTestContextFromCli(c *cli.Context) TestCommandContext {
 		Verbose:    c.Bool("verbose"),
 		NoColor:    c.Bool("no-color"),
 		Dir:        c.Bool("dir"),
+		Workdir:    c.String("workdir"),
 		Concurrent: c.Int("concurrent"),
 		Filters:    c.StringSlice("filter"),
 	}

pkg/app/test_command.go

@@ -22,6 +22,13 @@ var out output.OutputWriter
 // ctx holds the command flags. If directory scanning is enabled with --dir,
 // test filtering is not supported
 func TestCommand(testPath string, ctx TestCommandContext) error {
+	if ctx.Workdir != "" {
+		err := os.Chdir(ctx.Workdir)
+		if err != nil {
+			return fmt.Errorf(err.Error())
+		}
+	}
+
 	if ctx.Verbose {
 		log.SetOutput(os.Stdout)
 	}

pkg/app/test_command_test.go

@@ -178,6 +178,15 @@ func Test_ConvergeResults(t *testing.T) {
 	assert.Equal(t, 1, actual.Failed)
 }
 
+func Test_TestCommand_InvalidDir(t *testing.T) {
+	err := TestCommand("foo", TestCommandContext{Workdir: "invalid_dir"})
+	if runtime.GOOS == "windows" {
+		assert.Contains(t, err.Error(), "The system cannot find the file specified")
+	} else {
+		assert.Contains(t, err.Error(), "no such file or directory")
+	}
+}
+
 func captureOutput(f func()) string {
 	reader, writer, err := os.Pipe()
 	if err != nil {