summaryrefslogtreecommitdiffhomepage
path: root/test/runtimes/images/proctor/proctor.go
blob: e6178e82b32c7e75fcaa969c7b76cb8121dcc647 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Copyright 2019 The gVisor 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.

// Binary proctor runs the test for a particular runtime. It is meant to be
// included in Docker images for all runtime tests.
package main

import (
	"flag"
	"fmt"
	"log"
	"os"
	"os/exec"
	"os/signal"
	"path/filepath"
	"regexp"
	"syscall"
)

// TestRunner is an interface that must be implemented for each runtime
// integrated with proctor.
type TestRunner interface {
	// ListTests returns a string slice of tests available to run.
	ListTests() ([]string, error)

	// TestCmd returns an *exec.Cmd that will run the given test.
	TestCmd(test string) *exec.Cmd
}

var (
	runtime = flag.String("runtime", "", "name of runtime")
	list    = flag.Bool("list", false, "list all available tests")
	test    = flag.String("test", "", "run a single test from the list of available tests")
	pause   = flag.Bool("pause", false, "cause container to pause indefinitely, reaping any zombie children")
)

func main() {
	flag.Parse()

	if *pause {
		pauseAndReap()
		panic("pauseAndReap should never return")
	}

	if *runtime == "" {
		log.Fatalf("runtime flag must be provided")
	}

	tr, err := testRunnerForRuntime(*runtime)
	if err != nil {
		log.Fatalf("%v", err)
	}

	// List tests.
	if *list {
		tests, err := tr.ListTests()
		if err != nil {
			log.Fatalf("failed to list tests: %v", err)
		}
		for _, test := range tests {
			fmt.Println(test)
		}
		return
	}

	// Run a single test.
	if *test == "" {
		log.Fatalf("test flag must be provided")
	}
	cmd := tr.TestCmd(*test)
	cmd.Stdout, cmd.Stderr = os.Stdout, os.Stderr
	if err := cmd.Run(); err != nil {
		log.Fatalf("FAIL: %v", err)
	}
}

// testRunnerForRuntime returns a new TestRunner for the given runtime.
func testRunnerForRuntime(runtime string) (TestRunner, error) {
	switch runtime {
	case "go":
		return goRunner{}, nil
	case "java":
		return javaRunner{}, nil
	case "nodejs":
		return nodejsRunner{}, nil
	case "php":
		return phpRunner{}, nil
	case "python":
		return pythonRunner{}, nil
	}
	return nil, fmt.Errorf("invalid runtime %q", runtime)
}

// pauseAndReap is like init. It runs forever and reaps any children.
func pauseAndReap() {
	// Get notified of any new children.
	ch := make(chan os.Signal, 1)
	signal.Notify(ch, syscall.SIGCHLD)

	for {
		if _, ok := <-ch; !ok {
			// Channel closed. This should not happen.
			panic("signal channel closed")
		}

		// Reap the child.
		for {
			if cpid, _ := syscall.Wait4(-1, nil, syscall.WNOHANG, nil); cpid < 1 {
				break
			}
		}
	}
}

// search is a helper function to find tests in the given directory that match
// the regex.
func search(root string, testFilter *regexp.Regexp) ([]string, error) {
	var testSlice []string

	err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}

		name := filepath.Base(path)

		if info.IsDir() || !testFilter.MatchString(name) {
			return nil
		}

		relPath, err := filepath.Rel(root, path)
		if err != nil {
			return err
		}
		testSlice = append(testSlice, relPath)
		return nil
	})
	if err != nil {
		return nil, fmt.Errorf("walking %q: %v", root, err)
	}

	return testSlice, nil
}