edu.si.sidora.excel2tabular.integration.IntegrationTestUtilities.java Source code

Introduction

Here is the source code for edu.si.sidora.excel2tabular.integration.IntegrationTestUtilities.java

Source

/*
 * Copyright 2015-2016 Smithsonian Institution.
 *
 * 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/
 *
 * This software and accompanying documentation is supplied without
 * warranty of any kind. The copyright holder and the Smithsonian Institution:
 * (1) expressly disclaim any warranties, express or implied, including but not
 * limited to any implied warranties of merchantability, fitness for a
 * particular purpose, title or non-infringement; (2) do not assume any legal
 * liability or responsibility for the accuracy, completeness, or usefulness of
 * the software; (3) do not represent that use of the software would not
 * infringe privately owned rights; (4) do not warrant that the software
 * is error-free or will be maintained, supported, updated or enhanced;
 * (5) will not be liable for any indirect, incidental, consequential special
 * or punitive damages of any kind or nature, including but not limited to lost
 * profits or loss of data, on any basis arising from contract, tort or
 * otherwise, even if any of the parties has been warned of the possibility of
 * such loss or damage.
 *
 * This distribution includes several third-party libraries, each with their own
 * license terms. For a complete copy of all copyright and license terms, including
 * those of third-party libraries, please see the product release notes.
 */

package edu.si.sidora.excel2tabular.integration;

import static com.google.common.base.Charsets.UTF_8;
import static com.googlecode.totallylazy.Functions.returns;
import static com.googlecode.totallylazy.Predicates.equalTo;
import static com.googlecode.totallylazy.Sequences.zip;
import static com.googlecode.totallylazy.matchers.Matchers.matcher;
import static java.util.regex.Pattern.compile;
import static org.hamcrest.CoreMatchers.anyOf;
import static org.hamcrest.CoreMatchers.not;

import java.io.IOException;
import java.net.URL;
import java.util.List;
import java.util.regex.Pattern;

import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;
import org.junit.ComparisonFailure;

import com.google.common.io.Resources;
import com.googlecode.totallylazy.Pair;

/**
 * Some convenient utilities for integration tests.
 * 
 * @author ajs6f
 */
public class IntegrationTestUtilities {

    protected static List<String> readLines(final URL result) throws IOException {
        return Resources.readLines(result, UTF_8);
    }

    private static final Pattern REMOVE_TRAILING_COMMAS = compile("(.+?),*$");

    protected static String withoutTrailingCommas(final String input) {
        final java.util.regex.Matcher matcher = REMOVE_TRAILING_COMMAS.matcher(input);
        matcher.find();
        return matcher.group(1);
    }

    private static Matcher<LinePair> matchesUpToTrailingCommas = new TypeSafeMatcher<LinePair>() {

        @Override
        public boolean matchesSafely(final LinePair lines) {
            return withoutTrailingCommas(lines.first()).equals(withoutTrailingCommas(lines.second()));
        }

        @Override
        public void describeTo(final Description d) {
            d.appendText("are equal modulo trailing commas");
        }
    };

    private static Matcher<LinePair> matchesUpToQuotationCharacters = new TypeSafeMatcher<LinePair>() {

        @Override
        public boolean matchesSafely(final LinePair lines) {
            final String a = withoutTrailingCommas(lines.first()).replace("\"", "");
            final String b = withoutTrailingCommas(lines.second()).replace("\"", "");
            return a.equals(b);
        }

        @Override
        public void describeTo(final Description d) {
            d.appendText("are equal modulo trailing commas and quotation chars");
        }
    };

    @SuppressWarnings("unchecked")
    protected static void compareLines(final Iterable<String> checkLines, final Iterable<String> resultLines) {
        int lineNum = 0;
        for (final Pair<String, String> pair : zip(checkLines, resultLines)) {
            final LinePair lines = new LinePair(pair);
            lineNum++;
            if (not(anyOf(matcher(equalTo()), matchesUpToTrailingCommas, matchesUpToQuotationCharacters))
                    .matches(lines)) {
                throw new ComparisonFailure("Mismatch at line: " + lineNum, lines.first(), lines.second());
            }
        }
    }

    private static class LinePair extends Pair<String, String> {

        protected LinePair(final Pair<String, String> lines) {
            super(returns(lines.first()), returns(lines.second()));
        }
    }
}