github.com/lixvbnet/courtney@v0.0.0-20221025031132-0dcb02231211/tester/tester.go

package tester

import (
	"crypto/md5"
	"fmt"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
	"strings"

	"github.com/lixvbnet/courtney/shared"
	"github.com/lixvbnet/courtney/tester/logger"
	"github.com/lixvbnet/courtney/tester/merge"
	"github.com/pkg/errors"
	"golang.org/x/tools/cover"
)

// New creates a new Tester with the provided setup
func New(setup *shared.Setup) *Tester {
	t := &Tester{
		setup: setup,
	}
	return t
}

// Tester runs tests and merges coverage files
type Tester struct {
	setup   *shared.Setup
	cover   string
	Results []*cover.Profile
}

// Load loads pre-prepared coverage files instead of running 'go test'
func (t *Tester) Load() error {
	files, err := filepath.Glob(t.setup.Load)
	if err != nil {
		return errors.Wrap(err, "Error loading coverage files")
	}
	for _, fpath := range files {
		if err := t.processCoverageFile(fpath); err != nil {
			return err
		}
	}
	return nil
}

// Test initiates the tests and merges the coverage files
func (t *Tester) Test() error {

	var err error
	if t.cover, err = ioutil.TempDir("", "coverage"); err != nil {
		return errors.Wrap(err, "Error creating temporary coverage dir")
	}
	defer os.RemoveAll(t.cover)

	for _, spec := range t.setup.Packages {
		if err := t.processDir(spec.Dir); err != nil {
			return err
		}
	}

	return nil
}

// Save saves the coverage file
func (t *Tester) Save() error {
	if len(t.Results) == 0 {
		fmt.Fprintln(t.setup.Env.Stdout(), "No results")
		return nil
	}
	currentDir, err := t.setup.Env.Getwd()
	if err != nil {
		return errors.Wrap(err, "Error getting working dir")
	}
	out := filepath.Join(currentDir, "coverage.out")
	if t.setup.Output != "" {
		out = t.setup.Output
	}
	f, err := os.Create(out)
	if err != nil {
		return errors.Wrapf(err, "Error creating output coverage file %s", out)
	}
	defer f.Close()
	merge.DumpProfiles(t.Results, f)
	return nil
}

// Enforce returns an error if code is untested if the -e command line option
// is set
func (t *Tester) Enforce() error {
	if !t.setup.Enforce {
		return nil
	}
	untested := make(map[string][]cover.ProfileBlock)
	for _, r := range t.Results {
		for _, b := range r.Blocks {
			if b.Count == 0 {
				if len(untested[r.FileName]) > 0 {
					// check if the new block is directly after the last one
					last := untested[r.FileName][len(untested[r.FileName])-1]
					if b.StartLine <= last.EndLine+1 {
						last.EndLine = b.EndLine
						last.EndCol = b.EndCol
						untested[r.FileName][len(untested[r.FileName])-1] = last
						continue
					}
				}
				untested[r.FileName] = append(untested[r.FileName], b)
			}
		}
	}

	if len(untested) == 0 {
		return nil
	}

	var s string
	for name, blocks := range untested {
		fpath, err := t.setup.Paths.FilePath(name)
		if err != nil {
			return err
		}
		by, err := ioutil.ReadFile(fpath)
		if err != nil {
			return errors.Wrapf(err, "Error reading source file %s", fpath)
		}
		lines := strings.Split(string(by), "\n")
		for _, b := range blocks {
			s += fmt.Sprintf("%s:%d-%d:\n", name, b.StartLine, b.EndLine)
			undented := undent(lines[b.StartLine-1 : b.EndLine])
			s += strings.Join(undented, "\n")
		}
	}
	return errors.Errorf("Error - untested code:\n%s", s)

}

