Add ci readme

coder · cmoog · Aug 10, 2020 · Jul 31, 2020 · Aug 2, 2020 · Aug 4, 2020
commit 12619695323959a4b70e5e688a9fc7d34a5d5377
diff --git a/ci/README.md b/ci/README.md
@@ -0,0 +1,26 @@
+# ci
+
+## integration tests
+
+### `tcli`
+
+Package `tcli` provides a framework for writing end-to-end CLI tests.
+Each test group can have its own container for executing commands in a consistent
+and isolated filesystem.
+
+### prerequisites
+
+Assign the following environment variables to run the integration tests
+against an existing Enterprise deployment instance.
+
+```bash
+export CODER_URL=...
+export CODER_EMAIL=...
+export CODER_PASSWORD=...
+```
+
+Then, simply run the test command from the project root
+
+```sh
+go test -v ./ci/integration
+```
diff --git a/ci/integration/integration_test.go b/ci/integration/integration_test.go
@@ -2,13 +2,11 @@ package integration
 
 import (
 	"context"
-	"encoding/json"
 	"math/rand"
 	"testing"
 	"time"
 
 	"cdr.dev/coder-cli/ci/tcli"
-	"cdr.dev/slog"
 	"cdr.dev/slog/sloggers/slogtest/assert"
 )
 
@@ -76,14 +74,6 @@ func TestCoderCLI(t *testing.T) {
 	)
 }
 
-func stdoutUnmarshalsJSON(target interface{}) tcli.Assertion {
-	return func(t *testing.T, r *tcli.CommandResult) {
-		slog.Helper()
-		err := json.Unmarshal(r.Stdout, target)
-		assert.Success(t, "json unmarshals", err)
-	}
-}
-
 var seededRand = rand.New(rand.NewSource(time.Now().UnixNano()))
 
 func randString(length int) string {

diff --git a/ci/integration/users_test.go b/ci/integration/users_test.go
@@ -36,7 +36,7 @@ func TestUsers(t *testing.T) {
 	var user entclient.User
 	c.Run(ctx, `coder users ls --output json | jq -c '.[] | select( .username == "charlie")'`).Assert(t,
 		tcli.Success(),
-		stdoutUnmarshalsJSON(&user),
+		tcli.StdoutJSONUnmarshal(&user),
 	)
 	assert.Equal(t, "user email is as expected", "charlie@coder.com", user.Email)
 	assert.Equal(t, "username is as expected", "Charlie", user.Name)

diff --git a/ci/tcli/tcli.go b/ci/tcli/tcli.go
@@ -3,6 +3,7 @@ package tcli
 import (
 	"bytes"
 	"context"
+	"encoding/json"
 	"fmt"
 	"io"
 	"os/exec"
@@ -329,3 +330,21 @@ func DurationGreaterThan(dur time.Duration) Assertion {
 		}
 	}
 }
+
+// StdoutJSONUnmarshal attempts to unmarshal stdout into the given target
+func StdoutJSONUnmarshal(target interface{}) Assertion {
+	return func(t *testing.T, r *CommandResult) {
+		slog.Helper()
+		err := json.Unmarshal(r.Stdout, target)
+		assert.Success(t, "stdout json unmarshals", err)
+	}
+}
+
+// StderrJSONUnmarshal attempts to unmarshal stderr into the given target
+func StderrJSONUnmarshal(target interface{}) Assertion {
+	return func(t *testing.T, r *CommandResult) {
+		slog.Helper()
+		err := json.Unmarshal(r.Stdout, target)
+		assert.Success(t, "stderr json unmarshals", err)
+	}
+}