org.testifyproject.annotation.RemoteResource Maven / Gradle / Ivy
Show all versions of api Show documentation
/*
* Copyright 2016-2017 Testify Project.
*
* 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 org.testifyproject.annotation;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.testifyproject.DataProvider;
import org.testifyproject.RemoteResourceProvider;
/**
*
* An annotation that can be placed on integration and system tests to specify resources that
* must be loaded, configured, started, stopped before and after each test case (i.e. an
* in-memory database).
*
*
* Note that an remote resource consists of a server component and client component (optional).
* For example, if a test class requires an in-memory database then the database
* {@link javax.sql.DataSource} can be thought of as the server component and the
* {@link java.sql.Connection} to the DataSource as the client component.
*
*
*
* @author saden
*/
@Documented
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE, TYPE})
@Repeatable(RemoteResources.class)
public @interface RemoteResource {
/**
* Specifies the remote resource's implementation provider class.
*
* @return the remote resource implementation provider class.
*/
Class value();
/**
*
* Specifies the name of the {@link org.testifyproject.RemoteResourceInstance} provided by {@link #value()
* }.
*
*
* Note that if a test class requires multiple resources that provide similar resources then
* name must be specified to resolve ambiguity as to which resource instance should be
* injected into your test code.
*
*
* @return the resource instance name.
*/
String name() default "";
/**
* The configuration section key in .testify.yml associated with the remote resource.
*
* @return the configKey section key.
*/
String configKey() default "";
/**
* A list of classpath data files that should be loaded by the remote resource prior to
* being used. Note that {@link java.nio.file.FileSystem#getPathMatcher(java.lang.String)}
* glob patterns are supported
*
* @return an array of data file names or patterns.
*/
String[] dataFiles() default {};
/**
* Specifies a data provider implementations that loads data into the resource prior to it
* being used.
*
* @return the data provider implementation class.
*/
Class dataProvider() default DataProvider.class;
/**
*
* Specifies the remote resource's name. This useful for giving the resource instance a
* unique name that can be used to qualify and distinguish it from other similar resources.
*
*
* Note that if the name is not specified the name provided by the remote resource provider
* implementation will be used.
*
*
* @return the remote resource's name.
*/
String resourceName() default "";
/**
*
* Specifies the virtual resource's contract. This useful for getting the resource by its
* contract.
*
*
* Note that if the contract is not specified the resource instance will be injectable by
* its implementation class only.
*
*
* @return the remote resource's contract type.
*/
Class resourceContract() default void.class;
}