mirror of
https://github.com/apache/druid.git
synced 2025-02-13 13:34:58 +00:00
cfed036091
This commit is a first draft of the revised integration test framework which provides: - A new directory, integration-tests-ex that holds the new integration test structure. (For now, the existing integration-tests is left unchanged.) - Maven module druid-it-tools to hold code placed into the Docker image. - Maven module druid-it-image to build the Druid-only test image from the tarball produced in distribution. (Dependencies live in their "official" image.) - Maven module druid-it-cases that holds the revised tests and the framework itself. The framework includes file-based test configuration, test-specific clients, test initialization and updated versions of some of the common test support classes. The integration test setup is primarily a huge mass of details. This approach refactors many of those details: from how the image is built and configured to how the Docker Compose scripts are structured to test configuration. An extensive set of "readme" files explains those details. Rather than repeat that material here, please consult those files for explanations.
135 lines
4.1 KiB
Markdown
135 lines
4.1 KiB
Markdown
<!--
|
|
~ 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.
|
|
-->
|
|
|
|
# Revised Integration Tests
|
|
|
|
This directory builds a Docker image for Druid, then uses that image, along
|
|
with test configuration to run tests. This version greatly evolves the
|
|
integration tests from the earlier form. See the [History](docs/history.md)
|
|
section for details.
|
|
|
|
## Shortcuts
|
|
|
|
List of the most common commands once you're familiar with the framework.
|
|
If you are new to the framework, see [Quickstart](docs/quickstart.md) for
|
|
an explanation.
|
|
|
|
### Build Druid
|
|
|
|
To make the text a bit simpler, define a variable for the standard settings:
|
|
|
|
```bash
|
|
export MAVEN_IGNORE=-P skip-static-checks,skip-tests -Dmaven.javadoc.skip=true
|
|
|
|
```bash
|
|
mvn clean package -P dist $MAVEN_IGNORE -T1.0C
|
|
```
|
|
|
|
### Build the Test Image
|
|
|
|
```bash
|
|
cd $DRUID_DEV/integration-tests-ex/image
|
|
mvn install -P test-image $MAVEN_IGNORE
|
|
```
|
|
|
|
### Run an IT from the Command Line
|
|
|
|
```bash
|
|
mvn verify -P IT-<category> -pl :druid-it-cases $MAVEN_IGNORE
|
|
```
|
|
|
|
Where `<category>` is one of the test categories.
|
|
|
|
Or
|
|
|
|
```bash
|
|
cd $DRUID_DEV/integration-tests-ex/cases
|
|
mvn verify -P skip-static-checks,docker-tests,IT-<category> \
|
|
-Dmaven.javadoc.skip=true -DskipUTs=true \
|
|
-pl :druid-it-cases
|
|
```
|
|
|
|
### Run an IT from the IDE
|
|
|
|
Start the cluster:
|
|
|
|
```bash
|
|
cd $DRUID_DEV/integration-tests-ex/cases
|
|
./cluster.sh <category> up
|
|
```
|
|
|
|
Where `<category>` is one of the test categories. Then launch the
|
|
test as a JUnit test.
|
|
|
|
## Contents
|
|
|
|
* [Goals](#Goals)
|
|
* [Quickstart](docs/quickstart.md)
|
|
* [Create a new test](docs/guide.md)
|
|
* [Maven configuration](docs/maven.md)
|
|
* [Travis integration](docs/travis.md)
|
|
* [Docker image](docs/docker.md)
|
|
* [Druid configuration](docs/druid-config.md)
|
|
* [Docker Compose configuration](docs/compose.md)
|
|
* [Test configuration](docs/test-config.md)
|
|
* [Test structure](docs/tests.md)
|
|
* [Test runtime semantics](docs/runtime.md)
|
|
* [Scripts](docs/scripts.md)
|
|
* [Dependencies](docs/dependencies.md)
|
|
* [Debugging](docs/debugging.md)
|
|
|
|
Background information
|
|
|
|
* [Next steps](docs/next-steps.md)
|
|
* [Test conversion](docs/conversion.md) - How to convert existing tests.
|
|
* [History](docs/history.md) - Comparison with prior integration tests.
|
|
|
|
## Goals
|
|
|
|
The goal of the present version is to simplify development.
|
|
|
|
* Speed up the Druid test image build by avoiding download of
|
|
dependencies. (Instead, any such dependencies are managed by
|
|
Maven and reside in the local build cache.)
|
|
* Use official images for dependencies to avoid the need to
|
|
download, install, and manage those dependencies.
|
|
* Make it is easy to manually build the image, launch
|
|
a cluster, and run a test against the cluster.
|
|
* Convert tests to JUnit so that they will easily run in your
|
|
favorite IDE, just like other Druid tests.
|
|
* Use the actual Druid build from `distribution` so we know
|
|
what is tested.
|
|
* Leverage, don't fight, Maven.
|
|
* Run the integration tests easily on a typical development machine.
|
|
|
|
By meeting these goals, you can quickly:
|
|
|
|
* Build the Druid distribution.
|
|
* Build the Druid image. (< 1 minute)
|
|
* Launch the cluster for the particular test. (a few seconds)
|
|
* Run the test any number of times in your debugger.
|
|
* Clean up the test artifacts.
|
|
|
|
The result is that the fastest path to develop a Druid patch or
|
|
feature is:
|
|
|
|
* Create a normal unit test and run it to verify your code.
|
|
* Create an integration test that double-checks the code in
|
|
a live cluster.
|