ParameterValueFactoryTest.java

/**
 * Copyright (C) 2020 Czech Technical University in Prague
 * <p>
 * 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.
 * <p>
 * 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.parameter;

import cz.cvut.kbss.jopa.environment.OWLClassA;
import cz.cvut.kbss.jopa.environment.utils.Generators;
import cz.cvut.kbss.jopa.environment.utils.MetamodelMocks;
import cz.cvut.kbss.jopa.model.metamodel.Metamodel;
import cz.cvut.kbss.jopa.sessions.MetamodelProvider;
import cz.cvut.kbss.jopa.vocabulary.XSD;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import java.net.URI;
import java.net.URL;
import java.time.*;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.stream.Collectors;

import static org.hamcrest.CoreMatchers.instanceOf;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

/**
 * Datatype specifications in the assertions are taken from the SPARQL specification.
 */
class ParameterValueFactoryTest {

    @Mock
    private MetamodelProvider metamodelProvider;

    @InjectMocks
    private ParameterValueFactory sut;

    @BeforeEach
    void setUp() {
        MockitoAnnotations.openMocks(this);
    }

    @Test
    void createStringValueWithoutLanguageTag() {
        final ParameterValue value = sut.create("test");
        assertEquals("test", value.getValue());
        assertEquals("\"test\"", value.getQueryString());
    }

    @Test
    void createStringValueWithLanguageTag() {
        final ParameterValue value = sut.create("test", "en");
        assertEquals("test", value.getValue());
        assertEquals("\"test\"@en", value.getQueryString());
    }

    @Test
    void createBooleanValue() {
        final ParameterValue value = sut.create(true);
        assertEquals(Boolean.TRUE, value.getValue());
        assertEquals("\"true\"^^<" + XSD.BOOLEAN + ">", value.getQueryString());
    }

    @Test
    void createShortValue() {
        final ParameterValue value = sut.create((short) 117);
        assertEquals((short) 117, value.getValue());
        assertEquals("\"117\"^^<" + XSD.SHORT + ">", value.getQueryString());
    }

    @Test
    void createIntegerValue() {
        final ParameterValue value = sut.create(117);
        assertEquals(117, value.getValue());
        assertEquals("\"117\"^^<" + XSD.INT + ">", value.getQueryString());
    }

    @Test
    void createLongValue() {
        final long v = System.currentTimeMillis();
        final ParameterValue value = sut.create(v);
        assertEquals(v, value.getValue());
        assertEquals("\"" + v + "\"^^<" + XSD.LONG + ">", value.getQueryString());
    }

    @Test
    void createFloatValue() {
        final ParameterValue value = sut.create(3.14f);
        assertEquals(3.14f, value.getValue());
        assertEquals("\"3.14\"^^<" + XSD.FLOAT + ">", value.getQueryString());
    }

    @Test
    void createDoubleValue() {
        final ParameterValue value = sut.create(3.14);
        assertEquals(3.14, value.getValue());
        assertEquals("\"3.14\"^^<" + XSD.DOUBLE + ">", value.getQueryString());
    }

    @Test
    void createDateValue() {
        final Date date = new Date();
        final ParameterValue value = sut.create(date);
        assertEquals(date, value.getValue());
        assertEquals("\"" + date.toInstant().toString() + "\"^^<" + XSD.DATETIME + ">",
                value.getQueryString());
    }

    @Test
    void createUriValue() {
        final URI uri = URI.create("http://krizik.felk.cvut.cz/jopa#Individual");
        final ParameterValue value = sut.create(uri);
        assertEquals(uri, value.getValue());
        assertEquals("<" + uri.toString() + ">", value.getQueryString());
    }

    @Test
    void createUrlValue() throws Exception {
        final URL url = new URL("http://krizik.felk.cvut.cz/jopa#Individual");
        final ParameterValue value = sut.create(url);
        assertEquals(url.toURI(), value.getValue());    // URLs are internally transformed to URIs
        assertEquals("<" + url.toString() + ">", value.getQueryString());
    }

    @Test
    void createUntypedValue() {
        final Integer integer = 117;
        final ParameterValue value = sut.createUntyped(integer);
        assertEquals(integer, value.getValue());
        assertEquals(integer.toString(), value.getQueryString());
    }

