Skip to content

feat(coderd/database/dbtestutil): add ability to dump database on failure #9704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 18, 2023
Merged

feat(coderd/database/dbtestutil): add ability to dump database on failure #9704

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e711c7c
feat(coderd/database/dbtestutil): add ability to dump database on fai…
johnstcn Sep 15, 2023
1c4bf16
column inserts only
johnstcn Sep 15, 2023
d9353a5
lint
johnstcn Sep 15, 2023
e44e8d2
make gen
johnstcn Sep 15, 2023
fad8705
Merge remote-tracking branch 'origin/main' into cj/dbtestutil-dump-on…
johnstcn Sep 18, 2023
ea7fe2e
address PR comments
johnstcn Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
address PR comments
  • Loading branch information
@johnstcn
johnstcn committed Sep 18, 2023
commit ea7fe2e971416aa555f1d74e2cb935eb4a5875c9
15 changes: 14 additions & 1 deletion coderd/database/dbtestutil/db.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"regexp"
"strings"
"testing"
"time"

"github.com/stretchr/testify/require"
"golang.org/x/xerrors"
Expand Down Expand Up @@ -127,6 +128,16 @@ func dbNameFromConnectionURL(t testing.TB, connectionURL string) string {
return strings.TrimPrefix(u.Path, "/")
}

// DumpOnFailure exports the database referenced by connectionURL to a file
// corresponding to the current test, with a suffix indicating the time the
// test was run.
// To import this into a new database (assuming you have already run make test-postgres-docker):
// - Create a new test database:
// go run ./scripts/migrate-ci/main.go and note the database name it outputs
// - Import the file into the above database:
// psql 'postgres://postgres:postgres@127.0.0.1:5432/<dbname>?sslmode=disable' -f <path to file.test.sql>
// - Run a dev server against that database:
// ./scripts/coder-dev.sh server --postgres-url='postgres://postgres:postgres@127.0.0.1:5432/<dbname>?sslmode=disable'
func DumpOnFailure(t testing.TB, connectionURL string) {
if !t.Failed() {
return
Expand All @@ -137,7 +148,9 @@ func DumpOnFailure(t testing.TB, connectionURL string) {
return
}
snakeCaseName := regexp.MustCompile("[^a-zA-Z0-9-_]+").ReplaceAllString(t.Name(), "_")
outPath := filepath.Join(cwd, snakeCaseName+".test.sql")
now := time.Now()
timeSuffix := fmt.Sprintf("%d%d%d%d%d%d", now.Year(), now.Month(), now.Day(), now.Hour(), now.Minute(), now.Second())
outPath := filepath.Join(cwd, snakeCaseName+"."+timeSuffix+".test.sql")
dump, err := pgDump(connectionURL)
if err != nil {
t.Errorf("dump on failure: failed to run pg_dump")
Expand Down