feat (postgres): support for creating and restoring Snapshots #2199

Minivera · 2024-02-05T22:15:58Z

What does this PR do?

I recently went through building a complex testing setup for an entire webservice using testcontainers-go, which taught me some important tips and tricks about the library. I have added these in the documentation wherever I thought they could be useful.

I also added a new example for using the postgres module and making each test use a clean database. It's a pretty useful tool, and it's available as an example in the Java version, so I've added it here as well.

Why is it important?

During my own work, I ran into some roadblocks where the docs did not offer all the information I needed to get things working. I worked things with the team and by reading the official Java example. I thought it'd be a good idea to upstream those learnings to the library.

Related issues

How to test this PR

Run the postgres example, it should pass and should show how we can use a clean database in multiple tests.

I recently went through building a complex testing setup for an entire webservice using testcontainers-go, which taught me some important tips and tricks about the library. I have added these in the documentation wherever I thought they could be useful. I also added a new example for using the postgres module and making each test use a clean database. It's a pretty useful tool, and it's available as an example in the Java version, so I've added it here as well.

netlify · 2024-02-05T22:16:04Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`994b86d`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/65ccf402ea8c4b0008d44df1
😎 Deploy Preview	https://deploy-preview-2199--testcontainers-go.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/examples/postgres.md

mdelapenya

Thanks for this PR! I do appreciate any improvement to the docs, even more when they come after suffering them first hand.

This LGTM, although I'd recommend moving the code in the examples/postgres to the module. If like to have the code you added into the testable examples (e.g. func ExampleFoo) of the postgres module, so they are automatically run on the CI.

Does it make sense to you?

Minivera · 2024-02-06T14:36:52Z

@mdelapenya do you mean to add the snapshot and reset function officially to the module so anyone can use them, then move the test there once those functions are added? I'd assume I would also change the example accordingly.

mdelapenya · 2024-02-07T07:00:26Z

Yeah, I'd remove anything related to the postgres example, having everything under the postgres module.

mdelapenya

I added a few comments regarding the example. Once resolved I think we are done and we can merge this indeed needed improvement.

mkdocs.yml

docs/examples/postgres.md

… sense in context

docs/features/files_and_mounts.md

modules/postgres/postgres.go

Co-authored-by: Manuel de la Peña <social.mdelapenya@gmail.com>

…ents' into gui/add-docs-from-recent-experiments

This reverts commit b7d6e90.

mdelapenya

LGTM, thanks!

