RenderingEngineTest.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 com.celements.cells;

import static com.celements.common.test.CelementsTestUtils.*;
import static org.easymock.EasyMock.*;
import static org.junit.Assert.*;

import java.util.ArrayList;
import java.util.List;

import org.junit.Before;
import org.junit.Test;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.model.reference.SpaceReference;
import org.xwiki.model.reference.WikiReference;

import com.celements.common.test.AbstractComponentTest;
import com.celements.navigation.TreeNode;
import com.celements.navigation.service.ITreeNodeService;
import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.web.Utils;

public class RenderingEngineTest extends AbstractComponentTest {

  private RenderingEngine renderingEngine;
  private XWikiContext context;
  private IRenderStrategy renderStrategyMock;
  private ITreeNodeService mockTreeNodeService;

  @Before
  public void setUp_RenderingEngineTest() throws Exception {
    renderStrategyMock = createMock(IRenderStrategy.class);
    mockTreeNodeService = createMock(ITreeNodeService.class);
    renderingEngine = new RenderingEngine().setRenderStrategy(renderStrategyMock);
    renderingEngine.treeNodeService = mockTreeNodeService;
    context = getContext();
  }

  @Test
  public void testRenderCell_notRender() {
    DocumentReference docRef = new DocumentReference(context.getDatabase(), "Skin", "MasterCell");
    TreeNode node = new TreeNode(docRef, null, 0);
    renderStrategyMock.startRendering();
    expectLastCall().once();
    renderStrategyMock.endRendering();
    expectLastCall().once();
    expect(renderStrategyMock.isRenderCell(same(node))).andReturn(false).once();
    replayAll();
    renderingEngine.renderCell(node);
    verifyAll();
  }

