io.github.theangrydev.yatspecfluent.Given Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yatspec-fluent Show documentation

A plugin for the yatspec acceptance test library used to write acceptance tests in a fluent way, reusing givens, whens and thens.

The newest version!

/*
 * Copyright 2016 Liam Williams .
 *
 * This file is part of yatspec-fluent.
 *
 * 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 io.github.theangrydev.yatspecfluent;

/**
 * When the {@link #prime()} method is invoked, any setup necessary for this
 * to affect the system under test should be performed immediately.
 *
 * For example, this could mean priming a HTTP stub with a canned response.
 *
 * This class should act as a builder for use in {@link YatspecFluentCommands}.
 *
 * @see The Builder Pattern
 */
@FunctionalInterface
public interface Given {

    /**
     * Prime the given immediately, which will make a change that is visible to
     * the system under test (that is implemented in the {@link When}.
     */
    void prime();
}