Merge pull request #146 from commander-cli/test-from-stdin

add ability to test from stdin

Author: SimonBaeumer

CHANGELOG.md

@@ -1,6 +1,7 @@
 # v2.4.0
 
  - Add ability to test suite from a url
+ - Add ability to test suite from stdin
 
 # v2.3.0
 

README.md

@@ -201,10 +201,13 @@ $ ./commander test
 $ ./commander test /tmp/test.yaml
 
 # Execute a single test
-$ ./commander test /tmp/test.yaml "my test"
+$ ./commander test /tmp/test.yaml --filter "my test"
+
+# Execute suite from stdin
+$ cat /tmp/test.yaml | ./commander test -
 
 # Execute suite from url
-$ ./commander test https://raw.githubusercontent.com/commander-cli/commander/master/integration/unix/commander_test.yaml
+$ ./commander test https://your-url/commander_test.yaml
 
 # Execute suites within a test directory
 $ ./commander test --dir /tmp

cmd/commander/commander.go

@@ -53,6 +53,15 @@ Tests are always executed in alphabetical order.
 
 Examples:
 
+Directory test:
+test --dir /your/dir/
+
+Stdin test:
+cat commander.yaml | commander test -
+
+HTTP test:
+test https://your-url/commander_test.yaml
+
 Filtering tests:
 test commander.yaml --filter="my test"
 

commander_linux.yaml

@@ -37,4 +37,4 @@ tests:
     stdout:
       contains:
         - Use --dir to test directories with multiple test files
-    exit-code: 1
+    exit-code: 1

commander_unix.yaml

@@ -128,10 +128,15 @@ tests:
     config:
       env:
         USER: from_parent
-    command: ./commander test https://raw.githubusercontent.com/commander-cli/commander/master/integration/unix/commander_test.yaml
+    command: ./commander test https://raw.githubusercontent.com/commander-cli/commander/master/integration/unix/remote_http.yaml
     stdout:
       contains:
-        - ✓ [local] it should exit with error code
-        - "- [local] it should skip, was skipped"
-      line-count: 17
+        - ✓ [local] hello world
+    exit-code: 0
+
+  test stdin input:
+    command: cat integration/unix/stdin.yaml | ./commander test -
+    stdout:
+      contains:
+        - ✓ [local] hello world
     exit-code: 0

commander_windows.yaml

@@ -63,3 +63,10 @@ tests:
       contains:
         - ✗ [local] echo hello, retries 3
     exit-code: 1
+
+  test stdin input:
+    command: type integration\windows\stdin.yaml | commander.exe test -
+    stdout:
+      contains:
+        - ✓ [local] hello world
+    exit-code: 0

integration/unix/stdin.yaml

@@ -0,0 +1,5 @@
+tests:
+  hello world:
+    command: echo hello world
+    stdout: hello world
+    exit-code: 0

integration/windows/stdin.yaml

@@ -0,0 +1,5 @@
+tests:
+  hello world:
+    command: echo hello world
+    stdout: hello world
+    exit-code: 0

pkg/app/test_command.go

@@ -1,6 +1,7 @@
 package app
 
 import (
+	"bufio"
 	"fmt"
 	"io/ioutil"
 	"log"
@@ -38,6 +39,10 @@ func TestCommand(testPath string, ctx TestCommandContext) error {
 		fmt.Println("Starting test against directory: " + testPath + "...")
 		fmt.Println("")
 		result, err = testDir(testPath, ctx.Filters)
+	case testPath == "-":
+		fmt.Println("Starting test from stdin...")
+		fmt.Println("")
+		result, err = testStdin(ctx.Filters)
 	case isURL(testPath):
 		fmt.Println("Starting test from " + testPath + "...")
 		fmt.Println("")
@@ -121,6 +126,23 @@ func convergeResults(result runtime.Result, new runtime.Result) runtime.Result {
 	return result
 }
 
+func testStdin(filters runtime.Filters) (runtime.Result, error) {
+	f, err := os.Stdin.Stat()
+	if err != nil {
+		return runtime.Result{}, err
+	}
+
+	if (f.Mode() & os.ModeCharDevice) != 0 {
+		return runtime.Result{}, fmt.Errorf("Error: when testing from stdin the command is intended to work with pipes")
+	}
+
+	r := bufio.NewReader(os.Stdin)
+	content, err := ioutil.ReadAll(r)
+	s := suite.ParseYAML(content, "")
+
+	return execute(s, filters)
+}
+
 func execute(s suite.Suite, filters runtime.Filters) (runtime.Result, error) {
 	tests := s.GetTests()
 	if len(filters) != 0 {

pkg/app/test_command_test.go

@@ -3,6 +3,7 @@ package app
 import (
 	"bytes"
 	"io"
+	"io/ioutil"
 	"log"
 	"os"
 	"runtime"
@@ -101,11 +102,55 @@ tests:
 func Test_TestCommand_Http_Err(t *testing.T) {
 	err := TestCommand("http://error/not/a/url", TestCommandContext{Dir: false})
 
-	if runtime.GOOS == "windows" {
-		assert.NotNil(t, err)
-	} else {
-		assert.NotNil(t, err)
+	assert.NotNil(t, err)
+}
+
+func Test_TestCommand_StdIn(t *testing.T) {
+	tmpfile, err := ioutil.TempFile("", "test")
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer os.Remove(tmpfile.Name()) //clean up
+
+	content := []byte(`
+tests:
+   echo hello:
+     exit-code: 0
+`)
+
+	if _, err := tmpfile.Write(content); err != nil {
+		log.Fatal(err)
+	}
+
+	if _, err := tmpfile.Seek(0, 0); err != nil {
+		log.Fatal(err)
 	}
+
+	// set stdin to tempfile
+	oldStdin := os.Stdin
+	defer func() { os.Stdin = oldStdin }() // Restore original Stdin
+	os.Stdin = tmpfile
+
+	out := captureOutput(func() {
+		TestCommand("-", TestCommandContext{Verbose: false})
+	})
+
+	if err := tmpfile.Close(); err != nil {
+		log.Fatal(err)
+	}
+
+	assert.Contains(t, out, "✓ [local] echo hello")
+}
+
+func Test_TestCommand_StdIn_Err(t *testing.T) {
+	// set stdin to nil
+	oldStdin := os.Stdin
+	defer func() { os.Stdin = oldStdin }() // Restore original Stdin
+	os.Stdin = nil
+
+	err := TestCommand("-", TestCommandContext{Verbose: false})
+
+	assert.NotNil(t, err)
 }
 
 func Test_ConvergeResults(t *testing.T) {