IntegrationTest.java

/**
 * Copyright 2016 Hortonworks.
 *
 * Licensed 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.
 **/

package com.hortonworks.registries.common.test;

/**
 * Marker interface used to mark integration tests. Integration tests will be run during the Maven
 * <b><i>integration-test</i></b> phase, whereas unit tests will be run during the Maven <b><i>test</i></b> phase.
 * <p></p>
 * Integration tests can be in the same package as unit tests. To mark a test as integration test,

 * add the annotation @Category(IntegrationTest.class) to the class definition. For example:
 * <p></p>
 *
 * Category(IntegrationTest.class)<br>
 * public class MyIntegrationTest {<br>
 * ...<br>
 * }
 * <p>
 * Please consult the  @see <a href="file:///../../../../../../README.md">README.md</a> for info on how to add the dependencies
 * to the Maven project POM files of the projects that include integration tests
 * <p>
 * <p>
 * <pre>
 * {@code
 * <dependency>
 *  <groupId>org.apache</groupId>
 *  <artifactId>core</artifactId>
 *  <version>${snapshot.version}</version>
 *  <type>test-jar</type>
 *  <scope>test</scope>
 * </dependency> }
 * </pre>
 * <br>
 * <pre>
 * {@code
 * <plugin>
 *  <groupId>org.apache.maven.plugins</groupId>
 * <artifactId>maven-surefire-plugin</artifactId>
 * </plugin> }
 * </pre>
 * <pre>
 * {@code
 * <plugin>
 * <groupId>org.apache.maven.plugins</groupId>
 * <artifactId>maven-failsafe-plugin</artifactId>
 * </plugin> }
 * </pre>
 */
public interface IntegrationTest {
}