perkeep/dev/devcam/test.go

/*
Copyright 2013 The Perkeep Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// This file adds the "test" subcommand to devcam, to run the full test suite.

package main

import (
	"flag"
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
	"runtime"
	"strings"

	"perkeep.org/internal/osutil"
	"perkeep.org/pkg/cmdmain"
)

type testCmd struct {
	// start of flag vars
	verbose   bool
	precommit bool
	short     bool
	race      bool
	run       string
	sqlite    bool
}

func init() {
	cmdmain.RegisterMode("test", func(flags *flag.FlagSet) cmdmain.CommandRunner {
		cmd := new(testCmd)
		flags.BoolVar(&cmd.short, "short", false, "Use '-short' with go test.")
		flags.BoolVar(&cmd.race, "race", false, "Use '-race' with go test.")
		flags.BoolVar(&cmd.precommit, "precommit", true, "Run the pre-commit githook as part of tests.")
		flags.BoolVar(&cmd.verbose, "v", false, "Use '-v' (for verbose) with go test.")
		flags.StringVar(&cmd.run, "run", "", "Use '-run' with go test.")
		flags.BoolVar(&cmd.sqlite, "sqlite", true, "Run tests with SQLite built-in where relevant.")
		return cmd
	})
}

func (c *testCmd) Usage() {
	fmt.Fprintf(cmdmain.Stderr, "Usage: devcam test [test_opts] [targets]\n")
}

func (c *testCmd) Describe() string {
	return "run the full test suite, or the tests in the specified target packages."
}

func (c *testCmd) RunCommand(args []string) error {
	if c.precommit {
		if err := c.runPrecommitHook(); err != nil {
			return err
		}
	}
	if err := c.buildSelf(); err != nil {
		return err
	}
	if err := c.runTests(args); err != nil {
		return err
	}
	println("PASS")
	return nil
}

func (c *testCmd) env() *Env {
	env := NewCopyEnv()
	env.NoGo()
	cmd := exec.Command("go", "env", "GOPATH")
	cmd.Stderr = os.Stderr
	out, err := cmd.Output()
	if err != nil {
		panic("Cannot find GOPATH with 'go env GOPATH'")
	}
	gopath := strings.TrimSpace(string(out))
	if gopath == "" {
		panic("devcam test needs GOPATH to be set")
	}
	env.Set("GOPATH", gopath)

	// Disable CGO on windows if it doesn't look like it's available.
	if runtime.GOOS == "windows" {
		if _, err := exec.LookPath("gcc"); err != nil {
			if _, err := exec.LookPath("clang"); err != nil {
				env.Set("CGO_ENABLED", "0")
			}
		}
	}
	return env
}

func (c *testCmd) buildSelf() error {
	args := []string{
		"install",
		filepath.FromSlash("./dev/devcam"),
	}
	cmd := exec.Command("go", args...)
	env := c.env()
	cmd.Env = env.Flat()
	cmd.Stdout = os.Stdout
	cmd.Stderr = os.Stderr
	if err := cmd.Run(); err != nil {
		return fmt.Errorf("Error building devcam: %v", err)
	}
	return nil
}

func (c *testCmd) runTests(args []string) error {
	targs := []string{"test"}
	if c.sqlite {
		targs = append(targs, "--tags=with_sqlite fake_android libsqlite3")
	} else {
		targs = append(targs, "--tags=fake_android")
	}
	if c.short {
		targs = append(targs, "-short")
	}
	if c.race {
		targs = append(targs, "-race")
	}
	if c.verbose {
		targs = append(targs, "-v")
	}
	if c.run != "" {
		targs = append(targs, "-run="+c.run)
	}
	if len(args) > 0 {
		targs = append(targs, args...)
	} else {
		targs = append(targs, []string{
			"./internal/...",
			"./pkg/...",
			"./server/perkeepd",
			"./cmd/...",
			"./app/publisher/...",
			"./misc/docker/...",
			"./website/pk-web",
		}...)
	}
	env := c.env()
	env.Set("SKIP_DEP_TESTS", "1")
	return runExec("go", targs, env)
}

func (c *testCmd) runPrecommitHook() error {
	cmdBin, err := osutil.LookPathGopath("devcam")
	if err != nil {
		return err
	}
	out, err := exec.Command(cmdBin, "hook", "pre-commit", "test").CombinedOutput()
	if err != nil {
		fmt.Println(string(out))
	}
	return err

}