poutine/poutine_test.go at main · calumari/poutine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
package poutine

import (
	"context"
	"testing"

	"github.com/calumari/jwalk"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/mock"
	"github.com/stretchr/testify/require"

	"github.com/calumari/poutine/database"
)

type mockDriver struct{ mock.Mock }

var _ database.Driver = (*mockDriver)(nil)

func (m *mockDriver) Seed(ctx context.Context, root jwalk.Document) (jwalk.Document, error) {
	args := m.Called(ctx, root)
	return args.Get(0).(jwalk.Document), args.Error(1)
}
func (m *mockDriver) Snapshot(ctx context.Context) (jwalk.Document, error) {
	args := m.Called(ctx)
	return args.Get(0).(jwalk.Document), args.Error(1)
}
func (m *mockDriver) Teardown(ctx context.Context) error {
	args := m.Called(ctx)
	return args.Error(0)
}

type mockRegistrarDriver struct{ mockDriver }

var _ Registrar = (*mockRegistrarDriver)(nil)

func (m *mockRegistrarDriver) RegisterTypes(reg *jwalk.Registry) error {
	args := m.Called(reg)
	return args.Error(0)
}

func docKV(k string, v any) jwalk.Document { return jwalk.Document{{Key: k, Value: v}} }

func TestPoutine_Seed(t *testing.T) {
	t.Run("seed success returns document", func(t *testing.T) {
		md := &mockDriver{}
		root := docKV("root", 0)
		want := docKV("seed", 1)
		md.On("Seed", mock.Anything, root).Return(want, nil).Once()
		p := New(md)
		got, err := p.Seed(t.Context(), root)
		require.NoError(t, err)
		assert.Equal(t, want, got)
		md.AssertExpectations(t)
	})

	t.Run("seed driver error returns error", func(t *testing.T) {
		md := &mockDriver{}
		root := docKV("root", 0)
		md.On("Seed", mock.Anything, root).Return(jwalk.Document(nil), assert.AnError).Once()
		p := New(md)
		got, err := p.Seed(t.Context(), root)
		assert.Error(t, err)
		assert.Nil(t, got)
		assert.Equal(t, assert.AnError, err)
		md.AssertExpectations(t)
	})
}

func TestPoutine_Snapshot(t *testing.T) {
	t.Run("snapshot success returns document", func(t *testing.T) {
		md := &mockDriver{}
		want := docKV("snap", 2)
		md.On("Snapshot", mock.Anything).Return(want, nil).Once()
		p := New(md)
		got, err := p.Snapshot(t.Context())
		require.NoError(t, err)
		assert.Equal(t, want, got)
		md.AssertExpectations(t)
	})

	t.Run("snapshot driver error returns error", func(t *testing.T) {
		md := &mockDriver{}
		md.On("Snapshot", mock.Anything).Return(jwalk.Document(nil), assert.AnError).Once()
		p := New(md)
		got, err := p.Snapshot(t.Context())
		assert.Error(t, err)
		assert.Nil(t, got)
		assert.Equal(t, assert.AnError, err)
		md.AssertExpectations(t)
	})
}

func TestPoutine_Teardown(t *testing.T) {
	t.Run("teardown success returns nil", func(t *testing.T) {
		md := &mockDriver{}
		md.On("Teardown", mock.Anything).Return(nil).Once()
		p := New(md)
		err := p.Teardown(t.Context())
		require.NoError(t, err)
		md.AssertExpectations(t)
	})

	t.Run("teardown driver error returns error", func(t *testing.T) {
		md := &mockDriver{}
		md.On("Teardown", mock.Anything).Return(assert.AnError).Once()
		p := New(md)
		err := p.Teardown(t.Context())
		assert.Error(t, err)
		assert.Equal(t, assert.AnError, err)
		md.AssertExpectations(t)
	})
}

func TestPoutine_RegisterTypes(t *testing.T) {
	t.Run("bind registrar driver success invokes register", func(t *testing.T) {
		md := &mockRegistrarDriver{}
		reg, err := jwalk.NewRegistry()
		require.NoError(t, err)
		md.On("RegisterTypes", reg).Return(nil).Once()
		p := New(md)
		err = p.RegisterTypes(reg)
		require.NoError(t, err)
		md.AssertExpectations(t)
	})

	t.Run("bind registrar driver error returns error", func(t *testing.T) {
		md := &mockRegistrarDriver{}
		reg, err := jwalk.NewRegistry()
		require.NoError(t, err)
		md.On("RegisterTypes", reg).Return(assert.AnError).Once()
		p := New(md)
		gotErr := p.RegisterTypes(reg)
		assert.Error(t, gotErr)
		assert.Equal(t, assert.AnError, gotErr)
		md.AssertExpectations(t)
	})

	t.Run("bind non-registrar driver no-op succeeds", func(t *testing.T) {
		md := &mockDriver{}
		p := New(md)
		reg, err := jwalk.NewRegistry()
		require.NoError(t, err)
		// no expectation set for RegisterTypes (not implemented)
		err = p.RegisterTypes(reg)
		require.NoError(t, err)
		md.AssertExpectations(t)
	})
}