org.exist.test.XQueryAssertions Maven / Gradle / Ivy

Go to download
/*
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * [email protected]
 * http://www.exist-db.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.test;

import com.evolvedbinary.j8fu.Either;
import org.exist.xquery.CompiledXQuery;
import org.exist.xquery.ErrorCodes;
import org.exist.xquery.XPathException;
import org.exist.xquery.value.Sequence;
import org.hamcrest.Matcher;
import javax.xml.transform.Source;

import static org.exist.test.DiffMatcher.hasIdenticalXml;
import static org.exist.test.DiffMatcher.hasSimilarXml;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.fail;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertEquals;

/**
 * This set of assertions are meant to help when testing XQuery compilation, execution and errors
 * Especially useful, if the testsuite inherits from/ extends XQueryCompilationTest class
 *
 * @author Juri Leino
 * @author Adam Retter
 */
public class XQueryAssertions {
    public static void assertXQStaticError(final ErrorCodes.ErrorCode expectedCode, final int line, final int column, final String expectedMessage, final Either actual) {
        assertXQStaticError(expectedCode, line, column, actual);
        assertXQErrorMessage(expectedMessage, actual.left().get());
    }

    public static void assertXQStaticError(final ErrorCodes.ErrorCode expectedCode, final int line, final int column, final Either actual) {
        assertTrue("Expected static error: " + expectedCode.getErrorQName() + ", but no error was thrown.", actual.isLeft());
        final XPathException xpe = actual.left().get();
        assertXQErrorCode(expectedCode, xpe);
        assertXQErrorLine(line, xpe);
        assertXQErrorColumn(column, xpe);
    }

    public static void assertXQDynamicError(final ErrorCodes.ErrorCode expectedCode, final int line, final int column, final String expectedMessage, final Either actual) {
        assertXQDynamicError(expectedCode, line, column, actual);
        assertXQErrorMessage(expectedMessage, actual.left().get());
    }

    public static void assertXQDynamicError(final ErrorCodes.ErrorCode expectedCode, final int line, final int column, final Either actual) {
        assertTrue("Expected dynamic error: " + expectedCode.getErrorQName() + ", but no error was thrown.", actual.isLeft());
        final XPathException xpe = actual.left().get();
        assertXQErrorLine(line, xpe);
        assertXQErrorColumn(column, xpe);
        assertXQErrorCode(expectedCode, xpe);
    }

    public static void assertThatXQResult(final Either actual, final Matcher expectedMatcher) {
        if (actual.isLeft()) {
            fail("Expected result, but found XPathException: " + actual.left().get().toString());
        }
        final Sequence sequence = actual.right().get();
        assertThat(sequence, expectedMatcher);
    }

    public static void assertXQResultSimilar(final Source expectedSource, final Either actual) {
        assertThatXQResult(actual, hasSimilarXml(expectedSource));
    }

    public static void assertXQResultIdentical(final Source expectedSource, final Either actual) {
        assertThatXQResult(actual, hasIdenticalXml(expectedSource));
    }

    public static void assertXQErrorCode(final ErrorCodes.ErrorCode expectedCode, final XPathException exception) {
        assertEquals("Expected: " + expectedCode.getErrorQName() + ", but got: " + exception.getErrorCode().getErrorQName(),
                expectedCode, exception.getErrorCode());
    }

    public static void assertXQErrorLine(final int expectedLine, final XPathException exception) {
        assertEquals("Expected line to be " + expectedLine + ", but got " + exception.getLine(),
                expectedLine, exception.getLine());
    }

    public static void assertXQErrorColumn(final int expectedColumn, final XPathException exception) {
        assertEquals("Expected column to be " + expectedColumn + ", but got " + exception.getColumn(),
                expectedColumn, exception.getColumn());
    }

    public static void assertXQErrorMessage(final String expectedMessage, final XPathException exception) {
        assertEquals("Expected message to be " + expectedMessage + ", but got " + exception.getMessage(),
                expectedMessage, exception.getDetailMessage());
    }
}