// ProcessExcludes uses the output from the scanner package and removes blocks
// from the merged coverage file.
func (t *Tester) ProcessExcludes(excludes map[string]map[int]bool) error {
	var processed []*cover.Profile

	for _, p := range t.Results {

		// Filenames in t.Results are in go package form. We need to convert to
		// filepaths before use
		fpath, err := t.setup.Paths.FilePath(p.FileName)
		if err != nil {
			return err
		}

		f, ok := excludes[fpath]
		if !ok {
			// no excludes in this file - add the profile unchanged
			processed = append(processed, p)
			continue
		}
		var blocks []cover.ProfileBlock
		for _, b := range p.Blocks {
			excluded := false
			for line := b.StartLine; line <= b.EndLine; line++ {
				if ex, ok := f[line]; ok && ex {
					excluded = true
					break
				}
			}
			//if !excluded || b.Count > 0 {
			//	// include blocks that are not excluded
			//	// also include any blocks that have coverage
			//	blocks = append(blocks, b)
			//}

			// excluded blocks are considered to have coverage of count 1
			if excluded {
				b.Count = 1
			}
			// include all blocks
			blocks = append(blocks, b)
		}
		profile := &cover.Profile{
			FileName: p.FileName,
			Mode:     p.Mode,
			Blocks:   blocks,
		}
		processed = append(processed, profile)
	}
	t.Results = processed
	return nil
}

func (t *Tester) processDir(dir string) error {

	coverfile := filepath.Join(
		t.cover,
		fmt.Sprintf("%x", md5.Sum([]byte(dir)))+".out",
	)

	files, err := ioutil.ReadDir(dir)
	if err != nil {
		return errors.Wrapf(err, "Error reading files from %s", dir)
	}

	foundTest := false
	for _, f := range files {
		if strings.HasSuffix(f.Name(), "_test.go") {
			foundTest = true
		}
	}
	if !foundTest {
		// notest
		return nil
	}

	combined, stdout, stderr := logger.Log(
		t.setup.Verbose,
		t.setup.Env.Stdout(),
		t.setup.Env.Stderr(),
	)

	var args []string
	var pkgs []string
	for _, s := range t.setup.Packages {
		pkgs = append(pkgs, s.Path)
	}
	args = append(args, "test")
	if t.setup.Short {
		// notest
		// TODO: add test
		args = append(args, "-short")
	}
	if t.setup.Timeout != "" {
		// notest
		// TODO: add test
		args = append(args, "-timeout", t.setup.Timeout)
	}
	args = append(args, fmt.Sprintf("-coverpkg=%s", strings.Join(pkgs, ",")))
	args = append(args, fmt.Sprintf("-coverprofile=%s", coverfile))
	if t.setup.Verbose {
		args = append(args, "-v")
	}
	if len(t.setup.TestArgs) > 0 {
		// notest
		args = append(args, t.setup.TestArgs...)
	}
	if t.setup.Verbose {
		fmt.Fprintf(
			t.setup.Env.Stdout(),
			"Running test: %s\n",
			strings.Join(append([]string{"go"}, args...), " "),
		)
	}

	exe := exec.Command("go", args...)
	exe.Dir = dir
	exe.Env = t.setup.Env.Environ()
	exe.Stdout = stdout
	exe.Stderr = stderr
	err = exe.Run()
	if strings.Contains(combined.String(), "no buildable Go source files in") {
		// notest
		return nil
	}
	if err != nil {
		// TODO: Remove when https://github.com/dave/courtney/issues/4 is fixed
		// notest
		if t.setup.Verbose {
			// They will already have seen the output
			return errors.Wrap(err, "Error executing test")
		}
		return errors.Wrapf(err, "Error executing test \nOutput:[\n%s]\n", combined.String())
	}
	return t.processCoverageFile(coverfile)
}

func (t *Tester) processCoverageFile(filename string) error {
	profiles, err := cover.ParseProfiles(filename)
	if err != nil {
		return err
	}
	for _, p := range profiles {
		if t.Results, err = merge.AddProfile(t.Results, p); err != nil {
			return err
		}
	}
	return nil
}

func undent(lines []string) []string {

	indentRegex := regexp.MustCompile("[^\t]")
	mindent := -1

	for _, line := range lines {
		loc := indentRegex.FindStringIndex(line)
		if len(loc) == 0 {
			// notest
			// string is empty?
			continue
		}
		if mindent == -1 || loc[0] < mindent {
			mindent = loc[0]
		}
	}

	var out []string
	for _, line := range lines {
		if line == "" {
			// notest
			out = append(out, "")
		} else {
			out = append(out, "\t"+line[mindent:])
		}
	}
	return out
}