chore: parameterize SubCommandTest with configLevel

.github/workflows/go.yml

@@ -59,3 +59,20 @@ jobs:
         # the file with `test_registry` also requires windows, so we can safely add this tag
         # without it running on non-windows OSes
         run: go test -v -tags test_registry ./...
+
+      # User and System level tests
+      - name: Run Tests (User)
+        run: go test -v ./...
+        env:
+          DBC_TEST_LEVEL_USER: 1
+      - name: Run Tests (System, Unixlike)
+        # Run system tests with sudo on Unixlikes to replicate what users do
+        if: runner.os != 'Windows'
+        run: sudo -E go test -v ./...
+        env:
+          DBC_TEST_LEVEL_SYSTEM: 1
+      - name: Run Tests (System, Windows)
+        if: runner.os == 'Windows'
+        run: go test -v ./...
+        env:
+          DBC_TEST_LEVEL_SYSTEM: 1

cmd/dbc/install_test.go

@@ -23,21 +23,20 @@ import (
 )
 
 func (suite *SubcommandTestSuite) TestInstall() {
-	m := InstallCmd{Driver: "test-driver-1", Level: config.ConfigEnv}.
+	m := InstallCmd{Driver: "test-driver-1", Level: suite.configLevel}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 	out := suite.runCmd(m)
 
 	suite.validateOutput("\r[✓] searching\r\n[✓] downloading\r\n[✓] installing\r\n[✓] verifying signature\r\n",
-		"\nInstalled test-driver-1 1.1.0 to "+suite.tempdir+"\n", out)
-	if runtime.GOOS != "windows" {
-		suite.FileExists(filepath.Join(suite.tempdir, "test-driver-1.toml"))
-	}
+		"\nInstalled test-driver-1 1.1.0 to "+suite.Dir()+"\n", out)
+	suite.driverIsInstalled("test-driver-1", true)
 }
 
 func (suite *SubcommandTestSuite) TestInstallDriverNotFound() {
-	m := InstallCmd{Driver: "foo", Level: config.ConfigEnv}.
+	m := InstallCmd{Driver: "foo", Level: suite.configLevel}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 	suite.validateOutput("Error: could not find driver: driver `foo` not found in driver registry index\r\n\r ", "", suite.runCmdErr(m))
+	suite.driverIsNotInstalled("test-driver-1")
 }
 
 func (suite *SubcommandTestSuite) TestInstallWithVersion() {
@@ -54,13 +53,14 @@ func (suite *SubcommandTestSuite) TestInstallWithVersion() {
 
 	for _, tt := range tests {
 		suite.Run(tt.driver, func() {
-			m := InstallCmd{Driver: tt.driver}.
+			m := InstallCmd{Driver: tt.driver, Level: suite.configLevel}.
 				GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 			out := suite.runCmd(m)
-			suite.validateOutput("\r[✓] searching\r\n[✓] downloading\r\n[✓] installing\r\n[✓] verifying signature\r\n",
-				"\nInstalled test-driver-1 "+tt.expectedVersion+" to "+suite.tempdir+"\n", out)
 
-			m = UninstallCmd{Driver: "test-driver-1"}.GetModelCustom(
+			suite.validateOutput("\r[✓] searching\r\n[✓] downloading\r\n[✓] installing\r\n[✓] verifying signature\r\n",
+				"\nInstalled test-driver-1 "+tt.expectedVersion+" to "+suite.Dir()+"\n", out)
+			suite.driverIsInstalled("test-driver-1", true)
+			m = UninstallCmd{Driver: "test-driver-1", Level: suite.configLevel}.GetModelCustom(
 				baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 			suite.runCmd(m)
 		})
@@ -91,59 +91,9 @@ func (suite *SubcommandTestSuite) TestReinstallUpdateVersion() {
 		"test-driver-1.1/test-driver-1-not-valid.so.sig", "test-driver-1.toml"}, suite.getFilesInTempDir())
 }
 
-func (suite *SubcommandTestSuite) TestInstallUserFake() {
-	if runtime.GOOS == "windows" {
-		suite.T().Skip()
-	}
-
-	os.Unsetenv("ADBC_DRIVER_PATH")
-
-	m := InstallCmd{Driver: "test-driver-1"}.
-		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
-	installModel := m.(progressiveInstallModel)
-	suite.Equal(installModel.cfg.Level, config.ConfigUser)
-	installModel.cfg.Location = filepath.Join(suite.tempdir, "root", installModel.cfg.Location)
-	m = installModel // <- We need to reassign to make the change stick
-	suite.runCmd(m)
-	suite.FileExists(filepath.Join(installModel.cfg.Location, "test-driver-1.toml"))
-}
-
-func (suite *SubcommandTestSuite) TestInstallUserFakeExplicit() {
-	if runtime.GOOS == "windows" {
-		suite.T().Skip()
-	}
-
-	os.Unsetenv("ADBC_DRIVER_PATH")
-
-	m := InstallCmd{Driver: "test-driver-1", Level: config.ConfigUser}.
-		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
-	installModel := m.(progressiveInstallModel)
-	suite.Equal(installModel.cfg.Level, config.ConfigUser)
-	installModel.cfg.Location = filepath.Join(suite.tempdir, "root", installModel.cfg.Location)
-	m = installModel // <- We need to reassign to make the change stick
-	suite.runCmd(m)
-	suite.FileExists(filepath.Join(installModel.cfg.Location, "test-driver-1.toml"))
-}
-
-func (suite *SubcommandTestSuite) TestInstallSystemFake() {
-	if runtime.GOOS == "windows" {
-		suite.T().Skip()
-	}
-
-	m := InstallCmd{Driver: "test-driver-1", Level: config.ConfigSystem}.
-		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
-	installModel := m.(progressiveInstallModel)
-	suite.Equal(installModel.cfg.Level, config.ConfigSystem)
-	installModel.cfg.Location = filepath.Join(suite.tempdir, "root", installModel.cfg.Location)
-	m = installModel // <- We need to reassign to make the change stick
-	suite.runCmd(m)
-	suite.FileExists(filepath.Join(installModel.cfg.Location, "test-driver-1.toml"))
-}
-
 func (suite *SubcommandTestSuite) TestInstallVenv() {
-	os.Unsetenv("ADBC_DRIVER_PATH")
-	os.Setenv("VIRTUAL_ENV", suite.tempdir)
-	defer os.Unsetenv("VIRTUAL_ENV")
+	suite.T().Setenv("ADBC_DRIVER_PATH", "")
+	suite.T().Setenv("VIRTUAL_ENV", suite.tempdir)
 
 	m := InstallCmd{Driver: "test-driver-1"}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
@@ -158,9 +108,10 @@ func (suite *SubcommandTestSuite) TestInstallEnvironmentPrecedence() {
 	driver_path := filepath.Join(suite.tempdir, "driver_path")
 	venv_path := filepath.Join(suite.tempdir, "venv_path")
 	conda_path := filepath.Join(suite.tempdir, "conda_path")
-	os.Setenv("ADBC_DRIVER_PATH", driver_path)
-	os.Setenv("VIRTUAL_ENV", venv_path)
-	os.Setenv("CONDA_PREFIX", conda_path)
+
+	suite.T().Setenv("ADBC_DRIVER_PATH", driver_path)
+	suite.T().Setenv("VIRTUAL_ENV", venv_path)
+	suite.T().Setenv("CONDA_PREFIX", conda_path)
 
 	m := InstallCmd{Driver: "test-driver-1", Level: config.ConfigEnv}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
@@ -170,59 +121,38 @@ func (suite *SubcommandTestSuite) TestInstallEnvironmentPrecedence() {
 	suite.NoFileExists(filepath.Join(venv_path, "test-driver-1.toml"))
 	suite.NoFileExists(filepath.Join(conda_path, "test-driver-1.toml"))
 
-	os.Unsetenv("ADBC_DRIVER_PATH")
+	suite.T().Setenv("ADBC_DRIVER_PATH", "")
 	m = InstallCmd{Driver: "test-driver-1", Level: config.ConfigEnv}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 	suite.runCmd(m)
 	suite.FileExists(filepath.Join(venv_path, "etc", "adbc", "drivers", "test-driver-1.toml"))
 	suite.NoFileExists(filepath.Join(conda_path, "etc", "adbc", "drivers", "test-driver-1.toml"))
 
-	os.Unsetenv("VIRTUAL_ENV")
+	suite.T().Setenv("VIRTUAL_ENV", "")
 	m = InstallCmd{Driver: "test-driver-1", Level: config.ConfigEnv}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 	suite.runCmd(m)
 	suite.FileExists(filepath.Join(conda_path, "etc", "adbc", "drivers", "test-driver-1.toml"))
-
-	os.Unsetenv("CONDA_PREFIX")
 }
 
 func (suite *SubcommandTestSuite) TestInstallCondaPrefix() {
-	os.Unsetenv("ADBC_DRIVER_PATH")
-	os.Setenv("CONDA_PREFIX", suite.tempdir)
-	defer os.Unsetenv("CONDA_PREFIX")
+	suite.T().Setenv("ADBC_DRIVER_PATH", "")
+	suite.T().Setenv("CONDA_PREFIX", suite.tempdir)
 
 	m := InstallCmd{Driver: "test-driver-1"}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 	suite.validateOutput("\r[✓] searching\r\n[✓] downloading\r\n[✓] installing\r\n[✓] verifying signature\r\n",
 		"\nInstalled test-driver-1 1.1.0 to "+filepath.Join(suite.tempdir, "etc", "adbc", "drivers")+"\n", suite.runCmd(m))
 }
 
-func (suite *SubcommandTestSuite) TestInstallUserFakeExplicitLevelOverrides() {
-	if runtime.GOOS == "windows" {
-		suite.T().Skip()
-	}
-
-	// If the user explicitly sets level, it should override ADBC_DRIVER_PATH
-	// which, when testing, is set to tempdir
-	m := InstallCmd{Driver: "test-driver-1", Level: config.ConfigSystem}.
-		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
-	installModel := m.(progressiveInstallModel)
-	suite.Equal(installModel.cfg.Level, config.ConfigSystem)
-	installModel.cfg.Location = filepath.Join(suite.tempdir, "user", installModel.cfg.Location)
-	m = installModel // <- We need to reassign to make the change stick
-	suite.runCmd(m)
-	suite.FileExists(filepath.Join(installModel.cfg.Location, "test-driver-1.toml"))
-}
-
 func (suite *SubcommandTestSuite) TestInstallManifestOnlyDriver() {
-	m := InstallCmd{Driver: "test-driver-manifest-only"}.
+	m := InstallCmd{Driver: "test-driver-manifest-only", Level: suite.configLevel}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
+
 	suite.validateOutput("\r[✓] searching\r\n[✓] downloading\r\n[✓] installing\r\n[✓] verifying signature\r\n",
-		"\nInstalled test-driver-manifest-only 1.0.0 to "+suite.tempdir+"\n"+
+		"\nInstalled test-driver-manifest-only 1.0.0 to "+suite.Dir()+"\n"+
 			"\nMust have libtest_driver installed to load this driver\n", suite.runCmd(m))
-	if runtime.GOOS != "windows" {
-		suite.FileExists(filepath.Join(suite.tempdir, "test-driver-manifest-only.toml"))
-	}
+	suite.driverIsInstalled("test-driver-manifest-only", false)
 }
 
 func (suite *SubcommandTestSuite) TestInstallDriverNoSignature() {
@@ -243,8 +173,7 @@ func (suite *SubcommandTestSuite) TestInstallDriverNoSignature() {
 func (suite *SubcommandTestSuite) TestInstallGitignoreDefaultBehavior() {
 	driver_path := filepath.Join(suite.tempdir, "driver_path")
 	ignorePath := filepath.Join(driver_path, ".gitignore")
-	os.Setenv("ADBC_DRIVER_PATH", driver_path)
-	defer os.Unsetenv("ADBC_DRIVER_PATH")
+	suite.T().Setenv("ADBC_DRIVER_PATH", driver_path)
 
 	suite.NoFileExists(ignorePath)
 
@@ -258,8 +187,7 @@ func (suite *SubcommandTestSuite) TestInstallGitignoreDefaultBehavior() {
 func (suite *SubcommandTestSuite) TestInstallGitignoreExisingDir() {
 	driver_path := filepath.Join(suite.tempdir, "driver_path")
 	ignorePath := filepath.Join(driver_path, ".gitignore")
-	os.Setenv("ADBC_DRIVER_PATH", driver_path)
-	defer os.Unsetenv("ADBC_DRIVER_PATH")
+	suite.T().Setenv("ADBC_DRIVER_PATH", driver_path)
 
 	// Create the directory before we install the driver
 	mkdirerr := os.MkdirAll(driver_path, 0o755)
@@ -282,8 +210,7 @@ func (suite *SubcommandTestSuite) TestInstallGitignoreExisingDir() {
 func (suite *SubcommandTestSuite) TestInstallGitignorePreserveUserModified() {
 	driver_path := filepath.Join(suite.tempdir, "driver_path")
 	ignorePath := filepath.Join(driver_path, ".gitignore")
-	os.Setenv("ADBC_DRIVER_PATH", driver_path)
-	defer os.Unsetenv("ADBC_DRIVER_PATH")
+	suite.T().Setenv("ADBC_DRIVER_PATH", driver_path)
 
 	suite.NoFileExists(ignorePath)
 
@@ -316,3 +243,22 @@ func (suite *SubcommandTestSuite) TestInstallGitignorePreserveUserModified() {
 	}
 	suite.Equal(userContent, string(data))
 }
+
+func (suite *SubcommandTestSuite) TestInstallCreatesSymlinks() {
+	if runtime.GOOS == "windows" && (suite.configLevel == config.ConfigUser || suite.configLevel == config.ConfigSystem) {
+		suite.T().Skip("Symlinks aren't created on Windows for User and System config levels")
+	}
+
+	// Install a driver
+	m := InstallCmd{Driver: "test-driver-1", Level: suite.configLevel}.
+		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
+	_ = suite.runCmd(m)
+	suite.driverIsInstalled("test-driver-1", true)
+
+	// Verify symlink is in place in the parent dir and is actually a symlink
+	manifestPath := filepath.Join(suite.Dir(), "..", "test-driver-1.toml")
+	suite.FileExists(manifestPath)
+	info, err := os.Lstat(manifestPath)
+	suite.NoError(err)
+	suite.Equal(os.ModeSymlink, info.Mode()&os.ModeSymlink, "Expected test-driver-1.toml to be a symlink")
+}

cmd/dbc/subcommand_test.go

@@ -27,6 +27,7 @@ import (
 
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/columnar-tech/dbc"
+	"github.com/columnar-tech/dbc/config"
 	"github.com/go-faster/yaml"
 	"github.com/stretchr/testify/suite"
 )
@@ -83,22 +84,24 @@ type SubcommandTestSuite struct {
 	openBrowserFn         func(string) error
 	fallbackDriverDocsUrl map[string]string
 	tempdir               string
+
+	configLevel config.ConfigLevel
 }
 
 func (suite *SubcommandTestSuite) SetupSuite() {
 	suite.getDriverRegistryFn = getDriverRegistry
 	getDriverRegistry = getTestDriverRegistry
 	suite.openBrowserFn = openBrowserFunc
 	suite.fallbackDriverDocsUrl = fallbackDriverDocsUrl
+
+	if suite.configLevel == config.ConfigUnknown {
+		suite.configLevel = config.ConfigEnv
+	}
 }
 
 func (suite *SubcommandTestSuite) SetupTest() {
 	suite.tempdir = suite.T().TempDir()
-	suite.Require().NoError(os.Setenv("ADBC_DRIVER_PATH", suite.tempdir))
-}
-
-func (suite *SubcommandTestSuite) TearDownTest() {
-	suite.Require().NoError(os.Unsetenv("ADBC_DRIVER_PATH"))
+	suite.T().Setenv("ADBC_DRIVER_PATH", suite.tempdir)
 }
 
 func (suite *SubcommandTestSuite) TearDownSuite() {
@@ -120,6 +123,15 @@ func (suite *SubcommandTestSuite) getFilesInTempDir() []string {
 	return filelist
 }
 
+// Get the base directory for where drivers are installed. Use this instead of
+// hardcoding checks to suite.tempdir to make tests support other config levels.
+func (suite *SubcommandTestSuite) Dir() string {
+	if suite.configLevel == config.ConfigEnv {
+		return suite.tempdir
+	}
+	return suite.configLevel.ConfigLocation()
+}
+
 func (suite *SubcommandTestSuite) runCmdErr(m tea.Model) string {
 	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
 	defer cancel()
@@ -171,6 +183,64 @@ func (suite *SubcommandTestSuite) validateOutput(expected, extra, actual string)
 	suite.Equal(terminalPrefix+expected+terminalSuffix+extra, actual)
 }
 
-func TestSubcommands(t *testing.T) {
-	suite.Run(t, new(SubcommandTestSuite))
+// The SubcommandTestSuite is only run for ConfigEnv by default but is
+// parametrized by configLevel so tests can be run for other levels. Tests must
+// opt into this behavior by instantiating subcommands with `suite.configLevel`
+// like:
+//
+//	m := InstallCmd{Driver: "foo", Level: suite.configLevel}
+//	                                      ^---- here
+//
+// and can opt out of this behavior by specifying it separately like:
+//
+//	m := InstallCmd{Driver: "test-driver-1", Level: config.ConfigEnv}.
+//
+// When any level is explicitly requested, tests are only run for that level.
+// i.e., to run tests for multiple levels, each level must be specified
+// separately.
+func TestSubcommandsEnv(t *testing.T) {
+	_, env := os.LookupEnv("DBC_TEST_LEVEL_ENV")
+	_, user := os.LookupEnv("DBC_TEST_LEVEL_USER")
+	_, system := os.LookupEnv("DBC_TEST_LEVEL_SYSTEM")
+
+	// Run if explicitly requested, or if no levels were requested (default
+	// behavior)
+	if env || (!user && !system) {
+		suite.Run(t, &SubcommandTestSuite{configLevel: config.ConfigEnv})
+		return
+	}
+	t.Skip("skipping tests for config level: ConfigEnv")
+}
+
+func TestSubcommandsUser(t *testing.T) {
+	if _, ok := os.LookupEnv("DBC_TEST_LEVEL_USER"); !ok {
+		t.Skip("skipping tests for config level: ConfigUser")
+	}
+	suite.Run(t, &SubcommandTestSuite{configLevel: config.ConfigUser})
+}
+
+func TestSubcommandsSystem(t *testing.T) {
+	if _, ok := os.LookupEnv("DBC_TEST_LEVEL_SYSTEM"); !ok {
+		t.Skip("skipping tests for config level: ConfigSystem")
+	}
+	suite.Run(t, &SubcommandTestSuite{configLevel: config.ConfigSystem})
+}
+
+func (suite *SubcommandTestSuite) driverIsInstalled(path string, checkShared bool) {
+	cfg := config.Get()[suite.configLevel]
+
+	driver, err := config.GetDriver(cfg, path)
+	suite.Require().NoError(err, "driver manifest should exist for driver `%s`", path)
+
+	if checkShared {
+		sharedPath := driver.Driver.Shared.Get(config.PlatformTuple())
+		suite.FileExists(sharedPath, "driver shared library should exist for driver `%s`", path)
+	}
+}
+
+func (suite *SubcommandTestSuite) driverIsNotInstalled(path string) {
+	cfg := config.Get()[suite.configLevel]
+
+	_, err := config.GetDriver(cfg, path)
+	suite.Require().Error(err, "driver manifest should not exist for driver `%s`", path)
 }