github.com/oweisse/u-root@v0.0.0-20181109060735-d005ad25fef1/integration/gotest_test.go

// Copyright 2018 the u-root Authors. All rights reserved
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package integration

import (
	"fmt"
	"io/ioutil"
	"os"
	"os/exec"
	"path"
	"path/filepath"
	"regexp"
	"sort"
	"strings"
	"testing"
	"time"
)

// testPkgs returns a slice of tests to run.
func testPkgs(t *testing.T) []string {
	// Packages which do not contain tests (or do not contain tests for the
	// build target) will still compile a test binary which vacuously pass.
	cmd := exec.Command("go", "list",
		"github.com/u-root/u-root/cmds/...",
		// TODO: only running tests in cmds because tests in pkg have
		// duplicate names which confuses the test runner. This should
		// get fixed.
		// "github.com/u-root/u-root/xcmds/...",
		// "github.com/u-root/u-root/pkg/...",
	)
	out, err := cmd.CombinedOutput()
	if err != nil {
		t.Fatal(err)
	}
	pkgs := strings.Fields(strings.TrimSpace(string(out)))

	// TODO: Some tests do not run properly in QEMU at the moment. They are
	// blacklisted. These tests fail for mostly two reasons:
	// 1. either it requires networking (not enabled in the kernel)
	// 2. or it depends on some test files (for example /bin/sleep)
	blacklist := []string{
		"github.com/u-root/u-root/cmds/bzimage",
		"github.com/u-root/u-root/cmds/cmp",
		"github.com/u-root/u-root/cmds/dd",
		"github.com/u-root/u-root/cmds/dhclient",
		"github.com/u-root/u-root/cmds/elvish/eval",
		"github.com/u-root/u-root/cmds/fmap",
		"github.com/u-root/u-root/cmds/gpt",
		"github.com/u-root/u-root/cmds/kill",
		"github.com/u-root/u-root/cmds/mount",
		"github.com/u-root/u-root/cmds/tail",
		"github.com/u-root/u-root/cmds/wget",
		"github.com/u-root/u-root/cmds/which",
		"github.com/u-root/u-root/cmds/wifi",
	}
	for i := 0; i < len(pkgs); i++ {
		for _, b := range blacklist {
			if pkgs[i] == b {
				pkgs = append(pkgs[:i], pkgs[i+1:]...)
			}
		}
	}

	return pkgs
}

// TestGoTest effectively runs "go test ./..." inside a QEMU instance. The
// tests run as root and can do all sorts of things not possible otherwise.
func TestGoTest(t *testing.T) {
	// Create a temporary directory.
	tmpDir, err := ioutil.TempDir("", "uroot-integration")
	if err != nil {
		t.Fatal(err)
	}

	// Statically build tests and add them to the temporary directory.
	pkgs := testPkgs(t)
	tests := []string{}
	os.Setenv("CGO_ENABLED", "0")
	testDir := filepath.Join(tmpDir, "tests")
	for _, pkg := range pkgs {
		testFile := filepath.Join(testDir, path.Base(pkg))
		cmd := exec.Command("go", "test", "-ldflags", "-s -w", "-c", pkg, "-o", testFile)
		if err := cmd.Run(); err != nil {
			t.Fatalf("could not build %s: %v", pkg, err)
		}

		// When a package does not contain any tests, the test
		// executable is not generated, so it is not included in the
		// `tests` list.
		if _, err := os.Stat(testFile); !os.IsNotExist(err) {
			tests = append(tests, pkg)
		}
	}

	// Create the CPIO and start QEMU.
	q, cleanup := QEMUTest(t, &Options{
		Cmds: []string{
			"github.com/u-root/u-root/integration/testcmd/gotest/uinit",
			"github.com/u-root/u-root/cmds/init",
			// Used by gotest/uinit.
			"github.com/u-root/u-root/cmds/mkdir",
			"github.com/u-root/u-root/cmds/mount",
			// Used by an elvish test.
			"github.com/u-root/u-root/cmds/ls",
		},
		TmpDir: tmpDir,
	})
	defer cleanup()

	// Tests are run and checked in sorted order.
	bases := []string{}
	for _, test := range tests {
		bases = append(bases, path.Base(test))
	}
	sort.Strings(bases)

	// Check that the test runner is running inside QEMU.
	headerMsg := fmt.Sprintf("TAP: 1..%d", len(bases))
	if err := q.ExpectTimeout(headerMsg, 30*time.Second); err != nil {
		t.Fatalf("cannot communicate with test runner: %v", err)
	}
	t.Log(headerMsg)

	// Check that each test passed.
	for i, base := range bases {
		runMsg := fmt.Sprintf("TAP: # running %d - %s", i, base)
		passMsg := fmt.Sprintf("TAP: ok %d - %s", i, base)
		failMsg := fmt.Sprintf("TAP: not ok %d - %s", i, base)
		passOrFailMsg := regexp.MustCompile(fmt.Sprintf("TAP: (not )?ok %d - %s", i, base))

		t.Log(runMsg)
		str, err := q.ExpectRETimeout(passOrFailMsg, 30*time.Second)
		if err != nil {
			// If we can neither find the "ok" nor the "not ok" message, the
			// test runner inside QEMU is misbehaving and we fatal early
			// instead of wasting time.
			t.Logf(failMsg)
			t.Fatal("TAP: Bail out! QEMU test runner stopped printing.")
		}

		if strings.Contains(str, passMsg) {
			t.Log(passMsg)
		} else {
			t.Error(failMsg)
		}
	}
}