Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,6 @@ jobs:
- name: Build dbc
run: go build ./cmd/dbc
- name: Run Tests
run: go test -v ./...
# 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 ./...
10 changes: 5 additions & 5 deletions cmd/dbc/driver_list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ func TestUnmarshalDriverList(t *testing.T) {
expected []dbc.PkgInfo
err error
}{
{"basic", "[drivers]\nflightsql = {version = '1.7.0'}", []dbc.PkgInfo{
{Driver: dbc.Driver{Path: "flightsql"}, Version: semver.MustParse("1.7.0")},
{"basic", "[drivers]\nflightsql = {version = '1.8.0'}", []dbc.PkgInfo{
{Driver: dbc.Driver{Path: "flightsql"}, Version: semver.MustParse("1.8.0")},
}, nil},
{"less", "[drivers]\nflightsql = {version = '<=1.7.0'}", []dbc.PkgInfo{
{Driver: dbc.Driver{Path: "flightsql"}, Version: semver.MustParse("1.7.0")},
{"less", "[drivers]\nflightsql = {version = '<=1.8.0'}", []dbc.PkgInfo{
{Driver: dbc.Driver{Path: "flightsql"}, Version: semver.MustParse("1.8.0")},
}, nil},
{"greater", "[drivers]\nflightsql = {version = '>=1.7.0'}", []dbc.PkgInfo{
{"greater", "[drivers]\nflightsql = {version = '>=1.8.0'}", []dbc.PkgInfo{
{Driver: dbc.Driver{Path: "flightsql"}, Version: semver.MustParse("1.8.0")},
}, nil},
}
Expand Down
123 changes: 123 additions & 0 deletions cmd/dbc/registry_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
// Copyright (c) 2025 Columnar Technologies. All rights reserved.

//go:build windows && test_registry

package main

import (
"bytes"
"context"
"errors"
"os"
"path/filepath"
"testing"
"time"

tea "github.com/charmbracelet/bubbletea"
"github.com/columnar-tech/dbc/config"
"github.com/stretchr/testify/suite"
"golang.org/x/sys/windows/registry"
)

// This test suite is only run when the "test_registry" build tag is set.
// Only run these tests if you're able to modify the windows registry and won't be broken
// if the ADBC registry keys are cleared/modified/etc.
type RegistryTestSuite struct {
suite.Suite

cfgUserPath string
}

func (s *RegistryTestSuite) run(m tea.Model) string {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()

var out bytes.Buffer
p := tea.NewProgram(m, tea.WithInput(nil), tea.WithOutput(&out),
tea.WithContext(ctx), tea.WithoutRenderer())

var err error
m, err = p.Run()
s.Require().NoError(err)
s.Equal(0, m.(HasStatus).Status(), "exited with a non-zero status")

var extra string
if fo, ok := m.(HasFinalOutput); ok {
extra = fo.FinalOutput()
}
return out.String() + extra
}

func (s *RegistryTestSuite) clearRegistry() {
// Clear out any existing ADBC registry keys to ensure a clean slate.
k, err := registry.OpenKey(registry.CURRENT_USER, "SOFTWARE\\ADBC\\Drivers", registry.ALL_ACCESS)
if errors.Is(err, registry.ErrNotExist) {
return
}
s.Require().NoError(err)
defer k.Close()

names, err := k.ReadSubKeyNames(-1) // Ensure the key is readable
s.Require().NoError(err)
for _, name := range names {
s.Require().NoError(registry.DeleteKey(k, name))
}
}

func (s *RegistryTestSuite) SetupSuite() {
s.cfgUserPath = config.Get()[config.ConfigUser].Location
os.RemoveAll(s.cfgUserPath)
}

func (s *RegistryTestSuite) TearDownSuite() {
s.clearRegistry()
os.RemoveAll(s.cfgUserPath)
}

func (s *RegistryTestSuite) SetupTest() {
s.clearRegistry()
}

func (s *RegistryTestSuite) TearDownTest() {
os.RemoveAll(s.cfgUserPath)
}

func (s *RegistryTestSuite) TestInstallDriver() {
m := InstallCmd{Driver: "test-driver-1"}.
GetModelCustom(baseModel{getDriverList: getTestDriverList, downloadPkg: downloadTestPkg})
out := s.run(m)
s.Equal("\nInstalled test-driver-1 1.1.0 to "+s.cfgUserPath+"\n", out)

k, err := registry.OpenKey(registry.CURRENT_USER, "SOFTWARE\\ADBC\\Drivers\\test-driver-1", registry.READ)
s.Require().NoError(err)
defer k.Close()

// Verify the registry key was created with the expected values.
val, _, err := k.GetStringValue("version")
s.Require().NoError(err)
s.Equal("1.1.0", val)

val, _, err = k.GetStringValue("driver")
s.Require().NoError(err)
s.Equal(filepath.Join(s.cfgUserPath, "test-driver-1.1", "test-driver-1-not-valid.so"), val)
}

func (s *RegistryTestSuite) TestPartialReinstallDriver() {
// First install the driver normally.
m := InstallCmd{Driver: "test-driver-1"}.
GetModelCustom(baseModel{getDriverList: getTestDriverList, downloadPkg: downloadTestPkg})
out := s.run(m)
s.Equal("\nInstalled test-driver-1 1.1.0 to "+s.cfgUserPath+"\n", out)

s.clearRegistry()

// Now reinstall the driver, which should succeed even though the registry key is missing.
m = InstallCmd{Driver: "test-driver-1"}.
GetModelCustom(baseModel{getDriverList: getTestDriverList, downloadPkg: downloadTestPkg})
out = s.run(m)
s.Equal("\nInstalled test-driver-1 1.1.0 to "+s.cfgUserPath+"\n", out)
}

func TestRegistryKeyHandling(t *testing.T) {
suite.Run(t, new(RegistryTestSuite))
}
2 changes: 1 addition & 1 deletion cmd/dbc/sync_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (

tea "github.com/charmbracelet/bubbletea"
"github.com/columnar-tech/dbc"
"github.com/go-faster/yaml"
"github.com/stretchr/testify/suite"
"gopkg.in/yaml.v3"
)

func getTestDriverList() ([]dbc.Driver, error) {
Expand Down
39 changes: 25 additions & 14 deletions config/dirs_windows.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,6 @@ func loadRegistryConfig(lvl ConfigLevel) Config {

ret.Exists, ret.Drivers = true, make(map[string]DriverInfo)
if info.SubKeyCount == 0 {
log.Println("No drivers found")
return ret
}

Expand All @@ -171,23 +170,35 @@ func loadRegistryConfig(lvl ConfigLevel) Config {
}

func Get() map[ConfigLevel]Config {
configs := map[ConfigLevel]Config{
ConfigUser: loadConfig(ConfigUser),
ConfigSystem: loadConfig(ConfigSystem),
ConfigEnv: loadConfig(ConfigEnv),
}
cfgUser, cfgSys, cfgEnv := loadConfig(ConfigUser), loadConfig(ConfigSystem), loadConfig(ConfigEnv)

regUser := loadRegistryConfig(ConfigUser)
if regUser.Exists {
maps.Copy(configs[ConfigUser].Drivers, regUser.Drivers)
if cfgUser.Drivers == nil {
cfgUser.Drivers = regUser.Drivers
} else {
maps.Copy(cfgUser.Drivers, regUser.Drivers)
}
} else {
cfgUser.Exists = false
}

regSys := loadRegistryConfig(ConfigSystem)
if regSys.Exists {
maps.Copy(configs[ConfigSystem].Drivers, regSys.Drivers)
if cfgSys.Drivers == nil {
cfgSys.Drivers = regSys.Drivers
} else {
maps.Copy(cfgSys.Drivers, regSys.Drivers)
}
} else {
cfgSys.Exists = false
}

return configs
return map[ConfigLevel]Config{
ConfigUser: cfgUser,
ConfigSystem: cfgSys,
ConfigEnv: cfgEnv,
}
}

func FindDriverConfigs(lvl ConfigLevel) []DriverInfo {
Expand Down Expand Up @@ -225,26 +236,26 @@ func CreateManifest(cfg Config, driver DriverInfo) (err error) {
var k registry.Key

if !cfg.Exists {
k, _, err = registry.CreateKey(cfg.Level.key(), "SOFTWARE\\ADBC", registry.WRITE)
k, _, err = registry.CreateKey(cfg.Level.key(), "SOFTWARE\\ADBC", registry.ALL_ACCESS)
if err != nil {
return err
}
defer k.Close()

k, _, err = registry.CreateKey(k, "Drivers", registry.WRITE)
k, _, err = registry.CreateKey(k, "Drivers", registry.ALL_ACCESS)
if err != nil {
return err
}
defer k.Close()
} else {
k, err = registry.OpenKey(cfg.Level.key(), regKeyADBC, registry.WRITE)
k, err = registry.OpenKey(cfg.Level.key(), regKeyADBC, registry.ALL_ACCESS)
if err != nil {
return err
}
defer k.Close()
}

dkey, _, err := registry.CreateKey(k, driver.ID, registry.WRITE)
dkey, _, err := registry.CreateKey(k, driver.ID, registry.ALL_ACCESS)
if err != nil {
return err
}
Expand Down Expand Up @@ -275,7 +286,7 @@ func CreateManifest(cfg Config, driver DriverInfo) (err error) {

func UninstallDriver(cfg Config, info DriverInfo) error {
if cfg.Level != ConfigEnv {
k, err := registry.OpenKey(cfg.Level.key(), regKeyADBC, registry.WRITE)
k, err := registry.OpenKey(cfg.Level.key(), regKeyADBC, registry.ALL_ACCESS)
if err != nil {
return err
}
Expand Down
Loading