kyuubi/docs/develop_tools/testing.md
gabrywu af162b1f2e [KYUUBI #2487] Fix test command to make it runnable
### _Why are the changes needed?_

only change testing.md

### _How was this patch tested?_
- [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #2487 from gabrywu/fixTestingMd.

Closes #2487

3c648a7e [gabrywu] fix module test command
7c6d1df0 [gabrywu] fix Running Tests Fully command
0582b6ec [gabrywu] fix test command to make it runnable

Authored-by: gabrywu <gabrywu@apache.org>
Signed-off-by: Fei Wang <fwang12@ebay.com>
2022-04-27 21:40:32 +08:00

61 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-->
<div align=center>
![](../imgs/kyuubi_logo.png)
</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 install
```
## Running Tests for a Module
```bash
./build/mvn clean install -pl kyuubi-common
```
## Running Tests for a Single Test
When developing locally, its 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 clean install -Dtest=none -DwildcardSuites=org.apache.kyuubi.service.FrontendServiceSuite
```
If you want to make a single test that need to 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
```