CachedLESSCompilerTest.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.lesscss.internal.compiler;

import javax.inject.Provider;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.xwiki.lesscss.compiler.LESSCompilerException;
import org.xwiki.lesscss.internal.LESSConfiguration;
import org.xwiki.lesscss.internal.compiler.less4j.Less4jCompiler;
import org.xwiki.lesscss.internal.resources.LESSSkinFileResourceReference;
import org.xwiki.lesscss.resources.LESSResourceReference;
import org.xwiki.test.mockito.MockitoComponentMockingRule;

import com.github.sommeri.less4j.Less4jException;
import com.xpn.xwiki.XWiki;
import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.doc.XWikiDocument;
import com.xpn.xwiki.web.XWikiEngineContext;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyZeroInteractions;
import static org.mockito.Mockito.when;

/**
 * @since 6.4M2
 * @version $Id: ad2213867b65ceedb3d1558fca4d7e299b7b5884 $
 */
public class CachedLESSCompilerTest
{
    @Rule
    public MockitoComponentMockingRule<CachedLESSCompiler> mocker =
            new MockitoComponentMockingRule<>(CachedLESSCompiler.class);

    private Provider<XWikiContext> xcontextProvider;

    private Less4jCompiler less4jCompiler;

    private LESSConfiguration lessConfiguration;

    private XWikiContext xcontext;

    private XWiki xwiki;

    private XWikiEngineContext engineContext;

    @Before
    public void setUp() throws Exception
    {
        less4jCompiler = mocker.getInstance(Less4jCompiler.class);
        lessConfiguration = mocker.getInstance(LESSConfiguration.class);
        xcontextProvider = mocker.registerMockComponent(XWikiContext.TYPE_PROVIDER);
        xcontext = mock(XWikiContext.class);
        when(xcontextProvider.get()).thenReturn(xcontext);
        xwiki = mock(XWiki.class);
        when(xcontext.getWiki()).thenReturn(xwiki);
        engineContext = mock(XWikiEngineContext.class);
        when(xwiki.getEngineContext()).thenReturn(engineContext);
        when(xwiki.getSkin(xcontext)).thenReturn("skin");

        XWikiDocument mockDocument = mock(XWikiDocument.class);
        when(mockDocument.getPrefixedFullName()).thenReturn("SomeContextDocument");
        when(xcontext.getDoc()).thenReturn(mockDocument);

        when(lessConfiguration.getMaximumSimultaneousCompilations()).thenReturn(1);
        when(lessConfiguration.isGenerateInlineSourceMaps()).thenReturn(false);
    }

    @Test
    public void computeSkinFile() throws Exception
    {
        // Mocks
        LESSResourceReference resource = mock(LESSSkinFileResourceReference.class);
        when(resource.getContent(eq("skin2"))).thenReturn("Some LESS content");
        when(xwiki.evaluateVelocity(eq("Some LESS content"), eq("SomeContextDocument"))).
            thenReturn("Some Velocity-rendered LESS content");
        when(less4jCompiler.compile(eq("Some Velocity-rendered LESS content"), eq("skin2"),
                eq(false)))
            .thenReturn("output");

        // Tests
        assertEquals("output", mocker.getComponentUnderTest().compute(resource, false, true, true, "skin2"));

        // Verify
        verify(xcontext, times(1)).put("skin", "skin2");
        verify(xcontext, times(1)).put("skin", "skin");
    }

    @Test
    public void computeSkinFileWithoutVelocity() throws Exception
    {
        // Mocks
        LESSResourceReference resource = mock(LESSSkinFileResourceReference.class);
        when(resource.getContent(eq("skin2"))).thenReturn("Some LESS content");
        when(less4jCompiler.compile(eq("Some LESS content"), eq("skin2"),
                eq(false))).thenReturn("output");

        // Tests
        assertEquals("output", mocker.getComponentUnderTest().compute(resource, false, false, true, "skin2"));

        // Verify
        verify(xcontext, never()).put(eq("skin"), any());
    }

    @Test
    public void computeSkinFileWithoutLESS() throws Exception
    {
        // Mocks
        LESSResourceReference resource = mock(LESSSkinFileResourceReference.class);
        when(resource.getContent(eq("skin2"))).thenReturn("Some LESS content");
        when(xwiki.evaluateVelocity(eq("Some LESS content"), eq("SomeContextDocument"))).
                thenReturn("Some Velocity-rendered LESS content");

        // Tests
        assertEquals("Some Velocity-rendered LESS content", mocker.getComponentUnderTest().compute(resource, false,
            true, false, "skin2"));

        // Verify that the LESS compiler is never called
        verifyZeroInteractions(less4jCompiler);
    }

    @Test
    public void computeSkinFileWithMainStyleIncluded() throws Exception
    {
        // Mocks
        LESSResourceReference resource = mock(LESSSkinFileResourceReference.class);
        when(resource.getContent(eq("skin"))).thenReturn("Some LESS content");
        when(
            xwiki.evaluateVelocity(eq("@import (reference) \"style.less.vm\";\n" + "Some LESS content"),
                eq("SomeContextDocument")))
                .thenReturn("@import (reference) \"style.less.vm\";\n"
                        +"Some Velocity-rendered LESS content");
        when(less4jCompiler.compile(eq("@import (reference) \"style.less.vm\";\n"
            +"Some Velocity-rendered LESS content"), eq("skin"),
                eq(false)))
                .thenReturn("output");

        // Tests
        assertEquals("output", mocker.getComponentUnderTest().compute(resource, true, true, true, "skin"));

    }

    @Test
    public void computeSkinFileWhenException() throws Exception
    {
        // Mocks
        LESSResourceReference resource = mock(LESSSkinFileResourceReference.class);
        when(resource.getContent(eq("skin"))).thenReturn("Some LESS content");
        when(xwiki.evaluateVelocity(eq("Some LESS content"), eq("SomeContextDocument"))).
                thenReturn("Some Velocity-rendered LESS content");
        Less4jException lessCompilerException = mock(Less4jException.class);
        when(less4jCompiler.compile(eq("Some Velocity-rendered LESS content"), eq("skin"),
                eq(false))).
            thenThrow(lessCompilerException);

        // Tests
        LESSCompilerException caughtException = null;
        try {
            mocker.getComponentUnderTest().compute(resource, false, true, true, "skin");
        } catch(LESSCompilerException e) {
            caughtException = e;
        }

        // Verify
        assertNotNull(caughtException);
        assertEquals(lessCompilerException, caughtException.getCause());
        assertEquals("Failed to compile the resource ["+resource.toString()+"] with LESS.",
            caughtException.getMessage());

    }
}