From b4ccdc75114bb5204e35eeb7ee131a4e08d6384c Mon Sep 17 00:00:00 2001
From: dmullis <dmullis>
Date: Tue, 18 Jun 2024 21:38:15 -0700
Subject: [PATCH] Regression testing: Clarify source code and CLI text

Bump required Go version to 1.21 for access to functions min() and max().
---
 .github/workflows/test.yml |  2 +-
 examples_test.go           | 44 ++++++++++++++++++++++++--------------
 go.mod                     |  2 +-
 pre-push.sh                |  2 ++
 4 files changed, 32 insertions(+), 18 deletions(-)

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 9d5ecbc..b92e1e2 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -10,7 +10,7 @@ jobs:
   build:
     strategy:
       matrix:
-        go-version: [1.20.x]
+        go-version: [1.21.x]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
diff --git a/examples_test.go b/examples_test.go
index 1ac709a..17e56a4 100644
--- a/examples_test.go
+++ b/examples_test.go
@@ -14,7 +14,8 @@ import (
 )
 
 var (
-	write = flag.Bool("write", false, "write examples to disk")  // XX rename: more descriptive
+	write = flag.Bool("write",
+		false, "write reference SVG output files")
 	svgColorLightScheme = flag.String("svg-color-light-scheme", "#000000",
 		`See help for cmd/goat`)
 	svgColorDarkScheme = flag.String("svg-color-dark-scheme", "#FFFFFF",
@@ -50,7 +51,7 @@ func TestExamples(t *testing.T) {
 
 	var buff *bytes.Buffer
 	if write == nil {
-		t.Logf("Verifying output of current build against earlier .svg files in examples/.\n")
+		t.Logf("Verifying equality of current SVG with examples/ references.\n")
 	}
 	var failures int
 	for _, name := range filenames {
@@ -83,15 +84,26 @@ func TestExamples(t *testing.T) {
 			if err != nil {
 				t.Log(err)
 			}
-			if buff.String() != golden {
-				// XX  Skip this if the modification timestamp of the .txt file
-				//     source is fresher than the .svg?
-				t.Log(buff.Len(), len(golden))
-				t.Logf("Content mismatch for %s", toSVGFilename(name))
+			if newStr := buff.String(); newStr != golden {
+				// Skip complaint if the modification timestamp of the .txt file
+				// source is fresher than that of the .svg?
+				//   => NO, Any .txt difference might be an editing mistake.
+
+				t.Logf("Content mismatch for %s. Length was %d, expected %d",
+					toSVGFilename(name), buff.Len(), len(golden))
+				for i:=0; i<min(len(golden), len(newStr)); i++ {
+					if newStr[i] != golden[i] {
+						t.Logf("Differing runes at offset %d: new='%#v' reference='%#v'\n",
+							i, newStr[i], golden[i])
+						break
+					}
+				}
+				t.Logf("Generated contents do not match existing %s",
+					toSVGFilename(name))
 				failures++
 			} else {
 				if testing.Verbose() {
-					t.Logf("Verified contents of SVG file %s\n",
+					t.Logf("Existing and generated contents match %s\n",
 						toSVGFilename(name))
 				}
 			}
@@ -119,24 +131,24 @@ func BenchmarkComplicated(b *testing.B) {
 
 const basePath string = "examples"
 
-func getIn(filename string) io.ReadCloser {
-	in, err := os.Open(filename)
+func getIn(txtFilename string) io.ReadCloser {
+	in, err := os.Open(txtFilename)
 	if err != nil {
 		panic(err)
 	}
 	return in
 }
 
-func getOut(filename string) io.WriteCloser {
-	out, err := os.Create(toSVGFilename(filename))
+func getOut(txtFilename string) io.WriteCloser {
+	out, err := os.Create(toSVGFilename(txtFilename))
 	if err != nil {
 		panic(err)
 	}
 	return out
 }
 
-func getOutString(filename string) (string, error) {
-	b, err := ioutil.ReadFile(toSVGFilename(filename))
+func getOutString(txtFilename string) (string, error) {
+	b, err := ioutil.ReadFile(toSVGFilename(txtFilename))
 	if err != nil {
 		return "", err
 	}
@@ -145,6 +157,6 @@ func getOutString(filename string) (string, error) {
 	return string(b), nil
 }
 
-func toSVGFilename(filename string) string {
-	return strings.TrimSuffix(filename, filepath.Ext(filename)) + ".svg"
+func toSVGFilename(txtFilename string) string {
+	return strings.TrimSuffix(txtFilename, filepath.Ext(txtFilename)) + ".svg"
 }
diff --git a/go.mod b/go.mod
index f9a07e8..6ede171 100644
--- a/go.mod
+++ b/go.mod
@@ -1,6 +1,6 @@
 module github.com/blampe/goat
 
-go 1.17
+go 1.21
 
 require (
 	github.com/frankban/quicktest v1.14.2
diff --git a/pre-push.sh b/pre-push.sh
index e5f6f64..384709a 100755
--- a/pre-push.sh
+++ b/pre-push.sh
@@ -87,3 +87,5 @@ go run ./cmd/goat <examples/trees.txt \
 #  X `tac` is a slightly sleazy way to get the .txt/.svg pairs listed in the
 #     source/dest order as required by tmpl_expand.
 tmpl_expand <README.md.tmpl >README.md $(git-ls-files examples | tac)
+
+printf "\nTo install in local GOPATH:\n\t%s\n" "go install ./cmd/goat"