kyuubi/docs/building.md

Building Kyuui

Building Kyuubi with Apache Maven

Kyuubi server is built based on Apache Maven,

./build/mvn clean package -DskipTests

Running the code above in the Kyuubi project root directory is all we need to build a runnable Kyuubi server.

Building a Runnable Distribution

To create a Kyuubi distribution like those distributed by Kyuubi Release Page, and that is laid out so as to be runnable, use ./build/dist in the project root directory.

Example:

./build/dist --name custom-name --tgz

This will build a Kyuubi distribution name kyuubi-{version}-bin-custom-name.tar.gz. For more information on usage, run ./build/dist --help

Running Tests

The following is an example of a command to run the tests:

./build/mvn clean test

With Maven, you can use the -DwildcardSuites flag to run individual Scala tests:

./build/mvn -Dtest=none -DwildcardSuites=yaooqinn.kyuubi.operation.OperationTypeSuite test

For more information about the ScalaTest Maven Plugin, refer to the ScalaTest documentation.