tartrazine/internal/code-generator/generator/generator_test.go

300 lines
8.3 KiB
Go
Raw Normal View History

2017-04-04 11:10:35 +00:00
package generator
import (
"flag"
2017-04-04 11:10:35 +00:00
"io/ioutil"
"os"
2017-05-25 10:33:26 +00:00
"os/exec"
"path/filepath"
"strings"
2017-04-04 11:10:35 +00:00
"testing"
"github.com/stretchr/testify/assert"
2017-05-25 10:33:26 +00:00
"github.com/stretchr/testify/suite"
2017-04-04 11:10:35 +00:00
)
const (
linguistURL = "https://github.com/github/linguist.git"
linguistClonedEnvVar = "ENRY_TEST_REPO"
commit = "e4560984058b4726010ca4b8f03ed9d0f8f464db"
samplesDir = "samples"
languagesFile = "lib/linguist/languages.yml"
testDir = "test_files"
assetsDir = "../assets"
2017-05-25 10:33:26 +00:00
// Extensions test
extensionGold = testDir + "/extension.gold"
extensionTestTmplPath = assetsDir + "/extension.go.tmpl"
2017-06-13 11:56:07 +00:00
extensionTestTmplName = "extension.go.tmpl"
2017-04-05 14:01:31 +00:00
// Heuristics test
heuristicsTestFile = "lib/linguist/heuristics.yml"
contentGold = testDir + "/content.gold"
contentTestTmplPath = assetsDir + "/content.go.tmpl"
contentTestTmplName = "content.go.tmpl"
2017-04-06 15:31:17 +00:00
// Vendor test
2017-06-13 11:56:07 +00:00
vendorTestFile = "lib/linguist/vendor.yml"
vendorGold = testDir + "/vendor.gold"
vendorTestTmplPath = assetsDir + "/vendor.go.tmpl"
vendorTestTmplName = "vendor.go.tmpl"
// Documentation test
2017-06-13 11:56:07 +00:00
documentationTestFile = "lib/linguist/documentation.yml"
documentationGold = testDir + "/documentation.gold"
documentationTestTmplPath = assetsDir + "/documentation.go.tmpl"
documentationTestTmplName = "documentation.go.tmpl"
2017-04-11 09:26:23 +00:00
// Types test
typeGold = testDir + "/type.gold"
typeTestTmplPath = assetsDir + "/type.go.tmpl"
2017-06-13 11:56:07 +00:00
typeTestTmplName = "type.go.tmpl"
// Interpreters test
interpreterGold = testDir + "/interpreter.gold"
interpreterTestTmplPath = assetsDir + "/interpreter.go.tmpl"
2017-06-13 11:56:07 +00:00
interpreterTestTmplName = "interpreter.go.tmpl"
// Filenames test
filenameGold = testDir + "/filename.gold"
filenameTestTmplPath = assetsDir + "/filename.go.tmpl"
2017-06-13 11:56:07 +00:00
filenameTestTmplName = "filename.go.tmpl"
// Aliases test
aliasGold = testDir + "/alias.gold"
aliasTestTmplPath = assetsDir + "/alias.go.tmpl"
2017-06-13 11:56:07 +00:00
aliasTestTmplName = "alias.go.tmpl"
2017-05-25 10:33:26 +00:00
// Frequencies test
frequenciesGold = testDir + "/frequencies.gold"
frequenciesTestTmplPath = assetsDir + "/frequencies.go.tmpl"
2017-05-25 10:33:26 +00:00
frequenciesTestTmplName = "frequencies.go.tmpl"
// commit test
commitGold = testDir + "/commit.gold"
commitTestTmplPath = assetsDir + "/commit.go.tmpl"
commitTestTmplName = "commit.go.tmpl"
2017-07-11 09:13:49 +00:00
// mime test
mimeTypeGold = testDir + "/mimeType.gold"
mimeTypeTestTmplPath = assetsDir + "/mimeType.go.tmpl"
2017-07-11 09:13:49 +00:00
mimeTypeTestTmplName = "mimeType.go.tmpl"
2017-04-04 11:10:35 +00:00
)
2017-05-25 10:33:26 +00:00
type GeneratorTestSuite struct {
suite.Suite
tmpLinguist string
cloned bool
testCases []testCase
2017-05-25 10:33:26 +00:00
}
type testCase struct {
name string
fileToParse string
samplesDir string
tmplPath string
tmplName string
commit string
generate File
wantOut string
}
var updateGold = flag.Bool("update_gold", false, "Update golden test files")
func Test_GeneratorTestSuite(t *testing.T) {
2017-05-29 08:05:16 +00:00
suite.Run(t, new(GeneratorTestSuite))
}
func (s *GeneratorTestSuite) maybeCloneLinguist() {
var err error
s.tmpLinguist = os.Getenv(linguistClonedEnvVar)
s.cloned = s.tmpLinguist == ""
if s.cloned {
s.tmpLinguist, err = ioutil.TempDir("", "linguist-")
assert.NoError(s.T(), err)
cmd := exec.Command("git", "clone", linguistURL, s.tmpLinguist)
err = cmd.Run()
assert.NoError(s.T(), err)
2017-05-25 10:33:26 +00:00
cwd, err := os.Getwd()
assert.NoError(s.T(), err)
2017-05-25 10:33:26 +00:00
err = os.Chdir(s.tmpLinguist)
assert.NoError(s.T(), err)
2017-05-25 10:33:26 +00:00
cmd = exec.Command("git", "checkout", commit)
err = cmd.Run()
assert.NoError(s.T(), err)
2017-05-25 10:33:26 +00:00
err = os.Chdir(cwd)
assert.NoError(s.T(), err)
}
2017-05-25 10:33:26 +00:00
}
func (s *GeneratorTestSuite) SetupSuite() {
s.maybeCloneLinguist()
s.testCases = []testCase{
2017-04-04 11:10:35 +00:00
{
2017-06-13 11:56:07 +00:00
name: "Extensions()",
fileToParse: filepath.Join(s.tmpLinguist, languagesFile),
2017-06-13 11:56:07 +00:00
samplesDir: "",
tmplPath: extensionTestTmplPath,
tmplName: extensionTestTmplName,
commit: commit,
generate: Extensions,
2017-06-13 11:56:07 +00:00
wantOut: extensionGold,
2017-04-04 11:10:35 +00:00
},
2017-04-05 14:01:31 +00:00
{
2017-06-13 11:56:07 +00:00
name: "Heuristics()",
fileToParse: filepath.Join(s.tmpLinguist, heuristicsTestFile),
2017-06-13 11:56:07 +00:00
samplesDir: "",
2017-04-05 14:01:31 +00:00
tmplPath: contentTestTmplPath,
tmplName: contentTestTmplName,
2017-06-13 11:56:07 +00:00
commit: commit,
generate: GenHeuristics,
wantOut: contentGold,
2017-04-05 14:01:31 +00:00
},
2017-04-06 15:31:17 +00:00
{
2017-06-13 11:56:07 +00:00
name: "Vendor()",
fileToParse: filepath.Join(s.tmpLinguist, vendorTestFile),
2017-06-13 11:56:07 +00:00
samplesDir: "",
tmplPath: vendorTestTmplPath,
tmplName: vendorTestTmplName,
2017-06-13 11:56:07 +00:00
commit: commit,
2017-04-06 15:31:17 +00:00
generate: Vendor,
wantOut: vendorGold,
2017-04-06 15:31:17 +00:00
},
{
2017-06-13 11:56:07 +00:00
name: "Documentation()",
fileToParse: filepath.Join(s.tmpLinguist, documentationTestFile),
2017-06-13 11:56:07 +00:00
samplesDir: "",
tmplPath: documentationTestTmplPath,
tmplName: documentationTestTmplName,
2017-06-13 11:56:07 +00:00
commit: commit,
generate: Documentation,
wantOut: documentationGold,
},
2017-04-11 09:26:23 +00:00
{
2017-06-13 11:56:07 +00:00
name: "Types()",
fileToParse: filepath.Join(s.tmpLinguist, languagesFile),
2017-06-13 11:56:07 +00:00
samplesDir: "",
tmplPath: typeTestTmplPath,
tmplName: typeTestTmplName,
commit: commit,
2017-04-11 09:26:23 +00:00
generate: Types,
2017-06-13 11:56:07 +00:00
wantOut: typeGold,
2017-04-11 09:26:23 +00:00
},
{
2017-06-13 11:56:07 +00:00
name: "Interpreters()",
fileToParse: filepath.Join(s.tmpLinguist, languagesFile),
2017-06-13 11:56:07 +00:00
samplesDir: "",
tmplPath: interpreterTestTmplPath,
tmplName: interpreterTestTmplName,
commit: commit,
generate: Interpreters,
2017-06-13 11:56:07 +00:00
wantOut: interpreterGold,
},
{
2017-06-13 11:56:07 +00:00
name: "Filenames()",
fileToParse: filepath.Join(s.tmpLinguist, languagesFile),
samplesDir: filepath.Join(s.tmpLinguist, samplesDir),
2017-06-13 11:56:07 +00:00
tmplPath: filenameTestTmplPath,
tmplName: filenameTestTmplName,
commit: commit,
generate: Filenames,
2017-06-13 11:56:07 +00:00
wantOut: filenameGold,
},
{
2017-06-13 11:56:07 +00:00
name: "Aliases()",
fileToParse: filepath.Join(s.tmpLinguist, languagesFile),
2017-06-13 11:56:07 +00:00
samplesDir: "",
tmplPath: aliasTestTmplPath,
tmplName: aliasTestTmplName,
commit: commit,
generate: Aliases,
2017-06-13 11:56:07 +00:00
wantOut: aliasGold,
},
2017-05-25 10:33:26 +00:00
{
2017-06-13 11:56:07 +00:00
name: "Frequencies()",
samplesDir: filepath.Join(s.tmpLinguist, samplesDir),
2017-05-25 10:33:26 +00:00
tmplPath: frequenciesTestTmplPath,
tmplName: frequenciesTestTmplName,
2017-06-13 11:56:07 +00:00
commit: commit,
generate: Frequencies,
2017-05-25 10:33:26 +00:00
wantOut: frequenciesGold,
},
{
name: "Commit()",
samplesDir: "",
tmplPath: commitTestTmplPath,
tmplName: commitTestTmplName,
commit: commit,
generate: Commit,
wantOut: commitGold,
},
2017-07-11 09:13:49 +00:00
{
name: "MimeType()",
fileToParse: filepath.Join(s.tmpLinguist, languagesFile),
samplesDir: "",
tmplPath: mimeTypeTestTmplPath,
tmplName: mimeTypeTestTmplName,
commit: commit,
generate: MimeType,
wantOut: mimeTypeGold,
},
2017-05-25 10:33:26 +00:00
}
}
func (s *GeneratorTestSuite) TearDownSuite() {
if s.cloned {
err := os.RemoveAll(s.tmpLinguist)
if err != nil {
s.T().Logf("Failed to clean up %s after the test.\n", s.tmpLinguist)
}
}
}
2017-05-25 10:33:26 +00:00
// TestUpdateGeneratorTestSuiteGold is a Gold results generation automation.
// It should only be enabled&run manually on every new Linguist version
// to update *.gold files.
func (s *GeneratorTestSuite) TestUpdateGeneratorTestSuiteGold() {
if !*updateGold {
s.T().Skip()
}
s.T().Logf("Generating new *.gold test files")
for _, test := range s.testCases {
dst := test.wantOut
s.T().Logf("Generating %s from %s\n", dst, test.fileToParse)
err := test.generate(test.fileToParse, test.samplesDir, dst, test.tmplPath, test.tmplName, test.commit)
assert.NoError(s.T(), err)
}
}
func (s *GeneratorTestSuite) TestGenerationFiles() {
for _, test := range s.testCases {
2017-05-25 10:33:26 +00:00
gold, err := ioutil.ReadFile(test.wantOut)
assert.NoError(s.T(), err)
2017-05-25 10:33:26 +00:00
2017-06-13 11:56:07 +00:00
outPath, err := ioutil.TempFile("/tmp", "generator-test-")
assert.NoError(s.T(), err)
2017-05-25 10:33:26 +00:00
defer os.Remove(outPath.Name())
2017-06-13 11:56:07 +00:00
err = test.generate(test.fileToParse, test.samplesDir, outPath.Name(), test.tmplPath, test.tmplName, test.commit)
assert.NoError(s.T(), err)
2017-05-25 10:33:26 +00:00
out, err := ioutil.ReadFile(outPath.Name())
assert.NoError(s.T(), err)
expected := normalizeSpaces(string(gold))
actual := normalizeSpaces(string(out))
assert.Equal(s.T(), expected, actual, "Test %s", test.name)
2017-05-25 10:33:26 +00:00
}
}
// normalizeSpaces returns a copy of str with whitespaces normalized.
// We use this to compare generated source as gofmt format may change.
// E.g for changes between Go 1.10 and 1.11 see
// https://go-review.googlesource.com/c/go/+/122295/
func normalizeSpaces(str string) string {
return strings.Join(strings.Fields(str), " ")
}