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

Jump to bottom

Update unit test doc #5856

Merged
merged 2 commits into from
Jun 20, 2022
Merged

Update unit test doc #5856

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c930e85
Update unit test doc
Jun 16, 2022
aa88dbc
Address comments
Jun 17, 2022
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
10 changes: 9 additions & 1 deletion tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,15 @@ and the code is in the `com.nvidia.spark.rapids.tests.mortgage` package.
Unit tests exist in the [tests]() directory. This is unconventional and is done so we can run the
tests on the final shaded version of the plugin. It also helps with how we collect code coverage.

Use Maven to run the unit tests via `mvn test`.
The `tests` module depends on the `aggregator` module which is shading the dependencies.
Should first `mvn install` the aggregator jar to local Maven repository due to a limitation of the shading system.
The steps to run the unit tests:
tgravescs marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

@tgravescs does this wording make sense?

Suggested change
The `tests` module depends on the `aggregator` module which is shading the dependencies.
Should first `mvn install` the aggregator jar to local Maven repository due to a limitation of the shading system.
The steps to run the unit tests:
The `tests` module depends on the `aggregator` module which shades dependencies. When running the
tests, make sure to do an install via `mvn install` for the aggregator jar to the local maven
repository.
The steps to run the unit tests:

Copy link
Collaborator

Choose a reason for hiding this comment

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

its close, we might add "When running the tests via 'mvn test', make...

Copy link
Collaborator

Choose a reason for hiding this comment

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

Updating the suggestion:

Suggested change
The `tests` module depends on the `aggregator` module which is shading the dependencies.
Should first `mvn install` the aggregator jar to local Maven repository due to a limitation of the shading system.
The steps to run the unit tests:
The `tests` module depends on the `aggregator` module which shades dependencies. When running the
tests via `mvn test`, make sure to do an install via `mvn install` for the aggregator jar to the
local maven repository.
The steps to run the unit tests:

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

```bash
cd <root-path-of-spark-rapids>
mvn clean install
cd tests
mvn test
```

To run targeted Scala tests append `-DwildcardSuites=<comma separated list of wildcard suite
names to execute>` to the above command.
Expand Down