Remove class-level variables from containers. by tillahoffmann · Pull Request #296 · testcontainers/testcontainers-python

tillahoffmann · 2023-01-07T00:12:31Z

Several of the containers currently load environment variables at import time. Consequently, if we create a container, its configuration may not match the current environment variables. Containers also overwrite class variables with instance variables of the same name which can cause confusion.

This PR

removes all class-level variables and loads environment variables at the time the container is created.
unifies the container API by renaming user to username and port_to_expose to port where applicable such that all containers have the same parameter names. The motivation behind renaming port_to_expose is that some containers have multiple different ports (cf. Clickhouse container exposing ports setup is strange #257 and Add azurite module #234). [specific]_port_to_expose is just a bit long.

This will break a bunch of stuff, but I'm planning to squeeze a lot of this cleanup into the next major release.

pffijt · 2023-02-23T11:37:54Z

We should fix the minor inconsistencies then this pr should be ready for merge.

tillahoffmann force-pushed the pythonic branch from 915b67f to b9b4b2cCompare January 7, 2023 00:16

tillahoffmann mentioned this pull request Jan 10, 2023
Add Cockroach DB Container Support #281
Closed
7 tasks

This was referenced Feb 17, 2023
Add new postgresql env vars (#1) #279
Closed
Add ability to expose both http and native ports for clickhouse (#257) #261
Open

tillahoffmann added 23 commits February 17, 2023 22:57

Remove class-level variables from azurite.
5f5536a

Precompute TIMEOUT.
7a06617

Remove static variables from clickhouse.
ad3aef7

Remove static variables from kafka.
355ac71

Remove static variables from keycloak.
d357376

Remove static variables from mongodb.
bfb8200

Remove static variables from mssql.
e072dba

Remove static variables from mysql.
1d6e402

Remove static variables from neo4j.
e8e4078

Rename user to username in opensearch.
043dea0

Remove static variables from postgres.
d407859

Remove static variables from rabbitmq.
23e93b2

Use f-strings throughout.
33014e4

Fix typo in ClickHouseContainer.__init__.
95dc6ca

Fix default username in neo4j.
14761b1

Rename port_to_expose to port and use f-strings in tests.
cf6c585

Remove erroneous with_command statement.
3c28cdd

Rename db_user to username in tests.
89822f7

Remove unused function in docker api test.
deebd05

Rename db_name to dbname.
44d9b3d

Remove uninformative module docstrings.
7f08e44

Rename port_to_expose to port for Redis and Elasticsearch.
f5a16cb

Use utility function to raise for deprecated parameters.
3add8cb

tillahoffmann force-pushed the pythonic branch from 0735f3d to 3add8cbCompare February 18, 2023 03:58

tillahoffmann requested review from ImFlog and maltehedderich as code owners February 18, 2023 03:58

tillahoffmann requested review from ash1425, pffijt and yakimka as code owners February 18, 2023 03:58

tillahoffmann added 4 commits February 17, 2023 23:10

Remove ports_to_expose from Azurite container.
f881c80

Rename port_to_expose to port.
0a1b372

Expose port configuration for selenium.
6dc9b8d

Remove db_ from arango tests so we can search for db_name.
76a9bfa

tillahoffmann force-pushed the pythonic branch from 494ff33 to 76a9bfaCompare February 18, 2023 17:47

Fix incorrect port unpacking.
e2cc996

pffijt reviewed Feb 23, 2023
View reviewed changes

Comment threadcore/testcontainers/core/generic.py Outdated
Comment threadcore/testcontainers/core/utils.py Outdated
Comment threadneo4j/testcontainers/neo4j/__init__.py Outdated

pffijt approved these changes Feb 23, 2023
View reviewed changes

pffijt self-requested a review February 23, 2023 11:36

github-actionsBot added the 👀 requires attention label Feb 23, 2023

ImFlog approved these changes Feb 23, 2023
View reviewed changes

pffijt approved these changes Mar 2, 2023
View reviewed changes

Merge branch 'master' into pythonic
76a23d0

tillahoffmann requested a review from nshine as a code owner April 11, 2023 14:14

tillahoffmann added 5 commits April 11, 2023 10:21

Change error messages to title case.
c281a8e

Xfail docker-in-docker test.
6c653f7

Update requirements.
1be54d4

Add missing colon to error message.
703d975

Allow positional port argument for Neo4jContainer.
cfb2802

tillahoffmann merged commit 63ad996 into testcontainers:masterApr 11, 2023

tillahoffmann deleted the pythonic branch April 11, 2023 15:42

tillahoffmann added 🔧 maintenance and removed 👀 requires attention labels Apr 11, 2023

tillahoffmann mentioned this pull request Apr 11, 2023
Enable using clickhouse HTTP interface #319
Open

tillahoffmann mentioned this pull request May 19, 2023
add SingleStore container #354
Open

shunping mentioned this pull request Jul 1, 2025
Replace port_to_expose with port as testcontainers upgrade apache/beam#35501
Merged

Navigation Menu

Uh oh!

Remove class-level variables from containers. - #296

Remove class-level variables from containers.#296
tillahoffmann merged 34 commits into
testcontainers:masterfrom
tillahoffmann:pythonic

tillahoffmann commented Jan 7, 2023•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pffijt commented Feb 23, 2023•
edited
Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

tillahoffmann commented Jan 7, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pffijt commented Feb 23, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tillahoffmann commented Jan 7, 2023•
edited
Loading

pffijt commented Feb 23, 2023•
edited
Loading