refactor(api): change PublicKeyCreate to return fingerprint

- Change PublicKeyCreate return type from error to (string, error)

Author: heiytor

api/services/sshkeys.go

@@ -141,8 +141,7 @@ func (s *service) CreatePublicKey(ctx context.Context, req requests.PublicKeyCre
 		},
 	}
 
-	err = s.store.PublicKeyCreate(ctx, &model)
-	if err != nil {
+	if _, err := s.store.PublicKeyCreate(ctx, &model); err != nil {
 		return nil, err
 	}
 

api/services/sshkeys_test.go

@@ -855,7 +855,7 @@ func TestCreatePublicKeys(t *testing.T) {
 				}
 
 				storeMock.On("PublicKeyGet", ctx, keyWithHostname.Fingerprint, "tenant").Return(nil, store.ErrNoDocuments).Once()
-				storeMock.On("PublicKeyCreate", ctx, &keyWithHostnameModel).Return(errors.New("error", "", 0)).Once()
+				storeMock.On("PublicKeyCreate", ctx, &keyWithHostnameModel).Return("", errors.New("error", "", 0)).Once()
 			},
 			expected: Expected{nil, errors.New("error", "", 0)},
 		},
@@ -894,7 +894,7 @@ func TestCreatePublicKeys(t *testing.T) {
 				}
 
 				storeMock.On("PublicKeyGet", ctx, keyWithHostname.Fingerprint, "tenant").Return(nil, store.ErrNoDocuments).Once()
-				storeMock.On("PublicKeyCreate", ctx, &keyWithHostnameModel).Return(nil).Once()
+				storeMock.On("PublicKeyCreate", ctx, &keyWithHostnameModel).Return(ssh.FingerprintLegacyMD5(pubKey), nil).Once()
 			},
 			expected: Expected{&responses.PublicKeyCreate{
 				Data: ssh.MarshalAuthorizedKey(pubKey),
@@ -952,7 +952,7 @@ func TestCreatePublicKeys(t *testing.T) {
 					Once()
 				storeMock.On("TagList", ctx, mock.AnythingOfType("store.QueryOption")).Return(tags, len(tags), nil).Once()
 				storeMock.On("PublicKeyGet", ctx, keyWithTags.Fingerprint, "tenant").Return(nil, store.ErrNoDocuments).Once()
-				storeMock.On("PublicKeyCreate", ctx, &keyWithTagsModel).Return(errors.New("error", "", 0)).Once()
+				storeMock.On("PublicKeyCreate", ctx, &keyWithTagsModel).Return("", errors.New("error", "", 0)).Once()
 			},
 			expected: Expected{nil, errors.New("error", "", 0)},
 		},
@@ -1000,7 +1000,7 @@ func TestCreatePublicKeys(t *testing.T) {
 					Once()
 				storeMock.On("TagList", ctx, mock.AnythingOfType("store.QueryOption")).Return(tags, len(tags), nil).Once()
 				storeMock.On("PublicKeyGet", ctx, keyWithTags.Fingerprint, "tenant").Return(nil, store.ErrNoDocuments).Once()
-				storeMock.On("PublicKeyCreate", ctx, &keyWithTagsModel).Return(nil).Once()
+				storeMock.On("PublicKeyCreate", ctx, &keyWithTagsModel).Return(ssh.FingerprintLegacyMD5(pubKey), nil).Once()
 			},
 			expected: Expected{&responses.PublicKeyCreate{
 				Data: ssh.MarshalAuthorizedKey(pubKey),

api/store/mocks/store.go

@@ -88,15 +88,15 @@ func (s *Store) PublicKeyList(ctx context.Context, opts ...store.QueryOption) ([
 	return list, count, err
 }
 
-func (s *Store) PublicKeyCreate(ctx context.Context, key *models.PublicKey) error {
+func (s *Store) PublicKeyCreate(ctx context.Context, key *models.PublicKey) (string, error) {
 	bsonBytes, err := bson.Marshal(key)
 	if err != nil {
-		return FromMongoError(err)
+		return "", FromMongoError(err)
 	}
 
 	doc := make(bson.M)
 	if err := bson.Unmarshal(bsonBytes, &doc); err != nil {
-		return FromMongoError(err)
+		return "", FromMongoError(err)
 	}
 
 	// WORKAROUND: Convert string TagIDs to MongoDB ObjectIDs for referential integrity
@@ -110,10 +110,10 @@ func (s *Store) PublicKeyCreate(ctx context.Context, key *models.PublicKey) erro
 	}
 
 	if _, err := s.db.Collection("public_keys").InsertOne(ctx, doc); err != nil {
-		return FromMongoError(err)
+		return "", FromMongoError(err)
 	}
 
-	return nil
+	return doc["fingerprint"].(string), nil
 }
 
 func (s *Store) PublicKeyUpdate(ctx context.Context, publicKey *models.PublicKey) error {

api/store/mongo/publickey.go

@@ -184,11 +184,16 @@ func TestPublicKeyList(t *testing.T) {
 }
 
 func TestPublicKeyCreate(t *testing.T) {
+	type Expected struct {
+		fingerprint string
+		err         error
+	}
+
 	cases := []struct {
 		description string
 		key         *models.PublicKey
 		fixtures    []string
-		expected    error
+		expected    Expected
 	}{
 		{
 			description: "succeeds when data is valid",
@@ -199,7 +204,7 @@ func TestPublicKeyCreate(t *testing.T) {
 				PublicKeyFields: models.PublicKeyFields{Name: "public_key", Filter: models.PublicKeyFilter{Hostname: ".*"}},
 			},
 			fixtures: []string{},
-			expected: nil,
+			expected: Expected{fingerprint: "fingerprint", err: nil},
 		},
 	}
 
@@ -212,8 +217,8 @@ func TestPublicKeyCreate(t *testing.T) {
 				assert.NoError(t, srv.Reset())
 			})
 
-			err := s.PublicKeyCreate(ctx, tc.key)
-			assert.Equal(t, tc.expected, err)
+			fingerprint, err := s.PublicKeyCreate(ctx, tc.key)
+			assert.Equal(t, tc.expected, Expected{fingerprint: fingerprint, err: err})
 		})
 	}
 }

api/store/mongo/publickey_test.go

@@ -9,7 +9,7 @@ import (
 type PublicKeyStore interface {
 	PublicKeyList(ctx context.Context, opts ...QueryOption) ([]models.PublicKey, int, error)
 	PublicKeyGet(ctx context.Context, fingerprint string, tenantID string) (*models.PublicKey, error)
-	PublicKeyCreate(ctx context.Context, key *models.PublicKey) error
+	PublicKeyCreate(ctx context.Context, key *models.PublicKey) (string, error)
 	PublicKeyUpdate(ctx context.Context, publicKey *models.PublicKey) error
 	PublicKeyDelete(ctx context.Context, publicKey *models.PublicKey) error
 }