refactor (shuffle around) storage interfaces into storage package

cmd/kmfddm/storage.go

@@ -20,10 +20,9 @@ type allStorage interface {
 	ddm.StatusStorage
 	api.EnrollmentAPIStorage
 	api.StatusAPIStorage
-	storage.Toucher
+	storage.DeclarationAPIStorage
 	storage.EnrollmentIDRetriever
-	storage.DeclarationRetriever
-	storage.TokensDeclarationItemsRetriever
+	storage.EnrollmentDeclarationStorage
 }
 
 var hasher func() hash.Hash = func() hash.Hash { return xxhash.New() }

http/api/declarations.go

@@ -18,12 +18,11 @@ type DeclarationAPIStorage interface {
 	RetrieveDeclaration(ctx context.Context, declarationID string) (*ddm.Declaration, error)
 	DeleteDeclaration(ctx context.Context, declarationID string) (bool, error)
 	RetrieveDeclarationSets(ctx context.Context, declarationID string) (setNames []string, err error)
-	StoreDeclaration(ctx context.Context, d *ddm.Declaration) (bool, error)
 	RetrieveDeclarations(ctx context.Context) ([]string, error)
 }
 
 // PutDeclarationHandler stores a new or overwrites an existing declaration.
-func PutDeclarationHandler(store DeclarationAPIStorage, notifier Notifier, logger log.Logger) http.HandlerFunc {
+func PutDeclarationHandler(store storage.DeclarationStorer, notifier Notifier, logger log.Logger) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		logger := ctxlog.Logger(r.Context(), logger)
 		bodyBytes, err := io.ReadAll(r.Body)

storage/storage.go

@@ -3,13 +3,29 @@ package storage
 
 import (
 	"context"
+
+	"github.com/jessepeterson/kmfddm/ddm"
 )
 
 type Toucher interface {
-	// TouchDeclaration forces a change only to a declaration's ServerToken.
+	// TouchDeclaration forces a change to a declaration's ServerToken only.
 	TouchDeclaration(ctx context.Context, declarationID string) error
 }
 
+type DeclarationStorer interface {
+	// StoreDeclaration stores a declaration.
+	//
+	// Note that a storage backend may tried to creation relations
+	// based on the the ddm.IdentifierRefs field.
+	StoreDeclaration(ctx context.Context, d *ddm.Declaration) (bool, error)
+}
+
+// DeclarationAPIStorage are storage interfaces relating to declaration APIs.
+type DeclarationAPIStorage interface {
+	Toucher
+	DeclarationStorer
+}
+
 type EnrollmentIDRetriever interface {
 	// RetrieveEnrollmentIDs retrieves MDM enrollment IDs from storage.
 	// In the case of sets and declarations the transitive associations
@@ -22,10 +38,12 @@ type EnrollmentIDRetriever interface {
 }
 
 type TokensJSONRetriever interface {
+	// RetrieveTokensJSON returns the token JSON for an enrollment ID.
 	RetrieveTokensJSON(ctx context.Context, enrollmentID string) ([]byte, error)
 }
 
 type TokensDeclarationItemsRetriever interface {
+	// RetrieveDeclarationItemsJSON returns the declaration items JSON for an enrollment ID.
 	RetrieveDeclarationItemsJSON(ctx context.Context, enrollmentID string) ([]byte, error)
 	TokensJSONRetriever
 }
@@ -34,3 +52,9 @@ type DeclarationRetriever interface {
 	// RetrieveEnrollmentDeclarationJSON fetches the JSON for a declaration for an enrollment ID.
 	RetrieveEnrollmentDeclarationJSON(ctx context.Context, declarationID, declarationType, enrollmentID string) ([]byte, error)
 }
+
+// EnrollmentDeclarationStorage is the storage required to support declarations in the DDM protocol.
+type EnrollmentDeclarationStorage interface {
+	TokensDeclarationItemsRetriever
+	DeclarationRetriever
+}

storage/test/basic.go

@@ -21,8 +21,8 @@ type allTestStorage interface {
 	setAndDeclStorage
 	api.EnrollmentAPIStorage
 	storage.TokensDeclarationItemsRetriever
-	storage.Toucher
 	storage.EnrollmentIDRetriever
+	storage.DeclarationAPIStorage
 }
 
 func TestBasic(t *testing.T, storage allTestStorage, ctx context.Context) {

storage/test/declarations.go

@@ -11,7 +11,7 @@ import (
 
 type declStorage interface {
 	api.DeclarationAPIStorage
-	storage.Toucher
+	storage.DeclarationAPIStorage
 }
 
 func testStoreDeclaration(t *testing.T, storage declStorage, ctx context.Context, decl *ddm.Declaration) {

storage/test/status.go

@@ -15,7 +15,7 @@ import (
 type statusStorage interface {
 	httpddm.StatusStorage
 	api.StatusAPIStorage
-	api.DeclarationAPIStorage
+	storage.DeclarationStorer
 	api.EnrollmentAPIStorage
 	api.SetAPIStorage
 }