PageXmlizerTest.java

// Copyright (C) 2003-2009 by Object Mentor, Inc. All rights reserved.
// Released under the terms of the CPL Common Public License version 1.0.
package fitnesse.wiki.fs;

import java.text.DateFormat;
import java.util.Date;
import java.util.LinkedList;
import java.util.List;
import org.junit.Before;
import org.junit.Test;
import org.w3c.dom.Document;

import fitnesse.util.XmlUtil;
import fitnesse.wiki.*;
import fitnesse.wiki.fs.InMemoryPage;
import fitnesse.wiki.fs.PageXmlizer;
import fitnesse.wiki.fs.WikiPageProperties;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNotSame;
import static util.RegexTestCase.assertNotSubString;
import static util.RegexTestCase.assertSubString;

public class PageXmlizerTest {
  private PageXmlizer xmlizer;
  private WikiPage root;
  private PageCrawler crawler;
  private DateFormat format = WikiPageProperty.getTimeFormat();

  @Before
  public void setUp() throws Exception {
    xmlizer = new PageXmlizer();
    root = InMemoryPage.makeRoot("RooT");
    crawler = root.getPageCrawler();
    root.commit(root.getData());
  }

  @Test
  public void testXmlizeOneWikiPage() throws Exception {
    Document doc = xmlizer.xmlize(root);
    String value = XmlUtil.xmlAsString(doc);

    assertSubString("<page>", value);
    assertSubString("</page>", value);
    assertSubString("<name>RooT</name>", value);

    checkForLastModifiedTag(root, value);
  }

  private void checkForLastModifiedTag(WikiPage page, String value) throws Exception {
    Date lastModificationTime = page.getData().getProperties().getLastModificationTime();
    String timeString = WikiPageProperties.getTimeFormat().format(lastModificationTime);
    assertSubString("<lastModified>" + timeString + "</lastModified>", value);
  }

  @Test
  public void testDeXmlizeOneWikiPage() throws Exception {
    Document doc = xmlizer.xmlize(root);
    xmlizer.deXmlize(doc, root, new MockXmlizerPageHandler());

    List<?> children = root.getChildren();
    assertEquals(1, children.size());
    WikiPage page = (WikiPage) children.get(0);
    assertEquals("RooT", page.getName());
  }

  @Test
  public void testXmlizeTwoPages() throws Exception {
    WikiPage pageOne = WikiPageUtil.addPage(root, PathParser.parse("PageOne"), "");
    Document doc = xmlizer.xmlize(root);
    String value = XmlUtil.xmlAsString(doc);

    assertSubString("<name>RooT</name>", value);
    assertSubString("<name>PageOne</name>", value);
    checkForLastModifiedTag(root, value);
    checkForLastModifiedTag(pageOne, value);
  }

  @Test
  public void testDeXmlizingTwoPages() throws Exception {
    WikiPageUtil.addPage(root, PathParser.parse("PageOne"), "");
    xmlizer.deXmlize(xmlizer.xmlize(root), root, new MockXmlizerPageHandler());

    assertEquals(2, root.getChildren().size());
    WikiPage marshaledRoot = root.getChildPage("RooT");
    assertNotNull(marshaledRoot);

    assertEquals(1, marshaledRoot.getChildren().size());
    assertNotNull(marshaledRoot.getChildPage("PageOne"));
  }

  @Test
  public void testXmlizingAnEntireTree() throws Exception {
    makeFamilyOfPages();
    Document doc = xmlizer.xmlize(root);

    String value = XmlUtil.xmlAsString(doc);

    assertSubString("PageA", value);
    assertSubString("ChildOneA", value);
    assertSubString("GrandChildA", value);
    assertSubString("GreatGrandChildA", value);
    assertSubString("ChildTwoA", value);
    assertSubString("GrandChildTwoA", value);
    assertSubString("PageB", value);
    assertSubString("ChildOneB", value);
    assertSubString("GrandChildB", value);
    assertSubString("PageC", value);
  }

