refactor(db): return secret on created / updated (#928)

api/admin/secret.go

@@ -66,7 +66,7 @@ func UpdateSecret(c *gin.Context) {
 	}
 
 	// send API call to update the secret
-	err = database.FromContext(c).UpdateSecret(input)
+	s, err := database.FromContext(c).UpdateSecret(input)
 	if err != nil {
 		retErr := fmt.Errorf("unable to update secret %d: %w", input.GetID(), err)
 
@@ -75,5 +75,5 @@ func UpdateSecret(c *gin.Context) {
 		return
 	}
 
-	c.JSON(http.StatusOK, input)
+	c.JSON(http.StatusOK, s)
 }

api/secret/create.go

@@ -229,7 +229,7 @@ func CreateSecret(c *gin.Context) {
 	}
 
 	// send API call to create the secret
-	err = secret.FromContext(c, e).Create(t, o, n, input)
+	s, err := secret.FromContext(c, e).Create(t, o, n, input)
 	if err != nil {
 		retErr := fmt.Errorf("unable to create secret %s for %s service: %w", entry, e, err)
 
@@ -238,7 +238,5 @@ func CreateSecret(c *gin.Context) {
 		return
 	}
 
-	s, _ := secret.FromContext(c, e).Get(t, o, n, input.GetName())
-
 	c.JSON(http.StatusOK, s.Sanitize())
 }

api/secret/update.go

@@ -161,7 +161,7 @@ func UpdateSecret(c *gin.Context) {
 	}
 
 	// send API call to update the secret
-	err = secret.FromContext(c, e).Update(t, o, n, input)
+	secret, err := secret.FromContext(c, e).Update(t, o, n, input)
 	if err != nil {
 		retErr := fmt.Errorf("unable to update secret %s for %s service: %w", entry, e, err)
 
@@ -170,8 +170,5 @@ func UpdateSecret(c *gin.Context) {
 		return
 	}
 
-	// send API call to capture the updated secret
-	secret, _ := secret.FromContext(c, e).Get(t, o, n, input.GetName())
-
 	c.JSON(http.StatusOK, secret.Sanitize())
 }

api/webhook/post.go

@@ -849,7 +849,7 @@ func renameRepository(h *library.Hook, r *library.Repo, c *gin.Context, m *types
 		secret.SetOrg(r.GetOrg())
 		secret.SetRepo(r.GetName())
 
-		err = database.FromContext(c).UpdateSecret(secret)
+		_, err = database.FromContext(c).UpdateSecret(secret)
 		if err != nil {
 			return nil, fmt.Errorf("unable to update secret for repo %s/%s: %w", prevOrg, prevRepo, err)
 		}

database/integration_test.go

@@ -1053,7 +1053,7 @@ func testSecrets(t *testing.T, db Interface, resources *Resources) {
 
 	// create the secrets
 	for _, secret := range resources.Secrets {
-		err := db.CreateSecret(secret)
+		_, err := db.CreateSecret(secret)
 		if err != nil {
 			t.Errorf("unable to create secret %d: %v", secret.GetID(), err)
 		}
@@ -1226,16 +1226,11 @@ func testSecrets(t *testing.T, db Interface, resources *Resources) {
 	// update the secrets
 	for _, secret := range resources.Secrets {
 		secret.SetUpdatedAt(time.Now().UTC().Unix())
-		err = db.UpdateSecret(secret)
+		got, err := db.UpdateSecret(secret)
 		if err != nil {
 			t.Errorf("unable to update secret %d: %v", secret.GetID(), err)
 		}
 
-		// lookup the secret by ID
-		got, err := db.GetSecret(secret.GetID())
-		if err != nil {
-			t.Errorf("unable to get secret %d by ID: %v", secret.GetID(), err)
-		}
 		if !reflect.DeepEqual(got, secret) {
 			t.Errorf("GetSecret() is %v, want %v", got, secret)
 		}

database/secret/count_org_test.go

@@ -51,12 +51,12 @@ func TestSecret_Engine_CountSecretsForOrg(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/count_repo_test.go

@@ -62,12 +62,12 @@ func TestSecret_Engine_CountSecretsForRepo(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/count_team_test.go

@@ -52,12 +52,12 @@ func TestSecret_Engine_CountSecretsForTeam(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
@@ -158,12 +158,12 @@ func TestSecret_Engine_CountSecretsForTeams(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/count_test.go

@@ -49,12 +49,12 @@ func TestSecret_Engine_CountSecrets(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test repo for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test repo for sqlite: %v", err)
 	}

database/secret/create.go

@@ -15,7 +15,7 @@ import (
 )
 
 // CreateSecret creates a new secret in the database.
-func (e *engine) CreateSecret(s *library.Secret) error {
+func (e *engine) CreateSecret(s *library.Secret) (*library.Secret, error) {
 	// handle the secret based off the type
 	switch s.GetType() {
 	case constants.SecretShared:
@@ -44,7 +44,7 @@ func (e *engine) CreateSecret(s *library.Secret) error {
 	// https://pkg.go.dev/github.com/go-vela/types/database#Secret.Validate
 	err := secret.Validate()
 	if err != nil {
-		return err
+		return nil, err
 	}
 
 	// encrypt the fields for the secret
@@ -54,15 +54,29 @@ func (e *engine) CreateSecret(s *library.Secret) error {
 	if err != nil {
 		switch s.GetType() {
 		case constants.SecretShared:
-			return fmt.Errorf("unable to encrypt secret %s/%s/%s/%s: %w", s.GetType(), s.GetOrg(), s.GetTeam(), s.GetName(), err)
+			return nil, fmt.Errorf("unable to encrypt secret %s/%s/%s/%s: %w", s.GetType(), s.GetOrg(), s.GetTeam(), s.GetName(), err)
 		default:
-			return fmt.Errorf("unable to encrypt secret %s/%s/%s/%s: %w", s.GetType(), s.GetOrg(), s.GetRepo(), s.GetName(), err)
+			return nil, fmt.Errorf("unable to encrypt secret %s/%s/%s/%s: %w", s.GetType(), s.GetOrg(), s.GetRepo(), s.GetName(), err)
 		}
 	}
 
-	// send query to the database
-	return e.client.
-		Table(constants.TableSecret).
-		Create(secret.Nullify()).
-		Error
+	// create secret record
+	result := e.client.Table(constants.TableSecret).Create(secret.Nullify())
+
+	if result.Error != nil {
+		return nil, result.Error
+	}
+
+	// decrypt the fields for the secret to return
+	err = secret.Decrypt(e.config.EncryptionKey)
+	if err != nil {
+		switch s.GetType() {
+		case constants.SecretShared:
+			return nil, fmt.Errorf("unable to decrypt secret %s/%s/%s/%s: %w", s.GetType(), s.GetOrg(), s.GetTeam(), s.GetName(), err)
+		default:
+			return nil, fmt.Errorf("unable to decrypt secret %s/%s/%s/%s: %w", s.GetType(), s.GetOrg(), s.GetRepo(), s.GetName(), err)
+		}
+	}
+
+	return secret.ToLibrary(), nil
 }

database/secret/create_test.go

@@ -5,6 +5,7 @@
 package secret
 
 import (
+	"reflect"
 	"testing"
 
 	"github.com/DATA-DOG/go-sqlmock"
@@ -127,7 +128,7 @@ VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,$10,$11,$12,$13,$14) RETURNING "id"`).
 	// run tests
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			err := test.database.CreateSecret(test.secret)
+			got, err := test.database.CreateSecret(test.secret)
 
 			if test.failure {
 				if err == nil {
@@ -140,6 +141,10 @@ VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,$10,$11,$12,$13,$14) RETURNING "id"`).
 			if err != nil {
 				t.Errorf("CreateSecret for %s returned err: %v", test.name, err)
 			}
+
+			if !reflect.DeepEqual(got, test.secret) {
+				t.Errorf("CreateSecret is %s, want %s", got, test.secret)
+			}
 		})
 	}
 }

database/secret/delete_test.go

@@ -70,17 +70,17 @@ func TestSecret_Engine_DeleteSecret(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretRepo)
+	_, err := _sqlite.CreateSecret(_secretRepo)
 	if err != nil {
 		t.Errorf("unable to create test repo secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretOrg)
+	_, err = _sqlite.CreateSecret(_secretOrg)
 	if err != nil {
 		t.Errorf("unable to create test org secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretShared)
+	_, err = _sqlite.CreateSecret(_secretShared)
 	if err != nil {
 		t.Errorf("unable to create test shared secret for sqlite: %v", err)
 	}

database/secret/get_org_test.go

@@ -42,7 +42,7 @@ func TestSecret_Engine_GetSecretForOrg(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secret)
+	_, err := _sqlite.CreateSecret(_secret)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/get_repo_test.go

@@ -52,7 +52,7 @@ func TestSecret_Engine_GetSecretForRepo(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secret)
+	_, err := _sqlite.CreateSecret(_secret)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/get_team_test.go

@@ -42,7 +42,7 @@ func TestSecret_Engine_GetSecretForTeam(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secret)
+	_, err := _sqlite.CreateSecret(_secret)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/get_test.go

@@ -40,7 +40,7 @@ func TestSecret_Engine_GetSecret(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secret)
+	_, err := _sqlite.CreateSecret(_secret)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/interface.go

@@ -37,7 +37,7 @@ type SecretInterface interface {
 	// CountSecretsForTeams defines a function that gets the count of secrets by teams within an org.
 	CountSecretsForTeams(string, []string, map[string]interface{}) (int64, error)
 	// CreateSecret defines a function that creates a new secret.
-	CreateSecret(*library.Secret) error
+	CreateSecret(*library.Secret) (*library.Secret, error)
 	// DeleteSecret defines a function that deletes an existing secret.
 	DeleteSecret(*library.Secret) error
 	// GetSecret defines a function that gets a secret by ID.
@@ -59,5 +59,5 @@ type SecretInterface interface {
 	// ListSecretsForTeams defines a function that gets a list of secrets by teams within an org.
 	ListSecretsForTeams(string, []string, map[string]interface{}, int, int) ([]*library.Secret, int64, error)
 	// UpdateSecret defines a function that updates an existing secret.
-	UpdateSecret(*library.Secret) error
+	UpdateSecret(*library.Secret) (*library.Secret, error)
 }

database/secret/list_org_test.go

@@ -62,12 +62,12 @@ func TestSecret_Engine_ListSecretsForOrg(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/list_repo_test.go

@@ -73,12 +73,12 @@ func TestSecret_Engine_ListSecretsForRepo(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/list_team_test.go

@@ -63,12 +63,12 @@ func TestSecret_Engine_ListSecretsForTeam(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
@@ -169,12 +169,12 @@ func TestSecret_Engine_ListSecretsForTeams(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}

database/secret/list_test.go

@@ -59,12 +59,12 @@ func TestSecret_Engine_ListSecrets(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	err := _sqlite.CreateSecret(_secretOne)
+	_, err := _sqlite.CreateSecret(_secretOne)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}
 
-	err = _sqlite.CreateSecret(_secretTwo)
+	_, err = _sqlite.CreateSecret(_secretTwo)
 	if err != nil {
 		t.Errorf("unable to create test secret for sqlite: %v", err)
 	}