This is an automated email from the ASF dual-hosted git repository.
yuqi4733 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new 58fdd5d68 [#5563] Improvement(docs): Improve Docker test instructions
to enhance user clarity and guidance (#5566)
58fdd5d68 is described below
commit 58fdd5d68bb41944f725c48b351612504a3a4d0c
Author: TungYuChiang <[email protected]>
AuthorDate: Thu Nov 14 09:57:29 2024 +0800
[#5563] Improvement(docs): Improve Docker test instructions to enhance user
clarity and guidance (#5566)
### What changes were proposed in this pull request?
Added instructions to docs/how-to-test.md for configuring
Docker-dependent tests by setting skipDockerTests=false in
gradle.properties, using -PskipDockerTests=false in the command, or
exporting SKIP_DOCKER_TESTS=false in the shell.
### Why are the changes needed?
To prevent confusion for users expecting a complete test run, as tests
requiring Docker will be skipped by default without these
configurations.
Fix: #5563
### Does this PR introduce _any_ user-facing change?
Yes, it provides clearer documentation on how to enable Docker-related
tests to ensure a comprehensive test run.s.)
### How was this patch tested?
N/A
---
docs/how-to-test.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/how-to-test.md b/docs/how-to-test.md
index 99bfed7c9..027046c5d 100644
--- a/docs/how-to-test.md
+++ b/docs/how-to-test.md
@@ -105,6 +105,9 @@ public class CatalogHiveIT extends AbstractIT {
:::note
* Make sure that the `Docker server` is running before running all the
integration tests. Otherwise, it only runs the integration tests without the
`gravitino-docker-test` tag.
+* To run Docker-related tests, make sure you have installed Docker in your
environment and either
+ set skipDockerTests=false in the gradle.properties file (or use
`-PskipDockerTests=false` in the command) or
+ (2) export SKIP_DOCKER_TESTS=false in shell. Otherwise, all tests requiring
Docker will be skipped.
* On macOS, be sure to run the
`${GRAVITINO_HOME}/dev/docker/tools/mac-docker-connector.sh`
script before running the integration tests; or make sure that
[OrbStack](https://orbstack.dev/) is running.