  @Test
  public void testDeXmlizingEntireTree() throws Exception {
    makeFamilyOfPages();
    xmlizer.deXmlize(xmlizer.xmlize(root), root, new MockXmlizerPageHandler());

    assertEquals(4, root.getChildren().size());
    WikiPage marshaledRoot = root.getChildPage("RooT");
    assertEquals(3, marshaledRoot.getChildren().size());
    WikiPage pageA = marshaledRoot.getChildPage("PageA");
    assertEquals(2, pageA.getChildren().size());
    WikiPage childOneA = pageA.getChildPage("ChildOneA");
    WikiPage grandChildA = childOneA.getChildPage("GrandChildA");
    WikiPage greatGrandChildA = grandChildA.getChildPage("GreatGrandChildA");
    assertNotNull(greatGrandChildA);

    assertNotNull(getPage("RooT.PageB.ChildOneB.GrandChildB"));
    assertNotNull(getPage("RooT.PageC"));
  }

  @Test
  public void testDeXmlizeEntireTreeTwice() throws Exception {
    makeFamilyOfPages();
    Document doc = xmlizer.xmlize(root);
    xmlizer.deXmlize(doc, root, new MockXmlizerPageHandler());
    xmlizer.deXmlize(doc, root, new MockXmlizerPageHandler());

    assertEquals(4, root.getChildren().size());
    WikiPage marshaledRoot = root.getChildPage("RooT");
    assertEquals(3, marshaledRoot.getChildren().size());
    WikiPage pageA = marshaledRoot.getChildPage("PageA");
    assertEquals(2, pageA.getChildren().size());
  }

  @Test
  public void testDeXmlizeSkippingRootLevel() throws Exception {
    makeFamilyOfPages();
    WikiPage pageC = root.getChildPage("PageC");
    xmlizer.deXmlizeSkippingRootLevel(xmlizer.xmlize(root), pageC, new MockXmlizerPageHandler());

    assertEquals(3, pageC.getChildren().size());
    WikiPage pageA = pageC.getChildPage("PageA");
    assertEquals(2, pageA.getChildren().size());
    WikiPage childOneA = pageA.getChildPage("ChildOneA");
    WikiPage grandChildA = childOneA.getChildPage("GrandChildA");
    WikiPage greatGrandChildA = grandChildA.getChildPage("GreatGrandChildA");
    assertNotNull(greatGrandChildA);

    assertNotNull(pageC.getPageCrawler().getPage(PathParser.parse("PageB.ChildOneB.GrandChildB")));
    assertNotNull(pageC.getPageCrawler().getPage(PathParser.parse("PageC")));
  }

  @Test
  public void testUsageOfHandler() throws Exception {
    makeFamilyOfPages();
    MockXmlizerPageHandler handler = new MockXmlizerPageHandler();
    xmlizer.deXmlize(xmlizer.xmlize(root), root, handler);

    assertEquals(11, handler.handledPages.size());

    checkPageWasHandledWithRightDate(0, root, handler);
    checkPageWasHandledWithRightDate(1, getPage("PageA"), handler);
    checkPageWasHandledWithRightDate(2, getPage("PageA.ChildOneA"), handler);
    checkPageWasHandledWithRightDate(3, getPage("PageA.ChildOneA.GrandChildA"), handler);
    checkPageWasHandledWithRightDate(4, getPage("PageA.ChildOneA.GrandChildA.GreatGrandChildA"), handler);
    checkPageWasHandledWithRightDate(5, getPage("PageA.ChildTwoA"), handler);
    checkPageWasHandledWithRightDate(6, getPage("PageA.ChildTwoA.GrandChildTwoA"), handler);
    checkPageWasHandledWithRightDate(7, getPage("PageB"), handler);
    checkPageWasHandledWithRightDate(8, getPage("PageB.ChildOneB"), handler);
    checkPageWasHandledWithRightDate(9, getPage("PageB.ChildOneB.GrandChildB"), handler);
    checkPageWasHandledWithRightDate(10, getPage("PageC"), handler);

    assertEquals(11, handler.exits);
  }

