org.testifyproject.annotation.Fake Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

A module that provides Testify's annotations

There is a newer version: 1.0.6

/*
 * 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 java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.FIELD;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;

/**
 * 
 * An annotation that can be placed on unit, integration and system test class
 * fields to denote the fields as a fake collaborators. Fake collaborators are
 * mock instance of collaborators and allow us to mock functionality and verify
 * interaction between the System Under Test and the collaborator in isolation.
 * Note that if the value of the test class field is already initialized with:
 * 
 * 
 * a mock instance of the collaborator then this mock instance will be used
 * and injected into the system under test.
 * 
 * 
 * a concrete instance of the collaborator then a mock instances that delegates
 * to the field value will be created and injected into the system under test.
 * 
 * 
 *
 * @author saden
 */
@Documented
@Retention(RUNTIME)
@Target(FIELD)
public @interface Fake {

    /**
     * 
     * This value represents the field name of the system under test associated
     * with the test field. Please note that name based auto detection only
     * works if your code is compiled with parameter names or debug information
     * (javac -parameters or javac -g:vars).
     * 
     * 
     * By default this value is set to "" to enable auto detection. If you wish
     * to not rely on auto detection you can explicitly specify the name of the
     * system under test field associated with the test field.
     * 
     *
     * @return the system under test field name.
     */
    String value() default "";

}