//go:build !integration package download import ( "fmt" "os" "path/filepath" "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "go.uber.org/mock/gomock" gitlab "gitlab.com/gitlab-org/api/client-go/v3" gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing" "gitlab.com/gitlab-org/cli/internal/testing/cmdtest" ) const ( fileContents = "Hello" fileContentsChecksum = "185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969" repoName = "OWNER/REPO" ) func mockChecksumLookup(tc *gitlabtesting.TestClient, checksum string) { mockChecksumLookupFiles(tc, []*gitlab.PackageFile{{ID: 1, FileName: "app.zip", FileSHA256: checksum}}) } func mockChecksumLookupFiles(tc *gitlabtesting.TestClient, files []*gitlab.PackageFile) { tc.MockPackages.EXPECT(). ListProjectPackages(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.Package{{ID: 7, Name: "my-package", Version: "1.0.0", PackageType: "generic"}}, &gitlab.Response{}, nil) tc.MockPackages.EXPECT(). ListPackageFiles(repoName, int64(7), gomock.Any(), gomock.Any(), gomock.Any()). Return(files, &gitlab.Response{}, nil) } func Test_PackagesDownload(t *testing.T) { testCases := []struct { name string cli string expectedMsg []string expectedFileName string wantErr bool wantStderr string setup func(t *testing.T) setupMocks func(*gitlabtesting.TestClient) }{ { name: "Download with checksum verification", cli: "--name my-package --version 1.0.0 --filename app.zip", expectedMsg: []string{"Downloaded package file to 'app.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "app.zip", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, fileContentsChecksum) }, }, { name: "Republished file verifies against the most recent upload", cli: "--name my-package --version 1.0.0 --filename app.zip", expectedMsg: []string{"Downloaded package file to 'app.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "app.zip", setupMocks: func(tc *gitlabtesting.TestClient) { // The download endpoint serves the newest file with a given name, // while the package files list is ordered by ID ascending. tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookupFiles(tc, []*gitlab.PackageFile{ {ID: 1, FileName: "app.zip", FileSHA256: "checksum_of_the_old_upload"}, {ID: 2, FileName: "app.zip", FileSHA256: fileContentsChecksum}, {ID: 3, FileName: "other.zip", FileSHA256: "checksum_of_another_file"}, }) }, }, { name: "Republished file verifies against the highest ID in any list order", cli: "--name my-package --version 1.0.0 --filename app.zip", expectedMsg: []string{"Downloaded package file to 'app.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "app.zip", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookupFiles(tc, []*gitlab.PackageFile{ {ID: 9, FileName: "app.zip", FileSHA256: fileContentsChecksum}, {ID: 4, FileName: "app.zip", FileSHA256: "checksum_of_the_old_upload"}, }) }, }, { name: "Download to a custom path", cli: "--name my-package --version 1.0.0 --filename app.zip --path newdir/new.zip", expectedMsg: []string{"Downloaded package file to 'newdir/new.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "newdir/new.zip", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, fileContentsChecksum) }, }, { name: "Download without checksum verification", cli: "--name my-package --version 1.0.0 --filename app.zip --no-verify", expectedMsg: []string{"Downloaded package file to 'app.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "app.zip", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) }, }, { name: "Download with invalid checksum", cli: "--name my-package --version 1.0.0 --filename app.zip", wantErr: true, wantStderr: "checksum verification failed for app.zip: expected invalid_checksum, got " + fileContentsChecksum, setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, "invalid_checksum") }, }, { name: "Download into a directory keeps the original name", cli: "--name my-package --version 1.0.0 --filename app.zip --path subdir/", expectedMsg: []string{"Downloaded package file to 'subdir/app.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "subdir/app.zip", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, fileContentsChecksum) }, }, { name: "Download into an existing directory keeps the original name", cli: "--name my-package --version 1.0.0 --filename app.zip --path existing", expectedMsg: []string{"Downloaded package file to 'existing/app.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "existing/app.zip", setup: func(t *testing.T) { t.Helper() require.NoError(t, os.Mkdir("existing", 0o755)) }, setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, fileContentsChecksum) }, }, { name: "Force overwrites an existing file", cli: "--name my-package --version 1.0.0 --filename app.zip --force", expectedMsg: []string{"Downloaded package file to 'app.zip' (Package: my-package, Version: 1.0.0)\n"}, expectedFileName: "app.zip", setup: func(t *testing.T) { t.Helper() require.NoError(t, os.WriteFile("app.zip", []byte("stale"), 0o644)) }, setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, fileContentsChecksum) }, }, { name: "Existing file without force errors", cli: "--name my-package --version 1.0.0 --filename app.zip", wantErr: true, wantStderr: "file app.zip already exists; use --force to overwrite current file", setup: func(t *testing.T) { t.Helper() require.NoError(t, os.WriteFile("app.zip", []byte("stale"), 0o644)) }, setupMocks: func(tc *gitlabtesting.TestClient) {}, }, { name: "Download but API errors", cli: "--name my-package --version 1.0.0 --filename app.zip --no-verify", wantErr: true, wantStderr: "failed to download package file: GET https://gitlab.com/api/v4/projects/OWNER%2FREPO/packages/generic: 404", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return(nil, nil, fmt.Errorf("GET https://gitlab.com/api/v4/projects/OWNER%%2FREPO/packages/generic: 404")) }, }, { name: "Download but package not found", cli: "--name my-package --version 1.0.0 --filename app.zip", wantErr: true, wantStderr: "failed to look up package: couldn't locate package \"my-package\" with package-type \"generic\" and version \"1.0.0\"", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) tc.MockPackages.EXPECT(). ListProjectPackages(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return(nil, &gitlab.Response{}, nil) }, }, { name: "Download but several packages match", cli: "--name my-package --version 1.0.0 --filename app.zip", wantErr: true, wantStderr: "failed to look up package: found 2 packages named \"my-package\" with package-type \"generic\" and version \"1.0.0\" (IDs: 7, 8)", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) tc.MockPackages.EXPECT(). ListProjectPackages(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.Package{ {ID: 7, Name: "my-package", Version: "1.0.0", PackageType: "generic"}, {ID: 8, Name: "my-package", Version: "1.0.0", PackageType: "generic"}, }, &gitlab.Response{}, nil) }, }, { name: "Download missing file in package", cli: "--name my-package --version 1.0.0 --filename missing.zip", wantErr: true, wantStderr: "couldn't locate file missing.zip in package my-package version 1.0.0", setupMocks: func(tc *gitlabtesting.TestClient) { tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "missing.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, fileContentsChecksum) }, }, } for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { tempDir := t.TempDir() t.Chdir(tempDir) if tc.setup != nil { tc.setup(t) } testClient := gitlabtesting.NewTestClient(t) tc.setupMocks(testClient) exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(testClient.Client), ) out, err := exec(tc.cli) if tc.wantErr { require.Error(t, err) assert.Equal(t, tc.wantStderr, err.Error()) return } require.NoError(t, err) for _, msg := range tc.expectedMsg { require.Contains(t, out.String(), msg) } actualContent, err := os.ReadFile(tc.expectedFileName) require.NoError(t, err, "Failed to read downloaded test file") assert.Equal(t, fileContents, string(actualContent), "File content should match") }) } } // The table above can only carry static CLI strings, so the absolute-path // cases live here where a t.TempDir() can be interpolated. func Test_PackagesDownload_AbsoluteDestination(t *testing.T) { mockDownload := func(t *testing.T, checksum string) *gitlabtesting.TestClient { t.Helper() tc := gitlabtesting.NewTestClient(t) tc.MockGenericPackages.EXPECT(). DownloadPackageFile(repoName, "my-package", "1.0.0", "app.zip", gomock.Any()). Return([]byte(fileContents), nil, nil) mockChecksumLookup(tc, checksum) return tc } const cli = "--name my-package --version 1.0.0 --filename app.zip --path " t.Run("absolute path creates missing parents and writes the file", func(t *testing.T) { t.Chdir(t.TempDir()) dest := filepath.Join(t.TempDir(), "nested", "deeper", "out.zip") exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(mockDownload(t, fileContentsChecksum).Client)) out, err := exec(cli + dest) require.NoError(t, err) assert.Contains(t, out.String(), "Downloaded package file to '"+dest+"'") got, err := os.ReadFile(dest) require.NoError(t, err) assert.Equal(t, fileContents, string(got)) }) t.Run("absolute path naming an existing directory appends the filename", func(t *testing.T) { t.Chdir(t.TempDir()) destDir := t.TempDir() exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(mockDownload(t, fileContentsChecksum).Client)) _, err := exec(cli + destDir) require.NoError(t, err) got, err := os.ReadFile(filepath.Join(destDir, "app.zip")) require.NoError(t, err) assert.Equal(t, fileContents, string(got)) }) // The existing-file guard reads through the same root, so it has to keep // working once that root is anchored at an absolute destination. t.Run("absolute path refuses to overwrite without --force", func(t *testing.T) { t.Chdir(t.TempDir()) dest := filepath.Join(t.TempDir(), "out.zip") require.NoError(t, os.WriteFile(dest, []byte("existing"), 0o600)) exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(gitlabtesting.NewTestClient(t).Client)) _, err := exec(cli + dest) require.Error(t, err) assert.Equal(t, fmt.Sprintf("file %s already exists; use --force to overwrite current file", dest), err.Error()) got, err := os.ReadFile(dest) require.NoError(t, err) assert.Equal(t, "existing", string(got), "the existing file must be left untouched") }) t.Run("absolute path overwrites with --force", func(t *testing.T) { t.Chdir(t.TempDir()) dest := filepath.Join(t.TempDir(), "out.zip") require.NoError(t, os.WriteFile(dest, []byte("existing"), 0o600)) exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(mockDownload(t, fileContentsChecksum).Client)) _, err := exec(cli + dest + " --force") require.NoError(t, err) got, err := os.ReadFile(dest) require.NoError(t, err) assert.Equal(t, fileContents, string(got)) }) t.Run("failed checksum leaves no temporary file behind", func(t *testing.T) { t.Chdir(t.TempDir()) destDir := t.TempDir() dest := filepath.Join(destDir, "out.zip") exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(mockDownload(t, "invalid_checksum").Client)) _, err := exec(cli + dest) require.Error(t, err) entries, readErr := os.ReadDir(destDir) require.NoError(t, readErr) assert.Empty(t, entries, "destination directory should hold no temporary leftovers") }) }