aboutsummaryrefslogtreecommitdiff
path: root/pgtest/tracker.go
diff options
context:
space:
mode:
Diffstat (limited to 'pgtest/tracker.go')
-rw-r--r--pgtest/tracker.go38
1 files changed, 38 insertions, 0 deletions
diff --git a/pgtest/tracker.go b/pgtest/tracker.go
new file mode 100644
index 0000000..ebd53cd
--- /dev/null
+++ b/pgtest/tracker.go
@@ -0,0 +1,38 @@
+// SPDX-FileCopyrightText: 2026 Stefan Majewsky <majewsky@gmx.net>
+// SPDX-License-Identifier: Apache-2.0
+
+// Package pgtest contains test assertions for checking the contents of PostgreSQL databases.
+package pgtest
+
+import (
+ "go.xyrillian.de/gg/assert"
+ "go.xyrillian.de/gg/gsql"
+)
+
+// Tracker keeps a copy of the database contents and allows for checking the database contents (or changes made to them) during tests.
+type Tracker struct {
+ t assert.TestingTB
+ dbh gsql.Handle
+ s Snapshot
+}
+
+// NewTracker creates a new Tracker.
+//
+// The initial creation involves taking a snapshot, which is returned as a second value.
+// This is an optimization, since it is often desirable to assert on the full DB contents when creating the tracker.
+// Calling [Tracker.DBContent] directly after [NewTracker] would take a superfluous second snapshot.
+func NewTracker(t assert.TestingTB, db gsql.Handle) (*Tracker, Snapshot) {
+ panic("TODO")
+}
+
+// DBChanges produces a diff of the current database contents against the state at the last Tracker call,
+// as a set of INSERT/UPDATE/DELETE statements on which test assertions can be executed.
+func (t *Tracker) DBChanges() Snapshot {
+ panic("TODO")
+}
+
+// DBContent produces a dump of the current database contents,
+// as a sequence of INSERT statements on which test assertions can be executed.
+func (t *Tracker) DBContent() Snapshot {
+ panic("TODO")
+}