src/test/java/org/apache/sling/feature/extension/content/ContentHandlerTest.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.sling.feature.extension.content;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.io.File;
import java.net.URL;
import java.util.Dictionary;
import java.util.Iterator;

import org.apache.sling.feature.Artifact;
import org.apache.sling.feature.ArtifactId;
import org.apache.sling.feature.Extension;
import org.apache.sling.feature.ExtensionType;
import org.apache.sling.feature.launcher.spi.extensions.ExtensionContext;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

@RunWith(MockitoJUnitRunner.class)
public class ContentHandlerTest {


    @Rule
    public TemporaryFolder testFolder = new TemporaryFolder();

    @Mock
    ExtensionContext extensionContext;

    /**
     * Test package A-1.0. Depends on B and C-1.X
     */
    private static final String COORDINATES_TEST_PACKAGE_A_10 = "my_packages:test_a:1.0";
    private static String TEST_PACKAGE_A_10 = "testpackages/test_a-1.0.zip";
    private static ArtifactId TEST_PACKAGE_AID_A_10 = ArtifactId.fromMvnId(COORDINATES_TEST_PACKAGE_A_10);

    /**
     * Test package B-1.0. Depends on C
     */
    private static final String COORDINATES_TEST_PACKAGE_B_10 = "my_packages:test_b:1.0";
    private static String TEST_PACKAGE_B_10 = "testpackages/test_b-1.0.zip";
    private static ArtifactId TEST_PACKAGE_AID_B_10 = ArtifactId.fromMvnId(COORDINATES_TEST_PACKAGE_B_10);

    /**
     * Test package C-1.0
     */
    private static final String COORDINATES_TEST_PACKAGE_C_10 = "my_packages:test_c:1.0";
    private static String TEST_PACKAGE_C_10 = "testpackages/test_c-1.0.zip";
    private static ArtifactId TEST_PACKAGE_AID_C_10 = ArtifactId.fromMvnId(COORDINATES_TEST_PACKAGE_C_10);

    @Before
    public void setUp() throws Exception {
        URL test_a = this.getClass().getResource(TEST_PACKAGE_A_10);
        when(extensionContext.getArtifactFile(TEST_PACKAGE_AID_A_10)).thenReturn(test_a);
        URL test_b = this.getClass().getResource(TEST_PACKAGE_B_10);
        when(extensionContext.getArtifactFile(TEST_PACKAGE_AID_B_10)).thenReturn(test_b);
        URL test_c = this.getClass().getResource(TEST_PACKAGE_C_10);
        when(extensionContext.getArtifactFile(TEST_PACKAGE_AID_C_10)).thenReturn(test_c);
    }

    @Test
    public void testMultipleStartOrders() throws Exception {
        ContentHandler ch = new ContentHandler();
        System.setProperty(ContentHandler.PACKAGEREGISTRY_HOME, testFolder.getRoot().toString());
        Extension ext = new Extension(ExtensionType.ARTIFACTS, "content-packages", false);
        Artifact artifact_a = new Artifact(TEST_PACKAGE_AID_A_10);
        Artifact artifact_b = new Artifact(TEST_PACKAGE_AID_B_10);
        Artifact artifact_c = new Artifact(TEST_PACKAGE_AID_C_10);
        artifact_a.getMetadata().put("start-order", "2");
        artifact_b.getMetadata().put("start-order", "1");
        artifact_c.getMetadata().put("start-order", "1");
        ext.getArtifacts().add(artifact_a);
        ext.getArtifacts().add(artifact_b);
        ext.getArtifacts().add(artifact_c);
        @SuppressWarnings("unchecked")
        ArgumentCaptor<Dictionary<String, Object>> executionPlanCaptor = ArgumentCaptor.forClass(Dictionary.class);

        ch.handle(extensionContext, ext);
        verify(extensionContext).addConfiguration(eq("org.UNSHADE.apache.sling.jcr.packageinit.impl.ExecutionPlanRepoInitializer"), any(), executionPlanCaptor.capture());
        verify(extensionContext).addConfiguration(eq("org.UNSHADE.apache.jackrabbit.vault.packaging.registry.impl.FSPackageRegistry"), any(), any());
        Iterator<Dictionary<String, Object>> dictIt = executionPlanCaptor.getAllValues().iterator();
        Dictionary<String, Object> dict = dictIt.next();
        final String[] executionplans = (String[]) dict.get("executionplans");
        final String statusFileHome = (String)dict.get("statusfilepath");
        File executedPlansFile = new File(testFolder.getRoot(), "executedplans.file");
        assertEquals(executedPlansFile.getAbsolutePath(), statusFileHome);
        final String expected_0 =
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
                        "<executionPlan version=\"1.0\">\n" +
                        "    <task cmd=\"extract\" packageId=\"my_packages:test_c:1.0\"/>\n" +
                        "    <task cmd=\"extract\" packageId=\"my_packages:test_b:1.0\"/>\n" +
                        "</executionPlan>\n";

        assertEquals(expected_0, executionplans[0]);
        final String expected_1 =
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
                        "<executionPlan version=\"1.0\">\n" +
                        "    <task cmd=\"extract\" packageId=\"my_packages:test_a:1.0\"/>\n" +
                        "</executionPlan>\n";

        assertEquals(expected_1, executionplans[1]);
        assertFalse(dictIt.hasNext());
    }
}