Skip to content

Commit 8e60f8c

Browse files
msanftmsanft
committed
treewide: align naming
To align with the configmapstore package, we also split the AferoStore into a separate aferostore package. Then, since the package names now convey the information about the backing store, the store creation functions are renamed to just "New".
1 parent 53b225a commit 8e60f8c

File tree

8 files changed

+42
-38
lines changed

8 files changed

+42
-38
lines changed

‎coordinator/internal/stateguard/stateguard_test.go‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import (
2020
"time"
2121

2222
"github.com/edgelesssys/contrast/internal/history"
23+
"github.com/edgelesssys/contrast/internal/history/aferostore"
2324
"github.com/edgelesssys/contrast/internal/manifest"
2425
"github.com/edgelesssys/contrast/internal/seedengine"
2526
"github.com/edgelesssys/contrast/internal/testkeys"
@@ -196,7 +197,7 @@ func TestConcurrentUpdateState(t *testing.T) {
196197
assert := assert.New(t)
197198

198199
store := &storeWithSync{
199-
Store: history.NewAferoStore(&afero.Afero{Fs: afero.NewMemMapFs()}),
200+
Store: aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()}),
200201
}
201202
hist := history.NewWithStore(slog.Default(), store)
202203
guard := New(hist, prometheus.NewRegistry(), slog.Default())
@@ -298,7 +299,7 @@ func TestWatchHistory(t *testing.T) {
298299
require := require.New(t)
299300

300301
store := &storeWithManualUpdates{
301-
Store: history.NewAferoStore(&afero.Afero{Fs: afero.NewMemMapFs()}),
302+
Store: aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()}),
302303
notifications: make(chan []byte),
303304
}
304305
hist := history.NewWithStore(slog.Default(), store)
@@ -347,7 +348,7 @@ func TestWatchHistoryLateNotifications(t *testing.T) {
347348
require := require.New(t)
348349

349350
store := &storeWithManualUpdates{
350-
Store: history.NewAferoStore(&afero.Afero{Fs: afero.NewMemMapFs()}),
351+
Store: aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()}),
351352
notifications: make(chan []byte),
352353
}
353354
hist := history.NewWithStore(slog.Default(), store)
@@ -401,7 +402,7 @@ func (s *storeWithManualUpdates) Watch(string) (<-chan []byte, func(), error) {
401402
func TestBadStoreWatcherIsRestarted(t *testing.T) {
402403
fs := afero.NewBasePathFs(afero.NewOsFs(), t.TempDir())
403404
store := &badStore{
404-
Store: history.NewAferoStore(&afero.Afero{Fs: fs}),
405+
Store: aferostore.New(&afero.Afero{Fs: fs}),
405406
watchCalls: make(chan string, 10),
406407
}
407408
ch := make(chan []byte)
@@ -498,7 +499,7 @@ func (c *waitingClock) WaitForAfterCall(t *testing.T, d time.Duration) {
498499

499500
func newTestGuard(t *testing.T) (*Guard, *prometheus.Registry) {
500501
t.Helper()
501-
store := history.NewAferoStore(&afero.Afero{Fs: afero.NewMemMapFs()})
502+
store := aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()})
502503
hist := history.NewWithStore(slog.Default(), store)
503504
reg := prometheus.NewRegistry()
504505
return New(hist, reg, slog.Default()), reg

‎coordinator/internal/userapi/userapi_test.go‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import (
2323

2424
"github.com/edgelesssys/contrast/coordinator/internal/stateguard"
2525
"github.com/edgelesssys/contrast/internal/history"
26+
"github.com/edgelesssys/contrast/internal/history/aferostore"
2627
"github.com/edgelesssys/contrast/internal/manifest"
2728
"github.com/edgelesssys/contrast/internal/testkeys"
2829
"github.com/edgelesssys/contrast/internal/userapi"
@@ -365,7 +366,7 @@ func TestRecovery(t *testing.T) {
365366

366367
logger := slog.Default()
367368
fs := afero.NewMemMapFs()
368-
store := history.NewAferoStore(&afero.Afero{Fs: fs})
369+
store := aferostore.New(&afero.Afero{Fs: fs})
369370
hist := history.NewWithStore(slog.Default(), store)
370371
auth := stateguard.New(hist, prometheus.NewRegistry(), logger)
371372
discovery := &stubDiscovery{
@@ -421,7 +422,7 @@ func TestRecoveryFlow(t *testing.T) {
421422

422423
logger := slog.Default()
423424
fs := afero.NewMemMapFs()
424-
store := history.NewAferoStore(&afero.Afero{Fs: fs})
425+
store := aferostore.New(&afero.Afero{Fs: fs})
425426
hist := history.NewWithStore(slog.Default(), store)
426427
auth := stateguard.New(hist, prometheus.NewRegistry(), logger)
427428
a := New(logger, auth, &stubDiscovery{})
@@ -500,7 +501,7 @@ func TestUserAPIConcurrent(t *testing.T) {
500501

501502
logger := slog.Default()
502503
fs := afero.NewBasePathFs(afero.NewOsFs(), t.TempDir())
503-
store := history.NewAferoStore(&afero.Afero{Fs: fs})
504+
store := aferostore.New(&afero.Afero{Fs: fs})
504505
hist := history.NewWithStore(slog.Default(), store)
505506
auth := stateguard.New(hist, prometheus.NewRegistry(), logger)
506507
coordinator := New(logger, auth, &stubDiscovery{})
@@ -814,7 +815,7 @@ func newCoordinator() *Server {
814815
func newCoordinatorWithRegistry(reg *prometheus.Registry) *Server {
815816
logger := slog.Default()
816817
fs := afero.NewMemMapFs()
817-
store := history.NewAferoStore(&afero.Afero{Fs: fs})
818+
store := aferostore.New(&afero.Afero{Fs: fs})
818819
hist := history.NewWithStore(slog.Default(), store)
819820
auth := stateguard.New(hist, reg, logger)
820821
return New(logger, auth, &stubDiscovery{})
@@ -941,7 +942,7 @@ type watchableStore struct {
941942
func newWatchableStore() *watchableStore {
942943
fs := afero.NewMemMapFs()
943944
return &watchableStore{
944-
Store: history.NewAferoStore(&afero.Afero{Fs: fs}),
945+
Store: aferostore.New(&afero.Afero{Fs: fs}),
945946
watchers: make(map[string][]chan []byte),
946947
watchCalled: make(chan string, 20),
947948
}

‎coordinator/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ func run() (retErr error) {
108108
promRegistry := prometheus.NewRegistry()
109109
serverMetrics := newServerMetrics(promRegistry)
110110

111-
store, err := configmapstore.NewConfigMapStore(clientset, string(namespace), logger.WithGroup("history-store"))
111+
store, err := configmapstore.New(clientset, string(namespace), logger.WithGroup("history-store"))
112112
if err != nil {
113113
return fmt.Errorf("creating history store: %w", err)
114114
}

internal/history/aferostore.go renamed to internal/history/aferostore/aferostore.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright 2024 Edgeless Systems GmbH
22
// SPDX-License-Identifier: BUSL-1.1
33

4-
package history
4+
package aferostore
55

66
import (
77
"bytes"
@@ -23,8 +23,8 @@ type AferoStore struct {
2323
mux sync.RWMutex
2424
}
2525

26-
// NewAferoStore creates a new instance backed by the given fs.
27-
func NewAferoStore(fs *afero.Afero) *AferoStore {
26+
// New creates a new [AferoStore] instance backed by the given fs.
27+
func New(fs *afero.Afero) *AferoStore {
2828
return &AferoStore{fs: fs}
2929
}
3030

internal/history/aferostore_test.go renamed to internal/history/aferostore/aferostore_test.go

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,32 @@
11
// Copyright 2024 Edgeless Systems GmbH
22
// SPDX-License-Identifier: BUSL-1.1
33

4-
package history
4+
package aferostore
55

66
import (
77
"os"
88
"testing"
99

10+
"github.com/edgelesssys/contrast/internal/history"
1011
"github.com/spf13/afero"
1112
"github.com/stretchr/testify/require"
1213
)
1314

1415
func TestAferoStore(t *testing.T) {
1516
t.Run("memmap", func(t *testing.T) {
16-
suite(t, func(_ *testing.T) Store {
17-
return NewAferoStore(&afero.Afero{Fs: afero.NewMemMapFs()})
17+
suite(t, func(_ *testing.T) history.Store {
18+
return New(&afero.Afero{Fs: afero.NewMemMapFs()})
1819
})
1920
})
2021

2122
t.Run("tmpdir", func(t *testing.T) {
22-
suite(t, func(t *testing.T) Store {
23-
return NewAferoStore(&afero.Afero{Fs: afero.NewBasePathFs(afero.NewOsFs(), t.TempDir())})
23+
suite(t, func(t *testing.T) history.Store {
24+
return New(&afero.Afero{Fs: afero.NewBasePathFs(afero.NewOsFs(), t.TempDir())})
2425
})
2526
})
2627
}
2728

28-
func suite(t *testing.T, storeFactory func(t *testing.T) Store) {
29+
func suite(t *testing.T, storeFactory func(t *testing.T) history.Store) {
2930
t.Run("Get and Set", func(t *testing.T) {
3031
require := require.New(t)
3132
s := storeFactory(t)

‎internal/history/configmapstore/configmapstore.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ type ConfigMapStore struct {
3939
logger *slog.Logger
4040
}
4141

42-
// NewConfigMapStore creates a new instance backed by Kubernetes Config Maps.
43-
func NewConfigMapStore(client kubernetes.Interface, namespace string, log *slog.Logger) (*ConfigMapStore, error) {
42+
// New creates a new [ConfigMapStore] instance with the given Kubernetes client.
43+
func New(client kubernetes.Interface, namespace string, log *slog.Logger) (*ConfigMapStore, error) {
4444
ctx, cancel := context.WithTimeout(context.Background(), timeout)
4545
defer cancel()
4646
self, err := client.CoreV1().Pods(namespace).Get(ctx, os.Getenv("HOSTNAME"), metav1.GetOptions{})

‎internal/history/configmapstore/configmapstore_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ func TestGetSet(t *testing.T) {
3434
require := require.New(t)
3535

3636
t.Setenv("HOSTNAME", "coordinator-0")
37-
s, err := NewConfigMapStore(fake.NewClientset(coordinatorPod()), "test", slog.Default())
37+
s, err := New(fake.NewClientset(coordinatorPod()), "test", slog.Default())
3838
require.NoError(err)
3939

4040
key := "foo/bar"
@@ -67,7 +67,7 @@ func TestHas(t *testing.T) {
6767
require := require.New(t)
6868

6969
t.Setenv("HOSTNAME", "coordinator-0")
70-
s, err := NewConfigMapStore(fake.NewClientset(coordinatorPod()), "test", slog.Default())
70+
s, err := New(fake.NewClientset(coordinatorPod()), "test", slog.Default())
7171
require.NoError(err)
7272

7373
key := "foo/bar"
@@ -84,7 +84,7 @@ func TestCompareAndSwap(t *testing.T) {
8484
require := require.New(t)
8585

8686
t.Setenv("HOSTNAME", "coordinator-0")
87-
s, err := NewConfigMapStore(fake.NewClientset(coordinatorPod()), "test", slog.Default())
87+
s, err := New(fake.NewClientset(coordinatorPod()), "test", slog.Default())
8888
require.NoError(err)
8989

9090
key := "foo/bar"
@@ -117,7 +117,7 @@ func TestWatch(t *testing.T) {
117117
require := require.New(t)
118118

119119
t.Setenv("HOSTNAME", "coordinator-0")
120-
s, err := NewConfigMapStore(fake.NewClientset(coordinatorPod()), "test", slog.Default())
120+
s, err := New(fake.NewClientset(coordinatorPod()), "test", slog.Default())
121121
require.NoError(err)
122122

123123
key := "foo/bar"

‎internal/history/history_test.go‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"testing"
1313
"time"
1414

15+
"github.com/edgelesssys/contrast/internal/history/aferostore"
1516
"github.com/edgelesssys/contrast/internal/testkeys"
1617
"github.com/spf13/afero"
1718
"github.com/stretchr/testify/assert"
@@ -89,7 +90,7 @@ func TestHistory_GetLatestAndHasLatest(t *testing.T) {
8990
}
9091

9192
h := &History{
92-
store: NewAferoStore(&fs),
93+
store: aferostore.New(&fs),
9394
}
9495

9596
gotT, err := h.GetLatest(&tc.signingKey.PublicKey)
@@ -116,7 +117,7 @@ func TestHistory_GetLatestAndHasLatest(t *testing.T) {
116117
}
117118

118119
h := &History{
119-
store: NewAferoStore(&fs),
120+
store: aferostore.New(&fs),
120121
}
121122

122123
got, err := h.HasLatest()
@@ -138,7 +139,7 @@ func TestHistory_GetLatestAndHasLatest(t *testing.T) {
138139
}
139140

140141
h := &History{
141-
store: NewAferoStore(&fs),
142+
store: aferostore.New(&fs),
142143
}
143144

144145
gotT, err := h.GetLatestInsecure()
@@ -243,7 +244,7 @@ func TestHistory_SetLatest(t *testing.T) {
243244
}
244245

245246
h := &History{
246-
store: NewAferoStore(&fs),
247+
store: aferostore.New(&fs),
247248
}
248249

249250
err := h.SetLatest(tc.oldT, tc.newT, tc.signingKey)
@@ -303,7 +304,7 @@ func TestHistory_GetTransition(t *testing.T) {
303304
}
304305

305306
h := &History{
306-
store: NewAferoStore(&fs),
307+
store: aferostore.New(&fs),
307308
}
308309

309310
gotTransition, err := h.GetTransition(strToHash(require, tc.hash))
@@ -378,7 +379,7 @@ func TestHistory_SetTransition(t *testing.T) {
378379
}
379380

380381
h := &History{
381-
store: NewAferoStore(&fs),
382+
store: aferostore.New(&fs),
382383
}
383384

384385
gotHash, err := h.SetTransition(&tc.transition)
@@ -452,7 +453,7 @@ func TestHistory_getCA(t *testing.T) {
452453
}
453454

454455
h := &History{
455-
store: NewAferoStore(&fs),
456+
store: aferostore.New(&fs),
456457
}
457458

458459
hash := strToHash(require, tc.hash)
@@ -523,7 +524,7 @@ func TestHistory_setCA(t *testing.T) {
523524
}
524525

525526
h := &History{
526-
store: NewAferoStore(&fs),
527+
store: aferostore.New(&fs),
527528
}
528529

529530
gotHash, err := h.setContentaddressed(tc.pathFmt, []byte(tc.data))
@@ -557,7 +558,7 @@ func TestHistory_setCA(t *testing.T) {
557558

558559
func TestHistory_SetGet(t *testing.T) {
559560
h := &History{
560-
store: &AferoStore{fs: &afero.Afero{Fs: afero.NewMemMapFs()}},
561+
store: aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()}),
561562
}
562563

563564
testCases := []string{
@@ -638,7 +639,7 @@ func TestHistory_WalkTransitions(t *testing.T) {
638639
t.Run("empty history", func(t *testing.T) {
639640
require := require.New(t)
640641
h := &History{
641-
store: &AferoStore{fs: &afero.Afero{Fs: afero.NewMemMapFs()}},
642+
store: aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()}),
642643
}
643644
doNotCall := func(_ [32]byte, _ *Transition) error {
644645
require.Fail("closure should not be called without any transitions")
@@ -651,7 +652,7 @@ func TestHistory_WalkTransitions(t *testing.T) {
651652
t.Run("walk transitions", func(t *testing.T) {
652653
require := require.New(t)
653654
h := &History{
654-
store: &AferoStore{fs: &afero.Afero{Fs: afero.NewMemMapFs()}},
655+
store: aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()}),
655656
}
656657
expectedTransitionChainSize := 42
657658
var latestTransition [HashSize]byte
@@ -690,7 +691,7 @@ func TestHistory_WalkTransitions(t *testing.T) {
690691
t.Run("failing consume func", func(t *testing.T) {
691692
require := require.New(t)
692693
h := &History{
693-
store: &AferoStore{fs: &afero.Afero{Fs: afero.NewMemMapFs()}},
694+
store: aferostore.New(&afero.Afero{Fs: afero.NewMemMapFs()}),
694695
}
695696
var latestTransition [HashSize]byte
696697

0 commit comments

Comments
 (0)