io.github.theangrydev.fluentbdd.hamcrest.WithFluentHamcrest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hamcrest-extensions Show documentation

The newest version!

/*
 * Copyright 2016 Liam Williams .
 *
 * This file is part of fluent-bdd.
 *
 * 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.fluentbdd.hamcrest;

import io.github.theangrydev.fluentbdd.core.When;
import io.github.theangrydev.fluentbdd.core.WithFluentBdd;
import org.hamcrest.Matcher;

import static org.junit.Assert.assertThat;

/**
 * This acts as a bridge to use BDD language with Hamcrest matchers.
 *
 * @param  The type of test result produced by the {@link When}.
 * @see Hamcrest
 */
public interface WithFluentHamcrest extends WithFluentBdd {

    /**
     * Assert that the given result matches the given matcher.
     *
     * @param result  The result to assert against. You can use {@link #theResult()} (or a private method that extracts something from the result)
     * @param matcher The matcher that should match the result
     * @param      The type of result
     */
    default  void then(T result, Matcher matcher) {
        fluentBdd().verification.recordThen(matcher);
        assertThat(result, matcher);
    }

    /**
     * Same as {@link #then(Object, Matcher)}.
     * 
     * Assert that the given result matches the given matcher.
     *
     * @param result  The result to assert against. You can use {@link #theResult()} (or a private method that extracts something from the result)
     * @param matcher The matcher that should match the result
     * @param      The type of result
     */
    default  void and(T result, Matcher matcher) {
        then(result, matcher);
    }
}