    @Test
    void createValueSupportsCreatingParameterValueFromEntityInstance() {
        final OWLClassA value = Generators.generateOwlClassAInstance();
        when(metamodelProvider.isEntityType(value.getClass())).thenReturn(true);
        final ParameterValue result = sut.create(value);
        assertThat(result, instanceOf(EntityParameterValue.class));
        assertEquals(value, result.getValue());
    }

    @Test
    void createLocalDateTimeValueCreatesDateTimeParameter() {
        final LocalDateTime localDateTime = LocalDateTime.now();
        final ParameterValue value = sut.create(localDateTime);
        assertEquals("\"" + localDateTime.toString() + "\"^^<" + XSD.DATETIME + ">",
                value.getQueryString());
    }

    @Test
    void createInstantValueCreatesDateTimeParameter() {
        final Instant instant = Instant.now();
        final ParameterValue value = sut.create(instant);
        assertEquals("\"" + instant.toString() + "\"^^<" + XSD.DATETIME + ">",
                value.getQueryString());
    }

    @Test
    void createZonedDateTimeValueCreatesDateTimeParameter() {
        final ZonedDateTime zonedDateTime = ZonedDateTime.now();
        final ParameterValue value = sut.create(zonedDateTime);
        assertEquals(
                "\"" + zonedDateTime.toOffsetDateTime().toString() + "\"^^<" + XSD.DATETIME + ">",
                value.getQueryString());
    }

    @Test
    void createOffsetDateTimeValueCreatesDateTimeParameter() {
        final OffsetDateTime offsetDateTime = OffsetDateTime.now();
        final ParameterValue value = sut.create(offsetDateTime);
        assertEquals(
                "\"" + offsetDateTime.toString() + "\"^^<" + XSD.DATETIME + ">",
                value.getQueryString());
    }

    @Test
    void createLocalDateValueCreatesDateParameter() {
        final LocalDate localDate = LocalDate.now();
        final ParameterValue value = sut.create(localDate);
        assertEquals("\"" + localDate.toString() + "\"^^<" + XSD.DATE + ">",
                value.getQueryString());
    }

    @Test
    void createLocalTimeValueCreatesTimeParameter() {
        final LocalTime localTime = LocalTime.now();
        final ParameterValue value = sut.create(localTime);
        assertEquals("\"" + localTime.toString() + "\"^^<" + XSD.TIME + ">",
                value.getQueryString());
    }

    @Test
    void createOffsetTimeValueCreatesTimeParameter() {
        final OffsetTime offsetTime = OffsetTime.now();
        final ParameterValue value = sut.create(offsetTime);
        assertEquals("\"" + offsetTime.toString() + "\"^^<" + XSD.TIME + ">",
                value.getQueryString());
    }

    @Test
    void createCollectionValueCreatesCollectionOfUriParametersValuesForUriElements() {
        final Collection<URI> uris = Arrays
                .asList(Generators.createIndividualIdentifier(), Generators.createIndividualIdentifier());
        final ParameterValue result = sut.create(uris);
        assertEquals(uris.stream().map(u -> "<" + u + ">").collect(Collectors.joining(",")), result.getQueryString());
    }

    @Test
    void createCollectionValueCreatesCollectionOfLiteralsForLiteralElements() {
        final Collection<Object> values = Arrays.asList(117, false);
        final ParameterValue result = sut.create(values);
        assertEquals("\"" + 117 + "\"^^<" + XSD.INT + ">,\"" + false + "\"^^<" + XSD.BOOLEAN + ">",
                result.getQueryString());
    }

    @Test
    void createCollectionValueCreatesCollectionOfUrisForEntityElements() throws Exception {
        final Collection<OWLClassA> values = Arrays
                .asList(Generators.generateOwlClassAInstance(), Generators.generateOwlClassAInstance());
        when(metamodelProvider.isEntityType(OWLClassA.class)).thenReturn(true);
        final MetamodelMocks mocks = new MetamodelMocks();
        final Metamodel metamodel = mock(Metamodel.class);
        mocks.setMocks(metamodel);
        when(metamodelProvider.getMetamodel()).thenReturn(metamodel);
        final ParameterValue result = sut.create(values);
        assertEquals(values.stream().map(a -> "<" + a.getUri() + ">").collect(Collectors.joining(",")),
                result.getQueryString());
    }
}