diff --git a/README.md b/README.md
index ad7e62098d583b1d557d8115de5417d509126e33..889346c66edc1a2e5fd187f3dac55da0c7dfa3e9 100644
--- a/README.md
+++ b/README.md
@@ -298,6 +298,13 @@ You can now run `make` to build the project, or `make install` to install the bi
To work on the web UI, have a look at [the dedicated Readme.](webui/Readme.md)
+Some tests for the CLI use golden files, if the output of CLI commands is
+changed, run the following command, then inspect the changed files in
+`commands/testdata/...` to make sure the output text is as expected:
+
+```shell
+go test ./commands -update
+```
## Contributors :heart:
diff --git a/commands/comment_add_test.go b/commands/comment_add_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..34ff3743f5dc9d26236a557014024ddd031c6067
--- /dev/null
+++ b/commands/comment_add_test.go
@@ -0,0 +1,33 @@
+package commands
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+)
+
+func newTestEnvAndBugWithComment(t *testing.T) (*testEnv, string, string) {
+ t.Helper()
+
+ env, bugID := newTestEnvAndBug(t)
+
+ opts := commentAddOptions{
+ message: "this is a bug comment",
+ }
+ require.NoError(t, runCommentAdd(env.env, opts, []string{bugID}))
+ require.NoError(t, runComment(env.env, []string{bugID}))
+ comments := parseComments(t, env)
+ require.Len(t, comments, 2)
+
+ env.out.Reset()
+
+ return env, bugID, comments[1].id
+}
+
+func TestCommentAdd(t *testing.T) {
+ const golden = "testdata/comment/add"
+
+ env, bugID, _ := newTestEnvAndBugWithComment(t)
+ require.NoError(t, runComment(env.env, []string{bugID}))
+ requireCommentsEqual(t, golden, env)
+}
diff --git a/commands/comment_edit_test.go b/commands/comment_edit_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..50c1850bc282733559040bbc82f51a3301f182d0
--- /dev/null
+++ b/commands/comment_edit_test.go
@@ -0,0 +1,21 @@
+package commands
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+)
+
+func TestCommentEdit(t *testing.T) {
+ const golden = "testdata/comment/edit"
+
+ env, bugID, commentID := newTestEnvAndBugWithComment(t)
+
+ opts := commentEditOptions{
+ message: "this is an altered bug comment",
+ }
+ require.NoError(t, runCommentEdit(env.env, opts, []string{commentID}))
+
+ require.NoError(t, runComment(env.env, []string{bugID}))
+ requireCommentsEqual(t, golden, env)
+}
diff --git a/commands/comment_test.go b/commands/comment_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..43062ed0caf1ec8a79b1112cad107a3282f30cbb
--- /dev/null
+++ b/commands/comment_test.go
@@ -0,0 +1,160 @@
+package commands
+
+import (
+ "fmt"
+ "io/ioutil"
+ "strings"
+ "testing"
+ "time"
+
+ "github.com/stretchr/testify/require"
+)
+
+func TestComment(t *testing.T) {
+ const golden = "testdata/comment/message-only"
+
+ env, bug := newTestEnvAndBug(t)
+
+ require.NoError(t, runComment(env.env, []string{bug}))
+
+ requireCommentsEqual(t, golden, env)
+}
+
+const gitDateFormat = "Mon Jan 2 15:04:05 2006 -0700"
+
+type parsedComment struct {
+ author string
+ id string
+ date time.Time
+ message string
+}
+
+type parseFunc func(*parsedComment, string)
+
+type commentParser struct {
+ t *testing.T
+ fn parseFunc
+ comments []parsedComment
+}
+
+func parseComments(t *testing.T, env *testEnv) []parsedComment {
+ t.Helper()
+
+ parser := &commentParser{
+ t: t,
+ comments: []parsedComment{},
+ }
+
+ comment := &parsedComment{}
+ parser.fn = parser.parseAuthor
+
+ for _, line := range strings.Split(env.out.String(), "\n") {
+ parser.fn(comment, line)
+ }
+
+ parser.comments = append(parser.comments, *comment)
+
+ return parser.comments
+}
+
+func (p *commentParser) parseAuthor(comment *parsedComment, line string) {
+ p.t.Helper()
+
+ tkns := strings.Split(line, ": ")
+ require.Len(p.t, tkns, 2)
+ require.Equal(p.t, "Author", tkns[0])
+
+ comment.author = tkns[1]
+ p.fn = p.parseID
+}
+
+func (p *commentParser) parseID(comment *parsedComment, line string) {
+ p.t.Helper()
+
+ tkns := strings.Split(line, ": ")
+ require.Len(p.t, tkns, 2)
+ require.Equal(p.t, "Id", tkns[0])
+
+ comment.id = tkns[1]
+ p.fn = p.parseDate
+}
+
+func (p *commentParser) parseDate(comment *parsedComment, line string) {
+ p.t.Helper()
+
+ tkns := strings.Split(line, ": ")
+ require.Len(p.t, tkns, 2)
+ require.Equal(p.t, "Date", tkns[0])
+
+ date, err := time.Parse(gitDateFormat, tkns[1])
+ require.NoError(p.t, err)
+
+ comment.date = date
+ p.fn = p.parseMessage
+}
+
+func (p *commentParser) parseMessage(comment *parsedComment, line string) {
+ p.t.Helper()
+
+ if strings.HasPrefix(line, "Author: ") {
+ p.comments = append(p.comments, *comment)
+ comment = &parsedComment{}
+ p.parseAuthor(comment, line)
+
+ return
+ }
+
+ require.True(p.t, line == "" || strings.HasPrefix(line, " "))
+
+ comment.message = strings.Join([]string{comment.message, line}, "\n")
+}
+
+func normalizeParsedComments(t *testing.T, comments []parsedComment) []parsedComment {
+ t.Helper()
+
+ prefix := 0x1234567
+ date, err := time.Parse(gitDateFormat, "Fri Aug 19 07:00:00 2022 +1900")
+ require.NoError(t, err)
+
+ out := []parsedComment{}
+
+ for i, comment := range comments {
+ comment.id = fmt.Sprintf("%7x", prefix+i)
+ comment.date = date.Add(time.Duration(i) * time.Minute)
+ out = append(out, comment)
+ }
+
+ return out
+}
+
+func requireCommentsEqual(t *testing.T, golden string, env *testEnv) {
+ t.Helper()
+
+ const goldenFilePatter = "%s-%d-golden.txt"
+
+ comments := parseComments(t, env)
+ comments = normalizeParsedComments(t, comments)
+
+ if *update {
+ t.Log("Got here")
+ for i, comment := range comments {
+ fileName := fmt.Sprintf(goldenFilePatter, golden, i)
+ require.NoError(t, ioutil.WriteFile(fileName, []byte(comment.message), 0644))
+ }
+ }
+
+ prefix := 0x1234567
+ date, err := time.Parse(gitDateFormat, "Fri Aug 19 07:00:00 2022 +1900")
+ require.NoError(t, err)
+
+ for i, comment := range comments {
+ require.Equal(t, "John Doe", comment.author)
+ require.Equal(t, fmt.Sprintf("%7x", prefix+i), comment.id)
+ require.Equal(t, date.Add(time.Duration(i)*time.Minute), comment.date)
+
+ fileName := fmt.Sprintf(goldenFilePatter, golden, i)
+ exp, err := ioutil.ReadFile(fileName)
+ require.NoError(t, err)
+ require.Equal(t, strings.ReplaceAll(string(exp), "\r", ""), strings.ReplaceAll(comment.message, "\r", ""))
+ }
+}
diff --git a/commands/golden_test.go b/commands/golden_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..9fcee0d60fb3ebc0e17275d9b90b586617ab0a5b
--- /dev/null
+++ b/commands/golden_test.go
@@ -0,0 +1,5 @@
+package commands
+
+import "flag"
+
+var update = flag.Bool("update", false, "update golden files")
diff --git a/commands/ls_test.go b/commands/ls_test.go
index 6e31ed838ffdb2e17c2946189ba52629c8740f9a..5759f9d0cea100616aaccb899f5143dcfa88ee9a 100644
--- a/commands/ls_test.go
+++ b/commands/ls_test.go
@@ -77,7 +77,6 @@ $`
env, _ := newTestEnvAndBug(t)
require.NoError(t, runLs(env.env, opts, []string{}))
- t.Log(env.out.String())
require.Regexp(t, testcase.exp, env.out.String())
})
}
diff --git a/commands/testdata/comment/add-0-golden.txt b/commands/testdata/comment/add-0-golden.txt
new file mode 100644
index 0000000000000000000000000000000000000000..44ae0c1a415e73872c231067c97ae2fca2f258de
--- /dev/null
+++ b/commands/testdata/comment/add-0-golden.txt
@@ -0,0 +1,3 @@
+
+
+ this is a bug message
diff --git a/commands/testdata/comment/add-1-golden.txt b/commands/testdata/comment/add-1-golden.txt
new file mode 100644
index 0000000000000000000000000000000000000000..bcf127c0eb5b5d015bc3de32e34272d8365b240c
--- /dev/null
+++ b/commands/testdata/comment/add-1-golden.txt
@@ -0,0 +1,6 @@
+
+
+ this is a bug message
+
+
+ this is a bug comment
diff --git a/commands/testdata/comment/edit-0-golden.txt b/commands/testdata/comment/edit-0-golden.txt
new file mode 100644
index 0000000000000000000000000000000000000000..44ae0c1a415e73872c231067c97ae2fca2f258de
--- /dev/null
+++ b/commands/testdata/comment/edit-0-golden.txt
@@ -0,0 +1,3 @@
+
+
+ this is a bug message
diff --git a/commands/testdata/comment/edit-1-golden.txt b/commands/testdata/comment/edit-1-golden.txt
new file mode 100644
index 0000000000000000000000000000000000000000..3d83c02bb3d0d27f99bb029214ad73030e2fd814
--- /dev/null
+++ b/commands/testdata/comment/edit-1-golden.txt
@@ -0,0 +1,6 @@
+
+
+ this is a bug message
+
+
+ this is an altered bug comment
diff --git a/commands/testdata/comment/message-only-0-golden.txt b/commands/testdata/comment/message-only-0-golden.txt
new file mode 100644
index 0000000000000000000000000000000000000000..44ae0c1a415e73872c231067c97ae2fca2f258de
--- /dev/null
+++ b/commands/testdata/comment/message-only-0-golden.txt
@@ -0,0 +1,3 @@
+
+
+ this is a bug message