AbstractJCRTestCase.java

/*
 * Copyright (C) 2003-2012 eXo Platform SAS.
 *
 * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see<http://www.gnu.org/licenses/>.
 */
package org.exoplatform.forum.membership;

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Calendar;

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

import org.exoplatform.forum.base.BaseForumServiceTestCase;
import org.exoplatform.services.jcr.RepositoryService;
import org.exoplatform.services.jcr.config.RepositoryConfigurationException;
import org.exoplatform.services.jcr.core.ManageableRepository;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;

public abstract class AbstractJCRTestCase  extends BaseForumServiceTestCase {
  
  private static final Log LOG = ExoLogger.getLogger(AbstractJCRTestCase.class);

  private String tempDir;

  public void beforeContainerStart() {
    initTempDir();
  }

  public void initTempDir() {
    tempDir = "target/temp" + System.nanoTime() + getClass().getCanonicalName();
    System.setProperty("test.tmpdir", tempDir);
  }

  protected RepositoryService getRepositoryService() {
    return (RepositoryService)getContainer().getComponentInstanceOfType(RepositoryService.class);
  }

  /**
   * @return The ManageableRepository for this test
   * @throws RepositoryConfigurationException 
   * @throws RepositoryException 
   */
  ManageableRepository getRepo() throws RepositoryException, RepositoryConfigurationException {
    return getRepositoryService().getDefaultRepository();
  }

  /**
   * Get the workspace available for test data
   * 
   * @return workspace name
   * @throws RepositoryConfigurationException 
   * @throws RepositoryException 
   */
  protected String getWorkspace() throws RepositoryException, RepositoryConfigurationException {
    return getRepo().getConfiguration().getDefaultWorkspaceName();
  }

  /**
   * Get the repository for the current test
   * 
   * @return repository name
   * @throws RepositoryConfigurationException 
   * @throws RepositoryException 
   */
  protected String getRepository() throws RepositoryException, RepositoryConfigurationException {
    return getRepo().getConfiguration().getName();
  }

  /**
   * Asserts a node exists at the given path
   * 
   * @param path path relative to root of test workspace
   */
  protected void assertNodeExists(String path) {
    Session session = null;
    try {
      session = getSession();
      boolean exists = session.getRootNode().hasNode(path);
      if (!exists) {
        fail("no node exists at " + path);
      }
    } catch (RepositoryException e) {
      LOG.error("failed to assert node exists", e);
    } catch (RepositoryConfigurationException e) {
      LOG.error("failed to assert node exists", e);
    } 
  }

  /**
   * Asserts a node does not exists at the given path
   * 
   * @param path relative path to root of test workspace
   */
  protected void assertNodeNotExists(String path) {
    Session session = null;
    try {
      session = getSession();
      boolean exists = session.getRootNode().hasNode(path);
      if (exists) {
        fail("node exists at " + path);
      }
    } catch (RepositoryException e) {
      LOG.error("failed to assert node exists", e);
    } catch (RepositoryConfigurationException e) {
      LOG.error("failed to assert node exists", e);
    } 
  }

  /**
   * Load a node from path
   * 
   * @param path
   * @return
   */
  protected Node getNode(String path) {
    Session session = null;
    try {
      session = getSession();
      return session.getRootNode().getNode(path);
    } catch (RepositoryException e) {
      LOG.error("failed to load node exists", e);
      return null;
    } catch (RepositoryConfigurationException e) {
      LOG.error("failed to load node exists", e);
      return null;
    } 
  }

  /**
   * Get a session on the test workspace
   * 
   * @return a new system session
   * @throws RepositoryConfigurationException 
   * @throws Exception
   */
  protected Session getSession() throws RepositoryException, RepositoryConfigurationException {
      return getRepo().getSystemSession(getWorkspace());
  }

  /**
   * Add a new node to a given path. intermediary are created if needed.
   * 
   * @param path relative path to root
   * @return the newly added node
   */
  protected Node addNode(String path) {
    return addNode(path, null);
  }

