Switch to cupaloy for snapshots

Slightly uglier filenames, but less code and free diffing!  Approved in
ADR-466 for Khan use.  Fixes Khan#23.

generate/generate_test.go

@@ -1,66 +1,20 @@
 package generate
 
 import (
-	"errors"
-	"go/format"
 	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
 	"testing"
+
+	"github.com/Khan/genqlient/internal/testutil"
 )
 
 const (
 	dataDir   = "testdata/queries"
 	errorsDir = "testdata/errors"
 )
 
-func gofmt(filename, src string) (string, error) {
-	src = strings.TrimSpace(src)
-	formatted, err := format.Source([]byte(src))
-	if err != nil {
-		return src, errorf(nil, "go parse error in %v: %v", filename, err)
-	}
-	return string(formatted), nil
-}
-
-func checkSnapshot(t *testing.T, filename, content string) {
-	t.Helper()
-	update := (os.Getenv("UPDATE_SNAPSHOTS") == "1")
-
-	expectedBytes, err := ioutil.ReadFile(filename)
-	if err != nil && !(update && errors.Is(err, os.ErrNotExist)) {
-		t.Fatal(err)
-	}
-	expectedContent := string(expectedBytes)
-
-	if strings.HasSuffix(filename, ".go") {
-		fmted, err := gofmt(filename, expectedContent)
-		if err != nil {
-			// Ignore gofmt errors if we are updating
-			if !update {
-				t.Fatal(err)
-			}
-		} else {
-			expectedContent = fmted
-		}
-	}
-
-	if content != expectedContent {
-		t.Errorf("mismatch in %v", filename)
-		if testing.Verbose() {
-			t.Errorf("got:\n%v\nwant:\n%v\n", content, expectedContent)
-		}
-		if update {
-			t.Log("Updating testdata dir to match")
-			err = ioutil.WriteFile(filename, []byte(content), 0o644)
-			if err != nil {
-				t.Errorf("Unable to update testdata dir: %v", err)
-			}
-		}
-	}
-}
-
 // TestGenerate is a snapshot-based test of code-generation.
 //
 // This file just has the test runner; the actual data is all in
@@ -109,7 +63,9 @@ func TestGenerate(t *testing.T) {
 			}
 
 			for filename, content := range generated {
-				checkSnapshot(t, filepath.Join(dataDir, filename), string(content))
+				t.Run(filename, func(t *testing.T) {
+					testutil.Cupaloy.SnapshotT(t, string(content))
+				})
 				// TODO(benkraft): Also check that the code at least builds!
 			}
 		})
@@ -133,8 +89,8 @@ func TestGenerateErrors(t *testing.T) {
 			continue
 		}
 
-		schemaFilename := strings.TrimSuffix(sourceFilename, filepath.Ext(sourceFilename)) + ".schema.graphql"
-		errorsFilename := sourceFilename + ".error"
+		baseFilename := strings.TrimSuffix(sourceFilename, filepath.Ext(sourceFilename))
+		schemaFilename := baseFilename + ".schema.graphql"
 
 		t.Run(sourceFilename, func(t *testing.T) {
 			_, err := Generate(&Config{
@@ -151,7 +107,7 @@ func TestGenerateErrors(t *testing.T) {
 				t.Fatal("expected an error")
 			}
 
-			checkSnapshot(t, filepath.Join(errorsDir, errorsFilename), err.Error())
+			testutil.Cupaloy.SnapshotT(t, err.Error())
 		})
 	}
 }

generate/parse_test.go

@@ -40,6 +40,7 @@ func getTestQueries(t *testing.T, ext string) *ast.QueryDocument {
 // produces equivalent results.  We do not test the results it produces (that's
 // covered by TestGenerate), just that they are equivalent in different
 // languages (since TestGenerate only uses .graphql as input).
+// TODO: redo this as more standard snapshot tests?
 func TestParse(t *testing.T) {
 	extensions := []string{"go"}
 

generate/testdata/queries/DateTime.graphql.json → generate/testdata/snapshots/TestGenerate-DateTime.graphql-DateTime.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/DateTime.graphql"
     }
   ]
-}
+}

generate/testdata/queries/EmptyInterface.graphql.json → generate/testdata/snapshots/TestGenerate-EmptyInterface.graphql-EmptyInterface.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/EmptyInterface.graphql"
     }
   ]
-}
+}

generate/testdata/queries/InputEnum.graphql.json → generate/testdata/snapshots/TestGenerate-InputEnum.graphql-InputEnum.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/InputEnum.graphql"
     }
   ]
-}
+}

generate/testdata/queries/InputObject.graphql.json → generate/testdata/snapshots/TestGenerate-InputObject.graphql-InputObject.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/InputObject.graphql"
     }
   ]
-}
+}

generate/testdata/queries/InterfaceNesting.graphql.json → generate/testdata/snapshots/TestGenerate-InterfaceNesting.graphql-InterfaceNesting.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/InterfaceNesting.graphql"
     }
   ]
-}
+}

