chore: parameterize SubCommandTest with configLevel #239
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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,24 +84,26 @@ 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)) | ||
|
||
| } | ||
|
|
||
|
Comment on lines
100
to
102
Member
There was a problem hiding this comment. why remove this? If we're not going to remove this env var after each test, then we should move the
Member
Author
There was a problem hiding this comment. This got split out into platform specific TearDownTest methods (subcommand_unix_test.go, subcommand_windows_test.go) |
||
| func (suite *SubcommandTestSuite) TearDownSuite() { | ||
| getDriverRegistry = suite.getDriverRegistryFn | ||
| openBrowserFunc = suite.openBrowserFn | ||
|
|
@@ -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 config.GetLocation(suite.configLevel) | ||
| } | ||
|
|
||
| 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) | ||
| } | ||
|
|
||
| // 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) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // Copyright 2025 Columnar Technologies Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| //go:build !windows | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/columnar-tech/dbc/config" | ||
| ) | ||
|
|
||
| func (suite *SubcommandTestSuite) TearDownTest() { | ||
| suite.Require().NoError(os.Unsetenv("ADBC_DRIVER_PATH")) | ||
|
|
||
| // Clean up filesystem after each test | ||
| _, user := os.LookupEnv("DBC_TEST_LEVEL_USER") | ||
| _, system := os.LookupEnv("DBC_TEST_LEVEL_SYSTEM") | ||
| if user { | ||
| suite.Require().NoError(os.RemoveAll(config.GetLocation(config.ConfigUser))) | ||
| } | ||
| if system { | ||
| suite.Require().NoError(os.RemoveAll(config.GetLocation(config.ConfigSystem))) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.