feat(postgres): ssl for postgres #2473

bearrito · 2024-04-08T18:45:57Z

What does this PR do?

Enables SSL for postgres

The main thing to recognize when reviewing this is that the secret material must be owned by the postgres user.
The docker file copy api doesn't allowfor setting a user when copying. The only way I could think was to take wrap the entrypoint script with one that does what we want.

Why is it important?

User ran into issue trying to use SSL. It's not obviously supported (able) due to file permissions.

Related issues

Link related issues below. Insert the issue link or reference after the word "Closes" if merging this should automatically close it.

Closes [Bug]: File permissions with custom PostgreSQL image #2404

How to test this PR

Unit tests will work when complete.

netlify · 2024-04-08T18:46:13Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`314d1cf`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/677d14234d05eb00087446e6
😎 Deploy Preview	https://deploy-preview-2473--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.

modules/postgres/testdata/docker-entrypoint-ssl.bash

mdelapenya

We are in the right track with this one, although I left some comments that need to be addressed.

Besides that, we need to include the new option in the docs. Please check the docs/modules/postgres.md file for that. Remember adding this right after the option title:

- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>

Thanks!

modules/postgres/postgres_test.go

modules/postgres/postgres.go

modules/postgres/options.go

modules/postgres/testdata/docker-entrypoint-ssl.bash

mdelapenya · 2024-04-10T14:39:06Z

@bearrito could you please take a look at #2478? I'm adding helper code to deal with TLS certificates in order to simplify the story for the client code. Wdyt?

bearrito · 2024-04-10T15:57:37Z

@mdelapenya That makes a lot of sense. Much cleaner.

Do you want me to wait until that's done then base this on top of that?

mdelapenya · 2024-04-11T16:00:02Z

@bearrito I went ahead and extracted the TLS cert generation to a separate go package, which makes more sense: https://github.com/mdelapenya/tlscert

Please take a look and use it as you need here!

bearrito · 2024-04-11T19:15:12Z

@mdelapenya Updated to use your package.

mdelapenya

Just one final concern regarding the entrypoint: do you think we need to pass it? Or is it something we can internally handle in the module, being transparent to the end users?

modules/postgres/go.mod

modules/postgres/testdata/docker-entrypoint-ssl.bash

bearrito · 2024-04-12T13:21:13Z

@mdelapenya Update so that the entrypoint is coupled with the ssl settings. What about doing something similar for the conf file?

modules/postgres/postgres.go

modules/postgres/postgres_test.go

modules/postgres/postgres.go

bearrito · 2024-04-24T13:14:36Z

@mdelapenya added docs.

Co-authored-by: Steven Hartland <stevenmhartland@gmail.com>

stevenh

Thanks for the changes, there's some outstanding bits needed to complete the switch to parameters, think I've caught them all in this pass.

modules/postgres/options.go

modules/postgres/postgres_test.go

modules/postgres/resources/customEntrypoint.sh

modules/postgres/options.go

bearrito · 2024-12-25T00:35:24Z

Addressed latest.

stevenh

Thanks for the fast turnaround on the changes, looks good to me, happy holidays!

bearrito · 2024-12-25T16:39:12Z

@mdelapenya Is this good to go from your end?

bearrito · 2025-01-05T19:33:31Z

@mdelapenya Is this good?

mdelapenya

@mdelapenya Is this good?

@bearrito sorry, I was on XMas PTO, and finish it tomorrow 7th. I left some minor comments that need to be addressed before merging.

As a follow-up, not for this PR to make progress and see it into main asap, I'd allow different users than postgres when enabling SSL.

Other than that, once the comments are addressed, LGTM

docs/modules/postgres.md

modules/postgres/postgres_test.go

mdelapenya · 2025-01-07T11:45:27Z

@bearrito I went ahead and added a few commits with my suggestions to avoid causing you more trouble 🙏

Hopefully this build will pass and we can proceed with the merge.

Sorry about it taking too long 🙇

mdelapenya

