Ben Kraft
b1adeca6da
If you do `UPDATE_SNAPSHOTS=1 go test ./...` that will: 1. run the snapshot tests, updating any changed snapshots 2. run the integration tests and (if you have tokens) example tests 3. check that the code for the integration tests and example tests is up-to-date Step 3 is not strictly a snapshot test; the generated code is actually checked in and used. But, I mean, it's basically the same! So now, we also update it if you asked to update snapshots, which is hopefully a little more convenient. Fixes #212. Test plan: Make a trivial change to `example/generated.go`; `go test ./...` should now fail. `UPDATE_SNAPSHOTS=1 go test ./...` should also fail, but say it updated the snapshot, and the change should be reverted. Run `go test ./...` again; it should pass again.
65 lines
1.5 KiB
Go
65 lines
1.5 KiB
Go
package integration
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"runtime"
|
|
"testing"
|
|
|
|
"github.com/Khan/genqlient/generate"
|
|
)
|
|
|
|
// RepoRoot returns the root of the genqlient repository,
|
|
func RepoRoot(t *testing.T) string {
|
|
_, thisFile, _, ok := runtime.Caller(0)
|
|
if !ok {
|
|
t.Fatal("runtime.Caller non-ok")
|
|
}
|
|
|
|
root := filepath.Dir(filepath.Dir(filepath.Dir(thisFile)))
|
|
if _, err := os.Stat(filepath.Join(root, ".gitignore")); err != nil {
|
|
t.Fatal(fmt.Errorf("doesn't look like repo root: %v", err))
|
|
}
|
|
return root
|
|
}
|
|
|
|
// RunGenerateTest checks that running genqlient with the given
|
|
// repo-root-relative config file would not produce any changes to the
|
|
// checked-in files.
|
|
func RunGenerateTest(t *testing.T, relConfigFilename string) {
|
|
configFilename := filepath.Join(RepoRoot(t), relConfigFilename)
|
|
config, err := generate.ReadAndValidateConfig(configFilename)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
generated, err := generate.Generate(config)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
for filename, content := range generated {
|
|
expectedContent, err := os.ReadFile(filename)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if !bytes.Equal(content, expectedContent) {
|
|
t.Errorf("mismatch in %s", filename)
|
|
if testing.Verbose() {
|
|
t.Errorf("got:\n%s\nwant:\n%s\n", content, expectedContent)
|
|
}
|
|
if os.Getenv("UPDATE_SNAPSHOTS") == "1" {
|
|
err = os.WriteFile(filename, content, 0o644)
|
|
if err != nil {
|
|
t.Errorf("unable to update generated file %s: %v", filename, err)
|
|
} else {
|
|
t.Errorf("updated generated file for %s", filename)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|