  private WikiPage getPage(String pathName) throws Exception {
    return crawler.getPage(PathParser.parse(pathName));
  }

  private void checkPageWasHandledWithRightDate(int i, WikiPage page, MockXmlizerPageHandler handler) throws Exception {
    assertEquals(page.getName(), handler.handledPages.get(i));
    String actualModifyTime = format.format(page.getData().getProperties().getLastModificationTime());
    String listedModifyTime = format.format(handler.modDates.get(i));
    assertEquals(actualModifyTime, listedModifyTime);
  }

  private void makeFamilyOfPages() throws Exception {
    addPage("PageA", "page a");
    addPage("PageA.ChildOneA", "child one a");
    addPage("PageA.ChildOneA.GrandChildA", "grand child a");
    addPage("PageA.ChildOneA.GrandChildA.GreatGrandChildA", "great grand child a");
    addPage("PageA.ChildTwoA", "child two a");
    addPage("PageA.ChildTwoA.GrandChildTwoA", "grand child two a");

    addPage("PageB", "page b");
    addPage("PageB.ChildOneB", "child one b");
    addPage("PageB.ChildOneB.GrandChildB", "grand child b");

    addPage("PageC", "page c");
  }

  private void addPage(String path, String content) throws Exception {
    WikiPageUtil.addPage(root, PathParser.parse(path), content);
  }

  @Test
  public void testXmlizingData() throws Exception {
    PageData data = root.getData();
    data.setContent("this is some content.");
    WikiPageProperty properties = data.getProperties();

    Document doc = xmlizer.xmlize(data);
    String marshaledValue = XmlUtil.xmlAsString(doc);

    assertSubString("<data>", marshaledValue);
    assertSubString("CDATA", marshaledValue);
    assertSubString("this is some content", marshaledValue);

    String[] propertyLines = new WikiPageProperties(properties).toXml().split("\n");
    for (String propertyLine : propertyLines) {
      String trimmedPropertyLine = propertyLine.trim();
      assertSubString(trimmedPropertyLine, marshaledValue);
    }
  }

  @Test
  public void testDeXmlizingPageData() throws Exception {
    PageData data = root.getData();
    data.setContent("this is some content.");
    WikiPageProperty properties = new WikiPageProperties(data.getProperties());

    PageData receivedData = xmlizer.deXmlizeData(xmlizer.xmlize(data));
    assertNotSame(data, receivedData);

    assertEquals("this is some content.", receivedData.getContent());
    WikiPageProperty receivedProperties = receivedData.getProperties();
    assertNotSame(properties, receivedProperties);
    assertEquals(properties.toString(), receivedProperties.toString());
  }

  @Test
  public void testConditionForXmlization() throws Exception {
    WikiPage pageOne = WikiPageUtil.addPage(root, PathParser.parse("PageOne"), "");
    WikiPageUtil.addPage(root, PathParser.parse("PageTwo"), "");

    xmlizer.addPageCondition(new XmlizePageCondition() {
      @Override
      public boolean canBeXmlized(WikiPage page) {
        return !page.getName().equals("PageTwo");
      }
    });
    Document doc = xmlizer.xmlize(root);
    String value = XmlUtil.xmlAsString(doc);

    assertSubString("<name>RooT</name>", value);
    assertSubString("<name>PageOne</name>", value);
    assertNotSubString("PageTwo", value);
    checkForLastModifiedTag(root, value);
    checkForLastModifiedTag(pageOne, value);
  }

  public static class MockXmlizerPageHandler implements XmlizerPageHandler {
    public List<String> handledPages = new LinkedList<>();
    public List<Date> modDates = new LinkedList<>();
    public int exits = 0;

    @Override
    public void enterChildPage(WikiPage newPage, Date lastModified) {
      handledPages.add(newPage.getName());
      modDates.add(lastModified);
      newPage.commit(newPage.getData());
    }

    @Override
    public void exitPage() {
      exits++;
    }
  }

}