| <!-- |
| - 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. |
| --> |
| |
| # Running Tests |
| |
| **Kyuubi** can be tested based on [Apache Maven](https://maven.apache.org) and the ScalaTest Maven Plugin, |
| please refer to the [ScalaTest documentation](https://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, 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 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 |
| ``` |
| |