Setup integration test suite for db package #387
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #387 +/- ##
==========================================
- Coverage 28.71% 20.82% -7.89%
==========================================
Files 19 24 +5
Lines 1386 2170 +784
==========================================
+ Hits 398 452 +54
- Misses 961 1678 +717
- Partials 27 40 +13
Continue to review full report at Codecov.
|
gianarb
added
the
ci-check/vagrant-setup
added 3 commits
December 14, 2020 09:52
This commit bootstrap a possible integration test suite for the db pkg.
It uses TestContainers to create an manage container lifecycle as code
inside a test case.
In order to run those tests you need Docker enable, for this reason you
have to execute them explicitly:
$ go test -v ./db/_integration
=== RUN TestCreateTemplate
=== RUN TestCreateTemplate/happy-path-single-crete-template
=== PAUSE TestCreateTemplate/happy-path-single-crete-template
=== CONT TestCreateTemplate/happy-path-single-crete-template
2020/12/11 10:43:03 Starting container id: 0ea745bc8539 image: quay.io/testcontainers/ryuk:0.2.3
2020/12/11 10:43:03 Waiting for container id 0ea745bc8539 image: quay.io/testcontainers/ryuk:0.2.3
2020/12/11 10:43:03 Container is ready id: 0ea745bc8539 image: quay.io/testcontainers/ryuk:0.2.3
2020/12/11 10:43:03 Starting container id: a61bdbf3b7c3 image: postgres:13.1
2020/12/11 10:43:03 Waiting for container id a61bdbf3b7c3 image: postgres:13.1
2020/12/11 10:43:04 Container is ready id: a61bdbf3b7c3 image: postgres:13.1
db_test.go:64: applyed 5 migrations
--- PASS: TestCreateTemplate (0.00s)
--- PASS: TestCreateTemplate/happy-path-single-crete-template (2.42s)
PASS
ok github.com/tinkerbell/tink/db/_integration 2.676s
Signed-off-by: Gianluca Arbezzano <gianarb92@gmail.com>
This commit add the integration tests as part of the CI checks Signed-off-by: Gianluca Arbezzano <gianarb92@gmail.com>
This commit adds more tests coming from #361 only for templates Signed-off-by: Gianluca Arbezzano <gianarb92@gmail.com>
mmlb
reviewed
Dec 16, 2020
db/_integration/db_test.go
Outdated
Comment on lines
57
to
64
| CHECK_DB: | ||
| for ii := 0; ii < 5; ii++ { | ||
| err = dbCon.Ping() | ||
| if err != nil { | ||
| t.Log(errors.Wrap(err, "db check")) | ||
| time.Sleep(1 * time.Second) | ||
| goto CHECK_DB | ||
| } |
There was a problem hiding this comment.
this kind of doesn't make any sense right? If not ready go back to before the loop forever. If it is ready... make sure its ready 5 times?
mmlb
suggested changes
Dec 16, 2020
db/_integration/db_test.go
Outdated
| ContainerRequest: testcontainers.ContainerRequest{ | ||
| Image: "postgres:13.1", | ||
| ExposedPorts: []string{"5432/tcp"}, | ||
| WaitingFor: wait.ForLog("database system is ready to accept connections"), |
There was a problem hiding this comment.
we should add support to wait for something like wait.Exec and then we can just call pg_isready.
| @@ -31,6 +33,26 @@ func Parse(yamlContent []byte) (*Workflow, error) { | |||
| return &workflow, nil | |||
| } | |||
|
|
|||
| // MustParse parse a slice of bytes to a template. It an error occurs the | |||
There was a problem hiding this comment.
can you add tests for these so codecov is happy?
mmlb
previously approved these changes
Dec 16, 2020
I moved the test back to the db package as suggested by Manny and now tests automatically skip if Docker is not running. Signed-off-by: Gianluca Arbezzano <gianarb92@gmail.com>
This commit tests the two new functions introduced as utilities for template and workflow testing Signed-off-by: Gianluca Arbezzano <gianarb92@gmail.com>
mmlb
approved these changes
Dec 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
TestContainer is a library that spins up and down containers programmatically inside a test case. It is very comfortable to run integration tests and to set up requirements such as Postgres in our case.
This PR contains the first tests that validate the happy path for the CreateTemplate function.
Question
Right now in order to separate the tests requiring docker from the one who can run standalone I created a separate package
./db/_integrationthat by default is not picked up bygo test ./...The thread off here is that code coverage does not count the new package, even if it will be nice to have it included. A possible solution is to add a flag like:
if the flag is set the tests requiring docker will run. In this way, we should have code coverage counting integration tests.
Why is this needed
Because it is better to refactor a package when it is covered by tests.