Commit1261969

committed

Add ci readme

1 parent8212be0 commit1261969Copy full SHA for 1261969

File tree

+46

-11

lines changed

+46

-11

lines changed

Lines changed: 26 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,26 @@`
	`1`	`+#ci`
	`2`	`+`
	`3`	`+##integration tests`
	`4`	`+`
	`5`	+###`tcli`
	`6`	`+`
	`7`	+Package`tcli` provides a framework for writing end-to-end CLI tests.
	`8`	`+Each test group can have its own container for executing commands in a consistent`
	`9`	`+and isolated filesystem.`
	`10`	`+`
	`11`	`+###prerequisites`
	`12`	`+`
	`13`	`+Assign the following environment variables to run the integration tests`
	`14`	`+against an existing Enterprise deployment instance.`
	`15`	`+`
	`16`	+```bash
	`17`	`+export CODER_URL=...`
	`18`	`+export CODER_EMAIL=...`
	`19`	`+export CODER_PASSWORD=...`
	`20`	+```
	`21`	`+`
	`22`	`+Then, simply run the test command from the project root`
	`23`	`+`
	`24`	+```sh
	`25`	`+gotest -v ./ci/integration`
	`26`	+```

Lines changed: 0 additions & 10 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,11 @@ package integration`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"context"`
`5`		`-"encoding/json"`
`6`	`5`	`"math/rand"`
`7`	`6`	`"testing"`
`8`	`7`	`"time"`
`9`	`8`
`10`	`9`	`"cdr.dev/coder-cli/ci/tcli"`
`11`		`-"cdr.dev/slog"`
`12`	`10`	`"cdr.dev/slog/sloggers/slogtest/assert"`
`13`	`11`	`)`
`14`	`12`
`@@ -76,14 +74,6 @@ func TestCoderCLI(t *testing.T) {`
`76`	`74`	`)`
`77`	`75`	`}`
`78`	`76`
`79`		`-funcstdoutUnmarshalsJSON(targetinterface{}) tcli.Assertion {`
`80`		`-returnfunc(ttesting.T,rtcli.CommandResult) {`
`81`		`-slog.Helper()`
`82`		`-err:=json.Unmarshal(r.Stdout,target)`
`83`		`-assert.Success(t,"json unmarshals",err)`
`84`		`-}`
`85`		`-}`
`86`		`-`
`87`	`77`	`varseededRand=rand.New(rand.NewSource(time.Now().UnixNano()))`
`88`	`78`
`89`	`79`	`funcrandString(lengthint)string {`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func TestUsers(t *testing.T) {`
`36`	`36`	`varuser entclient.User`
`37`	`37`	c.Run(ctx,`coder users ls --output json \| jq -c '.[] \| select( .username == "charlie")'`).Assert(t,
`38`	`38`	`tcli.Success(),`
`39`		`-stdoutUnmarshalsJSON(&user),`
	`39`	`+tcli.StdoutJSONUnmarshal(&user),`
`40`	`40`	`)`
`41`	`41`	`assert.Equal(t,"user email is as expected","charlie@coder.com",user.Email)`
`42`	`42`	`assert.Equal(t,"username is as expected","Charlie",user.Name)`

Lines changed: 19 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package tcli`
`3`	`3`	`import (`
`4`	`4`	`"bytes"`
`5`	`5`	`"context"`
	`6`	`+"encoding/json"`
`6`	`7`	`"fmt"`
`7`	`8`	`"io"`
`8`	`9`	`"os/exec"`
`@@ -329,3 +330,21 @@ func DurationGreaterThan(dur time.Duration) Assertion {`
`329`	`330`	`}`
`330`	`331`	`}`
`331`	`332`	`}`
	`333`	`+`
	`334`	`+// StdoutJSONUnmarshal attempts to unmarshal stdout into the given target`
	`335`	`+funcStdoutJSONUnmarshal(targetinterface{})Assertion {`
	`336`	`+returnfunc(ttesting.T,rCommandResult) {`
	`337`	`+slog.Helper()`
	`338`	`+err:=json.Unmarshal(r.Stdout,target)`
	`339`	`+assert.Success(t,"stdout json unmarshals",err)`
	`340`	`+}`
	`341`	`+}`
	`342`	`+`
	`343`	`+// StderrJSONUnmarshal attempts to unmarshal stderr into the given target`
	`344`	`+funcStderrJSONUnmarshal(targetinterface{})Assertion {`
	`345`	`+returnfunc(ttesting.T,rCommandResult) {`
	`346`	`+slog.Helper()`
	`347`	`+err:=json.Unmarshal(r.Stdout,target)`
	`348`	`+assert.Success(t,"stderr json unmarshals",err)`
	`349`	`+}`
	`350`	`+}`

Comments

(0)