  /**
   * Add a new node to a given path. intermediary are created if needed.
   * 
   * @param path relative path to root
   * @param nodetype nodetype for the last node to create
   * @return the newly added node
   */
  protected Node addNode(String path, String nodetype) {
    Session session = null;
    try {
      session = getSession();
      Node parent = session.getRootNode();
      String[] sections = path.split("/");
      for (String section : sections) {
        if (section.length() > 0 && !parent.hasNode(section)) {
          if (nodetype != null && path.endsWith(section)) {
            parent.addNode(section, nodetype); // add child
          } else {
            parent.addNode(section);
          }
        }
        parent = parent.getNode(section); // jump into
      }
      session.save();
      return parent;
    } catch (RepositoryException e) {
      LOG.error("failed to add node" + path, e);
      return null;
    } catch (RepositoryConfigurationException e) {
      LOG.error("failed to add node" + path, e);
      return null;
    } finally {
      if (session != null) {
        session.logout();
      }
    }
  }

  /**
   * Add a file at a given path. An nt:file is added at 'path' with a sample
   * text/plain jcr:content for the string "stuff"
   * 
   * @param path relative path to root
   * @return the node for the newly added file
   */
  protected Node addFile(String path) {
    Session session = null;
    try {
      session = getSession();
      Node parent = session.getRootNode();
      String[] sections = path.split("/");
      for (String section : sections) {
        if (section.length() > 0 && !parent.hasNode(section)) {
          if (path.endsWith(section)) {
            Node ntfile = parent.addNode(section, "nt:file");
            Node nodeContent = ntfile.addNode("jcr:content", "nt:resource");
            nodeContent.setProperty("jcr:mimeType", "text/plain");
            nodeContent.setProperty("jcr:data", new ByteArrayInputStream("stuff".getBytes()));
            nodeContent.setProperty("jcr:lastModified", Calendar.getInstance().getTimeInMillis());
          } else {
            parent.addNode(section);
          }
        }
        parent = parent.getNode(section); // jump into
      }
      session.save();
      return parent;
    } catch (RepositoryException e) {
      LOG.error("failed to add node" + path, e);
      return null;
    } catch (RepositoryConfigurationException e) {
      LOG.error("failed to add node" + path, e);
      return null;
    }
  }

  /**
   * removes a node at a given path
   * 
   * @param path relative path from root
   */
  protected void deleteNode(String path) {
    Session session = null;
    try {
      session = getSession();
      Node parent = session.getRootNode();
      Node target = parent.getNode(path);
      target.remove();
      session.save();
    } catch (RepositoryException e) {
      LOG.error("failed to remove node" + path, e);
    } catch (RepositoryConfigurationException e) {
      LOG.error("failed to remove node" + path, e);
    } finally {
      if (session != null) {
        session.logout();
      }
    }
  }

  /**
   * Asserts a node has a property
   * 
   * @param node note to assert
   * @param property propertyName
   */
  protected void assertPropertyExists(Node node, String property) {
    try {
      assertTrue("Node misses property " + property, node.hasProperty(property));
    } catch (RepositoryException e) {
      LOG.error("Repository Exception: ", e);
    }
  }

  /**
   * Asserts a property value is not empty
   * 
   * @param node
   * @param property
   */
  protected void assertBinaryPropertyNotEmpty(Node node, String property) {
    assertPropertyExists(node, property);

    try {
      InputStream is = node.getProperty(property).getStream();
      BufferedReader reader = new BufferedReader(new InputStreamReader(is));
      StringBuffer buff = new StringBuffer();
      String str;
      while ((str = reader.readLine()) != null) {
        buff.append(str);
      }
      reader.close();
      assertTrue("property " + property + " was empty", buff.length() > 0);
    } catch (RepositoryException e) {
      LOG.error("Repository error: ", e);
    } catch (IOException e) {
      LOG.error("IOException when using the reader: ", e);
    }

  }

  protected void assertPropertyEquals(String expected, Node node, String property) {
    try {
      assertEquals(expected, node.getProperty(property).getString());
    } catch (RepositoryException e) {
      LOG.error("Repository error: ", e);
    }
  }

  protected void assertPropertyEquals(boolean expected, Node node, String property) {
    try {
      assertEquals(expected, node.getProperty(property).getBoolean());
    } catch (RepositoryException e) {
      LOG.error("Repository error: ", e);
    }
  }

}