From bcf9d3241e70f313fbc87217b23bbdf2c71d006d Mon Sep 17 00:00:00 2001 From: Ashhar Hasan Date: Fri, 13 Aug 2021 11:18:23 +0530 Subject: [PATCH] Update path to run-launcher script --- testing/trino-product-tests/README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/testing/trino-product-tests/README.md b/testing/trino-product-tests/README.md index 4febfa33de1e2..38b000c416edf 100644 --- a/testing/trino-product-tests/README.md +++ b/testing/trino-product-tests/README.md @@ -10,9 +10,14 @@ setup is as follows: a single Docker container runs Hadoop in pseudo-distributed mode and Trino runs either in Docker container(s) (both pseudo-distributed and distributed setups are possible) or manually from IntelliJ (for debugging Trino). The tests run in a separate JVM and they can be started -using the launcher found in `trino-product-tests-launcher/bin/run-launcher`. The product +using the launcher found in `testing/trino-product-tests-launcher/bin/run-launcher`. The product tests are run using the [Tempto](https://github.com/trinodb/tempto) harness. +**There is a helper script at `bin/ptl` which calls +`testing/trino-product-tests-launcher/bin/run-launcher` and helps you avoid +typing the full path to the launcher everytime. Rest of this document uses +`bin/ptl` to start the launcher but you can use the full path too.** + Developers should consider writing product tests in addition to any unit tests when making changes to user visible features. The product tests should also be run after all code changes to ensure no existing functionality has been @@ -52,7 +57,7 @@ groups run the following command: ``` ./mvnw install -DskipTests -trino-product-tests-launcher/bin/run-launcher test run --environment \ +bin/ptl test run --environment \ [--config ] \ -- ``` @@ -97,7 +102,7 @@ You can obtain list of available environments using command: ``` ./mvnw install -DskipTests -trino-product-tests-launcher/bin/run-launcher env list +bin/ptl env list ``` #### Environment config @@ -111,7 +116,7 @@ Most of the Hadoop-based environments can be run in multiple configurations that You can obtain list of available environment configurations using command: ``` -trino-product-tests-launcher/bin/run-launcher env list +bin/ptl env list ``` All of `test run`, `env up` and `suite run` commands accept `--config ` setting. @@ -125,13 +130,13 @@ and each type can be run individually with the following commands: ``` # Run single Java based test -trino-product-tests-launcher/bin/run-launcher test run \ +bin/ptl test run \ --environment \ [--config ] \ -- -t io.trino.tests.functions.operators.Comparison.testLessThanOrEqualOperatorExists # Run single convention based test -trino-product-tests-launcher/bin/run-launcher test run \ +bin/ptl test run \ --environment \ [--config ] \ -- -t sql_tests.testcases.system.selectInformationSchemaTables @@ -148,7 +153,7 @@ particular group, use the `-g` argument as shown: ``` # Run all tests in the string_functions and create_table groups -trino-product-tests-launcher/bin/run-launcher test run \ +bin/ptl test run \ --environment \ [--config ] \ -- -g string_functions,create_tables @@ -185,16 +190,16 @@ Tests are further organized into suites which contain execution of multiple test You can obtain list of available test suites using command: ``` -trino-product-tests-launcher/bin/run-launcher suite list +bin/ptl suite list ``` -Command `trino-product-tests-launcher/bin/run-launcher suite describe --suite ` shows list of tests that will be executed and environments +Command `bin/ptl suite describe --suite ` shows list of tests that will be executed and environments that will be used when `suite run` is invoked. You can execute single suite using command: ``` -trino-product-tests-launcher/bin/run-launcher suite run --suite \ +bin/ptl suite run --suite \ [--config ] ```