example_test.go

package actionlint

import (
	"bufio"
	"io/ioutil"
	"os"
	"path/filepath"
	"regexp"
	"sort"
	"strings"
	"testing"

	"golang.org/x/sys/execabs"
)

func TestExamples(t *testing.T) {
	wd, err := os.Getwd()
	if err != nil {
		panic(err)
	}

	dir := filepath.Join(wd, "testdata", "examples")

	entries, err := ioutil.ReadDir(dir)
	if err != nil {
		panic(err)
	}

	infiles := make([]string, 0, len(entries))
	for _, info := range entries {
		if info.IsDir() {
			continue
		}
		n := info.Name()
		if strings.HasSuffix(n, ".yaml") || strings.HasSuffix(n, ".yml") {
			infiles = append(infiles, filepath.Join(dir, n))
		}
	}

	proj := &Project{root: dir}

	for _, infile := range infiles {
		base := strings.TrimSuffix(infile, filepath.Ext(infile))
		outfile := base + ".out"
		testName := filepath.Base(base)
		t.Run(testName, func(t *testing.T) {
			b, err := ioutil.ReadFile(infile)
			if err != nil {
				panic(err)
			}

			opts := LinterOptions{}

			if strings.Contains(testName, "shellcheck") {
				p, err := execabs.LookPath("shellcheck")
				if err != nil {
					t.Skip("skipped because \"shellcheck\" command does not exist in system")
				}
				opts.Shellcheck = p
			}

			if strings.Contains(testName, "pyflakes") {
				p, err := execabs.LookPath("pyflakes")
				if err != nil {
					t.Skip("skipped because \"pyflakes\" command does not exist in system")
				}
				opts.Pyflakes = p
			}

			linter, err := NewLinter(ioutil.Discard, &opts)
			if err != nil {
				t.Fatal(err)
			}

			config := Config{}
			linter.defaultConfig = &config

			expected := []string{}
			{
				f, err := os.Open(outfile)
				if err != nil {
					panic(err)
				}
				s := bufio.NewScanner(f)
				for s.Scan() {
					expected = append(expected, s.Text())
				}
				if err := s.Err(); err != nil {
					panic(err)
				}
			}

			errs, err := linter.Lint("test.yaml", b, proj)
			if err != nil {
				t.Fatal(err)
			}

			if len(errs) != len(expected) {
				t.Fatalf("%d errors are expected but actually got %d errors: %# v", len(expected), len(errs), errs)
			}

			sort.Sort(ByErrorPosition(errs))

			for i := 0; i < len(errs); i++ {
				want, have := expected[i], errs[i].Error()
				if strings.HasPrefix(want, "/") && strings.HasSuffix(want, "/") {
					want := regexp.MustCompile(want[1 : len(want)-1])
					if !want.MatchString(have) {
						t.Errorf("error message mismatch at %dth error does not match to regular expression\n  want: /%s/\n  have: %q", i+1, want, have)
					}
				} else {
					if want != have {
						t.Errorf("error message mismatch at %dth error does not match exactly\n  want: %q\n  have: %q", i+1, want, have)
					}
				}
			}
		})
	}
}