junit5/src/test/java/org/apache/sling/testing/mock/sling/junit5/SlingContextPluginTest.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.testing.mock.sling.junit5;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;

import org.apache.sling.testing.mock.sling.ResourceResolverType;
import org.apache.sling.testing.mock.sling.context.modelsautoreg.ClasspathRegisteredModel;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

import com.google.common.collect.ImmutableMap;

/**
 * Test with {@link SlingContext} with context plugins.
 */
@ExtendWith(SlingContextExtension.class)
@SuppressWarnings("null")
class SlingContextPluginTest {

    private final SlingContextCallback contextBeforeSetup = mock(SlingContextCallback.class);
    private final SlingContextCallback contextAfterSetup = mock(SlingContextCallback.class);
    private final SlingContextCallback contextBeforeTeardown = mock(SlingContextCallback.class);
    private final SlingContextCallback contextAfterTeardown = mock(SlingContextCallback.class);

    private final SlingContext context = new SlingContextBuilder()
            .beforeSetUp(contextBeforeSetup)
            .afterSetUp(contextAfterSetup)
            .beforeTearDown(contextBeforeTeardown)
            .afterTearDown(contextAfterTeardown)
            .resourceResolverFactoryActivatorProps(
                    ImmutableMap.<String, Object> of("resource.resolver.searchpath", new String[] { "/apps", "/libs", "/testpath", }))
            .build();

    @BeforeEach
    public void setUp() throws Exception {
        verify(contextBeforeSetup).execute(context);
    }

    @Test
    public void testRequest() throws Exception {
        verify(contextAfterSetup).execute(context);
        assertNotNull(context.request());
    }

    @Test
    public void testResourceResolverFactoryActivatorProps() throws Exception {
        verify(contextAfterSetup).execute(context);

        // skip this test for resource resolver mock, because it does not
        // respect the custom config
        if (context.resourceResolverType() == ResourceResolverType.RESOURCERESOLVER_MOCK) {
            return;
        }

        context.create().resource("/apps/node1");

        context.create().resource("/libs/node1");
        context.create().resource("/libs/node2");

        context.create().resource("/testpath/node1");
        context.create().resource("/testpath/node2");
        context.create().resource("/testpath/node3");

        assertEquals("/apps/node1", context.resourceResolver().getResource("node1").getPath());
        assertEquals("/libs/node2", context.resourceResolver().getResource("node2").getPath());
        assertEquals("/testpath/node3", context.resourceResolver().getResource("node3").getPath());
        assertNull(context.resourceResolver().getResource("node4"));
    }

    @Test
    @Disabled  // test does not work on the command line as the customized META-INF/MANIFEST.mf is not contained in the sling-mock test jar
    public void testSlingModelClasspathRegistered() {
        context.request().setAttribute("prop1", "myValue");
        ClasspathRegisteredModel model = context.request().adaptTo(ClasspathRegisteredModel.class);
        assertEquals("myValue", model.getProp1());
    }

    @AfterEach
    public void tearDown() throws Exception {
        verify(contextBeforeTeardown).execute(context);
    }

}