summaryrefslogtreecommitdiffhomepage
path: root/test/benchmarks/harness/util.go
blob: 36abe10697d33f435eeaa73525dc4a9d8a6ced8d (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
// Copyright 2020 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.

package harness

import (
	"context"
	"fmt"
	"net"
	"strings"
	"testing"

	"github.com/docker/docker/api/types/mount"
	"gvisor.dev/gvisor/pkg/test/dockerutil"
	"gvisor.dev/gvisor/pkg/test/testutil"
)

//TODO(gvisor.dev/issue/3535): move to own package or move methods to harness struct.

// WaitUntilServing grabs a container from `machine` and waits for a server at
// IP:port.
func WaitUntilServing(ctx context.Context, machine Machine, server net.IP, port int) error {
	var logger testutil.DefaultLogger = "util"
	netcat := machine.GetNativeContainer(ctx, logger)
	defer netcat.CleanUp(ctx)

	cmd := fmt.Sprintf("while ! wget -q --spider http://%s:%d; do true; done", server, port)
	_, err := netcat.Run(ctx, dockerutil.RunOpts{
		Image: "benchmarks/util",
	}, "sh", "-c", cmd)
	return err
}

// DropCaches drops caches on the provided machine. Requires root.
func DropCaches(machine Machine) error {
	if out, err := machine.RunCommand("/bin/sh", "-c", "sync && sysctl vm.drop_caches=3"); err != nil {
		return fmt.Errorf("failed to drop caches: %v logs: %s", err, out)
	}
	return nil
}

// DebugLog prints debug messages if the debug flag is set.
func DebugLog(b *testing.B, msg string, args ...interface{}) {
	b.Helper()
	if *debug {
		b.Logf(msg, args...)
	}
}

const (
	// BindFS indicates a bind mount should be created.
	BindFS = "bindfs"
	// TmpFS indicates a tmpfs mount should be created.
	TmpFS = "tmpfs"
	// RootFS indicates no mount should be created and the root mount should be used.
	RootFS = "rootfs"
)

// MakeMount makes a mount and cleanup based on the requested type. Bind
// and volume mounts are backed by a temp directory made with mktemp.
// tmpfs mounts require no such backing and are just made.
// rootfs mounts do not make a mount, but instead return a target direectory at root.
// It is up to the caller to call the returned cleanup.
func MakeMount(machine Machine, fsType string) ([]mount.Mount, string, func(), error) {
	mounts := make([]mount.Mount, 0, 1)
	switch fsType {
	case BindFS:
		dir, err := machine.RunCommand("mktemp", "-d")
		if err != nil {
			return mounts, "", func() {}, fmt.Errorf("failed to create tempdir: %v", err)
		}
		dir = strings.TrimSuffix(dir, "\n")

		out, err := machine.RunCommand("chmod", "777", dir)
		if err != nil {
			machine.RunCommand("rm", "-rf", dir)
			return mounts, "", func() {}, fmt.Errorf("failed modify directory: %v %s", err, out)
		}
		target := "/data"
		mounts = append(mounts, mount.Mount{
			Target: target,
			Source: dir,
			Type:   mount.TypeBind,
		})
		return mounts, target, func() { machine.RunCommand("rm", "-rf", dir) }, nil
	case RootFS:
		return mounts, "/", func() {}, nil
	case TmpFS:
		target := "/data"
		mounts = append(mounts, mount.Mount{
			Target: target,
			Type:   mount.TypeTmpfs,
		})
		return mounts, target, func() {}, nil
	default:
		return mounts, "", func() {}, fmt.Errorf("illegal mount type not supported: %v", fsType)
	}
}