package generator import ( "flag" "io/ioutil" "os" "os/exec" "path/filepath" "strings" "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/suite" ) 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" // Extensions test extensionGold = testDir + "/extension.gold" extensionTestTmplPath = assetsDir + "/extension.go.tmpl" extensionTestTmplName = "extension.go.tmpl" // Heuristics test heuristicsTestFile = "lib/linguist/heuristics.yml" contentGold = testDir + "/content.gold" contentTestTmplPath = assetsDir + "/content.go.tmpl" contentTestTmplName = "content.go.tmpl" // Vendor test vendorTestFile = "lib/linguist/vendor.yml" vendorGold = testDir + "/vendor.gold" vendorTestTmplPath = assetsDir + "/vendor.go.tmpl" vendorTestTmplName = "vendor.go.tmpl" // Documentation test documentationTestFile = "lib/linguist/documentation.yml" documentationGold = testDir + "/documentation.gold" documentationTestTmplPath = assetsDir + "/documentation.go.tmpl" documentationTestTmplName = "documentation.go.tmpl" // Types test typeGold = testDir + "/type.gold" typeTestTmplPath = assetsDir + "/type.go.tmpl" typeTestTmplName = "type.go.tmpl" // Interpreters test interpreterGold = testDir + "/interpreter.gold" interpreterTestTmplPath = assetsDir + "/interpreter.go.tmpl" interpreterTestTmplName = "interpreter.go.tmpl" // Filenames test filenameGold = testDir + "/filename.gold" filenameTestTmplPath = assetsDir + "/filename.go.tmpl" filenameTestTmplName = "filename.go.tmpl" // Aliases test aliasGold = testDir + "/alias.gold" aliasTestTmplPath = assetsDir + "/alias.go.tmpl" aliasTestTmplName = "alias.go.tmpl" // Frequencies test frequenciesGold = testDir + "/frequencies.gold" frequenciesTestTmplPath = assetsDir + "/frequencies.go.tmpl" frequenciesTestTmplName = "frequencies.go.tmpl" // commit test commitGold = testDir + "/commit.gold" commitTestTmplPath = assetsDir + "/commit.go.tmpl" commitTestTmplName = "commit.go.tmpl" // mime test mimeTypeGold = testDir + "/mimeType.gold" mimeTypeTestTmplPath = assetsDir + "/mimeType.go.tmpl" mimeTypeTestTmplName = "mimeType.go.tmpl" // colors test colorsGold = testDir + "/colors.gold" colorsTestTmplPath = assetsDir + "/colors.go.tmpl" colorsTestTmplName = "colors.go.tmpl" ) type GeneratorTestSuite struct { suite.Suite tmpLinguist string cloned bool testCases []testCase } 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) { 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) cwd, err := os.Getwd() assert.NoError(s.T(), err) err = os.Chdir(s.tmpLinguist) assert.NoError(s.T(), err) cmd = exec.Command("git", "checkout", commit) err = cmd.Run() assert.NoError(s.T(), err) err = os.Chdir(cwd) assert.NoError(s.T(), err) } } func (s *GeneratorTestSuite) SetupSuite() { s.maybeCloneLinguist() s.testCases = []testCase{ { name: "Extensions()", fileToParse: filepath.Join(s.tmpLinguist, languagesFile), samplesDir: "", tmplPath: extensionTestTmplPath, tmplName: extensionTestTmplName, commit: commit, generate: Extensions, wantOut: extensionGold, }, { name: "Heuristics()", fileToParse: filepath.Join(s.tmpLinguist, heuristicsTestFile), samplesDir: "", tmplPath: contentTestTmplPath, tmplName: contentTestTmplName, commit: commit, generate: GenHeuristics, wantOut: contentGold, }, { name: "Vendor()", fileToParse: filepath.Join(s.tmpLinguist, vendorTestFile), samplesDir: "", tmplPath: vendorTestTmplPath, tmplName: vendorTestTmplName, commit: commit, generate: Vendor, wantOut: vendorGold, }, { name: "Documentation()", fileToParse: filepath.Join(s.tmpLinguist, documentationTestFile), samplesDir: "", tmplPath: documentationTestTmplPath, tmplName: documentationTestTmplName, commit: commit, generate: Documentation, wantOut: documentationGold, }, { name: "Types()", fileToParse: filepath.Join(s.tmpLinguist, languagesFile), samplesDir: "", tmplPath: typeTestTmplPath, tmplName: typeTestTmplName, commit: commit, generate: Types, wantOut: typeGold, }, { name: "Interpreters()", fileToParse: filepath.Join(s.tmpLinguist, languagesFile), samplesDir: "", tmplPath: interpreterTestTmplPath, tmplName: interpreterTestTmplName, commit: commit, generate: Interpreters, wantOut: interpreterGold, }, { name: "Filenames()", fileToParse: filepath.Join(s.tmpLinguist, languagesFile), samplesDir: filepath.Join(s.tmpLinguist, samplesDir), tmplPath: filenameTestTmplPath, tmplName: filenameTestTmplName, commit: commit, generate: Filenames, wantOut: filenameGold, }, { name: "Aliases()", fileToParse: filepath.Join(s.tmpLinguist, languagesFile), samplesDir: "", tmplPath: aliasTestTmplPath, tmplName: aliasTestTmplName, commit: commit, generate: Aliases, wantOut: aliasGold, }, { name: "Frequencies()", samplesDir: filepath.Join(s.tmpLinguist, samplesDir), tmplPath: frequenciesTestTmplPath, tmplName: frequenciesTestTmplName, commit: commit, generate: Frequencies, wantOut: frequenciesGold, }, { name: "Commit()", samplesDir: "", tmplPath: commitTestTmplPath, tmplName: commitTestTmplName, commit: commit, generate: Commit, wantOut: commitGold, }, { name: "MimeType()", fileToParse: filepath.Join(s.tmpLinguist, languagesFile), samplesDir: "", tmplPath: mimeTypeTestTmplPath, tmplName: mimeTypeTestTmplName, commit: commit, generate: MimeType, wantOut: mimeTypeGold, }, { name: "Colors()", fileToParse: filepath.Join(s.tmpLinguist, languagesFile), samplesDir: "", tmplPath: colorsTestTmplPath, tmplName: colorsTestTmplName, commit: commit, generate: Colors, wantOut: colorsGold, }, } } 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) } } } // 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 { gold, err := ioutil.ReadFile(test.wantOut) assert.NoError(s.T(), err) outPath, err := ioutil.TempFile("/tmp", "generator-test-") assert.NoError(s.T(), err) defer os.Remove(outPath.Name()) err = test.generate(test.fileToParse, test.samplesDir, outPath.Name(), test.tmplPath, test.tmplName, test.commit) assert.NoError(s.T(), err) 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) } } // 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), " ") }