Skip to content

Add Cockroach DB Container Support #281

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

Add Cockroach DB Container Support #281

wants to merge 3 commits into from

Conversation

@joelhess
Copy link
Contributor

@joelhess joelhess commented Dec 19, 2022 •
edited
Loading

You have implemented a new container and would like to contribute it? Great! Here are the necessary steps:

  • You have added the new container as a module in the testcontainers directory (such as testcontainers/my_fancy_container.py).
  • You have added any new python dependencies in the extras_require section of setup.py.
  • You have added the extra_requires key to requirements.in.
  • You have updated all python requirements by running make requirements from the root directory.
  • You have added tests for the new container in the tests directory, e.g. tests/test_my_fancy_container.py.
  • You have added the name of the container (such as my_fancy_container) to the test-components matrix in .github/workflows/main.yml to ensure the tests are run.
  • You have rebased your development branch on master (or merged master into your development branch).

mattupstate
mattupstate reviewed Dec 21, 2022
View reviewed changes
@codecov-commenter
Copy link

codecov-commenter commented Dec 31, 2022 •
edited
Loading

Codecov Report

Attention: Patch coverage is 85.18519% with 4 lines in your changes are missing coverage. Please review.

❗ No coverage uploaded for pull request base (main@7a9490a). Click here to learn what that means.

❗ Current head dbfb587 differs from pull request most recent head d092695. Consider uploading reports for the commit d092695 to get more accurate results

Files Patch % Lines
testcontainers/cockroachdb.py 85.18% 1 Missing and 3 partials ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #281   +/-   ##
=======================================
  Coverage        ?   87.06%           
=======================================
  Files           ?       31           
  Lines           ?      866           
  Branches        ?       61           
=======================================
  Hits            ?      754           
  Misses          ?       79           
  Partials        ?       33

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rafiss
Copy link

rafiss commented Jan 3, 2023

I'm an engineer from CockroachDB - this looks good to me!

@joelhess
Copy link
Contributor Author

joelhess commented Jan 9, 2023

Please let me know if there's anything else that I need to do to get this merged. I'm trying to keep it up to date with Master at this point.

@tillahoffmann
Copy link
Contributor

tillahoffmann commented Jan 10, 2023

Please let me know if there's anything else that I need to do to get this merged. I'm trying to keep it up to date with Master at this point.

There a few more major-ish changes to prepare for v4.x (e.g. #296). I'd suggest not updating the PR until then (but thank you for putting the work in to keep it up to date). Shall I let you know when master is a bit more stable?

@joelhess
Copy link
Contributor Author

joelhess commented Jan 10, 2023

Please let me know if there's anything else that I need to do to get this merged. I'm trying to keep it up to date with Master at this point.

There a few more major-ish changes to prepare for v4.x (e.g. #296). I'd suggest not updating the PR until then (but thank you for putting the work in to keep it up to date). Shall I let you know when master is a bit more stable?

Yes Please. Thanks for the follow up.

@joelhess
Add Initial Cockroach DB Support
727a5f0 
Add Test

Tweak Naming, add to docs

Make insecure mode conditional on presence of password

Fix Tests

Address Linting
@joelhess
Rebase/Update
167d094
@joelhess
Remove Moved File
d092695
@joelhess
Copy link
Contributor Author

joelhess commented May 11, 2023

@tillahoffmann Is the Main branch ready enough to update this to the new patterns?

@tillahoffmann
Copy link
Contributor

tillahoffmann commented May 11, 2023

Yes, fingers crossed.

@alexanderankin alexanderankin added the community-feat feature but its a community module so we wont bump tc core for it label Mar 26, 2024
@alexanderankin alexanderankin mentioned this pull request Apr 17, 2024
Open
@joelhess joelhess closed this Jun 17, 2024
@joelhess joelhess mentioned this pull request Jun 17, 2024
Merged
6 tasks
alexanderankin added a commit that referenced this pull request Jun 18, 2024
@joelhess @alexanderankin
fix: Add Cockroach DB Module to Testcontainers (#608)
4aff679 
Adds [Cockroach DB] (https://www.cockroachlabs.com/) module to use with
Test containers

I had done this previously under
#281, but
opted to just redo it rather than try to rebase all the things.


- [x] Create a new feature directory and populate it with the package
structure [described in the
documentation](https://testcontainers-python.readthedocs.io/en/latest/#package-structure).
Copying one of the existing features is likely the best way to get
started.
- [x] Implement the new feature (typically in `__init__.py`) and
corresponding tests.
- [x] Update the feature `README.rst` and add it to the table of
contents (`toctree` directive) in the top-level `README.rst`.
- [] Add a line `[feature name]` to the list of components in the GitHub
Action workflow in `.github/workflows/main.yml` to run tests, build, and
publish your package when pushed to the `main` branch.
- [x] Rebase your development branch on `main` (or merge `main` into
your development branch).
- [x] Add Package to pyproject.toml
- [ ] Add a line `-e file:[feature name]` to `requirements.in` and open
a pull request. Opening a pull request will automatically generate lock
files to ensure reproducible builds (see the [pip-tools
documentation](https://pip-tools.readthedocs.io/en/latest/) for
details). Finally, run `python get_requirements.py --pr=[your PR
number]` to fetch the updated requirement files (the build needs to have
succeeded).

---------

Co-authored-by: joelhess <joelhess@flywheel.io>
Co-authored-by: David Ankin <daveankin@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@mattupstate mattupstate mattupstate left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

community-feat feature but its a community module so we wont bump tc core for it ✨ package: new

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@joelhess @codecov-commenter @rafiss @tillahoffmann @mattupstate @alexanderankin