cli/context/store: New(): return concrete type

Go conventions are for interfaces to be defined on the receiver side,
and for producers to return concrete types. This patch changes the
constructor to return a concrete type.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Author: thaJeztah

cli/context/store/store.go

@@ -94,11 +94,11 @@ type ContextTLSData struct {
 
 // New creates a store from a given directory.
 // If the directory does not exist or is empty, initialize it
-func New(dir string, cfg Config) Store {
+func New(dir string, cfg Config) *ContextStore {
 	metaRoot := filepath.Join(dir, metadataDir)
 	tlsRoot := filepath.Join(dir, tlsDir)
 
-	return &store{
+	return &ContextStore{
 		meta: &metadataStore{
 			root:   metaRoot,
 			config: cfg,
@@ -109,12 +109,12 @@ func New(dir string, cfg Config) Store {
 	}
 }
 
-type store struct {
+type ContextStore struct {
 	meta *metadataStore
 	tls  *tlsStore
 }
 
-func (s *store) List() ([]Metadata, error) {
+func (s *ContextStore) List() ([]Metadata, error) {
 	return s.meta.list()
 }
 
@@ -131,22 +131,22 @@ func Names(s Lister) ([]string, error) {
 	return names, nil
 }
 
-func (s *store) CreateOrUpdate(meta Metadata) error {
+func (s *ContextStore) CreateOrUpdate(meta Metadata) error {
 	return s.meta.createOrUpdate(meta)
 }
 
-func (s *store) Remove(name string) error {
+func (s *ContextStore) Remove(name string) error {
 	if err := s.meta.remove(name); err != nil {
 		return err
 	}
 	return s.tls.removeAllContextData(name)
 }
 
-func (s *store) GetMetadata(name string) (Metadata, error) {
+func (s *ContextStore) GetMetadata(name string) (Metadata, error) {
 	return s.meta.get(name)
 }
 
-func (s *store) ResetTLSMaterial(name string, data *ContextTLSData) error {
+func (s *ContextStore) ResetTLSMaterial(name string, data *ContextTLSData) error {
 	if err := s.tls.removeAllContextData(name); err != nil {
 		return err
 	}
@@ -163,7 +163,7 @@ func (s *store) ResetTLSMaterial(name string, data *ContextTLSData) error {
 	return nil
 }
 
-func (s *store) ResetEndpointTLSMaterial(contextName string, endpointName string, data *EndpointTLSData) error {
+func (s *ContextStore) ResetEndpointTLSMaterial(contextName string, endpointName string, data *EndpointTLSData) error {
 	if err := s.tls.removeAllEndpointData(contextName, endpointName); err != nil {
 		return err
 	}
@@ -178,23 +178,23 @@ func (s *store) ResetEndpointTLSMaterial(contextName string, endpointName string
 	return nil
 }
 
-func (s *store) ListTLSFiles(name string) (map[string]EndpointFiles, error) {
+func (s *ContextStore) ListTLSFiles(name string) (map[string]EndpointFiles, error) {
 	res, err := s.tls.listContextData(name)
 	if err != nil {
 		return res, errors.Wrapf(err, "failed to list TLS files for context %s", name)
 	}
 	return res, nil
 }
 
-func (s *store) GetTLSData(contextName, endpointName, fileName string) ([]byte, error) {
+func (s *ContextStore) GetTLSData(contextName, endpointName, fileName string) ([]byte, error) {
 	res, err := s.tls.getData(contextName, endpointName, fileName)
 	if err != nil {
 		return res, errors.Wrapf(err, "failed to read TLS data for context %s", contextName)
 	}
 	return res, nil
 }
 
-func (s *store) GetStorageInfo(contextName string) StorageInfo {
+func (s *ContextStore) GetStorageInfo(contextName string) StorageInfo {
 	dir := contextdirOf(contextName)
 	return StorageInfo{
 		MetadataPath: s.meta.contextDir(dir),

cli/context/store/storeconfig.go

@@ -19,7 +19,7 @@ func EndpointTypeGetter(name string, getter TypeGetter) NamedTypeGetter {
 	}
 }
 
-// Config is used to configure the metadata marshaler of the context store
+// Config is used to configure the metadata marshaler of the context ContextStore
 type Config struct {
 	contextType   TypeGetter
 	endpointTypes map[string]TypeGetter

cli/context/store/storeconfig_test.go

@@ -6,10 +6,12 @@ import (
 	"gotest.tools/v3/assert"
 )
 
-type testCtx struct{}
-type testEP1 struct{}
-type testEP2 struct{}
-type testEP3 struct{}
+type (
+	testCtx struct{}
+	testEP1 struct{}
+	testEP2 struct{}
+	testEP3 struct{}
+)
 
 func TestConfigModification(t *testing.T) {
 	cfg := NewConfig(func() interface{} { return &testCtx{} }, EndpointTypeGetter("ep1", func() interface{} { return &testEP1{} }))
@@ -24,7 +26,7 @@ func TestConfigModification(t *testing.T) {
 	assert.Equal(t, &testCtx{}, cfg.contextType())
 	assert.Equal(t, &testEP2{}, cfg.endpointTypes["ep1"]())
 	assert.Equal(t, &testEP3{}, cfg.endpointTypes["ep2"]())
-	// check it applied on already initialized store
+	// check it applied on already initialized ContextStore
 	assert.Equal(t, &testCtx{}, cfgCopy.contextType())
 	assert.Equal(t, &testEP2{}, cfgCopy.endpointTypes["ep1"]())
 	assert.Equal(t, &testEP3{}, cfgCopy.endpointTypes["ep2"]())