CswRecordCollectionMessageBodyWriterTest.java

/**
 * Copyright (c) Codice Foundation
 *
 * This 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 3 of the
 * License, or 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
 * Lesser General Public License for more details. A copy of the GNU Lesser General Public License
 * is distributed along with this program and can be found at
 * <http://www.gnu.org/licenses/lgpl.html>.
 *
 **/
package org.codice.ddf.spatial.ogc.csw.catalog.endpoint.writer;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.xml.bind.JAXBException;
import javax.xml.namespace.QName;

import org.codice.ddf.spatial.ogc.csw.catalog.common.CswConstants;
import org.codice.ddf.spatial.ogc.csw.catalog.common.CswRecordCollection;
import org.codice.ddf.spatial.ogc.csw.catalog.transformer.TransformerManager;
import org.junit.Test;
import org.mockito.ArgumentCaptor;

import ddf.catalog.data.BinaryContent;
import ddf.catalog.data.Metacard;
import ddf.catalog.data.impl.MetacardImpl;
import ddf.catalog.operation.SourceResponse;
import ddf.catalog.transform.CatalogTransformerException;
import ddf.catalog.transform.QueryResponseTransformer;
import net.opengis.cat.csw.v_2_0_2.ElementSetType;
import net.opengis.cat.csw.v_2_0_2.ResultType;

public class CswRecordCollectionMessageBodyWriterTest {

    private TransformerManager mockManager = mock(TransformerManager.class);

    private QueryResponseTransformer mockTransformer = mock(QueryResponseTransformer.class);

    private BinaryContent mockContent = mock(BinaryContent.class);

    @Test
    public void testWriteToWithSchema() throws WebApplicationException, IOException, JAXBException,
            CatalogTransformerException {
        CswRecordCollectionMessageBodyWriter writer = new CswRecordCollectionMessageBodyWriter(
                mockManager);
        when(mockManager.getCswQueryResponseTransformer()).thenReturn(mockTransformer);

        ArgumentCaptor<Map> captor = ArgumentCaptor.forClass(Map.class);
        when(mockTransformer.transform(any(SourceResponse.class), any(Map.class)))
                .thenReturn(mockContent);
        when(mockContent.getInputStream()).thenReturn(new ByteArrayInputStream("bytes".getBytes()));

        CswRecordCollection collection = createCswRecordCollection(6);
        collection.setNumberOfRecordsMatched(22);
        collection.setNumberOfRecordsReturned(6);
        final String EXAMPLE_SCHEMA = "http://example.com/schema";
        collection.setOutputSchema(EXAMPLE_SCHEMA);
        collection.setById(true);
        collection.setResultType(ResultType.HITS);
        QName example = new QName("example");

        collection.setElementName(Arrays.asList(example));
        collection.setElementSetType(ElementSetType.BRIEF);

        ByteArrayOutputStream stream = new ByteArrayOutputStream();
        writer.writeTo(collection, null, null, null, null, null, stream);

        verify(mockTransformer).transform(any(SourceResponse.class), captor.capture());

        Map arguments = captor.getValue();
        assertThat((Boolean) arguments.get(CswConstants.WRITE_NAMESPACES), is(false));
        assertThat((String) arguments.get(CswConstants.OUTPUT_SCHEMA_PARAMETER),
                is(EXAMPLE_SCHEMA));
        assertThat((ResultType) arguments.get(CswConstants.RESULT_TYPE_PARAMETER),
                is(ResultType.HITS));
        assertThat((Boolean) arguments.get(CswConstants.IS_BY_ID_QUERY), is(true));
        assertThat((ElementSetType) arguments.get(CswConstants.ELEMENT_SET_TYPE),
                is(ElementSetType.BRIEF));
        assertThat(((QName[]) arguments.get(CswConstants.ELEMENT_NAMES))[0], is(example));
    }