generate/testdata/queries/InterfaceNoFragments.graphql.json → generate/testdata/snapshots/TestGenerate-InterfaceNoFragments.graphql-InterfaceNoFragments.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/InterfaceNoFragments.graphql"
     }
   ]
-}
+}

generate/testdata/queries/ListInput.graphql.json → generate/testdata/snapshots/TestGenerate-ListInput.graphql-ListInput.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/ListInput.graphql"
     }
   ]
-}
+}

generate/testdata/queries/ListOfListsOfLists.graphql.json → generate/testdata/snapshots/TestGenerate-ListOfListsOfLists.graphql-ListOfListsOfLists.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/ListOfListsOfLists.graphql"
     }
   ]
-}
+}

generate/testdata/queries/Omitempty.graphql.json → generate/testdata/snapshots/TestGenerate-Omitempty.graphql-Omitempty.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/Omitempty.graphql"
     }
   ]
-}
+}

generate/testdata/queries/Pointers.graphql.json → generate/testdata/snapshots/TestGenerate-Pointers.graphql-Pointers.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/Pointers.graphql"
     }
   ]
-}
+}

generate/testdata/queries/PointersInline.graphql.json → generate/testdata/snapshots/TestGenerate-PointersInline.graphql-PointersInline.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/PointersInline.graphql"
     }
   ]
-}
+}

generate/testdata/queries/QueryWithAlias.graphql.json → generate/testdata/snapshots/TestGenerate-QueryWithAlias.graphql-QueryWithAlias.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/QueryWithAlias.graphql"
     }
   ]
-}
+}

generate/testdata/queries/QueryWithDoubleAlias.graphql.json → generate/testdata/snapshots/TestGenerate-QueryWithDoubleAlias.graphql-QueryWithDoubleAlias.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/QueryWithDoubleAlias.graphql"
     }
   ]
-}
+}

generate/testdata/queries/QueryWithEnums.graphql.json → generate/testdata/snapshots/TestGenerate-QueryWithEnums.graphql-QueryWithEnums.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/QueryWithEnums.graphql"
     }
   ]
-}
+}

generate/testdata/queries/QueryWithSlices.graphql.json → generate/testdata/snapshots/TestGenerate-QueryWithSlices.graphql-QueryWithSlices.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/QueryWithSlices.graphql"
     }
   ]
-}
+}

generate/testdata/queries/QueryWithStructs.graphql.json → generate/testdata/snapshots/TestGenerate-QueryWithStructs.graphql-QueryWithStructs.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/QueryWithStructs.graphql"
     }
   ]
-}
+}

generate/testdata/queries/SimpleInput.graphql.json → generate/testdata/snapshots/TestGenerate-SimpleInput.graphql-SimpleInput.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/SimpleInput.graphql"
     }
   ]
-}
+}

generate/testdata/queries/SimpleMutation.graphql.json → generate/testdata/snapshots/TestGenerate-SimpleMutation.graphql-SimpleMutation.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/SimpleMutation.graphql"
     }
   ]
-}
+}

generate/testdata/queries/SimpleQuery.graphql.json → generate/testdata/snapshots/TestGenerate-SimpleQuery.graphql-SimpleQuery.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/SimpleQuery.graphql"
     }
   ]
-}
+}

generate/testdata/queries/TypeName.graphql.json → generate/testdata/snapshots/TestGenerate-TypeName.graphql-TypeName.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/TypeName.graphql"
     }
   ]
-}
+}

generate/testdata/queries/UnionNoFragments.graphql.json → generate/testdata/snapshots/TestGenerate-UnionNoFragments.graphql-UnionNoFragments.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/UnionNoFragments.graphql"
     }
   ]
-}
+}

generate/testdata/queries/UsesEnumTwice.graphql.json → generate/testdata/snapshots/TestGenerate-UsesEnumTwice.graphql-UsesEnumTwice.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/UsesEnumTwice.graphql"
     }
   ]
-}
+}

generate/testdata/queries/unexported.graphql.json → generate/testdata/snapshots/TestGenerate-unexported.graphql-unexported.graphql.json

@@ -6,4 +6,4 @@
       "sourceLocation": "testdata/queries/unexported.graphql"
     }
   ]
-}
+}

generate/testdata/errors/InvalidQuery.go.error → generate/testdata/snapshots/TestGenerateErrors-InvalidQuery.go

@@ -1 +1 @@
-testdata/errors/InvalidQuery.go:4: query-spec does not match schema: Cannot query field "g" on type "Query". Did you mean "f"?
+testdata/errors/InvalidQuery.go:4: query-spec does not match schema: Cannot query field "g" on type "Query". Did you mean "f"?

generate/testdata/errors/InvalidQuery.graphql.error → generate/testdata/snapshots/TestGenerateErrors-InvalidQuery.graphql

@@ -1 +1 @@
-testdata/errors/InvalidQuery.graphql:1: query-spec does not match schema: Cannot query field "g" on type "Query". Did you mean "f"?
+testdata/errors/InvalidQuery.graphql:1: query-spec does not match schema: Cannot query field "g" on type "Query". Did you mean "f"?