freemarker-generator-base/src/test/java/org/apache/freemarker/generator/document/DocumentsTest.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.freemarker.generator.document;

import org.apache.freemarker.generator.base.document.Document;
import org.apache.freemarker.generator.base.document.DocumentFactory;
import org.apache.freemarker.generator.base.document.Documents;
import org.junit.Test;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;

import static java.nio.charset.StandardCharsets.UTF_8;
import static java.util.Arrays.asList;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;

public class DocumentsTest {

    private static final String UNKNOWN = "unknown";
    private static final String ANY_TEXT = "Hello World";
    private static final String ANY_FILE_NAME = "pom.xml";
    private static final String ANY_FILE_EXTENSION = "xml";
    private static final File ANY_FILE = new File(ANY_FILE_NAME);
    private static final String ANY_URL = "https://server.invalid?foo=bar";

    @Test
    public void shouldFindByWildcard() {
        final Documents documents = documents();

        assertEquals(0, documents.find(null).size());
        assertEquals(0, documents.find("").size());
        assertEquals(0, documents.find("*.bar").size());
        assertEquals(0, documents.find("foo.*").size());
        assertEquals(0, documents.find("foo.bar").size());

        assertEquals(2, documents.find("*.*").size());
        assertEquals(1, documents.find("*." + ANY_FILE_EXTENSION).size());
        assertEquals(1, documents.find("*.???").size());
        assertEquals(1, documents.find("*om*").size());
        assertEquals(1, documents.find("*o*.xml").size());

        assertEquals(1, documents.find(ANY_FILE_NAME).size());
        assertEquals(1, documents.find(ANY_FILE_NAME.charAt(0) + "*").size());

        assertEquals(3, documents.find("*").size());
    }

    @Test
    public void shouldGetDocument() {
        assertNotNull(documents().get(ANY_FILE_NAME));
    }

    @Test
    public void shouldGetAllDocuments() {
        final Documents documents = documents();

        assertEquals("unknown", documents().get(0).getName());
        assertEquals("pom.xml", documents().get(1).getName());
        assertEquals("server.invalid", documents().get(2).getName());
        assertEquals("unknown", documents().getFirst().getName());
        assertEquals(3, documents.getList().size());
        assertEquals(3, documents.size());
        assertFalse(documents.isEmpty());
    }

    @Test
    public void shouldGetNames() {
        assertEquals(asList("unknown", "pom.xml", "server.invalid"), documents().getNames());
    }

    @Test(expected = IllegalArgumentException.class)
    public void shouldThrowExceptionWhenGetDoesNotFindDocument() {
        documents().get("file-does-not-exist");
    }

    @Test(expected = IllegalArgumentException.class)
    public void shouldThrowExceptionWhenGetFindsMultipleDocuments() {
        documents().get("*");
    }

    private static Documents documents() {
        return new Documents(asList(textDocument(), fileDocument(), urlDocument()));
    }

    private static Document textDocument() {
        return DocumentFactory.create(UNKNOWN, ANY_TEXT);
    }

    private static Document fileDocument() {
        return DocumentFactory.create(ANY_FILE, UTF_8);
    }

    private static Document urlDocument() {
        try {
            return DocumentFactory.create(new URL(ANY_URL));
        } catch (MalformedURLException e) {
            throw new RuntimeException(e);
        }
    }
}