You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Run Catalog integration tests against REST Catalog impls (#2482)
<!--
Thanks for opening a pull request!
-->
<!-- In the case this PR will resolve an issue, please replace
${GITHUB_ISSUE_ID} below with the actual Github issue id. -->
Closes#2481
# Rationale for this change
This allows users to run our test suite against their REST Catalog
implementations.
## Are these changes tested?
Test-only change
## Are there any user-facing changes?
- Adds support for running catalog tests against REST Catalog
implementations.
<!-- In the case of user-facing changes, please add the changelog label.
-->
Copy file name to clipboardExpand all lines: mkdocs/docs/contributing.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -155,6 +155,34 @@ make test-integration-rebuild
155
155
156
156
To rebuild the containers from scratch.
157
157
158
+
#### Running Integration Tests against REST Catalogs
159
+
160
+
!!! warning "Do not run against production catalogs"
161
+
The integration tests will delete data throughout the entirety of your catalog. Running these integration tests against production catalogs will result in data loss.
162
+
163
+
PyIceberg supports the ability to run our catalog tests against an arbitrary REST Catalog.
164
+
165
+
In order to run the test catalog, you will need to specify which REST catalog to run against with the `PYICEBERG_TEST_CATALOG` environment variable
166
+
167
+
```sh
168
+
export PYICEBERG_TEST_CATALOG=test_catalog
169
+
```
170
+
171
+
The catalog in question can be configured either through the ~/.pyiceberg.yaml file or through environment variables.
Below are the formalized conventions that we adhere to in the PyIceberg project. The goal of this is to have a common agreement on how to evolve the codebase, but also using it as guidelines for newcomers to the project.
0 commit comments