paul-rogers commented on code in PR #12673: URL: https://github.com/apache/druid/pull/12673#discussion_r906332094
########## integration-tests/README.md: ########## @@ -54,47 +54,81 @@ export APACHE_ARCHIVE_MIRROR_HOST=https://example.com/remote-generic-repo ## Running tests againt auto brought up Docker containers -> NOTE: This section describes how to start integration tests against docker containers which will be brought up automatically by following commands. -If you want to buid docker images and run tests separately, see the next section. +This section describes how to start integration tests against Docker containers which will be brought up automatically by following commands. +If you want to build Docker images and run tests separately, see the next section. -To run all tests from a test group using docker and mvn run the following command: +To run all tests from a test group using Docker and Maven run the following command: + +To run all tests from a test group using docker and mvn run the following command: (list of test groups can be found at `integration-tests/src/test/java/org/apache/druid/tests/TestNGGroup.java`) ```bash mvn verify -P integration-tests -Dgroups=<test_group> ``` -To run only a single test using mvn run the following command: +### Run a Single Test + +To run only a single test using Maven: + ```bash mvn verify -P integration-tests -Dgroups=<test_group> -Dit.test=<test_name> ``` -The test group should always be set, as certain test setup and cleanup tasks are based on the test group. You can find -the test group for a given test as an annotation in the respective test class. -Add `-rf :druid-integration-tests` when running integration tests for the second time or later without changing +Parameters: + +* Test Group: Required, as certain test setup and cleanup tasks are based on the test group. You can find +the test group for a given test as an annotation in the respective test class. A list of test groups can be found at +`integration-tests/src/test/java/org/apache/druid/tests/TestNGGroup.java`. The annotation uses a string +constant defined in `TestNGGroup.java`, be sure to use the constant value, not name. For example, if your test has the the annotation: `@Test(groups = TestNGGroup.BATCH_INDEX)` then use the argument `-Dgroups=batch-index`. + +* Test Name: Use the fully-qualified class name. + +* Add `-pl :druid-integration-tests` when running integration tests for the second time or later without changing the code of core modules in between to skip up-to-date checks for the whole module dependency tree. -Integration tests can also be run with either Java 8 or Java 11 by adding `-Djvm.runtime=#` to mvn command, where `#` +* Integration tests can also be run with either Java 8 or Java 11 by adding `-Djvm.runtime=#` to the `mvn` command, where `#` can either be 8 or 11. -Druid's configuration (using Docker) can be overrided by providing `-Doverride.config.path=<PATH_TO_FILE>`. +* Druid's configuration (using Docker) can be overridden by providing `-Doverride.config.path=<PATH_TO_FILE>`. The file must contain one property per line, the key must start with `druid_` and the format should be snake case. -Note that when bringing up docker containers through mvn and -Doverride.config.path is provided, additional -Druid routers for security group integration test (permissive tls, no client auth tls, custom check tls) will not be started. +Note that when bringing up Docker containers through Maven and `-Doverride.config.path` is provided, additional +Druid routers for security group integration test (permissive tls, no client auth tls, custom check tls) will not be started. + +### Debugging Test Runs Review Comment: Great suggestion. To avoid redundant work, let's do that when we merge the "new" IT framework, since the steps will differ. ########## pom.xml: ########## @@ -1183,6 +1191,13 @@ <exclude>org/apache/druid/benchmark/**/*</exclude> <!-- benchmarks --> <exclude>org/apache/druid/**/*Benchmark*</exclude> <!-- benchmarks --> <exclude>org/apache/druid/testing/**/*</exclude> <!-- integration-tests --> + <!-- The ITs has test code sprinked through the module tree. Remove the following + once the old version is retired. --> Review Comment: Done. See issue #12689. ########## .travis.yml: ########## @@ -34,8 +34,8 @@ env: - DOCKER_IP=127.0.0.1 # for integration tests - MVN="mvn -B" - > # Various options to make execution of maven goals faster (e.g., mvn install) - MAVEN_SKIP="-Pskip-static-checks -Ddruid.console.skip=true -Dmaven.javadoc.skip=true" - - MAVEN_SKIP_TESTS="-Pskip-tests" + MAVEN_SKIP="-P skip-static-checks -Ddruid.console.skip=true -Dmaven.javadoc.skip=true" Review Comment: Good catch. These are the same changes as #12672, and disappeared when I rebased on the latest master. ########## integration-tests/README.md: ########## @@ -54,47 +54,81 @@ export APACHE_ARCHIVE_MIRROR_HOST=https://example.com/remote-generic-repo ## Running tests againt auto brought up Docker containers -> NOTE: This section describes how to start integration tests against docker containers which will be brought up automatically by following commands. -If you want to buid docker images and run tests separately, see the next section. +This section describes how to start integration tests against Docker containers which will be brought up automatically by following commands. +If you want to build Docker images and run tests separately, see the next section. -To run all tests from a test group using docker and mvn run the following command: +To run all tests from a test group using Docker and Maven run the following command: + +To run all tests from a test group using docker and mvn run the following command: (list of test groups can be found at `integration-tests/src/test/java/org/apache/druid/tests/TestNGGroup.java`) ```bash mvn verify -P integration-tests -Dgroups=<test_group> ``` -To run only a single test using mvn run the following command: +### Run a Single Test + +To run only a single test using Maven: + ```bash mvn verify -P integration-tests -Dgroups=<test_group> -Dit.test=<test_name> ``` -The test group should always be set, as certain test setup and cleanup tasks are based on the test group. You can find -the test group for a given test as an annotation in the respective test class. -Add `-rf :druid-integration-tests` when running integration tests for the second time or later without changing +Parameters: + +* Test Group: Required, as certain test setup and cleanup tasks are based on the test group. You can find Review Comment: Perhaps this is ambiguous. I read this as "setup ... tasks". You maybe saw it as "setups AND (cleanup tasks)". Reworded to avoid the ambiguity. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
