TikaConfigAsyncWriterTest.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.async.cli;

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

import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

import org.apache.tika.config.loader.TikaJsonConfig;
import org.apache.tika.pipes.core.PipesConfig;
import org.apache.tika.sax.BasicContentHandlerFactory;
import org.apache.tika.utils.XMLReaderUtils;

public class TikaConfigAsyncWriterTest {


    @Test
    public void testWriteNewXMLConfig(@TempDir Path dir) throws Exception {
        SimpleAsyncConfig config = new SimpleAsyncConfig(dir.toString(), dir.toString(), 4,
                10000L, null, null, null, BasicContentHandlerFactory.HANDLER_TYPE.TEXT,
                SimpleAsyncConfig.ExtractBytesMode.NONE, null);
        Path output = dir.resolve("output.xml");
        new TikaConfigAsyncWriter(config).write(output);

        Document document = XMLReaderUtils.buildDOM(output);
        assertEquals("properties", document.getDocumentElement().getTagName());
        assertEquals(0, document.getDocumentElement().getElementsByTagName("*").getLength());
    }

    @Test
    public void testWriteExistingXMLConfig(@TempDir Path dir) throws Exception {
        Path input = dir.resolve("input.xml");
        Files.writeString(input, "<properties><entry key=\"test\">value &amp; more</entry></properties>");
        SimpleAsyncConfig config = new SimpleAsyncConfig(dir.toString(), dir.toString(), 4,
                10000L, null, null, input.toString(), BasicContentHandlerFactory.HANDLER_TYPE.TEXT,
                SimpleAsyncConfig.ExtractBytesMode.NONE, null);
        Path output = dir.resolve("output.xml");
        new TikaConfigAsyncWriter(config).write(output);

        Document document = XMLReaderUtils.buildDOM(output);
        assertEquals("properties", document.getDocumentElement().getTagName());
        assertEquals(1, document.getElementsByTagName("entry").getLength());
        Element entry = (Element) document.getElementsByTagName("entry").item(0);
        assertEquals("test", entry.getAttribute("key"));
        assertEquals("value & more", entry.getTextContent());
    }

    @Test
    public void testBasic(@TempDir Path dir) throws Exception {
        Path p = Paths.get(TikaConfigAsyncWriter.class.getResource("/configs/TIKA-4508-parsers.json").toURI());
        SimpleAsyncConfig simpleAsyncConfig = new SimpleAsyncConfig("input", "output", 4,
                10000L, "-Xmx1g", null,
                p.toAbsolutePath().toString().replace("\\", "/"),
                BasicContentHandlerFactory.HANDLER_TYPE.TEXT, SimpleAsyncConfig.ExtractBytesMode.NONE, null);

        PluginsWriter pluginsWriter = new PluginsWriter(simpleAsyncConfig, null);

        Path tmp = Files.createTempFile(dir, "plugins-",".json");
        pluginsWriter.write(tmp);
        TikaJsonConfig tikaJsonConfig = TikaJsonConfig.load(tmp);
        PipesConfig pipesConfig = PipesConfig.load(tikaJsonConfig);
        assertEquals("-Xmx1g", pipesConfig.getForkedJvmArgs().get(0));
    }

    /**
     * -T is the total-task cap, not the stall detector, and it must merge into a
     * configured timeout-limits block rather than replace it.
     */
    @Test
    public void testTimeoutMillisMapsToTotalAndMerges(@TempDir Path dir) throws Exception {
        Path config = dir.resolve("config.json");
        Files.writeString(config, """
                {
                  "parse-context": {
                    "timeout-limits": {
                      "progressTimeoutMillis": 60000,
                      "throwOnDeadline": true
                    }
                  }
                }
                """);
        SimpleAsyncConfig simpleAsyncConfig = new SimpleAsyncConfig("input", "output", 4,
                10000L, null, null, config.toAbsolutePath().toString().replace("\\", "/"),
                BasicContentHandlerFactory.HANDLER_TYPE.TEXT,
                SimpleAsyncConfig.ExtractBytesMode.NONE, null);

        Path tmp = Files.createTempFile(dir, "plugins-", ".json");
        new PluginsWriter(simpleAsyncConfig, null).write(tmp);

        JsonNode timeouts = new ObjectMapper().readTree(tmp.toFile())
                .path("parse-context").path("timeout-limits");
        assertEquals(10000L, timeouts.path("totalTaskTimeoutMillis").asLong());
        assertEquals(60000L, timeouts.path("progressTimeoutMillis").asLong());
        assertTrue(timeouts.path("throwOnDeadline").asBoolean());
    }

    @Test
    public void testOnExistsReachesJsonlReporter(@TempDir Path dir) throws Exception {
        Path config = dir.resolve("config.json");
        Files.writeString(config, """
                {
                  "pipes-reporters": {
                    "file-system-jsonl-reporter": { "path": "audit.jsonl" }
                  }
                }
                """);
        for (String[] pair : new String[][]{{"REPLACE", "REPLACE"}, {"SKIP", "APPEND"}, {"EXCEPTION", "EXCEPTION"}}) {
            SimpleAsyncConfig simpleAsyncConfig = new SimpleAsyncConfig("input", "output", 4,
                    null, null, null, config.toAbsolutePath().toString().replace("\\", "/"),
                    BasicContentHandlerFactory.HANDLER_TYPE.TEXT,
                    SimpleAsyncConfig.ExtractBytesMode.NONE, null);
            simpleAsyncConfig.setOnExists(pair[0]);
            Path tmp = Files.createTempFile(dir, "plugins-", ".json");
            new PluginsWriter(simpleAsyncConfig, null).write(tmp);
            JsonNode root = new ObjectMapper().readTree(tmp.toFile());
            assertEquals(pair[1], root.path("pipes-reporters").path("file-system-jsonl-reporter")
                    .path("onExists").asText(), pair[0]);
        }
    }

    @Test
    public void testPluginRootsPlaceholderGetsDefault(@TempDir Path dir) throws Exception {
        // the docs' example configs carry this token (TIKA-4984)
        Path config = dir.resolve("config.json");
        Files.writeString(config, "{ \"plugin-roots\": \"PLUGINS_PATHS\" }");
        Path plugins = Files.createDirectories(dir.resolve("my-plugins"));
        SimpleAsyncConfig simpleAsyncConfig = new SimpleAsyncConfig("input", "output", 4,
                null, null, null, config.toAbsolutePath().toString().replace("\\", "/"),
                BasicContentHandlerFactory.HANDLER_TYPE.TEXT,
                SimpleAsyncConfig.ExtractBytesMode.NONE, plugins.toString());

        Path tmp = Files.createTempFile(dir, "plugins-", ".json");
        new PluginsWriter(simpleAsyncConfig, null).write(tmp);
        assertEquals(plugins.toAbsolutePath().toString(),
                new ObjectMapper().readTree(tmp.toFile()).path("plugin-roots").asText());
    }
}