JempboxExtractorTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.tika.parser.xmp;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;

import org.junit.jupiter.api.Test;

import org.apache.tika.TikaTest;
import org.apache.tika.exception.TikaException;
import org.apache.tika.io.TikaInputStream;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.metadata.TikaCoreProperties;
import org.apache.tika.metadata.XMPMM;

public class JempboxExtractorTest extends TikaTest {

    @Test
    public void testParseJpeg() throws IOException, TikaException {
        Metadata metadata = new Metadata();
        try (TikaInputStream tis = getResourceAsStream("/test-documents/testJPEG_commented.jpg")) {
            // set some values before extraction to see that they are overridden
            metadata.set(TikaCoreProperties.TITLE, "old title");
            metadata.set(TikaCoreProperties.DESCRIPTION, "old description");
            metadata.set(TikaCoreProperties.CREATOR, "previous author");
            // ... or kept in case the field is multi-value
            metadata.add(TikaCoreProperties.SUBJECT, "oldkeyword");

            JempboxExtractor extractor = new JempboxExtractor(metadata);
            extractor.parse(tis);

            // DublinCore fields
            assertEquals("Tosteberga \u00C4ngar", metadata.get(TikaCoreProperties.TITLE));
            assertEquals("Bird site in north eastern Sk\u00E5ne, Sweden.\n(new line)",
                    metadata.get(TikaCoreProperties.DESCRIPTION));
            assertEquals("Some Tourist", metadata.get(TikaCoreProperties.CREATOR));
            Collection<String> keywords =
                    Arrays.asList(metadata.getValues(TikaCoreProperties.SUBJECT));
            assertTrue(keywords.contains("oldkeyword"));
            assertTrue(keywords.contains("grazelands"));
            assertTrue(keywords.contains("nature reserve"));
            assertTrue(keywords.contains("bird watching"));
            assertTrue(keywords.contains("coast"));
        }
    }

    @Test
    public void testParseJpegPhotoshop() throws IOException, TikaException {
        Metadata metadata = new Metadata();
        try (TikaInputStream tis = getResourceAsStream(
                "/test-documents/testJPEG_commented_pspcs2mac.jpg")) {
            JempboxExtractor extractor = new JempboxExtractor(metadata);
            extractor.parse(tis);

            // DublinCore fields
            assertEquals("Tosteberga \u00C4ngar", metadata.get(TikaCoreProperties.TITLE));
            assertEquals("Bird site in north eastern Sk\u00E5ne, Sweden.\n(new line)",
                    metadata.get(TikaCoreProperties.DESCRIPTION));
            assertEquals("Some Tourist", metadata.get(TikaCoreProperties.CREATOR));
            Collection<String> keywords =
                    Arrays.asList(metadata.getValues(TikaCoreProperties.SUBJECT));
            assertTrue(keywords.contains("bird watching"));
            assertTrue(keywords.contains("coast"));
        }
    }

    @Test
    public void testParseJpegXnviewmp() throws IOException, TikaException {
        Metadata metadata = new Metadata();
        try (TikaInputStream tis = getResourceAsStream(
                "/test-documents/testJPEG_commented_xnviewmp026.jpg")) {
            JempboxExtractor extractor = new JempboxExtractor(metadata);
            extractor.parse(tis);

            // XnViewMp fields not understood by Jempbox
            assertEquals("Bird site in north eastern Sk\u00E5ne, Sweden.\n(new line)",
                    metadata.get(TikaCoreProperties.DESCRIPTION));
            Collection<String> keywords =
                    Arrays.asList(metadata.getValues(TikaCoreProperties.SUBJECT));
            assertTrue(keywords.contains("coast"));
            assertTrue(keywords.contains("nature reserve"));
        }
    }

    @Test
    public void testJoinCreators() {
        assertEquals("Mr B", new JempboxExtractor(null).joinCreators(Collections.singletonList("Mr B")));
        // TODO use multi-value property instead?
        assertEquals("Mr B, Mr A",
                new JempboxExtractor(null).joinCreators(Arrays.asList("Mr B", "Mr A")));
    }

    @Test
    public void testMaxXMPMMHistory() throws Exception {
        int maxHistory = JempboxExtractor.getMaxXMPMMHistory();
        try {
            Metadata m = new Metadata();
            JempboxExtractor ex = new JempboxExtractor(m);
            try (TikaInputStream tis = getResourceAsStream("/test-documents/testXMP.xmp")) {
                ex.parse(tis);
            }
            assertEquals(7, m.getValues(XMPMM.HISTORY_EVENT_INSTANCEID).length);

            JempboxExtractor.setMaxXMPMMHistory(5);
            m = new Metadata();
            ex = new JempboxExtractor(m);
            try (TikaInputStream tis = getResourceAsStream("/test-documents/testXMP.xmp")) {
                ex.parse(tis);
            }
            assertEquals(5, m.getValues(XMPMM.HISTORY_EVENT_INSTANCEID).length);
        } finally {
            //if something goes wrong, make sure to set this back to what it was
            JempboxExtractor.setMaxXMPMMHistory(maxHistory);
        }
    }

    @Test
    public void testModifiedTZ() throws Exception {
        Metadata m = new Metadata();
        JempboxExtractor ex = new JempboxExtractor(m);
        try (TikaInputStream tis = getResourceAsStream("/test-documents/testXMP.xmp")) {
            ex.parse(tis);
        }
        assertEquals("2014-03-04T22:50:41Z", m.get(XMPMM.HISTORY_WHEN));
    }

    @Test
    public void testXMPMMMisc() throws Exception {
        Metadata m = new Metadata();
        JempboxExtractor ex = new JempboxExtractor(m);
        try (TikaInputStream tis = getResourceAsStream("/test-documents/testXMP.xmp")) {
            ex.parse(tis);
        }
        assertEquals("uuid:cccee1fc-51b3-4b52-ac86-672af3974d25", m.getValues(XMPMM.DOCUMENTID)[0]);
        assertEquals("uuid:afa71b09-7cc5-48ac-8664-ac6dcf8b5ab4", m.getValues(XMPMM.INSTANCEID)[0]);
    }
}