### _Why are the changes needed?_ Add Docs for kyuubi tools spark-block-cleaner. * Explain the parameters * Introduction to basic startup * Give an example ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [X] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request Closes #815 from zwangsheng/doc/spark_block_cleaner. Closes #815 1ec6795f [Binjie Yang] delete todo bbf4d6e2 [Binjie Yang] make it common 9cf3e159 [Binjie Yang] format 0803995a [Binjie Yang] straighten out the article f834b382 [Binjie Yang] refactor 25be318f [Binjie Yang] fix 7304e595 [Binjie Yang] docs for spark-block-cleaner Authored-by: Binjie Yang <2213335496@qq.com> Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
<div align=center>
|
||
|
||

|
||
|
||
</div>
|
||
|
||
# Running Tests
|
||
|
||
**Kyuubi** can be tested based on [Apache Maven](http://maven.apache.org) and the ScalaTest Maven Plugin,
|
||
please refer to the [ScalaTest documentation](http://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin),
|
||
|
||
## Running Tests Fully
|
||
|
||
The following is an example of a command to run all the tests:
|
||
|
||
```bash
|
||
./build/mvn clean test
|
||
```
|
||
|
||
## Running Tests for a Module
|
||
|
||
```bash
|
||
./build/mvn clean test -pl :kyuubi-common
|
||
```
|
||
|
||
## Running Tests for a Single Test
|
||
|
||
When developing locally, it’s convenient to run one single test, or a couple of tests, rather than all.
|
||
|
||
With Maven, you can use the -DwildcardSuites flag to run individual Scala tests:
|
||
|
||
```bash
|
||
./build/mvn test -Dtest=none -DwildcardSuites=org.apache.kyuubi.service.FrontendServiceSuite
|
||
```
|
||
|
||
If you want to make a single test that need integrate with kyuubi-spark-sql-engine module, please build the package for kyuubi-spark-sql-engine module at first.
|
||
|
||
You can leverage the ready-made tool for creating a binary distribution.
|
||
|
||
```bash
|
||
./build/dist
|
||
```
|