* main: (33 commits) feat (postgres): support for creating and restoring Snapshots (testcontainers#2199) fix: apply volume options only to volumes (testcontainers#2201) redpanda/test: add admin client call (testcontainers#2200) chore(deps): bump cloud.google.com/go/spanner from 1.55.0 to 1.56.0 in /modules/gcloud, cloud.google.com/go/pubsub from 1.35.0 to 1.36.1 in /modules/gcloud, cloud.google.com/go/bigquery from 1.57.1 to 1.58.0 in /modules/gcloud (testcontainers#2197) chore(deps): bump github.com/docker/docker from 25.0.1+incompatible to 25.0.2+incompatible (testcontainers#2196) fix: go doc reference broken image (testcontainers#2195) Add Support for WASM Transforms to Redpanda Module (testcontainers#2170) feat(modules.clickhouse): Add zookeeper for clickhouse clusterization (testcontainers#1995) redpanda: allow using SASL and TLS together (testcontainers#2140) chore: do not panic in testable examples (testcontainers#2193) fix: all mounts should contain the testcontainers labels (testcontainers#2191) [redpanda] sasl test for wrong mechanism (testcontainers#2048) fix: deprecate BindMounts correctly (testcontainers#2190) chore(docker_mounts): stop doing misleading logging (testcontainers#2178) fix: Add HTTPStrategy WithForcedIPv4LocalHost To Fix Docker Port Map (testcontainers#1775) chore(deps): bump github.com/docker/compose/v2 in /modules/compose (testcontainers#2162) feat(modules.cockroachdb) Adds cockroachdb module (testcontainers#2131) chore(deps): bump golang.org/x/crypto in /modules/minio (testcontainers#2161) chore(deps): bump golang.org/x/crypto in /modules/openldap (testcontainers#2165) chore(deps): bump github.com/google/uuid from 1.5.0 to 1.6.0 (testcontainers#2169) ...

* main: feat (postgres): support for creating and restoring Snapshots (testcontainers#2199) fix: apply volume options only to volumes (testcontainers#2201) redpanda/test: add admin client call (testcontainers#2200) chore(deps): bump cloud.google.com/go/spanner from 1.55.0 to 1.56.0 in /modules/gcloud, cloud.google.com/go/pubsub from 1.35.0 to 1.36.1 in /modules/gcloud, cloud.google.com/go/bigquery from 1.57.1 to 1.58.0 in /modules/gcloud (testcontainers#2197) chore(deps): bump github.com/docker/docker from 25.0.1+incompatible to 25.0.2+incompatible (testcontainers#2196) fix: go doc reference broken image (testcontainers#2195) Add Support for WASM Transforms to Redpanda Module (testcontainers#2170)

Minivera requested a review from a team as a code owner February 5, 2024 22:15

Minivera commented Feb 5, 2024

View reviewed changes

docs/examples/postgres.md Outdated Show resolved Hide resolved

mdelapenya reviewed Feb 5, 2024

View reviewed changes

Added the example to the sidebar

dad7a38

Minivera added 2 commits February 7, 2024 10:57

Move everything to the module

15fe6fc

Remove testing stuff I added to debug the integration

a64189d

mdelapenya reviewed Feb 8, 2024

View reviewed changes

mkdocs.yml Outdated Show resolved Hide resolved

docs/examples/postgres.md Outdated Show resolved Hide resolved

Apply review feedback and rename reset to restore since it makes more…

6875d63

… sense in context

mdelapenya reviewed Feb 8, 2024

View reviewed changes

docs/features/files_and_mounts.md Outdated Show resolved Hide resolved

modules/postgres/postgres.go Outdated Show resolved Hide resolved

Minivera and others added 4 commits February 8, 2024 13:01

Update modules/postgres/postgres.go

7f8bf7f

Co-authored-by: Manuel de la Peña <social.mdelapenya@gmail.com>

Add test examples for file copy and update the docs

23a8f7f

Merge remote-tracking branch 'origin/gui/add-docs-from-recent-experim…

21f6d47

…ents' into gui/add-docs-from-recent-experiments

Add the wait for hello file to help understanding the example

da740bf

Minivera requested a review from mdelapenya February 12, 2024 15:58

mdelapenya added 12 commits February 14, 2024 16:16

chore: use pinned version of the image

d481680

chore: simplify waiting for an expected log

adcce9f

chore: check for errors in tests

f81f8ea

docs: use dot

f10d898

docs: simplify tabs

6b99a8f

chore: simplify variables and paths

e07d6b6

docs: remove misleading comment

4c0b81e

docs: move customise requests to each module

94a93e4

docs: swap places

1564371

chore: less verbose

50a011d

chore: use testify assertions

b7d6e90

Revert "chore: use testify assertions"

994b86d

This reverts commit b7d6e90.

mdelapenya self-assigned this Feb 14, 2024

mdelapenya changed the title ~~Add tips and examples to improve the documentation~~ feat (postgres): support for creating and restoring Snapshots Feb 14, 2024

mdelapenya added the feature New functionality or new behaviors on the existing one label Feb 14, 2024

mdelapenya approved these changes Feb 14, 2024

View reviewed changes

mdelapenya merged commit 48fc228 into testcontainers:main Feb 14, 2024
80 checks passed

mdelapenya mentioned this pull request Feb 15, 2024

fix: wait more time in test #2211

Merged

Minivera deleted the gui/add-docs-from-recent-experiments branch February 16, 2024 16:51

This was referenced Jun 20, 2024

feat(postgres): use faster sql.DB instead of docker exec psql for snapshot/restore #2599

Closed

feat(postgres): use faster sql.DB instead of docker exec psql for snapshot/restore [rebased for main] #2600

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat (postgres): support for creating and restoring Snapshots #2199

feat (postgres): support for creating and restoring Snapshots #2199

Minivera commented Feb 5, 2024

netlify bot commented Feb 5, 2024 •

edited

Loading

mdelapenya left a comment •

edited

Loading

Minivera commented Feb 6, 2024 •

edited

Loading

mdelapenya commented Feb 7, 2024

mdelapenya left a comment

mdelapenya left a comment

feat (postgres): support for creating and restoring Snapshots #2199

feat (postgres): support for creating and restoring Snapshots #2199

Conversation

Minivera commented Feb 5, 2024

What does this PR do?

Why is it important?

Related issues

How to test this PR

netlify bot commented Feb 5, 2024 • edited Loading

✅ Deploy Preview for testcontainers-go ready!

mdelapenya left a comment • edited Loading

Choose a reason for hiding this comment

Minivera commented Feb 6, 2024 • edited Loading

mdelapenya commented Feb 7, 2024

mdelapenya left a comment

Choose a reason for hiding this comment

mdelapenya left a comment

Choose a reason for hiding this comment

netlify bot commented Feb 5, 2024 •

edited

Loading

mdelapenya left a comment •

edited

Loading

Minivera commented Feb 6, 2024 •

edited

Loading