refactor(database): move secret logic into separate package

[jbrockopp]

Based off of #574, #663, #687, #692 #721 and #722

This change continues the refactor efforts initially introduced in the above PRs.

This adds a new secret package to the github.com/go-vela/server/database package.

This contains a SecretService interface declaring all functions necessary for worker based interactions with the database:

server/database/secret/service.go

Lines 11 to 63 in 662917e

	// SecretService represents the Vela interface for secret
	// functions with the supported Database backends.
	//
	//nolint:revive // ignore name stutter
	type SecretService interface {
	// Secret Data Definition Language Functions
	//
	// https://en.wikipedia.org/wiki/Data_definition_language
	// CreateSecretIndexes defines a function that creates the indexes for the secrets table.
	CreateSecretIndexes() error
	// CreateSecretTable defines a function that creates the secrets table.
	CreateSecretTable(string) error
	// Secret Data Manipulation Language Functions
	//
	// https://en.wikipedia.org/wiki/Data_manipulation_language
	// CountSecrets defines a function that gets the count of all secrets.
	CountSecrets() (int64, error)
	// CountSecretsForOrg defines a function that gets the count of secrets by org name.
	CountSecretsForOrg(string, map[string]interface{}) (int64, error)
	// CountSecretsForRepo defines a function that gets the count of secrets by org and repo name.
	CountSecretsForRepo(*library.Repo, map[string]interface{}) (int64, error)
	// CountSecretsForTeam defines a function that gets the count of secrets by org and team name.
	CountSecretsForTeam(string, string, map[string]interface{}) (int64, error)
	// 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
	// DeleteSecret defines a function that deletes an existing secret.
	DeleteSecret(*library.Secret) error
	// GetSecret defines a function that gets a secret by ID.
	GetSecret(int64) (*library.Secret, error)
	// GetSecretForOrg defines a function that gets a secret by org name.
	GetSecretForOrg(string, string) (*library.Secret, error)
	// GetSecretForRepo defines a function that gets a secret by org and repo name.
	GetSecretForRepo(string, *library.Repo) (*library.Secret, error)
	// GetSecretForTeam defines a function that gets a secret by org and team name.
	GetSecretForTeam(string, string, string) (*library.Secret, error)
	// ListSecrets defines a function that gets a list of all secrets.
	ListSecrets() ([]*library.Secret, error)
	// ListSecretsForOrg defines a function that gets a list of secrets by org name.
	ListSecretsForOrg(string, map[string]interface{}, int, int) ([]*library.Secret, int64, error)
	// ListSecretsForRepo defines a function that gets a list of secrets by org and repo name.
	ListSecretsForRepo(*library.Repo, map[string]interface{}, int, int) ([]*library.Secret, int64, error)
	// ListSecretsForTeam defines a function that gets a list of secrets by org and team name.
	ListSecretsForTeam(string, string, map[string]interface{}, int, int) ([]*library.Secret, int64, error)
	// 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
	}

This package also contains the engine which implements the above service interface:

server/database/secret/secret.go

Lines 25 to 39 in 662917e

	// engine represents the secret functionality that implements the SecretService interface.
	engine struct {
	// engine configuration settings used in secret functions
	config *config
	// gorm.io/gorm database client used in secret functions
	//
	// https://pkg.go.dev/gorm.io/gorm#DB
	client *gorm.DB
	// sirupsen/logrus logger used in secret functions
	//
	// https://pkg.go.dev/github.com/sirupsen/logrus#Entry
	logger *logrus.Entry
	}

This engine contains no raw SQL queries for integrating with the secrets table.

Instead, we leverage our DB library's (https://gorm.io/) agnostic abstraction for integrating with that table.

[cognifloyd]

This is so much cleaner! Thanks for working on this.

I started reviewing and have a few comments/requests about handling all secret types.

[cognifloyd]

On the count methods, the filters arg looks like a new feature. Where/when might this be used?

Also, where are we planning to use the count all secrets (database CountSecrets) method? I don't see anything that uses it in the native secrets engine.

edit: Oh. I see CountSecrets is used by the ListSecrets method. And that is probably useful for migrations or to rotate the encryption key or similar.

[cognifloyd]

Ok. I finished my first pass through this PR. This feels a lot cleaner.

I just noticed a couple bits of copy pasta to clean up.

[cognifloyd]

Awesome. Thank you!

[plyr4]

extremely minor comment typos

[ecrupper]

Nice — LGTM

Addressed