SparqlQueryParserTest.java

/**
 * Copyright (C) 2022 Czech Technical University in Prague
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * This program 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 General Public License for more
 * details. You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package cz.cvut.kbss.jopa.query.sparql;

import cz.cvut.kbss.jopa.exception.QueryParserException;
import cz.cvut.kbss.jopa.query.QueryHolder;
import cz.cvut.kbss.jopa.query.QueryParameter;
import cz.cvut.kbss.jopa.query.QueryParser;
import cz.cvut.kbss.jopa.query.parameter.ParameterValueFactory;
import cz.cvut.kbss.jopa.sessions.MetamodelProvider;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.mock;

public class SparqlQueryParserTest {

    private QueryParser queryParser;

    private ParameterValueFactory valueFactory;

    @BeforeEach
    void setUp() {
        this.valueFactory = new ParameterValueFactory(mock(MetamodelProvider.class));
        this.queryParser = new SparqlQueryParser(valueFactory);
    }

    @Test
    public void testParseSimpleQueryWithoutParameters() {
        final String query = "SELECT * WHERE { <http://a> <http://b> <http://c> . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertTrue(holder.getParameters().isEmpty());
        assertEquals(query, holder.assembleQuery());
        assertEquals(query, holder.getQuery());
    }

    @Test
    public void testParseQueryWithSingleParameter() {
        final String query = "SELECT ?x WHERE { ?x <http://www.w3.org/2000/01/rdf-schema#label> \"Test\" . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(1, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("x", valueFactory)));
    }

    @Test
    public void testParseQueryWithThreeParametersInSingleBGP() {
        final String query = "SELECT ?x ?y ?z WHERE { ?x ?y ?z . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(3, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("x", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("y", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("z", valueFactory)));
    }

    @Test
    public void testParseQueryWithMultiplePatternsAndParameters() {
        final String query = "PREFIX foaf: <http://xmlns.com/foaf/0.1/>\n" +
                "SELECT ?craft\n" +
                "{\n" +
                "?craft foaf:name \"Apollo 7\" .\n" +
                "?craft foaf:homepage ?homepage\n" +
                "}";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(2, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("craft", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("homepage", valueFactory)));
    }

    @Test
    public void testParseQueryWithFilterAndRegex() {
        final String query = "PREFIX  dc:  <http://purl.org/dc/elements/1.1/>\n" +
                "SELECT  ?title\n" +
                "WHERE   { ?x dc:title ?title\n" +
                "          FILTER regex(?title, \"^SPARQL\") \n" +
                "        }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(2, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("title", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("x", valueFactory)));
    }

    @Test
    public void testParseQueryWithFilterAndMultipleParameters() {
        final String query = "PREFIX  dc:  <http://purl.org/dc/elements/1.1/>\n" +
                "PREFIX  ns:  <http://example.org/ns#>\n" +
                "SELECT  ?title ?price\n" +
                "WHERE   { ?x ns:price ?price .\n" +
                "          FILTER (?price < 30.5)\n" +
                "          ?x dc:title ?title . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(3, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("title", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("price", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("x", valueFactory)));
    }

    @Test
    public void testParseConstructQuery() {
        final String query = "PREFIX foaf:   <http://xmlns.com/foaf/0.1/>\n" +
                "PREFIX org:    <http://example.com/ns#>\n" +
                "\n" +
                "CONSTRUCT { ?x foaf:name ?name }\n" +
                "WHERE  { ?x org:employeeName ?name }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(2, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("x", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("name", valueFactory)));
    }

    @Test
    public void parserThrowsExceptionWhenParameterNameIsMissing() {
        final String query = "SELECT ?x ?y ?z WHERE { ?x ?y ? . }";
        assertThrows(QueryParserException.class, () -> queryParser.parseQuery(query));
    }

    @Test
    public void testParseQueryWithNumberedPositionalParams() {
        final String query = "PREFIX foaf: <http://xmlns.com/foaf/0.1/>\n" +
                "SELECT ?craft\n" +
                "{\n" +
                "?craft foaf:name $1 .\n" +
                "?craft foaf:homepage $2\n" +
                "}";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(3, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("craft", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>(1, valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>(2, valueFactory)));
    }

    @Test
    public void testParseQueryWithUnnumberedPositionalParams() {
        final String query = "PREFIX foaf: <http://xmlns.com/foaf/0.1/>\n" +
                "SELECT ?craft\n" +
                "{\n" +
                "?craft foaf:name $ .\n" +
                "?craft foaf:homepage $\n" +
                "}";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(3, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("craft", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>(1, valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>(2, valueFactory)));
    }

    @Test
    public void testParseQueryWithMixedNumberedAndUnnumberedPositionalParams() {
        final String query = "PREFIX foaf: <http://xmlns.com/foaf/0.1/>\n" +
                "SELECT ?craft\n" +
                "{\n" +
                "?craft foaf:name $1 .\n" +
                "?craft foaf:homepage $\n" +
                "}";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(3, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("craft", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>(1, valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>(2, valueFactory)));
    }

    @Test
    public void parsingQueryWithUsedParameterPositionThrowsException() {
        final String query = "PREFIX foaf: <http://xmlns.com/foaf/0.1/>\n" +
                "SELECT ?craft\n" +
                "{\n" +
                "?craft foaf:name $1 .\n" +
                "?craft foaf:homepage $1\n" +
                "}";
        assertThrows(QueryParserException.class, () -> queryParser.parseQuery(query));
    }

    @Test
    public void parsingQueryWithIncorrectlyMixedNumberedAndUnnumberedPositionsThrowsException() {
        final String query = "PREFIX foaf: <http://xmlns.com/foaf/0.1/>\n" +
                "SELECT ?craft\n" +
                "{\n" +
                "?craft foaf:name $1 .\n" +
                "?craft foaf:homepage $\n" +    // Missing number here
                "?craft rdf:label $2\n" +
                // And here we're trying to use 2, but it will have been assigned to the previous one
                "}";
        assertThrows(QueryParserException.class, () -> queryParser.parseQuery(query));
    }

    @Test
    public void parsingQueryWithPositionalParameterNotNumberThrowsException() {
        final String query = "PREFIX foaf: <http://xmlns.com/foaf/0.1/>\n" +
                "SELECT ?craft\n" +
                "{\n" +
                "?craft foaf:name $1 .\n" +
                "?craft foaf:homepage $notanumber\n" +
                "}";
        assertThrows(QueryParserException.class, () -> queryParser.parseQuery(query));
    }

    @Test
    public void parsesQueryWithOrderByDescendingAtEnd() {
        final String query = "SELECT ?x WHERE { ?x a <http://a>. } ORDER BY DESC(?x)";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(1, holder.getParameters().size());
        assertEquals(query, holder.assembleQuery());
    }

    @Test
    public void parsesQueryWrittenInCondensedString() {
        final String query = "SELECT ?x WHERE { ?x a ?y. } ORDER BY DESC(?y)";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(2, holder.getParameters().size());
        assertTrue(holder.getParameters().contains(new QueryParameter<>("x", valueFactory)));
        assertTrue(holder.getParameters().contains(new QueryParameter<>("y", valueFactory)));
        assertEquals(query, holder.assembleQuery());
    }

    @Test
    public void parsesQueryWithOrderByAtEnd() {
        final String query = "SELECT ?x WHERE { ?x a <http://a>. } ORDER BY ?x";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(1, holder.getParameters().size());
        assertEquals(query, holder.assembleQuery());
    }

    /**
     * Bug #6.
     */
    @Test
    public void parsesQueryWithVariableWithoutTrailingSpace() {
        final String query = "SELECT ?x WHERE {?x a ?type}";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertEquals(2, holder.getParameters().size());
        assertNotNull(holder.getParameter("x"));
        assertNotNull(holder.getParameter("type"));
    }

    @Test
    public void parsesQueryWithStringLiteralInSingleQuotes() {
        final String query = "SELECT ?x WHERE {?x a ?type; ?x rdfs:label 'label'@en.}";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertNotNull(holder.getParameter("x"));
        assertNotNull(holder.getParameter("type"));
    }

    @Test
    public void parsesQueryWithPropertyPathOneOrMore() {
        final String query = "SELECT ?x WHERE {?x ?hasPart+ ?part . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertNotNull(holder.getParameter("x"));
        assertNotNull(holder.getParameter("hasPart"));
        assertNotNull(holder.getParameter("part"));
    }

    @Test
    public void parsesQueryWithPropertyPathZeroOrMore() {
        final String query = "SELECT ?x WHERE {?x ?hasPart* ?part . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertNotNull(holder.getParameter("x"));
        assertNotNull(holder.getParameter("hasPart"));
        assertNotNull(holder.getParameter("part"));
    }

    @Test
    public void parsesQueryWithPropertyPathZeroOrOne() {
        final String query = "SELECT ?x WHERE {?x ?hasPart? ?part . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertNotNull(holder.getParameter("x"));
        assertNotNull(holder.getParameter("hasPart"));
        assertNotNull(holder.getParameter("part"));
    }

    @Test
    public void parsesQueryWithPropertyPathSequence() {
        final String query = "SELECT ?x WHERE {?x ?hasPart/?hasQuestion ?part . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertNotNull(holder.getParameter("x"));
        assertNotNull(holder.getParameter("hasPart"));
        assertNotNull(holder.getParameter("hasQuestion"));
        assertNotNull(holder.getParameter("part"));
    }

    @Test
    public void parsesQueryWithPropertyPathAlternative() {
        final String query = "SELECT ?x WHERE {?x ?hasPart|?hasQuestion ?part . }";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertNotNull(holder.getParameter("x"));
        assertNotNull(holder.getParameter("hasPart"));
        assertNotNull(holder.getParameter("hasQuestion"));
        assertNotNull(holder.getParameter("part"));
    }

    @Test
    void parseQuerySupportsWindowsLikeLineEnds() {
        final String query = "SELECT * WHERE {\r\n" +
                "   GRAPH ?contextUri\r\n" +
                "        {  ?s ?p ?o . }\r" +
                "}";
        final QueryHolder holder = queryParser.parseQuery(query);
        assertNotNull(holder.getParameter("contextUri"));
        assertNotNull(holder.getParameter("s"));
        assertNotNull(holder.getParameter("p"));
        assertNotNull(holder.getParameter("o"));
    }
}