/**
 * This file Copyright (c) 2011-2012 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.rendering.template.variation;

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

import info.magnolia.beanmerger.BeanMerger;
import info.magnolia.beanmerger.ProxyBasedBeanMerger;
import info.magnolia.cms.core.Channel;
import info.magnolia.rendering.template.RenderableDefinition;
import info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition;
import info.magnolia.test.AbstractMagnoliaTestCase;
import info.magnolia.test.ComponentsTestUtil;
import info.magnolia.test.mock.MockUtil;
import info.magnolia.test.mock.MockWebContext;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;

/**
 * @version $Id$
 */
public class ChannelVariationResolverTest extends AbstractMagnoliaTestCase {

    private static final String TEST_TEMPLATE_VARIATION_NAME = "testTemplate";

    private ConfiguredTemplateDefinition templateDefinition;

    @Override
    @Before
    public void setUp() throws Exception {
        super.setUp();
        ComponentsTestUtil.setInstance(BeanMerger.class, new ProxyBasedBeanMerger());

        templateDefinition = new ConfiguredTemplateDefinition();
        templateDefinition.setTemplateScript("this-will-be-overridden-in-variation");
        templateDefinition.setDescription("this-will-be-reused-by-the-variation");

        ConfiguredTemplateDefinition variation = new ConfiguredTemplateDefinition();
        variation.setTemplateScript("this-is-an-overriding-templateScript");
        variation.setName(TEST_TEMPLATE_VARIATION_NAME);

        templateDefinition.addVariation(variation.getName(), variation);
    }

    @Override
    @After
    public void tearDown() throws Exception {
        super.tearDown();
        ComponentsTestUtil.clear();
    }

    @Test
    public void testChoosesTemplateVariationIfProperlySet() throws Exception {
        // GIVEN
        final MockWebContext mockContext = (MockWebContext) MockUtil.initMockContext();
        final Channel channel = new Channel();
        channel.setName(TEST_TEMPLATE_VARIATION_NAME);
        mockContext.getAggregationState().setChannel(channel);
        final ChannelVariationResolver resolver = new ChannelVariationResolver();

        // WHEN
        RenderableDefinition result = resolver.resolveVariation(templateDefinition);

        // THEN
        assertEquals(TEST_TEMPLATE_VARIATION_NAME, result.getName());
        assertEquals("this-is-an-overriding-templateScript", result.getTemplateScript());
        assertEquals("this-will-be-reused-by-the-variation", result.getDescription());
    }

    @Test
    public void testDoesNothingWhenVariationDoesntExist() throws Exception {

        MockWebContext mockContext = (MockWebContext) MockUtil.initMockContext();
        final Channel channel = new Channel();
        channel.setName("doesNotExist");
        mockContext.getAggregationState().setChannel(channel);

        final ChannelVariationResolver resolver = new ChannelVariationResolver();
        RenderableDefinition result = resolver.resolveVariation(templateDefinition);

        assertNull(result);
    }

    @Test
    public void testDoesNothingWhenAggregationStateNotAvailable() throws Exception {
        // GIVEN
        final ChannelVariationResolver resolver = new ChannelVariationResolver();

        // WHEN
        final RenderableDefinition result = resolver.resolveVariation(templateDefinition);

        // THEN
        assertNull(result);
    }
}