org.testifyproject.RemoteResourceProvider Maven / Gradle / Ivy

Go to download
/*
 * 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;

import org.testifyproject.annotation.RemoteResource;
import org.testifyproject.trait.PropertiesReader;

/**
 * A contract that defines methods to configure, start an stop a remote
 * resource.
 *
 * @author saden
 * @param  the configuration type
 * @param  the client type
 */
public interface RemoteResourceProvider {

    /**
     * 
     * A method to configure a remote resource. Configuring a remote resource
     * for testing typically involves creating a configuration object that can
     * be further configured by a test class method annotated with
     * {@link org.testifyproject.annotation.ConfigHandler}.
     * 
     * 
     * Note that implementation of this method should not do any work beyond
     * returning configuration object. That is to is to say it should be
     * stateless and should not perform instantiation of the remote resource for
     * testing as that should be handled in
     * {@link #start(org.testifyproject.TestContext, org.testifyproject.annotation.RemoteResource, java.lang.Object) }
     * method.
     * 
     *
     * @param testContext the test context
     * @param remoteResource test class remote resource annotation
     * @param configReader a configuration properties reader
     * @return the remote resource configuration object
     */
    T configure(TestContext testContext, RemoteResource remoteResource, PropertiesReader configReader);

    /**
     * Start the remote resource with the given testContext and configuration.
     *
     * @param testContext the test context
     * @param remoteResource test class remote resource annotation
     * @param config the remote resource configuration
     * @return a remote resource instance
     * @throws java.lang.Exception an exception thrown while starting
     */
    RemoteResourceInstance start(TestContext testContext, RemoteResource remoteResource, T config)
            throws Exception;

    /**
     * Stop the remote resource.
     *
     * @param testContext the test context
     * @param remoteResource test class remote resource annotation
     * @throws java.lang.Exception an exception thrown while stopping
     */
    void stop(TestContext testContext, RemoteResource remoteResource)
            throws Exception;

}