Improve test.CompareGoldenFile

When the golden file for a test doesn't exist, create it. This makes it easier to get started using golden files without having to create the empty file first. You can just edit the test to use that helper and it will make the file for you when run with mage updatetestfiles Signed-off-by: Carolyn Van Slyck <[email protected]>
getporter · Jan 27, 2022 · 27a8705 · 27a8705
1 parent 57cdb6f
commit 27a8705
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/pkg/porter/testdata/version/version-output.txt b/pkg/porter/testdata/version/version-output.txt
@@ -2,11 +2,10 @@ porter v1.2.3 (abc123)
 
 System
 -------
-os: darwin
+os: linux
 arch: amd64
 
 Mixins
--------
 ---------------------------------
   Name  Version  Author          
 ---------------------------------

diff --git a/pkg/porter/version.go b/pkg/porter/version.go
@@ -102,7 +102,6 @@ os: {{.SysInfo.OS}}
 arch: {{.SysInfo.Arch}}
 {{if .Mixins}}
 Mixins
--------
 {{.Mixins.PrintMixinsTable}}{{end}}
 `
 		tmpl, err := template.New("systemDebugInfo").Parse(plaintextTmpl)

diff --git a/pkg/porter/version_test.go b/pkg/porter/version_test.go
@@ -95,6 +95,11 @@ func TestPrintDebugInfoJsonVersion(t *testing.T) {
 }
 
 func TestPrintDebugInfoPlainTextVersion(t *testing.T) {
+	// Only run this on linux + amd64 machines to simplify the test (it has different output based on the os/arch)
+	if runtime.GOOS != "linux" || runtime.GOARCH != "amd64" {
+		t.Skip("skipping test because it is only for linux/amd64")
+	}
+
 	pkg.Commit = "abc123"
 	pkg.Version = "v1.2.3"
 

diff --git a/pkg/test/helper.go b/pkg/test/helper.go
@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"path/filepath"
 	"strconv"
 	"strings"
 	"testing"
@@ -63,13 +64,13 @@ func TestMainWithMockedCommandHandlers(m *testing.M) {
 // When they are different and PORTER_UPDATE_TEST_FILES is true, the file is updated to match
 // the new test output.
 func CompareGoldenFile(t *testing.T, goldenFile string, got string) {
-	wantSchema, err := ioutil.ReadFile(goldenFile)
-	require.NoError(t, err)
-
 	if os.Getenv("PORTER_UPDATE_TEST_FILES") == "true" {
+		os.MkdirAll(filepath.Dir(goldenFile), 0700)
 		t.Logf("Updated test file %s to match latest test output", goldenFile)
 		require.NoError(t, ioutil.WriteFile(goldenFile, []byte(got), 0600), "could not update golden file %s", goldenFile)
 	} else {
+		wantSchema, err := ioutil.ReadFile(goldenFile)
+		require.NoError(t, err)
 		assert.Equal(t, string(wantSchema), got, "The test output doesn't match the expected output in %s. If this was intentional, run mage updateTestfiles to fix the tests.", goldenFile)
 	}
 }