de.unkrig.commons.junit4.AssertRegex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-junit4 Show documentation
The newest version!

/*
 * de.unkrig.commons - A general-purpose Java class library
 *
 * Copyright (c) 2016, Arno Unkrig
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *       following disclaimer in the documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
 *       products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package de.unkrig.commons.junit4;

import java.util.Arrays;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.junit.Assert;

import de.unkrig.commons.nullanalysis.Nullable;

/**
 * Utility methods related to JUNIT and {@code java.util.regex}.
 */
public final
class AssertRegex {

    private AssertRegex() {}

    /**
     * Fails unless the actual string matches the given expectedRegex.
     */
    public static void
    assertMatches(String expectedRegex, String actual) {
        AssertRegex.assertMatches(null, expectedRegex, actual);
    }

    /**
     * Fails with the given message unless the actual string matches the given
     * expectedRegex.
     */
    public static void
    assertMatches(@Nullable String message, String expectedRegex, String actual) {
        Pattern pattern = Pattern.compile(expectedRegex);
        Matcher matcher = pattern.matcher(actual);
        if (!matcher.matches()) {
            int mismatchOffset = AssertRegex.mismatchOffset(pattern, actual);

            String s = actual.substring(mismatchOffset);
            if (s.length() > 10) s = s.substring(0, 8) + "...";

            Assert.fail(
                (message == null ? "[" : message + ": [")
                + actual
                + "] did not match regex ["
                + expectedRegex
                + "] at offset "
                + mismatchOffset
                + ": \""
                + s
                + "\""
            );
        }
    }

    /**
     * @return The offset of the first character in the subject that causes a mismatch
     */
    private static int
    mismatchOffset(Pattern pattern, String subject) {
        for (int i = subject.length(); i >= 0; i--) {
            Matcher matcher = pattern.matcher(subject.substring(0, i));
            if (matcher.matches()) return i;
            if (matcher.hitEnd()) return i;
        }
        return 0;
    }

    /**
     * Fails unless each of the actuals matches the respective regex.
     */
    public static void
    assertMatches(List actuals, String... expectedRegexes) {
        AssertRegex.assertMatches(null, Arrays.asList(expectedRegexes), actuals);
    }

    /**
     * Fails unless each of the actuals matches the respective regex.
     */
    public static void
    assertMatches(String message, List actuals, String... expectedRegexes) {
        AssertRegex.assertMatches(message, Arrays.asList(expectedRegexes), actuals);
    }

    /**
     * Fails unless each of the actuals matches the respective regex.
     */
    public static void
    assertMatches(List expectedRegexes, List actuals) {
        AssertRegex.assertMatches(null, expectedRegexes, actuals);
    }

    /**
     * Fails with the given message unless each of the actuals matches the respective regex.
     */
    public static void
    assertMatches(@Nullable String message, List expectedRegexes, List actuals) {

        // Generate the "correct" REGEXes for the actual strings:
        if (Boolean.getBoolean("AssertRegex.assertMatches.printActualRegexes")) {
            for (String s : actuals) {
                s = (
                    s
                    .replaceAll("\\\\", "\\\\\\\\")
                    .replaceAll("[\\[{\\$}\\].*+]", "\\\\$0")
                );
                for (String regex : new String[] {
                    "@\\w+",
                    "\\w{3} \\w{3} \\d\\d \\d\\d:\\d\\d:\\d\\d \\w+ \\d{4}",
                    "lastModified=-?\\d{7,}",
                }) {
                    s = s.replaceAll(regex, Matcher.quoteReplacement(regex));
                }
                System.out.println(s);
            }
        }

        for (int i = 0; i < expectedRegexes.size() && i < actuals.size(); i++) {
            String expectedRegex = expectedRegexes.get(i);
            String actual        = actuals.get(i);

            AssertRegex.assertMatches(
                (message == null ? "Element " : message + ": Element ") + i,
                expectedRegex,
                actual
            );
        }
        if (expectedRegexes.size() != actuals.size()) {
            Assert.fail(
                (message == null ? "Expected " : message + ": Expected ")
                + expectedRegexes.size()
                + " strings, but got "
                + actuals.size()
            );
        }
    }

    /**
     * Fails unless the expectedRegex can be found at least once in the actual string.
     */
    public static void
    assertFind(String expectedRegex, String actual) {
        AssertRegex.assertFind(null, expectedRegex, actual);
    }

    /**
     * Fails with the given message unless the expectedRegex can be found at least once in the
     * actual string.
     */
    public static void
    assertFind(@Nullable String message, String expectedRegex, String actual) {
        Pattern pattern = Pattern.compile(expectedRegex);
        Matcher matcher = pattern.matcher(actual);
        if (!matcher.find()) {

            Assert.fail(
                (message == null ? "regex [" : message + ": regex [")
                + expectedRegex
                + "] not found in ["
                + actual
                + "]"
            );
        }
    }
}