chore: switch to assert lib with support for excluding fields by type

alecthomas · alecthomas · commit 0ac2aeb04b34 · 2023-10-03T12:22:56.000+08:00
diff --git a/engine/internal/memoise.go b/engine/internal/memoise.go
@@ -9,13 +9,15 @@ func Memoise[T any](f func() (T, error)) *MemoisedFunction[T] {
 	return &MemoisedFunction[T]{f: f}
 }
 
+// MemoisedFunction lazily caches the result of a function on first use.
 type MemoisedFunction[T any] struct {
 	once sync.Once
 	f    func() (T, error)
 	val  T
 	err  error
 }
 
+// Get calls the function or returns the result of the previous call.
 func (o *MemoisedFunction[T]) Get() (T, error) {
 	o.once.Do(func() { o.val, o.err = o.f() })
 	return o.val, o.err
diff --git a/engine/logging/logger.go b/engine/logging/logger.go
@@ -256,6 +256,7 @@ func (l *Logger) writerScanner(wg *sync.WaitGroup, r *io.PipeReader, level LogLe
 			os.Stdout.Write(newline)
 			return
 		} else if err != nil {
+			os.Stdout.Write(newline)
 			l.Warnf("error reading CSI sequence: %s", err)
 			return
 		}
diff --git a/parser/parser.go b/parser/parser.go
@@ -307,6 +307,8 @@ func (r *RefList) Strings() []string {
 type Ref struct {
 	Pos lexer.Position
 
+	// Text is the text body of a Ref.
+	//
 	// This is a bit hairy because we need to explicitly match WS
 	// to "un"-elide it, but we don't want to capture it.
 	Text string `WS? ((?!WS) @(Var | Cmd | Ident | Number | "-" | "/" | "." | "*" | "@" | "[" | "]" | "{" | "}" | "!" | ","))+ | @(String | StringLiteral | MultilineString)`
diff --git a/parser/parser_test.go b/parser/parser_test.go
@@ -4,7 +4,6 @@ import (
 	"embed"
 	"io/fs"
 	"os"
-	"reflect"
 	"strings"
 	"testing"
 
@@ -232,30 +231,11 @@ func TestParser(t *testing.T) {
 			}
 			bitfile, err := parser.ParseString("", input, options...)
 			assert.NoError(t, err, "%s\n%s", repr.String(tokens, repr.Indent("  ")), repr.String(bitfile, repr.Indent("  ")))
-			normaliseAllNodes(bitfile)
-			assert.Equal(t, test.expected, bitfile, repr.String(tokens, repr.Indent("  ")))
+			assert.Equal(t, test.expected, bitfile, repr.String(tokens, repr.Indent("  ")), assert.Exclude[lexer.Position]())
 		})
 	}
 }
 
-func normaliseAllNodes[T Node](node T) T {
-	_ = Visit(node, func(node Node, next func() error) error {
-		normaliseNode(node)
-		return next()
-	})
-	return node
-}
-
-func normaliseNode[T any](node T) T {
-	v := reflect.Indirect(reflect.ValueOf(node))
-	f := v.FieldByName("Pos")
-	if !f.CanAddr() {
-		panic(node)
-	}
-	f.Set(reflect.Zero(f.Type()))
-	return node
-}
-
 func tokenise(t *testing.T, input string) []lexer.Token {
 	t.Helper()
 	lex, err := lex.Lex("", strings.NewReader(input))
@@ -284,6 +264,5 @@ func TestParseSamples(t *testing.T) {
 func TestParseRefList(t *testing.T) {
 	refs, err := ParseRefList(lexer.Position{}, `a b c`)
 	assert.NoError(t, err)
-	normaliseAllNodes(refs)
-	assert.Equal(t, &RefList{Refs: []*Ref{{Text: "a"}, {Text: "b"}, {Text: "c"}}}, refs)
+	assert.Equal(t, &RefList{Refs: []*Ref{{Text: "a"}, {Text: "b"}, {Text: "c"}}}, refs, assert.Exclude[lexer.Position]())
 }
diff --git a/parser/text_test.go b/parser/text_test.go
@@ -4,15 +4,12 @@ import (
 	"testing"
 
 	"github.com/alecthomas/assert/v2"
+	"github.com/alecthomas/participle/v2/lexer"
 )
 
 func TestParseText(t *testing.T) {
 	text, err := ParseTextString(`Hello, %{world}! What's happening %(echo "today")%?`)
 	assert.NoError(t, err)
-	text = normaliseNode(text)
-	for i, fragment := range text.Fragments {
-		text.Fragments[i] = normaliseNode(fragment)
-	}
 	assert.Equal(t, &Text{
 		Fragments: []Fragment{
 			&TextFragment{Text: "Hello, "},
@@ -21,5 +18,5 @@ func TestParseText(t *testing.T) {
 			&CmdFragment{Cmd: `echo "today"`},
 			&TextFragment{Text: "?"},
 		},
-	}, text)
+	}, text, assert.Exclude[lexer.Position]())
 }

Original file line number	Diff line number	Diff line change
`@@ -9,13 +9,15 @@ func Memoise[T any](f func() (T, error)) *MemoisedFunction[T] {`
`9`	`9`	`return &MemoisedFunction[T]{f: f}`
`10`	`10`	`}`
`11`	`11`
	`12`	`+// MemoisedFunction lazily caches the result of a function on first use.`
`12`	`13`	`type MemoisedFunction[T any] struct {`
`13`	`14`	`once sync.Once`
`14`	`15`	`f func() (T, error)`
`15`	`16`	`val T`
`16`	`17`	`err error`
`17`	`18`	`}`
`18`	`19`
	`20`	`+// Get calls the function or returns the result of the previous call.`
`19`	`21`	`func (o *MemoisedFunction[T]) Get() (T, error) {`
`20`	`22`	`o.once.Do(func() { o.val, o.err = o.f() })`
`21`	`23`	`return o.val, o.err`
Original file line number	Diff line number	Diff line change
`@@ -256,6 +256,7 @@ func (l Logger) writerScanner(wg sync.WaitGroup, r *io.PipeReader, level LogLe`
`256`	`256`	`os.Stdout.Write(newline)`
`257`	`257`	`return`
`258`	`258`	`} else if err != nil {`
	`259`	`+ os.Stdout.Write(newline)`
`259`	`260`	`l.Warnf("error reading CSI sequence: %s", err)`
`260`	`261`	`return`
`261`	`262`	`}`