refactor(database): use agnostic engine #873
Conversation
…nto feature/database/engine_ping
…ver into feature/database/engine_resources
…a/server into refactor/database/engine
Codecov Report
@@ Coverage Diff @@
## main #873 +/- ##
==========================================
- Coverage 72.07% 71.82% -0.25%
==========================================
Files 312 311 -1
Lines 13049 13026 -23
==========================================
- Hits 9405 9356 -49
- Misses 3188 3209 +21
- Partials 456 461 +5
|
| ) | ||
|
|
||
| // helper function to setup the database from the CLI arguments. | ||
| func setupDatabase(c *cli.Context) (database.Interface, error) { |
There was a problem hiding this comment.
This logic was moved to FromCLIContext() function inside the database package.
| @@ -35,3 +38,19 @@ func FromContext(c context.Context) Interface { | |||
| func ToContext(c Setter, d Interface) { | |||
| c.Set(key, d) | |||
| } | |||
|
|
|||
| // FromCLIContext creates and returns a database engine from the urfave/cli context. | |||
| func FromCLIContext(c *cli.Context) (Interface, error) { | |||
There was a problem hiding this comment.
This logic was copied from the setupDatabase() function in the cmd/vela-server/database.go file.
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/go-vela/server/database/sqlite" | ||
| "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| func TestDatabase_FromContext(t *testing.T) { |
There was a problem hiding this comment.
This function was refactored to use table driven tests.
| func TestDatabase_FromContext_WrongType(t *testing.T) { | ||
| // setup context | ||
| gin.SetMode(gin.TestMode) | ||
| func TestDatabase_ToContext(t *testing.T) { |
There was a problem hiding this comment.
This function was refactored to use table driven tests.
| // NewTest creates and returns an engine that integrates with an in-memory database provider. | ||
| // | ||
| // This function is ONLY intended to be used for testing purposes. | ||
| func NewTest() (Interface, error) { |
There was a problem hiding this comment.
This will be needed for tests all over the place that have a dependency on database logic
i.e. middleware, secret etc.
| // TODO: Add this function to the interface once other code has been updated to use the agnostic engine. | ||
| // | ||
| // Close defines a function that stops and terminates the connection to the database. | ||
| // Close() error |
There was a problem hiding this comment.
We can't add this function to the interface until we update all code to call database.NewTest().
That will be added in a separate PR because it will touch a lot of code.
Dependent on #870
This change updates the
database.New()function to return the database agnosticengine{}type introduced in #868.The logic for this function was copied from the duplicate code we already have in both supported drivers:
This also adds a new
FromCLIContext()function to thedatabasepackage to create the agnosticengine{}.