sneak/secret
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix revive package stuttering errors

Browse Source 
- Rename SecretMetadata to Metadata in secret package
- Rename SecretVersion to Version in secret package
- Update NewSecretVersion to NewVersion function
- Update all references across the codebase including:
  - vault package aliases
  - CLI usage
  - test files
  - method receivers and signatures
This commit is contained in:
Jeffrey Paul 2025-06-20 08:47:32 -07:00
parent efc9456948
commit e5b18202f3
10 changed files with 43 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
TODO.md
View File

@ -6,6 +6,11 @@ prioritized from most critical (top) to least critical (bottom).
## Code Cleanups ## Code Cleanups
* none of the integration tests should be searching for a binary or trying
to execute another process. the integration tests cannot make another
process or depend on a compiled file, they must do all of their testing in
the current (test) process.
* we shouldn't be passing around a statedir, it should be read from the * we shouldn't be passing around a statedir, it should be read from the
environment or default. environment or default.

2
internal/cli/version.go
View File

@ -114,7 +114,7 @@ func (cli *Instance) ListVersions(cmd *cobra.Command, secretName string) error {
// Load and display each version's metadata // Load and display each version's metadata
for _, version := range versions { for _, version := range versions {
sv := secret.NewSecretVersion(vlt, secretName, version) sv := secret.NewVersion(vlt, secretName, version)
// Load metadata // Load metadata
if err := sv.LoadMetadata(ltIdentity); err != nil { if err := sv.LoadMetadata(ltIdentity); err != nil {

4
internal/secret/metadata.go
View File

@ -20,8 +20,8 @@ type UnlockerMetadata struct {
Flags []string `json:"flags,omitempty"` Flags []string `json:"flags,omitempty"`
} }
// SecretMetadata contains information about a secret // Metadata contains information about a secret
type SecretMetadata struct { type Metadata struct {
CreatedAt time.Time `json:"createdAt"` CreatedAt time.Time `json:"createdAt"`
UpdatedAt time.Time `json:"updatedAt"` UpdatedAt time.Time `json:"updatedAt"`
} }

10
internal/secret/secret.go
View File

@ -28,7 +28,7 @@ type VaultInterface interface {
type Secret struct { type Secret struct {
Name string Name string
Directory string Directory string
Metadata SecretMetadata Metadata Metadata
vault VaultInterface vault VaultInterface
} }
@ -54,7 +54,7 @@ func NewSecret(vault VaultInterface, name string) *Secret {
Name: name, Name: name,
Directory: secretDir, Directory: secretDir,
vault: vault, vault: vault,
Metadata: SecretMetadata{ Metadata: Metadata{
CreatedAt: time.Now(), CreatedAt: time.Now(),
UpdatedAt: time.Now(), UpdatedAt: time.Now(),
}, },
@ -109,7 +109,7 @@ func (s *Secret) GetValue(unlocker Unlocker) ([]byte, error) {
} }
// Create version object // Create version object
version := NewSecretVersion(s.vault, s.Name, currentVersion) version := NewVersion(s.vault, s.Name, currentVersion)
// Check if we have SB_SECRET_MNEMONIC environment variable for direct decryption // Check if we have SB_SECRET_MNEMONIC environment variable for direct decryption
if envMnemonic := os.Getenv(EnvMnemonic); envMnemonic != "" { if envMnemonic := os.Getenv(EnvMnemonic); envMnemonic != "" {
@ -216,7 +216,7 @@ func (s *Secret) LoadMetadata() error {
Debug("LoadMetadata called but is deprecated in versioned model", "secret_name", s.Name) Debug("LoadMetadata called but is deprecated in versioned model", "secret_name", s.Name)
// For backward compatibility, we'll populate with basic info // For backward compatibility, we'll populate with basic info
now := time.Now() now := time.Now()
s.Metadata = SecretMetadata{ s.Metadata = Metadata{
CreatedAt: now, CreatedAt: now,
UpdatedAt: now, UpdatedAt: now,
} }
@ -224,7 +224,7 @@ func (s *Secret) LoadMetadata() error {
} }
// GetMetadata returns the secret metadata (deprecated) // GetMetadata returns the secret metadata (deprecated)
func (s *Secret) GetMetadata() SecretMetadata { func (s *Secret) GetMetadata() Metadata {
Debug("GetMetadata called but is deprecated in versioned model", "secret_name", s.Name) Debug("GetMetadata called but is deprecated in versioned model", "secret_name", s.Name)
return s.Metadata return s.Metadata
} }

16
internal/secret/version.go
View File

@ -23,8 +23,8 @@ type VersionMetadata struct {
NotAfter *time.Time `json:"notAfter,omitempty"` // When this version expires (nil = current) NotAfter *time.Time `json:"notAfter,omitempty"` // When this version expires (nil = current)
} }
// SecretVersion represents a version of a secret // Version represents a version of a secret
type SecretVersion struct { type Version struct {
SecretName string SecretName string
Version string Version string
Directory string Directory string
@ -32,8 +32,8 @@ type SecretVersion struct {
vault VaultInterface vault VaultInterface
} }
// NewSecretVersion creates a new SecretVersion instance // NewVersion creates a new Version instance
func NewSecretVersion(vault VaultInterface, secretName string, version string) *SecretVersion { func NewVersion(vault VaultInterface, secretName string, version string) *Version {
DebugWith("Creating new secret version instance", DebugWith("Creating new secret version instance",
slog.String("secret_name", secretName), slog.String("secret_name", secretName),
slog.String("version", version), slog.String("version", version),
@ -51,7 +51,7 @@ func NewSecretVersion(vault VaultInterface, secretName string, version string) *
) )
now := time.Now() now := time.Now()
return &SecretVersion{ return &Version{
SecretName: secretName, SecretName: secretName,
Version: version, Version: version,
Directory: versionDir, Directory: versionDir,
@ -107,7 +107,7 @@ func GenerateVersionName(fs afero.Fs, secretDir string) (string, error) {
} }
// Save saves the version metadata and value // Save saves the version metadata and value
func (sv *SecretVersion) Save(value []byte) error { func (sv *Version) Save(value []byte) error {
DebugWith("Saving secret version", DebugWith("Saving secret version",
slog.String("secret_name", sv.SecretName), slog.String("secret_name", sv.SecretName),
slog.String("version", sv.Version), slog.String("version", sv.Version),
@ -223,7 +223,7 @@ func (sv *SecretVersion) Save(value []byte) error {
} }
// LoadMetadata loads and decrypts the version metadata // LoadMetadata loads and decrypts the version metadata
func (sv *SecretVersion) LoadMetadata(ltIdentity *age.X25519Identity) error { func (sv *Version) LoadMetadata(ltIdentity *age.X25519Identity) error {
DebugWith("Loading version metadata", DebugWith("Loading version metadata",
slog.String("secret_name", sv.SecretName), slog.String("secret_name", sv.SecretName),
slog.String("version", sv.Version), slog.String("version", sv.Version),
@ -281,7 +281,7 @@ func (sv *SecretVersion) LoadMetadata(ltIdentity *age.X25519Identity) error {
} }
// GetValue retrieves and decrypts the version value // GetValue retrieves and decrypts the version value
func (sv *SecretVersion) GetValue(ltIdentity *age.X25519Identity) ([]byte, error) { func (sv *Version) GetValue(ltIdentity *age.X25519Identity) ([]byte, error) {
DebugWith("Getting version value", DebugWith("Getting version value",
slog.String("secret_name", sv.SecretName), slog.String("secret_name", sv.SecretName),
slog.String("version", sv.Version), slog.String("version", sv.Version),

14
internal/secret/version_test.go
View File

@ -4,7 +4,7 @@
// //
// - TestGenerateVersionName: Tests version name generation with date and serial format // - TestGenerateVersionName: Tests version name generation with date and serial format
// - TestGenerateVersionNameMaxSerial: Tests the 999 versions per day limit // - TestGenerateVersionNameMaxSerial: Tests the 999 versions per day limit
// - TestNewSecretVersion: Tests secret version object creation // - TestNewVersion: Tests secret version object creation
// - TestSecretVersionSave: Tests saving a version with encryption // - TestSecretVersionSave: Tests saving a version with encryption
// - TestSecretVersionLoadMetadata: Tests loading and decrypting version metadata // - TestSecretVersionLoadMetadata: Tests loading and decrypting version metadata
// - TestSecretVersionGetValue: Tests retrieving and decrypting version values // - TestSecretVersionGetValue: Tests retrieving and decrypting version values
@ -121,7 +121,7 @@ func TestGenerateVersionNameMaxSerial(t *testing.T) {
assert.Contains(t, err.Error(), "exceeded maximum versions per day") assert.Contains(t, err.Error(), "exceeded maximum versions per day")
} }
func TestNewSecretVersion(t *testing.T) { func TestNewVersion(t *testing.T) {
fs := afero.NewMemMapFs() fs := afero.NewMemMapFs()
vault := &MockVersionVault{ vault := &MockVersionVault{
Name: "test", Name: "test",
@ -129,7 +129,7 @@ func TestNewSecretVersion(t *testing.T) {
stateDir: "/test", stateDir: "/test",
} }
sv := NewSecretVersion(vault, "test/secret", "20231215.001") sv := NewVersion(vault, "test/secret", "20231215.001")
assert.Equal(t, "test/secret", sv.SecretName) assert.Equal(t, "test/secret", sv.SecretName)
assert.Equal(t, "20231215.001", sv.Version) assert.Equal(t, "20231215.001", sv.Version)
@ -161,7 +161,7 @@ func TestSecretVersionSave(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
// Create and save a version // Create and save a version
sv := NewSecretVersion(vault, "test/secret", "20231215.001") sv := NewVersion(vault, "test/secret", "20231215.001")
testValue := []byte("test-secret-value") testValue := []byte("test-secret-value")
err = sv.Save(testValue) err = sv.Save(testValue)
@ -196,7 +196,7 @@ func TestSecretVersionLoadMetadata(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
// Create and save a version with custom metadata // Create and save a version with custom metadata
sv := NewSecretVersion(vault, "test/secret", "20231215.001") sv := NewVersion(vault, "test/secret", "20231215.001")
now := time.Now() now := time.Now()
epochPlusOne := time.Unix(1, 0) epochPlusOne := time.Unix(1, 0)
sv.Metadata.NotBefore = &epochPlusOne sv.Metadata.NotBefore = &epochPlusOne
@ -206,7 +206,7 @@ func TestSecretVersionLoadMetadata(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
// Create new version object and load metadata // Create new version object and load metadata
sv2 := NewSecretVersion(vault, "test/secret", "20231215.001") sv2 := NewVersion(vault, "test/secret", "20231215.001")
err = sv2.LoadMetadata(ltIdentity) err = sv2.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
@ -239,7 +239,7 @@ func TestSecretVersionGetValue(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
// Create and save a version // Create and save a version
sv := NewSecretVersion(vault, "test/secret", "20231215.001") sv := NewVersion(vault, "test/secret", "20231215.001")
originalValue := []byte("test-secret-value-12345") originalValue := []byte("test-secret-value-12345")
err = sv.Save(originalValue) err = sv.Save(originalValue)

8
internal/vault/integration_version_test.go
View File

@ -84,7 +84,7 @@ func TestVersionIntegrationWorkflow(t *testing.T) {
assert.Equal(t, versions[0], currentVersion) assert.Equal(t, versions[0], currentVersion)
// Verify metadata // Verify metadata
version := secret.NewSecretVersion(vault, secretName, versions[0]) version := secret.NewVersion(vault, secretName, versions[0])
err = version.LoadMetadata(ltIdentity) err = version.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
assert.NotNil(t, version.Metadata.CreatedAt) assert.NotNil(t, version.Metadata.CreatedAt)
@ -120,13 +120,13 @@ func TestVersionIntegrationWorkflow(t *testing.T) {
assert.Len(t, versions, 2) assert.Len(t, versions, 2)
// Verify first version metadata was updated with notAfter // Verify first version metadata was updated with notAfter
firstVersion := secret.NewSecretVersion(vault, secretName, firstVersionName) firstVersion := secret.NewVersion(vault, secretName, firstVersionName)
err = firstVersion.LoadMetadata(ltIdentity) err = firstVersion.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
assert.NotNil(t, firstVersion.Metadata.NotAfter) assert.NotNil(t, firstVersion.Metadata.NotAfter)
// Verify second version metadata // Verify second version metadata
secondVersion := secret.NewSecretVersion(vault, secretName, versions[0]) secondVersion := secret.NewVersion(vault, secretName, versions[0])
err = secondVersion.LoadMetadata(ltIdentity) err = secondVersion.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
assert.NotNil(t, secondVersion.Metadata.NotBefore) assert.NotNil(t, secondVersion.Metadata.NotBefore)
@ -199,7 +199,7 @@ func TestVersionIntegrationWorkflow(t *testing.T) {
// Verify the version metadata hasn't changed // Verify the version metadata hasn't changed
// (promoting shouldn't modify timestamps) // (promoting shouldn't modify timestamps)
version := secret.NewSecretVersion(vault, secretName, oldestVersion) version := secret.NewVersion(vault, secretName, oldestVersion)
err = version.LoadMetadata(ltIdentity) err = version.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
assert.NotNil(t, version.Metadata.NotAfter) // should still have its old notAfter assert.NotNil(t, version.Metadata.NotAfter) // should still have its old notAfter

2
internal/vault/metadata.go
View File

@ -16,7 +16,7 @@ import (
type ( type (
VaultMetadata = secret.VaultMetadata VaultMetadata = secret.VaultMetadata
UnlockerMetadata = secret.UnlockerMetadata UnlockerMetadata = secret.UnlockerMetadata
SecretMetadata = secret.SecretMetadata SecretMetadata = secret.Metadata
Configuration = secret.Configuration Configuration = secret.Configuration
) )

10
internal/vault/secrets.go
View File

@ -136,7 +136,7 @@ func (v *Vault) AddSecret(name string, value []byte, force bool) error {
// Handle existing secret case // Handle existing secret case
now := time.Now() now := time.Now()
var previousVersion *secret.SecretVersion var previousVersion *secret.Version
if exists { if exists {
if !force { if !force {
@ -147,7 +147,7 @@ func (v *Vault) AddSecret(name string, value []byte, force bool) error {
// Get the current version to update its notAfter timestamp // Get the current version to update its notAfter timestamp
currentVersionName, err := secret.GetCurrentVersion(v.fs, secretDir) currentVersionName, err := secret.GetCurrentVersion(v.fs, secretDir)
if err == nil && currentVersionName != "" { if err == nil && currentVersionName != "" {
previousVersion = secret.NewSecretVersion(v, name, currentVersionName) previousVersion = secret.NewVersion(v, name, currentVersionName)
// We'll need to load and update its metadata after we unlock the vault // We'll need to load and update its metadata after we unlock the vault
} }
} else { } else {
@ -170,7 +170,7 @@ func (v *Vault) AddSecret(name string, value []byte, force bool) error {
secret.Debug("Generated new version name", "version", versionName, "secret_name", name) secret.Debug("Generated new version name", "version", versionName, "secret_name", name)
// Create new version // Create new version
newVersion := secret.NewSecretVersion(v, name, versionName) newVersion := secret.NewVersion(v, name, versionName)
// Set version timestamps // Set version timestamps
if previousVersion == nil { if previousVersion == nil {
@ -226,7 +226,7 @@ func (v *Vault) AddSecret(name string, value []byte, force bool) error {
} }
// updateVersionMetadata updates the metadata of an existing version // updateVersionMetadata updates the metadata of an existing version
func updateVersionMetadata(fs afero.Fs, version *secret.SecretVersion, ltIdentity *age.X25519Identity) error { func updateVersionMetadata(fs afero.Fs, version *secret.Version, ltIdentity *age.X25519Identity) error {
// Read the version's encrypted private key // Read the version's encrypted private key
encryptedPrivKeyPath := filepath.Join(version.Directory, "priv.age") encryptedPrivKeyPath := filepath.Join(version.Directory, "priv.age")
encryptedPrivKey, err := afero.ReadFile(fs, encryptedPrivKeyPath) encryptedPrivKey, err := afero.ReadFile(fs, encryptedPrivKeyPath)
@ -320,7 +320,7 @@ func (v *Vault) GetSecretVersion(name string, version string) ([]byte, error) {
} }
// Create version object // Create version object
secretVersion := secret.NewSecretVersion(v, name, version) secretVersion := secret.NewVersion(v, name, version)
// Check if version exists // Check if version exists
versionPath := filepath.Join(secretDir, "versions", version) versionPath := filepath.Join(secretDir, "versions", version)

10
internal/vault/secrets_version_test.go
View File

@ -196,7 +196,7 @@ func TestVaultVersionTimestamps(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
require.Len(t, versions, 1) require.Len(t, versions, 1)
firstVersion := secret.NewSecretVersion(vault, secretName, versions[0]) firstVersion := secret.NewVersion(vault, secretName, versions[0])
err = firstVersion.LoadMetadata(ltIdentity) err = firstVersion.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
@ -222,7 +222,7 @@ func TestVaultVersionTimestamps(t *testing.T) {
require.Len(t, versions, 2) require.Len(t, versions, 2)
// Reload first version metadata (should have notAfter now) // Reload first version metadata (should have notAfter now)
firstVersion = secret.NewSecretVersion(vault, secretName, versions[1]) firstVersion = secret.NewVersion(vault, secretName, versions[1])
err = firstVersion.LoadMetadata(ltIdentity) err = firstVersion.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
@ -231,7 +231,7 @@ func TestVaultVersionTimestamps(t *testing.T) {
assert.True(t, firstVersion.Metadata.NotAfter.Before(afterSecond.Add(time.Second))) assert.True(t, firstVersion.Metadata.NotAfter.Before(afterSecond.Add(time.Second)))
// Check second version timestamps // Check second version timestamps
secondVersion := secret.NewSecretVersion(vault, secretName, versions[0]) secondVersion := secret.NewVersion(vault, secretName, versions[0])
err = secondVersion.LoadMetadata(ltIdentity) err = secondVersion.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)
@ -272,7 +272,7 @@ func TestUpdateVersionMetadata(t *testing.T) {
// Create a version manually to test updateVersionMetadata // Create a version manually to test updateVersionMetadata
secretName := "test/secret" secretName := "test/secret"
versionName := "20231215.001" versionName := "20231215.001"
version := secret.NewSecretVersion(vault, secretName, versionName) version := secret.NewVersion(vault, secretName, versionName)
// Set initial metadata // Set initial metadata
now := time.Now() now := time.Now()
@ -290,7 +290,7 @@ func TestUpdateVersionMetadata(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
// Load and verify // Load and verify
version2 := secret.NewSecretVersion(vault, secretName, versionName) version2 := secret.NewVersion(vault, secretName, versionName)
err = version2.LoadMetadata(ltIdentity) err = version2.LoadMetadata(ltIdentity)
require.NoError(t, err) require.NoError(t, err)