Only run testarchive tests as part of nightlies (#3511)

These tests are not important to run regularly. This PR makes it a part
of nightlies to get some signal but not have these tests run on every
PR.

In order to convert these tests to nightlies we also remove main.go. The
DBR test runner can directly call the CreateArchive function instead.

Addresses post merge comment:
#3500 (comment)

Author: shreyas-goenka

internal/testarchive/archive_test.go integration/testarchive/archive_test.gointernal/testarchive/archive_test.go renamed to integration/testarchive/archive_test.go

@@ -1,9 +1,11 @@
-package main
+package testarchive
 
 import (
 	"path/filepath"
 	"testing"
 
+	"github.com/databricks/cli/internal/testarchive"
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -13,17 +15,19 @@ func TestArchive(t *testing.T) {
 		t.Skip("Skipping test in short mode")
 	}
 
+	testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
+
 	t.Parallel()
 
 	archiveDir := t.TempDir()
 	binDir := t.TempDir()
 	repoRoot := "../.."
 
-	err := createArchive(archiveDir, binDir, repoRoot)
+	err := testarchive.CreateArchive(archiveDir, binDir, repoRoot)
 	require.NoError(t, err)
 
 	assertDir := t.TempDir()
-	err = extractTarGz(filepath.Join(archiveDir, "archive.tar.gz"), assertDir)
+	err = testarchive.ExtractTarGz(filepath.Join(archiveDir, "archive.tar.gz"), assertDir)
 	require.NoError(t, err)
 
 	// Go installation is a directory because it includes the

internal/testarchive/downloader_test.go …tegration/testarchive/downloader_test.gointernal/testarchive/downloader_test.go renamed to integration/testarchive/downloader_test.go internal/testarchive/downloader_test.go renamed to integration/testarchive/downloader_test.go

@@ -1,10 +1,12 @@
-package main
+package testarchive
 
 import (
 	"os"
 	"path/filepath"
 	"testing"
 
+	"github.com/databricks/cli/internal/testarchive"
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -16,10 +18,12 @@ func TestUvDownloader(t *testing.T) {
 
 	t.Parallel()
 
+	testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
+
 	tmpDir := t.TempDir()
 
 	for _, arch := range []string{"arm64", "amd64"} {
-		err := uvDownloader{arch: arch, binDir: tmpDir}.Download()
+		err := testarchive.UvDownloader{Arch: arch, BinDir: tmpDir}.Download()
 		require.NoError(t, err)
 
 		files, err := os.ReadDir(filepath.Join(tmpDir, arch))
@@ -37,10 +41,12 @@ func TestJqDownloader(t *testing.T) {
 
 	t.Parallel()
 
+	testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
+
 	tmpDir := t.TempDir()
 
 	for _, arch := range []string{"arm64", "amd64"} {
-		err := jqDownloader{arch: arch, binDir: tmpDir}.Download()
+		err := testarchive.JqDownloader{Arch: arch, BinDir: tmpDir}.Download()
 		require.NoError(t, err)
 
 		files, err := os.ReadDir(filepath.Join(tmpDir, arch))
@@ -58,10 +64,12 @@ func TestGoDownloader(t *testing.T) {
 
 	t.Parallel()
 
+	testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
+
 	tmpDir := t.TempDir()
 
 	for _, arch := range []string{"arm64", "amd64"} {
-		err := goDownloader{arch: arch, binDir: tmpDir}.Download()
+		err := testarchive.GoDownloader{Arch: arch, BinDir: tmpDir}.Download()
 		require.NoError(t, err)
 
 		entries, err := os.ReadDir(filepath.Join(tmpDir, arch))

internal/testarchive/.gitignore

@@ -1,4 +1,4 @@
-package main
+package testarchive
 
 import (
 	"archive/tar"
@@ -97,18 +97,18 @@ func addFileToArchive(tarWriter *tar.Writer, src, dst string) error {
 	return nil
 }
 
-// createArchive creates a tar.gz archive of all git-tracked files plus downloaded tools
-func createArchive(archiveDir, binDir, repoRoot string) error {
+// CreateArchive creates a tar.gz archive of all git-tracked files plus downloaded tools
+func CreateArchive(archiveDir, binDir, repoRoot string) error {
 	archivePath := filepath.Join(archiveDir, "archive.tar.gz")
 
 	// Download tools for both arm and amd64 architectures.
 	// The right architecture to use is decided at runtime on the serverless driver.
 	// The Databricks platform explicitly does not provide any guarantees around
 	// the CPU architecture to keep the door open for future optimizations.
 	downloaders := []downloader{
-		goDownloader{arch: "amd64", binDir: binDir},
-		uvDownloader{arch: "amd64", binDir: binDir},
-		jqDownloader{arch: "amd64", binDir: binDir},
+		GoDownloader{Arch: "amd64", BinDir: binDir},
+		UvDownloader{Arch: "amd64", BinDir: binDir},
+		JqDownloader{Arch: "amd64", BinDir: binDir},
 
 		// TODO: Serverless clusters do not support arm64 yet.
 		// Enable ARM64 once serverless clusters support it.

internal/testarchive/archive.go

@@ -1,4 +1,4 @@
-package main
+package testarchive
 
 import (
 	"bufio"
@@ -10,24 +10,16 @@ import (
 	"strings"
 )
 
-// Initialize these to prevent linter from complaining about unused types.
-// This can be removed once we actually use these downloaders.
-var (
-	_ = goDownloader{}
-	_ = uvDownloader{}
-	_ = jqDownloader{}
-)
-
 type downloader interface {
 	Download() error
 }
 
-type goDownloader struct {
-	binDir string
-	arch   string
+type GoDownloader struct {
+	BinDir string
+	Arch   string
 }
 
-func (g goDownloader) readGoVersionFromMod() (string, error) {
+func (g GoDownloader) readGoVersionFromMod() (string, error) {
 	goModPath := filepath.Join("..", "..", "go.mod")
 
 	file, err := os.Open(goModPath)
@@ -57,21 +49,21 @@ func (g goDownloader) readGoVersionFromMod() (string, error) {
 }
 
 // Download downloads and extracts Go for Linux
-func (g goDownloader) Download() error {
+func (g GoDownloader) Download() error {
 	goVersion, err := g.readGoVersionFromMod()
 	if err != nil {
 		return fmt.Errorf("failed to read Go version from go.mod: %w", err)
 	}
 
 	// Create the directory for the download if it doesn't exist
-	dir := filepath.Join(g.binDir, g.arch)
+	dir := filepath.Join(g.BinDir, g.Arch)
 	err = os.MkdirAll(dir, 0o755)
 	if err != nil {
 		return err
 	}
 
 	// Download the tar archive.
-	fileName := fmt.Sprintf("go%s.linux-%s.tar.gz", goVersion, g.arch)
+	fileName := fmt.Sprintf("go%s.linux-%s.tar.gz", goVersion, g.Arch)
 	url := "https://go.dev/dl/" + fileName
 
 	tempFile := filepath.Join(dir, fileName)
@@ -80,7 +72,7 @@ func (g goDownloader) Download() error {
 		return err
 	}
 
-	err = extractTarGz(tempFile, dir)
+	err = ExtractTarGz(tempFile, dir)
 	if err != nil {
 		return err
 	}

internal/testarchive/go.go

@@ -1,28 +1,28 @@
-package main
+package testarchive
 
 import (
 	"fmt"
 	"os"
 	"path/filepath"
 )
 
-// jqDownloader handles downloading and extracting jq releases
-type jqDownloader struct {
-	binDir string
-	arch   string
+// JqDownloader handles downloading and extracting jq releases
+type JqDownloader struct {
+	BinDir string
+	Arch   string
 }
 
 // Download downloads and extracts jq for Linux
-func (j jqDownloader) Download() error {
+func (j JqDownloader) Download() error {
 	// create the directory for the download if it doesn't exist
-	dir := filepath.Join(j.binDir, j.arch)
+	dir := filepath.Join(j.BinDir, j.Arch)
 	err := os.MkdirAll(dir, 0o755)
 	if err != nil {
 		return err
 	}
 
 	// Construct the download URL for the latest release
-	url := "https://github.com/jqlang/jq/releases/latest/download/jq-linux-" + j.arch
+	url := "https://github.com/jqlang/jq/releases/latest/download/jq-linux-" + j.Arch
 
 	binaryPath := filepath.Join(dir, "jq")
 	if err := downloadFile(url, binaryPath); err != nil {

internal/testarchive/jq.go

@@ -1,4 +1,4 @@
-package main
+package testarchive
 
 import (
 	"archive/tar"
@@ -36,8 +36,8 @@ func downloadFile(url, outputPath string) error {
 	return nil
 }
 
-// extractTarGz extracts a tar.gz file to the specified directory
-func extractTarGz(archivePath, destDir string) error {
+// ExtractTarGz extracts a tar.gz file to the specified directory
+func ExtractTarGz(archivePath, destDir string) error {
 	fmt.Printf("Extracting %s to %s\n", archivePath, destDir)
 
 	file, err := os.Open(archivePath)

internal/testarchive/main.go

@@ -1,21 +1,21 @@
-package main
+package testarchive
 
 import (
 	"fmt"
 	"os"
 	"path/filepath"
 )
 
-// uvDownloader handles downloading and extracting UV releases
-type uvDownloader struct {
-	binDir string
-	arch   string
+// UvDownloader handles downloading and extracting UV releases
+type UvDownloader struct {
+	BinDir string
+	Arch   string
 }
 
 // uvDownloader creates a new UV downloader
 
 // mapArchitecture maps our architecture names to UV's naming convention
-func (u uvDownloader) mapArchitecture(arch string) (string, error) {
+func (u UvDownloader) mapArchitecture(arch string) (string, error) {
 	switch arch {
 	case "arm64":
 		return "aarch64", nil
@@ -27,15 +27,15 @@ func (u uvDownloader) mapArchitecture(arch string) (string, error) {
 }
 
 // Download downloads and extracts UV for Linux
-func (u uvDownloader) Download() error {
+func (u UvDownloader) Download() error {
 	// Map architecture names to UV's naming convention
-	uvArch, err := u.mapArchitecture(u.arch)
+	uvArch, err := u.mapArchitecture(u.Arch)
 	if err != nil {
 		return err
 	}
 
 	// create the directory for the download if it doesn't exist
-	dir := filepath.Join(u.binDir, u.arch)
+	dir := filepath.Join(u.BinDir, u.Arch)
 	err = os.MkdirAll(dir, 0o755)
 	if err != nil {
 		return err
@@ -52,7 +52,7 @@ func (u uvDownloader) Download() error {
 	}
 
 	// Extract the archive to the directory
-	if err := extractTarGz(tempFile, dir); err != nil {
+	if err := ExtractTarGz(tempFile, dir); err != nil {
 		return err
 	}