Rename the "reg" package to winregistry

Author: morestatic

tasks/realvncserver/configupdater_win.go

@@ -13,7 +13,7 @@ import (
 
 	tacoexec "github.com/realvnc-labs/tacoscript/exec"
 	"github.com/realvnc-labs/tacoscript/tasks/shared/fieldstatus"
-	"github.com/realvnc-labs/tacoscript/tasks/support/reg"
+	"github.com/realvnc-labs/tacoscript/tasks/support/winregistry"
 )
 
 const (
@@ -40,7 +40,7 @@ func (rvste *Executor) applyConfigChanges(rvst *Task) (addedCount int, updatedCo
 		desc := ""
 
 		if fs.Clear {
-			_, desc, err = reg.RemoveValue(baseKey, regPath)
+			_, desc, err = winregistry.RemoveValue(baseKey, regPath)
 			if err != nil {
 				return err
 			}
@@ -49,7 +49,7 @@ func (rvste *Executor) applyConfigChanges(rvst *Task) (addedCount int, updatedCo
 				logrus.Debugf(`removed key %s\%s`, baseKey, regPath)
 			}
 		} else {
-			_, desc, err = reg.SetValue(baseKey, regPath, regValue, reg.REG_SZ)
+			_, desc, err = winregistry.SetValue(baseKey, regPath, regValue, winregistry.REG_SZ)
 			if err != nil {
 				return err
 			}

tasks/realvncserver/configupdater_win_test.go

@@ -13,7 +13,7 @@ import (
 
 	"github.com/realvnc-labs/tacoscript/tasks/realvncserver"
 	"github.com/realvnc-labs/tacoscript/tasks/shared/fieldstatus"
-	"github.com/realvnc-labs/tacoscript/tasks/support/reg"
+	"github.com/realvnc-labs/tacoscript/tasks/support/winregistry"
 	"github.com/realvnc-labs/tacoscript/utils"
 )
 
@@ -31,7 +31,7 @@ func testTeardown(t *testing.T) {
 	t.Helper()
 	// remove test key and restore base key
 	defer func() {
-		_ = reg.DeleteKeyRecursive(testRealVNCBaseKey)
+		_ = winregistry.DeleteKeyRecursive(testRealVNCBaseKey)
 		realvncserver.HKLMBaseKey = origHKLMBaseKey
 	}()
 }
@@ -68,7 +68,7 @@ func TestShouldSetSimpleConfigRegistryParam(t *testing.T) {
 
 	assert.Equal(t, "1 config value change(s) applied", res.Changes["count"])
 
-	found, regVal, err := reg.GetValue(realvncserver.HKLMBaseKey, "Encryption", reg.REG_SZ)
+	found, regVal, err := winregistry.GetValue(realvncserver.HKLMBaseKey, "Encryption", winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.True(t, found)
 	assert.Equal(t, "AlwaysOff", regVal)
@@ -122,7 +122,7 @@ func TestShouldUpdateSimpleConfigRegistryParam(t *testing.T) {
 
 	assert.Equal(t, "1 config value change(s) applied", res.Changes["count"])
 
-	found, regVal, err := reg.GetValue(realvncserver.HKLMBaseKey, "Encryption", reg.REG_SZ)
+	found, regVal, err := winregistry.GetValue(realvncserver.HKLMBaseKey, "Encryption", winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.True(t, found)
 	assert.Equal(t, "PreferOn", regVal)
@@ -196,7 +196,7 @@ func TestShouldClearSimpleConfigRegistryParam(t *testing.T) {
 
 	assert.Equal(t, "1 config value change(s) applied", res.Changes["count"])
 
-	found, _, err := reg.GetValue(realvncserver.HKLMBaseKey, "BlankScreen", reg.REG_SZ)
+	found, _, err := winregistry.GetValue(realvncserver.HKLMBaseKey, "BlankScreen", winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.False(t, found)
 }

tasks/support/reg/deletekey_win.go renamed to tasks/support/winregistry/deletekey_win.go

@@ -1,7 +1,7 @@
 //go:build windows
 // +build windows
 
-package reg
+package winregistry
 
 import (
 	"fmt"

tasks/support/reg/registry_common.go renamed to tasks/support/winregistry/registry_common.go

@@ -1,4 +1,4 @@
-package reg
+package winregistry
 
 import "errors"
 

tasks/support/reg/registry_other.go renamed to tasks/support/winregistry/registry_other.go

@@ -1,7 +1,7 @@
 //go:build !windows
 // +build !windows
 
-package reg
+package winregistry
 
 import "errors"
 

tasks/support/reg/registry_test.go renamed to tasks/support/winregistry/registry_test.go

@@ -1,7 +1,7 @@
 //go:build windows
 // +build windows
 
-package reg_test
+package winregistry_test
 
 import (
 	"errors"
@@ -12,7 +12,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"golang.org/x/sys/windows/registry"
 
-	"github.com/realvnc-labs/tacoscript/tasks/support/reg"
+	"github.com/realvnc-labs/tacoscript/tasks/support/winregistry"
 )
 
 const baseTestKey = `HKLM:\Software\TestTacoScript`
@@ -21,7 +21,7 @@ const testKey = `UnitTestRun`
 func setup(t *testing.T) {
 	t.Helper()
 
-	err := reg.DeleteKeyRecursive(`HKLM:\Software\TestTacoScript`)
+	err := winregistry.DeleteKeyRecursive(`HKLM:\Software\TestTacoScript`)
 	if err != nil && !errors.Is(err, registry.ErrNotExist) {
 		require.NoError(t, err)
 	}
@@ -36,7 +36,7 @@ func TestShouldGetStringValue(t *testing.T) {
 	keyPath := `HKCU:\Software\GoProgrammingLanguage`
 	name := `installLocation`
 
-	found, val, err := reg.GetValue(keyPath, name, reg.REG_SZ)
+	found, val, err := winregistry.GetValue(keyPath, name, winregistry.REG_SZ)
 
 	assert.NoError(t, err)
 	assert.True(t, found)
@@ -47,16 +47,16 @@ func TestShouldEnsureNewRegistryValueIsPresent(t *testing.T) {
 	keyPath := newTestKeyPath(testKey)
 	name := `testValue`
 	val := `123456789`
-	valType := reg.REG_SZ
+	valType := winregistry.REG_SZ
 
 	setup(t)
 
-	updated, desc, err := reg.SetValue(keyPath, name, val, valType)
+	updated, desc, err := winregistry.SetValue(keyPath, name, val, valType)
 	require.NoError(t, err)
 	assert.True(t, updated)
 	assert.Equal(t, "added new key", desc)
 
-	found, currVal, err := reg.GetValue(keyPath, name, reg.REG_SZ)
+	found, currVal, err := winregistry.GetValue(keyPath, name, winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.True(t, found)
 	assert.Equal(t, val, currVal)
@@ -66,21 +66,21 @@ func TestShouldEnsureExistingRegistryValueIsPresent(t *testing.T) {
 	keyPath := newTestKeyPath(testKey)
 	name := `testValue`
 	val := "1234567890"
-	valType := reg.REG_SZ
+	valType := winregistry.REG_SZ
 
 	setup(t)
 
 	// set initial value
-	reg.SetValue(keyPath, name, val, valType)
+	winregistry.SetValue(keyPath, name, val, valType)
 
 	// now update again without no change
-	updated, desc, err := reg.SetValue(keyPath, name, val, valType)
+	updated, desc, err := winregistry.SetValue(keyPath, name, val, valType)
 	require.NoError(t, err)
 
 	assert.False(t, updated)
 	assert.Equal(t, "matching existing value", desc)
 
-	found, currVal, err := reg.GetValue(keyPath, name, valType)
+	found, currVal, err := winregistry.GetValue(keyPath, name, valType)
 	assert.NoError(t, err)
 	assert.True(t, found)
 	assert.Equal(t, val, currVal)
@@ -90,22 +90,22 @@ func TestShouldEnsureExistingRegistryValueIsUpdated(t *testing.T) {
 	keyPath := newTestKeyPath(testKey)
 	name := `testValue`
 	val := `123456789`
-	valType := reg.REG_SZ
+	valType := winregistry.REG_SZ
 
 	setup(t)
 
 	// set an initial value
-	reg.SetValue(keyPath, name, val+"abc", valType)
+	winregistry.SetValue(keyPath, name, val+"abc", valType)
 
 	// now update again
-	updated, desc, err := reg.SetValue(keyPath, name, val, valType)
+	updated, desc, err := winregistry.SetValue(keyPath, name, val, valType)
 	assert.NoError(t, err)
 
 	// new value will have updated as true as the value should have been updated
 	assert.True(t, updated)
 	assert.Equal(t, "existing value updated", desc)
 
-	_, updatedVal, err := reg.GetValue(keyPath, name, reg.REG_SZ)
+	_, updatedVal, err := winregistry.GetValue(keyPath, name, winregistry.REG_SZ)
 	require.NoError(t, err)
 
 	assert.Equal(t, val, updatedVal)
@@ -115,19 +115,19 @@ func TestShouldEnsureExistingRegistryValueIsUpdatedWhenTypeChange(t *testing.T)
 	keyPath := newTestKeyPath(testKey)
 	name := `testValue`
 	var val uint32 = 1
-	valType := reg.REG_DWORD
+	valType := winregistry.REG_DWORD
 
 	setup(t)
 
-	reg.SetValue(keyPath, name, "existing value", reg.REG_SZ)
+	winregistry.SetValue(keyPath, name, "existing value", winregistry.REG_SZ)
 
-	updated, desc, err := reg.SetValue(keyPath, name, val, valType)
+	updated, desc, err := winregistry.SetValue(keyPath, name, val, valType)
 
 	require.NoError(t, err)
 	assert.True(t, updated)
 	assert.Equal(t, "existing value updated", desc)
 
-	found, currVal, err := reg.GetValue(keyPath, name, valType)
+	found, currVal, err := winregistry.GetValue(keyPath, name, valType)
 	assert.NoError(t, err)
 	assert.True(t, found)
 	assert.Equal(t, val, currVal)
@@ -139,16 +139,16 @@ func TestShouldEnsureExistingRegistryValueIsAbsent(t *testing.T) {
 
 	setup(t)
 
-	reg.SetValue(keyPath, name, "value to be removed", reg.REG_SZ)
+	winregistry.SetValue(keyPath, name, "value to be removed", winregistry.REG_SZ)
 
-	updated, desc, err := reg.RemoveValue(keyPath, name)
+	updated, desc, err := winregistry.RemoveValue(keyPath, name)
 	assert.NoError(t, err)
 
 	// updated set to true indicates that a value was removed
 	assert.True(t, updated)
 	assert.Equal(t, "value removed", desc)
 
-	found, _, err := reg.GetValue(keyPath, name, reg.REG_SZ)
+	found, _, err := winregistry.GetValue(keyPath, name, winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.False(t, found)
 }
@@ -160,19 +160,19 @@ func TestShouldWhenAbsentOnlyRemoveValue(t *testing.T) {
 
 	setup(t)
 
-	reg.SetValue(keyPath, altName, "value to remain", reg.REG_SZ)
+	winregistry.SetValue(keyPath, altName, "value to remain", winregistry.REG_SZ)
 
-	updated, desc, err := reg.RemoveValue(keyPath, name)
+	updated, desc, err := winregistry.RemoveValue(keyPath, name)
 	require.NoError(t, err)
 
 	assert.False(t, updated)
 	assert.Equal(t, "no existing value", desc)
 
-	found, _, err := reg.GetValue(keyPath, name, reg.REG_SZ)
+	found, _, err := winregistry.GetValue(keyPath, name, winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.False(t, found)
 
-	found, val, err := reg.GetValue(keyPath, altName, reg.REG_SZ)
+	found, val, err := winregistry.GetValue(keyPath, altName, winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.True(t, found)
 	assert.Equal(t, "value to remain", val)
@@ -185,9 +185,9 @@ func TestShouldWhenAbsentAndNoExistingValueHaveCorrectDescription(t *testing.T)
 
 	setup(t)
 
-	reg.SetValue(keyPath, altName, "value to remain", reg.REG_SZ)
+	winregistry.SetValue(keyPath, altName, "value to remain", winregistry.REG_SZ)
 
-	updated, desc, err := reg.RemoveValue(keyPath, name)
+	updated, desc, err := winregistry.RemoveValue(keyPath, name)
 	require.NoError(t, err)
 
 	assert.False(t, updated)
@@ -201,59 +201,59 @@ func TestShouldEnsureExistingRegistryKeyIsAbsent(t *testing.T) {
 
 	setup(t)
 
-	reg.SetValue(keyPathToRemove, name, "1234", reg.REG_SZ)
-	reg.SetValue(keyPathToRemove, altName, "value to remove also", reg.REG_SZ)
+	winregistry.SetValue(keyPathToRemove, name, "1234", winregistry.REG_SZ)
+	winregistry.SetValue(keyPathToRemove, altName, "value to remove also", winregistry.REG_SZ)
 
-	updated, desc, err := reg.RemoveKey(keyPathToRemove)
+	updated, desc, err := winregistry.RemoveKey(keyPathToRemove)
 	assert.NoError(t, err)
 
 	// updated set to true indicates that a value was removed
 	assert.True(t, updated)
 	assert.Equal(t, "key removed", desc)
 
-	found, _, err := reg.GetValue(keyPathToRemove, name, reg.REG_SZ)
+	found, _, err := winregistry.GetValue(keyPathToRemove, name, winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.False(t, found)
 
-	found, _, err = reg.GetValue(keyPathToRemove, altName, reg.REG_SZ)
+	found, _, err = winregistry.GetValue(keyPathToRemove, altName, winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.False(t, found)
 }
 
 func TestShouldDeleteSubKeyRecursively(t *testing.T) {
 	keyPath := createTestRegBranch(t)
 
-	updated, desc, err := reg.RemoveKey(keyPath + `\2`)
+	updated, desc, err := winregistry.RemoveKey(keyPath + `\2`)
 	assert.NoError(t, err)
 
 	// updated set to true indicates that a value was removed
 	assert.True(t, updated)
 	assert.Equal(t, "key removed", desc)
 
-	found, _, err := reg.GetValue(keyPath+`\2`, "2", reg.REG_SZ)
+	found, _, err := winregistry.GetValue(keyPath+`\2`, "2", winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.False(t, found)
 
-	found, _, err = reg.GetValue(keyPath+`\6`, "4", reg.REG_SZ)
+	found, _, err = winregistry.GetValue(keyPath+`\6`, "4", winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.True(t, found)
 }
 
 func TestShouldDeleteSubKeyWithoutChildrenRecursively(t *testing.T) {
 	keyPath := createTestRegBranch(t)
 
-	updated, desc, err := reg.RemoveKey(keyPath + `\6`)
+	updated, desc, err := winregistry.RemoveKey(keyPath + `\6`)
 	assert.NoError(t, err)
 
 	// updated set to true indicates that a value was removed
 	assert.True(t, updated)
 	assert.Equal(t, "key removed", desc)
 
-	found, _, err := reg.GetValue(keyPath+`\6`, "4", reg.REG_SZ)
+	found, _, err := winregistry.GetValue(keyPath+`\6`, "4", winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.False(t, found)
 
-	found, _, err = reg.GetValue(keyPath+`\2`, "4", reg.REG_SZ)
+	found, _, err = winregistry.GetValue(keyPath+`\2`, "4", winregistry.REG_SZ)
 	require.NoError(t, err)
 	assert.True(t, found)
 }
@@ -275,7 +275,7 @@ func createTestRegBranch(t *testing.T) (keyPath string) {
 
 func createBranchLeaves(t *testing.T, keyPath string, from int, to int) {
 	for i := from; i <= to; i++ {
-		_, _, err := reg.SetValue(keyPath, strconv.Itoa(i), strconv.Itoa(i), reg.REG_SZ)
+		_, _, err := winregistry.SetValue(keyPath, strconv.Itoa(i), strconv.Itoa(i), winregistry.REG_SZ)
 		require.NoError(t, err)
 	}
 }

tasks/support/reg/registry_win.go renamed to tasks/support/winregistry/registry_win.go

@@ -1,7 +1,7 @@
 //go:build windows
 // +build windows
 
-package reg
+package winregistry
 
 import (
 	"bytes"