RetrieveThingsTest.java

/*
 * Copyright (c) 2017 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.signals.commands.things.query;

import static org.eclipse.ditto.signals.commands.things.assertions.ThingCommandAssertions.assertThat;
import static org.mutabilitydetector.unittesting.AllowedReason.provided;
import static org.mutabilitydetector.unittesting.MutabilityAssert.assertInstancesOf;
import static org.mutabilitydetector.unittesting.MutabilityMatchers.areImmutable;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

import org.eclipse.ditto.json.JsonArray;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonFieldSelector;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonParseOptions;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.model.base.auth.AuthorizationContext;
import org.eclipse.ditto.model.base.json.FieldType;
import org.eclipse.ditto.signals.commands.base.Command;
import org.eclipse.ditto.signals.commands.base.GlobalCommandRegistry;
import org.eclipse.ditto.signals.commands.things.TestConstants;
import org.eclipse.ditto.signals.commands.things.ThingCommand;
import org.eclipse.ditto.signals.commands.things.exceptions.MissingThingIdsException;
import org.junit.Test;

import nl.jqno.equalsverifier.EqualsVerifier;

/**
 * Unit test for {@link RetrieveThings}.
 */
public final class RetrieveThingsTest {

    private static final JsonArray THING_IDS = JsonFactory.newArrayBuilder()
            .add(TestConstants.Thing.THING_ID)
            .add(":AnotherThingId")
            .build();

    private static final JsonArray THING_IDS_WITH_DISTINCT_NAMESPACE = JsonFactory.newArrayBuilder()
            .add(TestConstants.Thing.THING_ID)
            .add(TestConstants.Thing.THING_ID + "1")
            .add(TestConstants.Thing.THING_ID + "2")
            .build();

    private static final String SELECTED_FIELDS = "field1,field2,field3";

    private static final JsonObject KNOWN_JSON = JsonFactory.newObjectBuilder()
            .set(ThingCommand.JsonFields.TYPE, RetrieveThings.TYPE)
            .set(RetrieveThings.JSON_THING_IDS, THING_IDS)
            .build();

    private static final JsonObject KNOWN_JSON_WITH_DISTINCT_NAMESPACE = JsonFactory.newObjectBuilder()
            .set(ThingCommand.JsonFields.TYPE, RetrieveThings.TYPE)
            .set(RetrieveThings.JSON_THING_IDS, THING_IDS_WITH_DISTINCT_NAMESPACE)
            .set(RetrieveThings.JSON_NAMESPACE, "example.com")
            .build();

    private static final JsonObject KNOWN_JSON_WITH_FIELD_SELECTION = JsonFactory.newObjectBuilder()
            .set(ThingCommand.JsonFields.TYPE, RetrieveThings.TYPE)
            .set(RetrieveThings.JSON_THING_IDS, THING_IDS)
            .set(RetrieveThings.JSON_SELECTED_FIELDS, SELECTED_FIELDS)
            .build();

    private static final JsonParseOptions JSON_PARSE_OPTIONS =
            JsonFactory.newParseOptionsBuilder().withoutUrlDecoding().build();

    private static List<String> getThingIds() {
        return THING_IDS.stream().map(JsonValue::asString).collect(Collectors.toList());
    }

    private static List<String> getThingIdsWithDistinctNamespace() {
        return THING_IDS_WITH_DISTINCT_NAMESPACE.stream().map(JsonValue::asString).collect(Collectors.toList());
    }

    private static JsonFieldSelector getJsonFieldSelector() {
        return JsonFactory.newFieldSelector(SELECTED_FIELDS, JSON_PARSE_OPTIONS);
    }

    @Test
    public void assertImmutability() {
        assertInstancesOf(RetrieveThings.class,
                areImmutable(),
                provided(AuthorizationContext.class, JsonFieldSelector.class).isAlsoImmutable());
    }

    @Test
    public void testHashCodeAndEquals() {
        EqualsVerifier.forClass(RetrieveThings.class)
                .withRedefinedSuperclass()
                .verify();
    }

    @Test
    public void toJsonReturnsExpected() {
        final RetrieveThings underTest = RetrieveThings.getBuilder(getThingIds()).build();
        final JsonObject actualJson = underTest.toJson(FieldType.regularOrSpecial());

        assertThat(actualJson).isEqualTo(KNOWN_JSON);
    }

    @Test
    public void toJsonReturnsExpectedWithNamespace() {
        final RetrieveThings underTest =
                RetrieveThings.getBuilder(getThingIdsWithDistinctNamespace()).namespace("example.com").build();
        final JsonObject actualJson = underTest.toJson(FieldType.regularOrSpecial());

        assertThat(actualJson).isEqualTo(KNOWN_JSON_WITH_DISTINCT_NAMESPACE);
    }

