summaryrefslogtreecommitdiffhomepage
path: root/pkg/test/dockerutil/profile_test.go
blob: b7b4d761861227ca1c5453ad325d59356a49ffa0 (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
// 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 dockerutil

import (
	"context"
	"fmt"
	"os"
	"path/filepath"
	"testing"
	"time"
)

type testCase struct {
	name          string
	pprof         Pprof
	expectedFiles []string
}

func TestPprof(t *testing.T) {
	// Basepath and expected file names for each type of profile.
	basePath := "/tmp/test/profile"
	block := "block.pprof"
	cpu := "cpu.pprof"
	goprofle := "go.pprof"
	heap := "heap.pprof"
	mutex := "mutex.pprof"

	testCases := []testCase{
		{
			name: "Cpu",
			pprof: Pprof{
				BasePath:   basePath,
				CPUProfile: true,
				Duration:   2 * time.Second,
			},
			expectedFiles: []string{cpu},
		},
		{
			name: "All",
			pprof: Pprof{
				BasePath:         basePath,
				BlockProfile:     true,
				CPUProfile:       true,
				GoRoutineProfile: true,
				HeapProfile:      true,
				MutexProfile:     true,
				Duration:         2 * time.Second,
			},
			expectedFiles: []string{block, cpu, goprofle, heap, mutex},
		},
	}
	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			ctx := context.Background()
			c := MakeContainer(ctx, t)
			// Set basepath to include the container name so there are no conflicts.
			tc.pprof.BasePath = filepath.Join(tc.pprof.BasePath, c.Name)
			c.AddProfile(&tc.pprof)

			func() {
				defer c.CleanUp(ctx)
				// Start a container.
				if err := c.Spawn(ctx, RunOpts{
					Image: "basic/alpine",
				}, "sleep", "1000"); err != nil {
					t.Fatalf("run failed with: %v", err)
				}

				if status, err := c.Status(context.Background()); !status.Running {
					t.Fatalf("container is not yet running: %+v err: %v", status, err)
				}

				// End early if the expected files exist and have data.
				for start := time.Now(); time.Since(start) < tc.pprof.Duration; time.Sleep(500 * time.Millisecond) {
					if err := checkFiles(tc); err == nil {
						break
					}
				}
			}()

			// Check all expected files exist and have data.
			if err := checkFiles(tc); err != nil {
				t.Fatalf(err.Error())
			}
		})
	}
}

func checkFiles(tc testCase) error {
	for _, file := range tc.expectedFiles {
		stat, err := os.Stat(filepath.Join(tc.pprof.BasePath, file))
		if err != nil {
			return fmt.Errorf("stat failed with: %v", err)
		} else if stat.Size() < 1 {
			return fmt.Errorf("file not written to: %+v", stat)
		}
	}
	return nil
}

func TestMain(m *testing.M) {
	EnsureSupportedDockerVersion()
	os.Exit(m.Run())
}