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
|
//go:build !gitaly_test_sha256
package config
import (
"errors"
"os"
"os/exec"
"path/filepath"
"testing"
"github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper"
)
func TestPruneOldGitalyProcessDirectories(t *testing.T) {
t.Run("no runtime directories", func(t *testing.T) {
require.NoError(t, PruneOldGitalyProcessDirectories(testhelper.NewDiscardingLogEntry(t), testhelper.TempDir(t)))
})
t.Run("unset runtime directory", func(t *testing.T) {
require.EqualError(t,
PruneOldGitalyProcessDirectories(testhelper.NewDiscardingLogEntry(t), ""), "list gitaly process directory: open : no such file or directory")
})
t.Run("non-existent runtime directory", func(t *testing.T) {
require.EqualError(t,
PruneOldGitalyProcessDirectories(testhelper.NewDiscardingLogEntry(t),
"/path/does/not/exist"), "list gitaly process directory: open /path/does/not/exist: no such file or directory")
})
t.Run("invalid, stale and active runtime directories", func(t *testing.T) {
baseDir := testhelper.TempDir(t)
cfg := Cfg{RuntimeDir: baseDir}
// Setup a runtime directory for our process, it can't be stale as long as
// we are running.
ownRuntimeDir, err := SetupRuntimeDirectory(cfg, os.Getpid())
require.NoError(t, err)
expectedLogs := map[string]string{}
expectedErrs := map[string]error{}
// Setup runtime directories for processes that have finished.
var prunableDirs []string
for i := 0; i < 2; i++ {
cmd := exec.Command("cat")
require.NoError(t, cmd.Run())
staleRuntimeDir, err := SetupRuntimeDirectory(cfg, cmd.Process.Pid)
require.NoError(t, err)
prunableDirs = append(prunableDirs, staleRuntimeDir)
expectedLogs[staleRuntimeDir] = "removed leftover gitaly process directory"
}
// Setup runtime directory with pid of process not owned by git user
rootRuntimeDir, err := SetupRuntimeDirectory(cfg, 1)
require.NoError(t, err)
expectedLogs[rootRuntimeDir] = "removed leftover gitaly process directory"
prunableDirs = append(prunableDirs, rootRuntimeDir)
// Create an unexpected file in the runtime directory
unexpectedFilePath := filepath.Join(baseDir, "unexpected-file")
require.NoError(t, os.WriteFile(unexpectedFilePath, []byte(""), os.ModePerm))
expectedLogs[unexpectedFilePath] = "could not prune entry"
expectedErrs[unexpectedFilePath] = errors.New("gitaly process directory contains an unexpected file")
nonPrunableDirs := []string{ownRuntimeDir}
// Setup some unexpected directories in the runtime directory
for _, dirName := range []string{
"nohyphen",
"too-many-hyphens",
"invalidprefix-3",
"gitaly-invalidpid",
} {
dirPath := filepath.Join(baseDir, dirName)
require.NoError(t, os.Mkdir(dirPath, os.ModePerm))
expectedLogs[dirPath] = "could not prune entry"
expectedErrs[dirPath] = errors.New("gitaly process directory contains an unexpected directory")
nonPrunableDirs = append(nonPrunableDirs, dirPath)
}
logger, hook := test.NewNullLogger()
require.NoError(t, PruneOldGitalyProcessDirectories(logger, cfg.RuntimeDir))
actualLogs := map[string]string{}
actualErrs := map[string]error{}
for _, entry := range hook.Entries {
actualLogs[entry.Data["path"].(string)] = entry.Message
if entry.Data["error"] != nil {
err, ok := entry.Data["error"].(error)
require.True(t, ok)
actualErrs[entry.Data["path"].(string)] = err
}
}
require.Equal(t, expectedLogs, actualLogs)
require.Equal(t, expectedErrs, actualErrs)
require.FileExists(t, unexpectedFilePath)
for _, nonPrunableEntry := range nonPrunableDirs {
require.DirExists(t, nonPrunableEntry, nonPrunableEntry)
}
for _, prunableEntry := range prunableDirs {
require.NoDirExists(t, prunableEntry, prunableEntry)
}
})
}
|