    @Test
    public void createInstanceFromValidJson() {
        final RetrieveThings underTest =
                RetrieveThings.fromJson(KNOWN_JSON.toString(), TestConstants.EMPTY_DITTO_HEADERS);

        assertThat(underTest).isNotNull();
        assertThat(underTest.getThingIds()).isEqualTo(getThingIds());
        assertThat(underTest.getSelectedFields()).isEmpty();
        assertThat(underTest.getNamespace()).isEmpty();
    }

    @Test
    public void createInstanceWithNamespaceFromValidJson() {
        final RetrieveThings underTest =
                RetrieveThings.fromJson(KNOWN_JSON_WITH_DISTINCT_NAMESPACE.toString(),
                        TestConstants.EMPTY_DITTO_HEADERS);

        assertThat(underTest).isNotNull();
        assertThat(underTest.getThingIds()).isEqualTo(
                THING_IDS_WITH_DISTINCT_NAMESPACE.stream().map(JsonValue::asString).collect(Collectors.toList()));
        assertThat(underTest.getSelectedFields()).isEmpty();
        assertThat(underTest.getNamespace()).contains("example.com");
    }

    @Test
    public void jsonSerializationWorksAsExpectedWithSelectedFields() {
        final RetrieveThings underTest =
                RetrieveThings.getBuilder(getThingIds()).selectedFields(getJsonFieldSelector()).build();
        final JsonObject actualJson = underTest.toJson(FieldType.regularOrSpecial());

        assertThat(actualJson).isEqualTo(KNOWN_JSON_WITH_FIELD_SELECTION);
    }

    @Test
    public void createInstanceFromValidJsonWithSelectedFields() {
        final RetrieveThings underTest =
                RetrieveThings.fromJson(KNOWN_JSON_WITH_FIELD_SELECTION.toString(),
                        TestConstants.EMPTY_DITTO_HEADERS);

        assertThat(underTest).isNotNull();
        assertThat(underTest.getThingIds()).isEqualTo(getThingIds());
        assertThat(underTest.getSelectedFields()).contains(getJsonFieldSelector());
    }

    @Test(expected = IllegalArgumentException.class)
    public void createInstanceWithInvalidNamespacesThrowsException() {
        RetrieveThings.getBuilder(getThingIds()).namespace("").build();
    }

    @Test
    public void checkRetrieveThingsWithEmptyJsonFieldSelectorBehavesEquallyAsOmittingFields() {
        final JsonFieldSelector selectedFields = JsonFactory.newFieldSelector(null, JSON_PARSE_OPTIONS);
        final RetrieveThings retrieveThings = RetrieveThings.getBuilder(TestConstants.Thing.THING_ID, ":AnotherThingId")
                .selectedFields(selectedFields)
                .build();

        final RetrieveThings retrieveThings2 =
                RetrieveThings.getBuilder(TestConstants.Thing.THING_ID, ":AnotherThingId")
                        .build();

        assertThat(retrieveThings).isEqualTo(retrieveThings2);
    }

    @Test(expected = NullPointerException.class)
    public void initializationWithNullForThingIdsArrayThrowsNullPointerException(){
        //This cast is used to resolve the ambiguous call
        RetrieveThings.getBuilder( (String[]) null).build();
    }

    @Test(expected = NullPointerException.class)
    public void initializationWithNullForThingIdsListThrowsNullPointerException(){
        //This cast is used to resolve the ambiguous call
        RetrieveThings.getBuilder( (List<String>) null).build();
    }

    @Test(expected = MissingThingIdsException.class)
    public void initializationWithoutThingIdsThrowsMissingThingIdsException(){
        RetrieveThings.getBuilder().build();
    }

    @Test(expected = MissingThingIdsException.class)
    public void initializationWithEmptyThingIdsListThrowsMissingThingIdsException(){
        RetrieveThings.getBuilder(new ArrayList<>()).build();
    }

    @Test
    public void parseRetrieveThingCommand() {
        final GlobalCommandRegistry commandRegistry = GlobalCommandRegistry.getInstance();

        final RetrieveThing command = RetrieveThing.of(
                TestConstants.Thing.THING_ID, TestConstants.DITTO_HEADERS);
        final JsonObject jsonObject = command.toJson(FieldType.regularOrSpecial());

        final Command parsedCommand = commandRegistry.parse(jsonObject, TestConstants.DITTO_HEADERS);

        assertThat(parsedCommand).isEqualTo(command);
    }
}