    @Test
    public void testWriteValidate() throws WebApplicationException, IOException, JAXBException,
            CatalogTransformerException {
        CswRecordCollectionMessageBodyWriter writer = new CswRecordCollectionMessageBodyWriter(
                mockManager);
        when(mockManager.getCswQueryResponseTransformer()).thenReturn(mockTransformer);

        ArgumentCaptor<Map> captor = ArgumentCaptor.forClass(Map.class);
        when(mockTransformer.transform(any(SourceResponse.class), any(Map.class)))
                .thenReturn(mockContent);
        when(mockContent.getInputStream()).thenReturn(new ByteArrayInputStream("bytes".getBytes()));

        CswRecordCollection collection = createCswRecordCollection(6);
        collection.setNumberOfRecordsMatched(22);
        collection.setNumberOfRecordsReturned(6);
        collection.setOutputSchema(CswConstants.CSW_OUTPUT_SCHEMA);
        collection.setById(true);
        QName example = new QName("example");

        collection.setElementName(Arrays.asList(example));
        collection.setElementSetType(ElementSetType.BRIEF);
        collection.setResultType(ResultType.VALIDATE);

        ByteArrayOutputStream stream = new ByteArrayOutputStream();
        writer.writeTo(collection, null, null, null, null, null, stream);

        verify(mockManager, times(1)).getCswQueryResponseTransformer();
        verify(mockTransformer).transform(any(SourceResponse.class), captor.capture());

        Map arguments = captor.getValue();
        assertThat((Boolean) arguments.get(CswConstants.WRITE_NAMESPACES), is(false));
        assertThat((String) arguments.get(CswConstants.OUTPUT_SCHEMA_PARAMETER),
                is(CswConstants.CSW_OUTPUT_SCHEMA));
        assertThat((ResultType) arguments.get(CswConstants.RESULT_TYPE_PARAMETER),
                is(ResultType.VALIDATE));
        assertThat((Boolean) arguments.get(CswConstants.IS_BY_ID_QUERY), is(true));
        assertThat((ElementSetType) arguments.get(CswConstants.ELEMENT_SET_TYPE),
                is(ElementSetType.BRIEF));
        assertThat(((QName[]) arguments.get(CswConstants.ELEMENT_NAMES))[0], is(example));
    }

    @Test
    public void testWriteToWithMimeType() throws WebApplicationException, IOException,
            JAXBException, CatalogTransformerException {
        CswRecordCollectionMessageBodyWriter writer = new CswRecordCollectionMessageBodyWriter(
                mockManager);
        when(mockManager.getTransformerByMimeType(any(String.class))).thenReturn(mockTransformer);
        when(mockTransformer.transform(any(SourceResponse.class), any(Map.class)))
                .thenReturn(mockContent);
        when(mockContent.getInputStream()).thenReturn(new ByteArrayInputStream("bytes".getBytes()));

        CswRecordCollection collection = createCswRecordCollection(6);
        collection.setNumberOfRecordsMatched(22);
        collection.setNumberOfRecordsReturned(6);
        collection.setById(true);
        collection.setResultType(ResultType.RESULTS);
        collection.setMimeType(MediaType.APPLICATION_JSON);
        QName example = new QName("example");

        collection.setElementName(Arrays.asList(example));
        collection.setElementSetType(ElementSetType.BRIEF);

        ByteArrayOutputStream stream = new ByteArrayOutputStream();
        writer.writeTo(collection, null, null, null, null, null, stream);

        verify(mockManager, times(1)).getTransformerByMimeType(any(String.class));

        // TODO - assert lookup by mime type
        // TODO failure case
    }

    private CswRecordCollection createCswRecordCollection(int resultCount) {
        CswRecordCollection collection = new CswRecordCollection();
        collection.setCswRecords(createMetacardList(resultCount));
        return collection;
    }

    private List<Metacard> createMetacardList(int count) {
        List<Metacard> list = new LinkedList<Metacard>();

        for (int i = 0; i <= count; i++) {
            MetacardImpl metacard = new MetacardImpl();

            metacard.setId("id_" + i);
            metacard.setSourceId("source_" + i);
            metacard.setTitle("title " + i);

            list.add(metacard);
        }

        return list;
    }
}