|
| 1 | +//go:build integration |
| 2 | + |
| 3 | +package helpers_test |
| 4 | + |
| 5 | +import ( |
| 6 | + "fmt" |
| 7 | + "maps" |
| 8 | + "os" |
| 9 | + "path/filepath" |
| 10 | + "slices" |
| 11 | + "strings" |
| 12 | + "testing" |
| 13 | + "time" |
| 14 | + |
| 15 | + "github.com/stretchr/testify/require" |
| 16 | + "github.com/urfave/cli" |
| 17 | + |
| 18 | + "gitlab.com/gitlab-org/gitlab-runner/commands/helpers" |
| 19 | +) |
| 20 | + |
| 21 | +func newFileArchiveInitTestApp(file string, paths []string) (*cli.App, *helpers.CacheArchiverCommand) { |
| 22 | + cmd := helpers.NewCacheArchiverCommandForTest(file, paths) |
| 23 | + app := cli.NewApp() |
| 24 | + app.Name = filepath.Base(os.Args[0]) |
| 25 | + app.Commands = append(app.Commands, cli.Command{ |
| 26 | + Name: "cache-archiver", |
| 27 | + Action: cmd.Execute, |
| 28 | + }) |
| 29 | + |
| 30 | + return app, &cmd |
| 31 | +} |
| 32 | + |
| 33 | +func TestFileArchiver(t *testing.T) { |
| 34 | + var err error |
| 35 | + |
| 36 | + // Create a temporary directory to hold our project |
| 37 | + parentDir, err := os.Getwd() |
| 38 | + require.NoError(t, err, "Error retrieving working directory") |
| 39 | + |
| 40 | + dir := filepath.Join( |
| 41 | + parentDir, |
| 42 | + fmt.Sprintf("test-%s-%s", t.Name(), time.Now().Format("20060102-150405.000")), |
| 43 | + ) |
| 44 | + err = os.MkdirAll(dir, 0755) |
| 45 | + require.NoError(t, err, "Error creating directory") |
| 46 | + |
| 47 | + archive := fmt.Sprintf("%s.%s", dir, "zip") |
| 48 | + paths := []string{"**/project"} |
| 49 | + |
| 50 | + t.Cleanup(func() { |
| 51 | + t.Logf("Removing temporary directory: %s", dir) |
| 52 | + os.RemoveAll(dir) |
| 53 | + t.Logf("Removing archive: %s", archive) |
| 54 | + os.RemoveAll(archive) |
| 55 | + }) |
| 56 | + |
| 57 | + files := setupEnvironment(t, fmt.Sprintf("%s", parentDir), dir) |
| 58 | + |
| 59 | + // Start a new cli with the arguments for the command. |
| 60 | + args := []string{os.Args[0], "cache-archiver"} |
| 61 | + |
| 62 | + app, cmd := newFileArchiveInitTestApp(archive, paths) |
| 63 | + err = app.Run(args) |
| 64 | + |
| 65 | + matches := helpers.GetMatches(cmd) |
| 66 | + require.ElementsMatch(t, files, slices.Collect(maps.Keys(matches)), "Elements in archive don't match with expected") |
| 67 | +} |
| 68 | + |
| 69 | +func setupEnvironment(t *testing.T, parentDir, dir string) []string { |
| 70 | + t.Helper() |
| 71 | + |
| 72 | + t.Logf("Creating project structure in: %s", dir) |
| 73 | + |
| 74 | + // Define project root path |
| 75 | + projectRoot := filepath.Join(dir, "project") |
| 76 | + |
| 77 | + dirs := []string{ |
| 78 | + projectRoot, |
| 79 | + filepath.Join(projectRoot, "folder1"), |
| 80 | + filepath.Join(projectRoot, "folder1", "subfolder"), |
| 81 | + filepath.Join(projectRoot, "folder2"), |
| 82 | + filepath.Join(projectRoot, "folder3"), |
| 83 | + filepath.Join(projectRoot, "selfreferential"), |
| 84 | + } |
| 85 | + |
| 86 | + for _, d := range dirs { |
| 87 | + err := os.MkdirAll(d, 0755) |
| 88 | + require.NoError(t, err, "Error creating directory") |
| 89 | + } |
| 90 | + |
| 91 | + files := []string{ |
| 92 | + filepath.Join(projectRoot, "folder1", "file1.txt"), |
| 93 | + filepath.Join(projectRoot, "folder1", "subfolder", "data.csv"), |
| 94 | + filepath.Join(projectRoot, "folder2", "file2.txt"), |
| 95 | + filepath.Join(projectRoot, "folder2", "report.csv"), |
| 96 | + filepath.Join(projectRoot, "folder3", "file3.csv"), |
| 97 | + } |
| 98 | + |
| 99 | + for _, f := range files { |
| 100 | + createFile(t, f) |
| 101 | + } |
| 102 | + |
| 103 | + symlinks := []struct{ target, link string }{ |
| 104 | + {"../folder2", filepath.Join(projectRoot, "folder1", "loop")}, |
| 105 | + {"../folder1/subfolder", filepath.Join(projectRoot, "folder2", "subfolder")}, |
| 106 | + {"../../folder1", filepath.Join(projectRoot, "folder1", "subfolder", "back")}, |
| 107 | + {"../folder3", filepath.Join(projectRoot, "folder2", "another")}, |
| 108 | + {"../folder1", filepath.Join(projectRoot, "folder3", "link_to_folder1")}, |
| 109 | + {".", filepath.Join(projectRoot, "selfreferential", "myself")}, |
| 110 | + } |
| 111 | + |
| 112 | + for _, s := range symlinks { |
| 113 | + err := os.Symlink(s.target, s.link) |
| 114 | + require.NoError(t, err, "Error creating symlink") |
| 115 | + } |
| 116 | + |
| 117 | + var createdPaths []string |
| 118 | + allPaths := append(dirs, files...) |
| 119 | + for _, s := range symlinks { |
| 120 | + allPaths = append(allPaths, s.link) |
| 121 | + } |
| 122 | + |
| 123 | + for _, path := range allPaths { |
| 124 | + relPath := trimPrefixes(path, parentDir, "/", "\\") |
| 125 | + createdPaths = append(createdPaths, strings.ReplaceAll(relPath, "\\", "/")) |
| 126 | + } |
| 127 | + |
| 128 | + return createdPaths |
| 129 | +} |
| 130 | + |
| 131 | +func trimPrefixes(s string, prefixes ...string) string { |
| 132 | + for _, prefix := range prefixes { |
| 133 | + if strings.HasPrefix(s, prefix) { |
| 134 | + s = strings.TrimPrefix(s, prefix) |
| 135 | + } |
| 136 | + } |
| 137 | + |
| 138 | + return s |
| 139 | +} |
| 140 | + |
| 141 | +func createFile(t *testing.T, path string) { |
| 142 | + t.Helper() |
| 143 | + |
| 144 | + file, err := os.Create(path) |
| 145 | + require.NoError(t, err, "creating file %q", path) |
| 146 | + require.NoError(t, file.Close(), "closing file %q", path) |
| 147 | +} |
0 commit comments