SiteMapTestUtil

/**
 * This file Copyright (c) 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.module.googlesitemap;

import static org.mockito.Mockito.*;

import info.magnolia.cms.beans.config.ServerConfiguration;
import info.magnolia.cms.i18n.DefaultI18nContentSupport;
import info.magnolia.cms.i18n.I18nContentSupport;
import info.magnolia.cms.security.MgnlUser;
import info.magnolia.cms.security.User;
import info.magnolia.context.MgnlContext;
import info.magnolia.jcr.util.NodeTypes;
import info.magnolia.module.googlesitemap.bean.SiteMapEntry;
import info.magnolia.module.googlesitemap.service.SiteMapService;
import info.magnolia.module.googlesitemap.service.query.QueryUtil;
import info.magnolia.module.templatingkit.sites.Site;
import info.magnolia.module.templatingkit.sites.SiteManager;
import info.magnolia.test.ComponentsTestUtil;
import info.magnolia.test.mock.MockWebContext;
import info.magnolia.test.mock.jcr.MockNode;
import info.magnolia.test.mock.jcr.MockSession;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;

import javax.jcr.Node;
import javax.jcr.RepositoryException;

import org.apache.jackrabbit.JcrConstants;
import org.junit.After;
import org.junit.Before;
import org.mockito.Answers;


/**
 * Utility test class.
 * @version $Id$
 *
 */
public class SiteMapTestUtil {

    protected static final String CONTEXT_PATH = "/manual_set_context_path";
    protected static final String DEFAULT_URL = "http://localhost:8080";
    protected static final String ROOT_PAGE = "rootPage";
    protected static final String PAGE_DEEP_1_1 = "page_1_1";
    protected static final String PAGE_DEEP_1_1_1 = "page_1_1_1";
    protected static final String PAGE_DEEP_1_2 = "page_1_2";
    protected static final String PAGE_DEEP_1_2_1 = "page_1_2_1";
    protected static final String VIRTUALURI_DEEP_2_1 = "virtualUri_2_1";
    protected static final String VIRTUALURI_DEEP_2_2 = "virtualUri_2_2";

    protected MockNode rootWebsite;
    protected Node rootPageWebsite;
    protected Node page_1_1;
    protected Node page_1_1_1;
    protected Node page_1_2;
    protected Node page_1_2_1;
    protected MockNode rootConfig;
    protected Node rootPageConfig;
    protected Node virtualURIMapping;
    protected Node virtualUri_2_1;
    protected Node virtualUri_2_2;


    protected MockWebContext ctx ;
    protected SiteMapService service;

    @Before
    public void setUp() throws RepositoryException{
        // Init ctx
        ctx = new MockWebContext();
        ctx.setContextPath(CONTEXT_PATH);
        User user = new MgnlUser("userName", "userRealName", new ArrayList<String>() , new ArrayList<String>(), new HashMap<String, String>());
        ctx.setUser(user);
        MgnlContext.setInstance(ctx);


        ServerConfiguration sc = new ServerConfiguration();
        sc.setDefaultBaseUrl(DEFAULT_URL);
        ComponentsTestUtil.setInstance(ServerConfiguration.class, sc);

        // Init website Session
        MockSession sessionWebsite = new MockSession("website");
        ctx.addSession("website", sessionWebsite);
        rootWebsite = (MockNode) sessionWebsite.getRootNode();
        rootPageWebsite = rootWebsite.addNode(ROOT_PAGE, NodeTypes.Content.NAME);
        page_1_1 = rootPageWebsite.addNode(PAGE_DEEP_1_1, NodeTypes.Content.NAME);
        page_1_1_1 = page_1_1.addNode(PAGE_DEEP_1_1_1, NodeTypes.Content.NAME);
        page_1_2 = rootPageWebsite.addNode(PAGE_DEEP_1_2, NodeTypes.Content.NAME);
        page_1_2_1 = page_1_2.addNode(PAGE_DEEP_1_2_1, JcrConstants.NT_FILE);

        // Init config Session
        MockSession sessionConfig = new MockSession("config");
        ctx.addSession("config", sessionConfig);
        rootConfig = (MockNode) sessionConfig.getRootNode();
        rootPageConfig = rootConfig.addNode(ROOT_PAGE, NodeTypes.Content.NAME);
        virtualURIMapping = rootPageConfig.addNode("virtualURIMapping", NodeTypes.Content.NAME);
        virtualUri_2_1 = virtualURIMapping.addNode(VIRTUALURI_DEEP_2_1, NodeTypes.ContentNode.NAME);
        virtualUri_2_2 = virtualURIMapping.addNode(VIRTUALURI_DEEP_2_2, NodeTypes.ContentNode.NAME);
    }


    @After
    public void tearDown() {
        ComponentsTestUtil.clear();
        MgnlContext.setInstance(null);
        service = null;
    }


    /**
     * Init the SiteMapService.
     */
    public void initService() throws RepositoryException {
        QueryUtil queryUtil =  mock(QueryUtil.class, Answers.RETURNS_SMART_NULLS.toString());
        String xpath = "//virtualURIMapping//element(*," + NodeTypes.ContentNode.NAME + ")";
        when(queryUtil.query("config", xpath, "xpath", NodeTypes.ContentNode.NAME)).thenReturn(virtualURIMapping.getNodes());
        GoogleSiteMapConfiguration configuration = new GoogleSiteMapConfiguration();
        // Init Site
        SiteManager siteManager = mock(SiteManager.class, Answers.RETURNS_SMART_NULLS.toString());
        Site site = new Site();
        site.setEnabled(true);
        when(siteManager.getAssignedSite(page_1_1)).thenReturn(site);
        when(siteManager.getAssignedSite(page_1_2)).thenReturn(site);
        when(siteManager.getAssignedSite(page_1_1_1)).thenReturn(site);
        when(siteManager.getAssignedSite(page_1_2_1)).thenReturn(site);

        ComponentsTestUtil.setInstance(I18nContentSupport.class, new DefaultI18nContentSupport());

        service = new SiteMapService(siteManager, configuration, queryUtil);
    }


    /**
     * Add a metaData to the Node.
     */
    public void setMetaData(Node node, String templateName) throws RepositoryException {
        NodeTypes.Created.set(node);
        NodeTypes.LastModified.update(node);
        if(templateName != null) {
            NodeTypes.Renderable.set(node, templateName);
        }
    }


    public List<SiteMapEntry> fromIteratorToList(Iterator< SiteMapEntry> iterator) {
        List<SiteMapEntry> res = new ArrayList<SiteMapEntry>();
        while(iterator.hasNext()) {
            res.add(iterator.next());
        }
        Collections.sort(res);
        return res;
    }

    public Node initSiteComponentNode(Node parent, String nodeName) throws RepositoryException {
        Node res = parent.addNode(nodeName, NodeTypes.Component.NAME);
        setMetaData(res, "google-sitemap:components/content/siteComponent");
        return res;
    }

    public Node initVirtualUriComponentNode(Node parent, String nodeName) throws RepositoryException {
        Node res = parent.addNode(nodeName, NodeTypes.Component.NAME);
        setMetaData(res, "google-sitemap:components/content/virtualUriComponent");
        return res;
    }

}