Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Tidy up persistent state tests #2914

Merged
merged 1 commit into from
Apr 7, 2023
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
1 change: 1 addition & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ linters-settings:
- github\.com/twpayne/chezmoi/v2/pkg/chezmoi\.ActualStateEntry
- github\.com/twpayne/chezmoi/v2/pkg/chezmoi\.Encryption
- github\.com/twpayne/chezmoi/v2/pkg/chezmoi\.Format
- github\.com/twpayne/chezmoi/v2/pkg/chezmoi\.PersistentState
- github\.com/twpayne/chezmoi/v2/pkg/chezmoi\.SourceStateOrigin
- github\.com/twpayne/chezmoi/v2/pkg/chezmoi\.SourceStateEntry
- github\.com/twpayne/chezmoi/v2/pkg/chezmoi\.System
Expand Down
18 changes: 18 additions & 0 deletions pkg/chezmoi/boltpersistentstate_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package chezmoi

import (
"os"
"testing"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -129,6 +130,23 @@ func TestBoltPersistentStateMock(t *testing.T) {
})
}

func TestBoltPersistentStateGeneric(t *testing.T) {
system := NewRealSystem(vfs.OSFS)
var tempDirs []string
defer func() {
for _, tempDir := range tempDirs {
assert.NoError(t, os.RemoveAll(tempDir))
}
}()
testPersistentState(t, func() PersistentState {
tempDir, err := os.MkdirTemp("", "chezmoi-test")
require.NoError(t, err)
b, err := NewBoltPersistentState(system, NewAbsPath(tempDir).JoinString("chezmoistate.boltdb"), BoltPersistentStateReadWrite)
require.NoError(t, err)
return b
})
}

func TestBoltPersistentStateReadOnly(t *testing.T) {
chezmoitest.WithTestFS(t, nil, func(fileSystem vfs.FS) {
var (
Expand Down
53 changes: 3 additions & 50 deletions pkg/chezmoi/mockpersistentstate_test.go
Original file line number Diff line number Diff line change
@@ -1,58 +1,11 @@
package chezmoi

import (
"io"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestMockPersistentState(t *testing.T) {
var (
bucket = []byte("bucket")
key = []byte("key")
value = []byte("value")
)

s1 := NewMockPersistentState()

require.NoError(t, s1.Delete(bucket, value))

actualValue, err := s1.Get(bucket, key)
require.NoError(t, err)
assert.Nil(t, actualValue)

require.NoError(t, s1.Set(bucket, key, value))

actualValue, err = s1.Get(bucket, key)
require.NoError(t, err)
assert.Equal(t, value, actualValue)

require.NoError(t, s1.ForEach(bucket, func(k, v []byte) error {
assert.Equal(t, key, k)
assert.Equal(t, value, v)
return nil
}))

assert.Equal(t, io.EOF, s1.ForEach(bucket, func(k, v []byte) error {
return io.EOF
}))

s2 := NewMockPersistentState()
require.NoError(t, s1.CopyTo(s2))
actualValue, err = s2.Get(bucket, key)
assert.NoError(t, err)
assert.Equal(t, value, actualValue)

require.NoError(t, s1.Close())

actualValue, err = s1.Get(bucket, key)
assert.NoError(t, err)
assert.Equal(t, value, actualValue)

require.NoError(t, s1.Delete(bucket, key))
actualValue, err = s1.Get(bucket, key)
require.NoError(t, err)
assert.Nil(t, actualValue)
testPersistentState(t, func() PersistentState {
return NewMockPersistentState()
})
}
70 changes: 70 additions & 0 deletions pkg/chezmoi/persistentstate_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package chezmoi

import (
"io"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func testPersistentState(t *testing.T, constructor func() PersistentState) {
t.Helper()

var (
bucket1 = []byte("bucket1")
bucket2 = []byte("bucket2")
key = []byte("key1")
value = []byte("value")
)

s1 := constructor()

require.NoError(t, s1.Delete(bucket1, value))

actualValue, err := s1.Get(bucket1, key)
require.NoError(t, err)
assert.Nil(t, actualValue)

require.NoError(t, s1.Set(bucket1, key, value))

actualValue, err = s1.Get(bucket1, key)
require.NoError(t, err)
assert.Equal(t, value, actualValue)

require.NoError(t, s1.ForEach(bucket1, func(k, v []byte) error {
assert.Equal(t, key, k)
assert.Equal(t, value, v)
return nil
}))

assert.Equal(t, io.EOF, s1.ForEach(bucket1, func(k, v []byte) error {
return io.EOF
}))

s2 := constructor()
require.NoError(t, s1.CopyTo(s2))
actualValue, err = s2.Get(bucket1, key)
assert.NoError(t, err)
assert.Equal(t, value, actualValue)

require.NoError(t, s2.Close())

actualValue, err = s1.Get(bucket1, key)
assert.NoError(t, err)
assert.Equal(t, value, actualValue)

require.NoError(t, s1.Delete(bucket1, key))
actualValue, err = s1.Get(bucket1, key)
require.NoError(t, err)
assert.Nil(t, actualValue)

require.NoError(t, s1.Set(bucket2, key, value))
actualValue, err = s1.Get(bucket2, key)
require.NoError(t, err)
assert.Equal(t, value, actualValue)
require.NoError(t, s1.DeleteBucket(bucket2))
actualValue, err = s1.Get(bucket2, key)
require.NoError(t, err)
assert.Nil(t, actualValue)
}