VariationAwareImagingSupportTest

/**
 * This file Copyright (c) 2015-2018 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.templating.imaging;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.*;

import info.magnolia.cms.beans.runtime.File;
import info.magnolia.context.MgnlContext;
import info.magnolia.imaging.ImagingSupport;
import info.magnolia.module.site.Site;
import info.magnolia.module.site.SiteManager;
import info.magnolia.module.site.theme.ThemeReference;
import info.magnolia.templating.imaging.variation.SimpleResizeVariation;
import info.magnolia.test.mock.MockWebContext;

import javax.jcr.Node;
import javax.jcr.Property;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
import javax.jcr.Workspace;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 * Tests for {@link VariationAwareImagingSupport}.
 */
public class VariationAwareImagingSupportTest {

    private static final String WORKSPACE_NAME = "workspace";
    private static final String CONTEXT_PATH = "contextPath";
    private static final String PATH_TO_NODE = "/path-to-node";
    private static final String THEME_NAME = "theme-name";
    private static final String FILENAME = "filename";
    private static final String EXTENSION = "jpg";

    private VariationAwareImagingSupport variationAwareImagingSupport;
    private SiteManager siteManager;
    private Session session;

    private Node binaryNode;
    private Property binaryProperty;

    @Before
    public void setUp() throws RepositoryException {
        MockWebContext ctx = new MockWebContext();
        ctx.setContextPath(CONTEXT_PATH);
        MgnlContext.setInstance(ctx);

        variationAwareImagingSupport = new VariationAwareImagingSupport();
        siteManager = mock(SiteManager.class);
        session = mock(Session.class);

        Workspace workspace = mock(Workspace.class);
        when(workspace.getName()).thenReturn(WORKSPACE_NAME);
        when(session.getWorkspace()).thenReturn(workspace);

        ThemeReference themeReference = new ThemeReference();
        themeReference.setName(THEME_NAME);

        Site site = mock(Site.class);
        when(site.getTheme()).thenReturn(themeReference);

        Property filenameProperty = mock(Property.class);
        when(filenameProperty.getString()).thenReturn(FILENAME);
        Property extensionProperty = mock(Property.class);
        when(extensionProperty.getString()).thenReturn(EXTENSION);

        binaryNode = mock(Node.class);
        binaryProperty = mock(Property.class);
        when(binaryNode.getSession()).thenReturn(session);
        when(binaryNode.getPath()).thenReturn(PATH_TO_NODE);
        when(binaryNode.hasProperty(File.PROPERTY_FILENAME)).thenReturn(true);
        when(binaryNode.getProperty(File.PROPERTY_FILENAME)).thenReturn(filenameProperty);
        when(binaryNode.hasProperty(File.EXTENSION)).thenReturn(true);
        when(binaryNode.getProperty(File.EXTENSION)).thenReturn(extensionProperty);
        when(binaryProperty.getSession()).thenReturn(session);
        when(binaryProperty.getParent()).thenReturn(binaryNode);
        when(siteManager.getAssignedSite(binaryNode)).thenReturn(site);
    }

    @After
    public void tearDown() {
        MgnlContext.setInstance(null);
    }

    @Test
    public void createLink() {
        // GIVEN
        String variationName = "small";
        SimpleResizeVariation variation = new SimpleResizeVariation(siteManager);
        variation.setName(variationName);

        variationAwareImagingSupport.addVariation(variationName, variation);

        // WHEN
        String link = variationAwareImagingSupport.createLink(binaryProperty, variationName);

        // THEN
        assertThat(link, is(String.format("%s/.imaging/%s/%s/%s/%s%s/%s.%s", CONTEXT_PATH, variation.getGeneratorName(), THEME_NAME, variationName, WORKSPACE_NAME, PATH_TO_NODE, FILENAME, EXTENSION)));
    }

    @Test
    public void createLinkWhenVariationIsDiabled() {
        // GIVEN
        String variationName = "small";
        SimpleResizeVariation variation = new SimpleResizeVariation(siteManager);
        variation.setName(variationName);

        variationAwareImagingSupport.addVariation(variationName, variation);
        variationAwareImagingSupport.setEnabled(false);

        // WHEN
        String link = variationAwareImagingSupport.createLink(binaryProperty, variationName);

        // THEN
        assertThat(link, is(String.format("%s/.imaging/default/%s%s.%s", CONTEXT_PATH, WORKSPACE_NAME, PATH_TO_NODE, EXTENSION)));
    }

    @Test
    public void createLinkWithOriginalVariation() {
        // GIVEN

        // WHEN
        String link = variationAwareImagingSupport.createLink(binaryProperty, ImagingSupport.VARIATION_ORIGINAL);

        // THEN
        assertThat(link, is(String.format("%s/.imaging/default/%s%s.%s", CONTEXT_PATH, WORKSPACE_NAME, PATH_TO_NODE, EXTENSION)));
    }

    @Test
    public void createLinkWithoutExistingVariation() {
        // GIVEN
        String variationName = "small";

        // WHEN
        String link = variationAwareImagingSupport.createLink(binaryProperty, variationName);

        // THEN
        assertThat(link, is(String.format("%s/.imaging/default/%s%s.%s", CONTEXT_PATH, WORKSPACE_NAME, PATH_TO_NODE, EXTENSION)));
    }

}