From cd56b894c65e2bcf307d9603d60d5ecfa11ac33a Mon Sep 17 00:00:00 2001 From: Edmondo Porcu Date: Wed, 8 May 2024 14:24:56 -0400 Subject: [PATCH 1/3] Adding documentation to run single tests --- README.md | 12 ++++++++++++ pom.xml | 2 ++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index fb17535aa..2e3b6cde7 100644 --- a/README.md +++ b/README.md @@ -74,3 +74,15 @@ See the [DataFusion Comet User Guide](https://datafusion.apache.org/comet/user-g ## Contributing See the [DataFusion Comet Contribution Guide](https://datafusion.apache.org/comet/contributor-guide/contributing.html) for information on how to get started contributing to the project. + +## Running ScalaTest suites from the CLI + +Running single ScalaTest suites from the CLI is possible using the `suites` +argument, for example if you only want to execute the test cases that contains *valid* +in their name in `org.apache.comet.CometCastSuite` you can use + +```sh +mvn test -Dsuites="org.apache.comet.CometCastSuite valid" -Dskip.surefire.tests=true +``` + +Other options for selecting specific suites are described in the [ScalaTest Maven Plugin documentation](https://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin) \ No newline at end of file diff --git a/pom.xml b/pom.xml index d47953fac..d65fb57df 100644 --- a/pom.xml +++ b/pom.xml @@ -725,7 +725,9 @@ under the License. file:src/test/resources/log4j2.properties + ${skip.surefire.tests} + org.apache.maven.plugins From a6f4f604c6873a4da30978c6a40ecae7dcc05af5 Mon Sep 17 00:00:00 2001 From: Edmondo Porcu Date: Wed, 8 May 2024 14:26:45 -0400 Subject: [PATCH 2/3] Removed empty newline --- pom.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/pom.xml b/pom.xml index d65fb57df..7d05d5a04 100644 --- a/pom.xml +++ b/pom.xml @@ -727,7 +727,6 @@ under the License. ${skip.surefire.tests} - org.apache.maven.plugins From 888fb804ad394086adaa0b40c6f83616c724bd66 Mon Sep 17 00:00:00 2001 From: Edmondo Porcu Date: Wed, 8 May 2024 14:55:16 -0400 Subject: [PATCH 3/3] Fixing README and development.md --- README.md | 12 ------------ docs/source/contributor-guide/development.md | 12 ++++++++++++ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2e3b6cde7..fb17535aa 100644 --- a/README.md +++ b/README.md @@ -74,15 +74,3 @@ See the [DataFusion Comet User Guide](https://datafusion.apache.org/comet/user-g ## Contributing See the [DataFusion Comet Contribution Guide](https://datafusion.apache.org/comet/contributor-guide/contributing.html) for information on how to get started contributing to the project. - -## Running ScalaTest suites from the CLI - -Running single ScalaTest suites from the CLI is possible using the `suites` -argument, for example if you only want to execute the test cases that contains *valid* -in their name in `org.apache.comet.CometCastSuite` you can use - -```sh -mvn test -Dsuites="org.apache.comet.CometCastSuite valid" -Dskip.surefire.tests=true -``` - -Other options for selecting specific suites are described in the [ScalaTest Maven Plugin documentation](https://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin) \ No newline at end of file diff --git a/docs/source/contributor-guide/development.md b/docs/source/contributor-guide/development.md index 356c81b33..b0d247c0b 100644 --- a/docs/source/contributor-guide/development.md +++ b/docs/source/contributor-guide/development.md @@ -73,6 +73,18 @@ After that you can open the project in CLion. The IDE should automatically detec Like other Maven projects, you can run tests in IntelliJ IDEA by right-clicking on the test class or test method and selecting "Run" or "Debug". However if the tests is related to the native side. Please make sure to run `make core` or `cd core && cargo build` before running the tests in IDEA. +### Running Tests from command line + +It is possible to specify which ScalaTest suites you want to run from the CLI using the `suites` +argument, for example if you only want to execute the test cases that contains *valid* +in their name in `org.apache.comet.CometCastSuite` you can use + +```sh +mvn test -Dsuites="org.apache.comet.CometCastSuite valid" -Dskip.surefire.tests=true +``` + +Other options for selecting specific suites are described in the [ScalaTest Maven Plugin documentation](https://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin) + ## Benchmark There's a `make` command to run micro benchmarks in the repo. For