org.opensearch.test.hamcrest.TupleMatchers Maven / Gradle / Ivy

Go to download

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

OpenSearch subproject :test:framework

There is a newer version: 2.17.0

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you 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.
 */
/*
 * Modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

package org.opensearch.test.hamcrest;

import org.opensearch.common.collect.Tuple;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;

import java.util.Arrays;

public class TupleMatchers {

    private static class TupleMatcher extends TypeSafeMatcher> {

        private final Matcher v1Matcher;
        private final Matcher v2Matcher;

        private TupleMatcher(Matcher v1Matcher, Matcher v2Matcher) {
            this.v1Matcher = v1Matcher;
            this.v2Matcher = v2Matcher;
        }

        @Override
        protected boolean matchesSafely(final Tuple item) {
            return item != null && v1Matcher.matches(item.v1()) && v2Matcher.matches(item.v2());
        }

        @Override
        public void describeTo(final Description description) {
            description.appendText("expected tuple matching ").appendList("[", ", ", "]", Arrays.asList(v1Matcher, v2Matcher));
        }
    }

    /**
     * Creates a matcher that matches iff:
     *  1. the examined tuple's v1() matches the specified v1Matcher
     * and
     *  2. the examined tuple's v2() matches the specified v2Matcher
     * For example:
     * assertThat(Tuple.tuple("myValue1", "myValue2"), isTuple(startsWith("my"), containsString("Val")))
     */
    public static  TupleMatcher isTuple(Matcher v1Matcher, Matcher v2Matcher) {
        return new TupleMatcher(v1Matcher, v2Matcher);
    }
}