Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Running ScalaTest suites from the CLI #404

Merged
merged 3 commits into from
May 9, 2024
Merged

docs: Running ScalaTest suites from the CLI #404

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd56b89
Adding documentation to run single tests
May 8, 2024
a6f4f60
Removed empty newline
May 8, 2024
888fb80
Fixing README and development.md
May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is helpful content @edmondop but I think this needs to be in the development guide (part of the contributing guide linked to here in the README), which is published at https://datafusion.apache.org/comet/contributor-guide/development.html

The source is in this repo under docs/source/contributor-guide

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

1 change: 1 addition & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,6 +725,7 @@ under the License.
<systemPropertyVariables>
<log4j.configurationFile>file:src/test/resources/log4j2.properties</log4j.configurationFile>
</systemPropertyVariables>
<skipTests>${skip.surefire.tests}</skipTests>
</configuration>
</plugin>
<plugin>
Expand Down