/*
 * 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.maven.project;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.is;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;

/**
 * Tests {@link ExtensionDescriptorBuilder}.
 *
 */
class ExtensionDescriptorBuilderTest {

    private ExtensionDescriptorBuilder builder;

    @BeforeEach
    void setUp() throws Exception {
        builder = new ExtensionDescriptorBuilder();
    }

    @AfterEach
    void tearDown() throws Exception {
        builder = null;
    }

    private InputStream toStream(String xml) {
        return new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8));
    }

    @Test
    void testEmptyDescriptor() throws Exception {
        String xml = "<extension></extension>";

        ExtensionDescriptor ed = builder.build(toStream(xml));

        assertNotNull(ed);
        assertNotNull(ed.getExportedPackages());
        assertThat(ed.getExportedPackages(), is(empty()));
        assertNotNull(ed.getExportedArtifacts());
        assertThat(ed.getExportedArtifacts(), is(empty()));
    }

    @Test
    void testCompleteDescriptor() throws Exception {
        String xml = "<?xml version='1.0' encoding='UTF-8'?>" + "<extension>" + "<exportedPackages>"
                + "<exportedPackage>a</exportedPackage>" + "<exportedPackage>b</exportedPackage>"
                + "<exportedPackage>c</exportedPackage>" + "</exportedPackages>" + "<exportedArtifacts>"
                + "<exportedArtifact>x</exportedArtifact>" + "<exportedArtifact>y</exportedArtifact>"
                + "<exportedArtifact> z </exportedArtifact>" + "</exportedArtifacts>" + "</extension>";

        ExtensionDescriptor ed = builder.build(toStream(xml));

        assertNotNull(ed);
        assertEquals(Arrays.asList("a", "b", "c"), ed.getExportedPackages());
        assertEquals(Arrays.asList("x", "y", "z"), ed.getExportedArtifacts());
    }

    @Test
    void testExternalEntityIsNotResolved() throws Exception {
        Path secret = Files.createTempFile("extension-xxe", ".txt");
        Files.writeString(secret, "TOPSECRET");
        try {
            String xml = "<?xml version='1.0'?>\n" + "<!DOCTYPE extension [ <!ENTITY xxe SYSTEM \""
                    + secret.toUri() + "\"> ]>\n"
                    + "<extension><exportedPackages><exportedPackage>&xxe;</exportedPackage></exportedPackages></extension>";

            try {
                ExtensionDescriptor ed = builder.build(toStream(xml));
                assertFalse(ed.getExportedPackages().contains("TOPSECRET"));
            } catch (IOException expected) {
                // doctype / external entities rejected at parse time
            }
        } finally {
            Files.deleteIfExists(secret);
        }
    }
}