  @Test
  public void testRenderCell_isRendering() {
    DocumentReference docRef = new DocumentReference(context.getDatabase(), "Skin", "MasterCell");
    TreeNode node = new TreeNode(docRef, null, 0);
    renderStrategyMock.startRendering();
    expectLastCall().once();
    renderStrategyMock.endRendering();
    expectLastCall().once();
    expect(renderStrategyMock.isRenderCell(same(node))).andReturn(true).once();
    // isFirst AND isLast because only this item and its children is
    // rendered (NO SIBLINGS!)
    boolean isLastItem = true;
    boolean isFirstItem = true;
    renderStrategyMock.startRenderCell(eq(node), eq(isFirstItem), eq(isLastItem));
    expectLastCall().once();
    renderStrategyMock.endRenderCell(eq(node), eq(isFirstItem), eq(isLastItem));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(docRef))).andReturn(false).once();
    replayAll();
    renderingEngine.renderCell(node);
    verifyAll();
  }

  @Deprecated
  @Test
  public void testRenderPageLayout_notRender_deprecated() {
    String spaceName = "Skin";
    renderStrategyMock.startRendering();
    expectLastCall().once();
    SpaceReference spaceReference = new SpaceReference(spaceName, new WikiReference(
        context.getDatabase()));
    renderStrategyMock.setSpaceReference(eq(spaceReference));
    expectLastCall().once();
    renderStrategyMock.endRendering();
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(spaceReference))).andReturn(false).once();
    expect(renderStrategyMock.getSpaceReference()).andReturn(spaceReference).anyTimes();
    replayAll();
    renderingEngine.renderPageLayout(spaceName);
    verifyAll();
  }

  @Test
  public void testRenderPageLayout_notRender() {
    SpaceReference spaceReference = new SpaceReference("MySkin", new WikiReference(
        context.getDatabase()));
    renderStrategyMock.startRendering();
    expectLastCall().once();
    renderStrategyMock.setSpaceReference(eq(spaceReference));
    expectLastCall().once();
    renderStrategyMock.endRendering();
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(spaceReference))).andReturn(false).once();
    expect(renderStrategyMock.getSpaceReference()).andReturn(spaceReference).anyTimes();
    replayAll();
    renderingEngine.renderPageLayout(spaceReference);
    verifyAll();
  }

  @Test
  public void testRenderPageLayout_isRendering() {
    SpaceReference masterPageLayoutRef = new SpaceReference("MasterPageLayout", new WikiReference(
        context.getDatabase()));
    renderStrategyMock.startRendering();
    expectLastCall().once();
    renderStrategyMock.endRendering();
    expectLastCall().once();
    renderStrategyMock.setSpaceReference(eq(masterPageLayoutRef));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(masterPageLayoutRef))).andReturn(true).once();
    String menuPart = "mainPart";
    expect(renderStrategyMock.getMenuPart((TreeNode) isNull())).andReturn(menuPart);
    List<TreeNode> subCellList = new ArrayList<TreeNode>();
    expect(mockTreeNodeService.getSubNodesForParent(eq(masterPageLayoutRef), eq(
        menuPart))).andReturn(subCellList);
    expectLastCall().once();
    expect(renderStrategyMock.getSpaceReference()).andReturn(masterPageLayoutRef).anyTimes();
    expect(renderStrategyMock.isRenderCell((TreeNode) isNull())).andReturn(false).once();
    replayAll();
    renderingEngine.renderPageLayout(masterPageLayoutRef);
    verifyAll();
  }

  @Test
  public void testRenderPageLayout_otherDB() {
    SpaceReference layoutRef = new SpaceReference("MasterPageLayout", new WikiReference(
        "celements2web"));
    renderStrategyMock.startRendering();
    expectLastCall().once();
    renderStrategyMock.endRendering();
    expectLastCall().once();
    renderStrategyMock.setSpaceReference(eq(layoutRef));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(layoutRef))).andReturn(true).once();
    expect(renderStrategyMock.getMenuPart((TreeNode) isNull())).andReturn("");
    List<TreeNode> subCellList = new ArrayList<TreeNode>();
    expect(mockTreeNodeService.getSubNodesForParent(eq(layoutRef), eq(""))).andReturn(subCellList);
    expect(renderStrategyMock.getSpaceReference()).andReturn(layoutRef).anyTimes();
    expect(renderStrategyMock.isRenderCell((TreeNode) isNull())).andReturn(false);
    replayAll();
    renderingEngine.renderPageLayout(layoutRef);
    verifyAll();
  }

  @Test
  public void testInternal_RenderCell_notRender() {
    DocumentReference docRef = new DocumentReference(context.getDatabase(), "Skin", "Cell2");
    TreeNode menuItem = new TreeNode(docRef, null, 0);
    expect(renderStrategyMock.isRenderCell(same(menuItem))).andReturn(false).once();
    replayAll();
    renderingEngine.internal_renderCell(menuItem, true, false);
    verifyAll();
  }

  @Test
  public void testInternal_RenderCell_isRendering() {
    boolean isLastItem = false;
    boolean isFirstItem = true;
    DocumentReference docRef = new DocumentReference(context.getDatabase(), "Skin", "Cell2");
    TreeNode menuItem = new TreeNode(docRef, null, 0);
    expect(renderStrategyMock.isRenderCell(same(menuItem))).andReturn(true).once();
    renderStrategyMock.startRenderCell(eq(menuItem), eq(isFirstItem), eq(isLastItem));
    expectLastCall().once();
    renderStrategyMock.endRenderCell(eq(menuItem), eq(isFirstItem), eq(isLastItem));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(docRef))).andReturn(false).once();
    replayAll();
    renderingEngine.internal_renderCell(menuItem, isFirstItem, isLastItem);
    verifyAll();
  }

  @Test
  public void testInternal_renderSubCells_notRenderSubCells() {
    DocumentReference docRef = new DocumentReference(context.getDatabase(), "Skin", "Cell2");
    TreeNode node = new TreeNode(docRef, null, 1);
    expect(renderStrategyMock.isRenderSubCells(eq(docRef))).andReturn(false).once();
    replayAll();
    renderingEngine.internal_renderSubCells(node);
    verifyAll();
  }

  @Test
  public void testInternal_renderSubCells_isRendering_noSubcells() {
    DocumentReference docRef = new DocumentReference(context.getDatabase(), "MySkin", "Cell2");
    TreeNode node = new TreeNode(docRef, null, 1);
    expect(renderStrategyMock.isRenderSubCells(eq(docRef))).andReturn(true).once();
    String menuPart = "mainPart";
    expect(renderStrategyMock.getMenuPart(eq(node))).andReturn(menuPart);
    List<TreeNode> subCellList = new ArrayList<TreeNode>();
    expect(mockTreeNodeService.getSubNodesForParent(eq(docRef), eq(menuPart))).andReturn(
        subCellList);
    expect(renderStrategyMock.isRenderCell(eq(node))).andReturn(true);
    renderStrategyMock.renderEmptyChildren(eq(node));
    expectLastCall().once();
    replayAll();
    renderingEngine.internal_renderSubCells(node);
    verifyAll();
  }

  @Test
  public void testInternal_renderSubCells_isRendering_withSubcells() {
    DocumentReference cellRef = new DocumentReference(context.getDatabase(), "MyLayout", "Cell2");
    TreeNode cellNode = new TreeNode(cellRef, null, 1);
    expect(renderStrategyMock.isRenderSubCells(eq(cellRef))).andReturn(true).once();
    String menuSpace = "MyCellSpace";
    String menuPart = "mainPart";
    expect(renderStrategyMock.getMenuPart(eq(cellNode))).andReturn(menuPart).once();
    List<TreeNode> subCellList = new ArrayList<TreeNode>();
    TreeNode subCell1 = new TreeNode(new DocumentReference(context.getDatabase(), menuSpace,
        "subCell1"), null, 1);
    subCellList.add(subCell1);
    TreeNode subCell2 = new TreeNode(new DocumentReference(context.getDatabase(), menuSpace,
        "subCell2"), null, 2);
    subCellList.add(subCell2);
    TreeNode subCell3 = new TreeNode(new DocumentReference(context.getDatabase(), menuSpace,
        "subCell3"), null, 3);
    subCellList.add(subCell3);
    TreeNode subCell4 = new TreeNode(new DocumentReference(context.getDatabase(), menuSpace,
        "subCell4"), null, 4);
    subCellList.add(subCell4);
    expect(mockTreeNodeService.getSubNodesForParent(eq(cellRef), eq(menuPart))).andReturn(
        subCellList);
    renderStrategyMock.startRenderChildren(eq(cellRef));
    expectLastCall().once();
    renderStrategyMock.endRenderChildren(eq(cellRef));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderCell(same(subCell1))).andReturn(true).once();
    renderStrategyMock.startRenderCell(eq(subCell1), eq(true), eq(false));
    expectLastCall().once();
    renderStrategyMock.endRenderCell(eq(subCell1), eq(true), eq(false));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(subCell1.getDocumentReference()))).andReturn(
        false);
    expect(renderStrategyMock.isRenderCell(same(subCell2))).andReturn(true).once();
    renderStrategyMock.startRenderCell(eq(subCell2), eq(false), eq(false));
    expectLastCall().once();
    renderStrategyMock.endRenderCell(eq(subCell2), eq(false), eq(false));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(subCell2.getDocumentReference()))).andReturn(
        false);
    expect(renderStrategyMock.isRenderCell(same(subCell3))).andReturn(false).once();
    expect(renderStrategyMock.isRenderCell(same(subCell4))).andReturn(true).once();
    renderStrategyMock.startRenderCell(eq(subCell4), eq(false), eq(true));
    expectLastCall().once();
    renderStrategyMock.endRenderCell(eq(subCell4), eq(false), eq(true));
    expectLastCall().once();
    expect(renderStrategyMock.isRenderSubCells(eq(subCell4.getDocumentReference()))).andReturn(
        false);
    replayAll();
    renderingEngine.internal_renderSubCells(cellNode);
    verifyAll();
  }

  @Test
  public void testGetTreeNodeService_inject() {
    assertSame(mockTreeNodeService, renderingEngine.getTreeNodeService());
  }

  @Test
  public void testGetTreeNodeService_defaultInstancing() {
    renderingEngine.treeNodeService = null;
    ITreeNodeService treeNodeService = renderingEngine.getTreeNodeService();
    assertNotNull(treeNodeService);
    assertSame(Utils.getComponent(ITreeNodeService.class), treeNodeService);
    assertNotSame(mockTreeNodeService, treeNodeService);
  }

  private void replayAll(Object... mocks) {
    replay(renderStrategyMock, mockTreeNodeService);
    replay(mocks);
  }

  private void verifyAll(Object... mocks) {
    verify(renderStrategyMock, mockTreeNodeService);
    verify(mocks);
  }

}