org.glassfish.tests.utils.junit.matcher.TextFileMatchers Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of test-utils Show documentation
The newest version!
/*
 * Copyright (c) 2022 Eclipse Foundation and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.tests.utils.junit.matcher;

import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeDiagnosingMatcher;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.LineNumberReader;
import java.util.function.Function;

import static org.hamcrest.CoreMatchers.equalTo;
import static org.junit.jupiter.api.Assertions.fail;

/**
 * @author David Matejcek
 */
public class TextFileMatchers {

    public static Matcher hasLineCount(final long expected) {
        return hasLineCount(equalTo(expected));
    }


    public static Matcher hasLineCount(final Matcher expected) {
        return new TypeSafeDiagnosingMatcher<>() {

            @Override
            public void describeTo(Description description) {
                description.appendText("A file with a number of lines: ").appendDescriptionOf(expected);
            }

            @Override
            protected boolean matchesSafely(File item, Description mismatchDescription) {
                try (LineNumberReader reader = new LineNumberReader(new FileReader(item))) {
                    long lineCount = reader.lines().count();
                    boolean result = expected.matches(lineCount);
                    if (!result) {
                        expected.describeMismatch(lineCount, mismatchDescription);
                    }
                    return result;
                } catch (IOException e) {
                    return fail(e);
                }
            }
        };
    }


    public static  Matcher getterMatches(final Function fileGetter, final Matcher expected) {
        return new TypeSafeDiagnosingMatcher<>() {

            @Override
            public void describeTo(Description description) {
                description.appendText("A file getter `").appendValue(fileGetter).appendText("'")
                    .appendDescriptionOf(expected);

            }

            @Override
            protected boolean matchesSafely(File item, Description mismatchDescription) {
                T value = fileGetter.apply(item);
                boolean result = expected.matches(value);
                if (!result) {
                    expected.describeMismatch(value, mismatchDescription);
                }
                return result;
            }

        };
    }
}