LGTM, thanks for your patience and the long time it took for the review. My apologies

* main: (103 commits) feat(postgres): ssl for postgres (testcontainers#2473) feat(ollama): support calling the Ollama local process (testcontainers#2923) chore(deps): bump jinja2 from 3.1.4 to 3.1.5 (testcontainers#2935) chore(deps): bump sonarsource/sonarcloud-github-action (testcontainers#2933) feat(termination)!: make container termination timeout configurable (testcontainers#2926) chore(deps): bump slackapi/slack-github-action from 1.26.0 to 2.0.0 (testcontainers#2934) chore(deps): bump github/codeql-action from 3.25.15 to 3.28.0 (testcontainers#2932) feat(wait): log sub match callback (testcontainers#2929) fix: Handle nil value in CleanupNetwork (testcontainers#2928) fix: avoid double lock in DockerProvider.DaemonHost() (testcontainers#2900) feat!: build log writer for container request (testcontainers#2925) feat(gcloud)!: add support to seed data when using RunBigQueryContainer (testcontainers#2523) security(deps): bump golang.org/x/crypto from 0.28.0 to 0.31.0 (testcontainers#2916) chore(ci): add Github labels based on PR title (testcontainers#2914) chore(gha): Use official setup-docker-action (testcontainers#2913) chore(ci): enforce conventional commits syntax in PR titles (testcontainers#2911) feat(nats): WithConfigFile - pass a configuration file to nats server (testcontainers#2905) chore: enable implicit default logger only in testing with -v (testcontainers#2877) fix: container binds syntax (testcontainers#2899) refactor(cockroachdb): to use request driven options (testcontainers#2883) ...

SSL for postgres

daa8cf2

bearrito requested a review from a team as a code owner April 8, 2024 18:45

bstrausser added 2 commits April 8, 2024 17:08

Add entrypoint wrapper

53e2135

Add in init so we can test ssl+init path

bd3360d

bearrito changed the title ~~[DRAFT] feat:SSL for postgres~~ feat:SSL for postgres Apr 8, 2024

bearrito mentioned this pull request Apr 8, 2024

[Bug]: File permissions with custom PostgreSQL image #2404

Closed

bearrito commented Apr 8, 2024

View reviewed changes

modules/postgres/testdata/docker-entrypoint-ssl.bash Outdated Show resolved Hide resolved

bstrausser added 2 commits April 8, 2024 17:17

Remove unused fields from options

c3fd69b

Remove unused consts

445a575

mdelapenya requested changes Apr 9, 2024

View reviewed changes

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

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

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

bearrito commented Apr 9, 2024

View reviewed changes

modules/postgres/testdata/docker-entrypoint-ssl.bash Outdated Show resolved Hide resolved

Separate entrypoint from ssl

8814e8c

Use external cert generation

2aecc1b

bearrito mentioned this pull request Apr 11, 2024

chore: create TLS certs in a consistent manner #2478

Merged

mdelapenya reviewed Apr 12, 2024

View reviewed changes

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

modules/postgres/testdata/docker-entrypoint-ssl.bash Outdated Show resolved Hide resolved

bstrausser added 2 commits April 12, 2024 09:14

Make entrypoint not-optional

eac665d

Add docstring

302472c

bearrito commented Apr 12, 2024

View reviewed changes

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

bearrito commented Apr 12, 2024

View reviewed changes

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

bearrito commented Apr 12, 2024

View reviewed changes

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

bearrito commented Apr 12, 2024

View reviewed changes

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

bstrausser added 2 commits April 24, 2024 08:56

Spaces to tab in entrypoint

3099790

Add postgres ssl docs

e067d0f

bearrito and others added 6 commits December 23, 2024 16:28

Update modules/postgres/postgres.go

18ab8b7

Co-authored-by: Steven Hartland <stevenmhartland@gmail.com>

Update modules/postgres/postgres_test.go

ab0e3ff

Co-authored-by: Steven Hartland <stevenmhartland@gmail.com>

Addresses review modulo cleanup

9e15ac5

Remove unused type

c1cda1e

Merge main into feature/postgres-ssl

3dfb0cb

Use ContainerCleanup

ff6ce3e

stevenh requested changes Dec 24, 2024

View reviewed changes

Lint pass

6adf44c

bearrito changed the title ~~feat:SSL for postgres~~ feat(postgres):SSL for postgres Dec 24, 2024

Add t.Helper and Linting

6fb5455

bearrito changed the title ~~feat(postgres):SSL for postgres~~ feat(postgres): SSL for postgres Dec 24, 2024

bearrito changed the title ~~feat(postgres): SSL for postgres~~ feat(postgres): ssl for postgres Dec 24, 2024

bstrausser added 2 commits December 24, 2024 19:32

Remove SSLSetting struct, use raw paths

81a8d18

Use single command for chown key material

e980a90

stevenh previously approved these changes Dec 25, 2024

View reviewed changes

Merge branch 'main' into feature/postgres-ssl

8f5db75

mdelapenya reviewed Jan 6, 2025

View reviewed changes

mdelapenya added 3 commits January 7, 2025 12:45

docs: remove spaces

d28c3c1

fix: use non-deprecated APIs

4076402

chore: rename variable

314d1cf

mdelapenya dismissed stevenh’s stale review via 314d1cf January 7, 2025 11:46

mdelapenya self-assigned this Jan 7, 2025

mdelapenya added the feature New functionality or new behaviors on the existing one label Jan 7, 2025

mdelapenya approved these changes Jan 7, 2025

View reviewed changes

mdelapenya merged commit 3330dc1 into testcontainers:main Jan 7, 2025
124 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(postgres): ssl for postgres #2473

feat(postgres): ssl for postgres #2473

bearrito commented Apr 8, 2024 •

edited

Loading

netlify bot commented Apr 8, 2024 •

edited

Loading

mdelapenya left a comment •

edited

Loading

mdelapenya commented Apr 10, 2024

bearrito commented Apr 10, 2024 •

edited

Loading

mdelapenya commented Apr 11, 2024

bearrito commented Apr 11, 2024

mdelapenya left a comment

bearrito commented Apr 12, 2024

bearrito commented Apr 24, 2024

stevenh left a comment

bearrito commented Dec 25, 2024

stevenh left a comment

bearrito commented Dec 25, 2024

bearrito commented Jan 5, 2025

mdelapenya left a comment

mdelapenya commented Jan 7, 2025

mdelapenya left a comment

feat(postgres): ssl for postgres #2473

feat(postgres): ssl for postgres #2473

Conversation

bearrito commented Apr 8, 2024 • edited Loading

What does this PR do?

Why is it important?

Related issues

How to test this PR

netlify bot commented Apr 8, 2024 • edited Loading

✅ Deploy Preview for testcontainers-go ready!

mdelapenya left a comment • edited Loading

Choose a reason for hiding this comment

mdelapenya commented Apr 10, 2024

bearrito commented Apr 10, 2024 • edited Loading

mdelapenya commented Apr 11, 2024

bearrito commented Apr 11, 2024

mdelapenya left a comment

Choose a reason for hiding this comment

bearrito commented Apr 12, 2024

bearrito commented Apr 24, 2024

stevenh left a comment

Choose a reason for hiding this comment

bearrito commented Dec 25, 2024

stevenh left a comment

Choose a reason for hiding this comment

bearrito commented Dec 25, 2024

bearrito commented Jan 5, 2025

mdelapenya left a comment

Choose a reason for hiding this comment

mdelapenya commented Jan 7, 2025

mdelapenya left a comment

Choose a reason for hiding this comment

bearrito commented Apr 8, 2024 •

edited

Loading

netlify bot commented Apr 8, 2024 •

edited

Loading

mdelapenya left a comment •

edited

Loading

bearrito commented Apr 10, 2024 •

edited

Loading