atg.test.util.RepositoryManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atgdust Show documentation

ATG DUST is a framework for building JUnit tests for applications built on the ATG Dynamo platform. This framework allows one to quickly write test code that depends up Nucleus or ATG Repositories. By using this framework one can drastically cut down on development time. It takes only a few seconds to start up a test with a repository, but it may take multiple minutes to start up an application server. To get started with DUST, take a look at http://atgdust.sourceforge.net/first-test.html. This page will walk you through the process of running a basic test which starts Nucleus. After that, read the other getting started guides to describe how to create standalone Junit tests which can startup repositories and use the DynamoHttpServletResponse classes. For only ATG10 and tested.

The newest version!

/**
 * Copyright 2010 ATG DUST Project
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * 
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and limitations under the License.
 */

package atg.test.util;

import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;

import org.apache.commons.dbcp.BasicDataSource;
import org.apache.log4j.Logger;

/**
 * This class is a merger of atg.test.util.DBUtils and
 * atg.adapter.gsa.GSATestUtils. The result will hopefully be a class that just
 * has the bare minimums needed for testing against an existing and/or in-memory
 * database.
 * 
 * 
 * TODO: re-enable versioned repositories
 * 
 * 
 * @author robert
 * 
 */
public class RepositoryManager {

  private static Logger log = Logger.getLogger(RepositoryManager.class);

  private boolean isDefaultInMemoryDb;

  private final BasicDataSource dataSource = new BasicDataSource();

  /**
   * 
   * @param configRoot
   * @param repositoryPath
   *          The the repository to be tested, specified as nucleus component
   *          path.
   * @param settings
   * 
   * A {@link Properties} instance with the following values (in this example
   * the properties are geared towards an mysql database):
   * 
   *    * final Properties properties = new Properties();
   * properties.put("driver", "com.mysql.jdbc.Driver");
   * properties.put("url", "jdbc:mysql://localhost:3306/someDb");
   * properties.put("user", "someUserName");
   * properties.put("password", "somePassword");
   * 
   * 
   * @param dropTables
   *          If true then existing tables will be dropped and
   *          re-created, if set to false the existing tables
   *          will be used.
   * @param isDebug
   *          Enables or disables debugging.
   * @param definitionFiles
   *          One or more needed repository definition files.
   * @throws SQLException
   * @throws IOException
   */
  public void initializeMinimalRepositoryConfiguration(File configRoot,
      String repositoryPath, Map settings,
      final boolean dropTables, final boolean isDebug,
      String... definitionFiles) throws SQLException, IOException {

    dataSource.setDriverClassName(settings.get("driver"));
    dataSource.setUsername(settings.get("user"));
    dataSource.setPassword(settings.get("password"));
    dataSource.setUrl(settings.get("url"));

    log.info(String.format("Connected to '%s' using driver '%s'", dataSource
        .getUrl(), dataSource.getDriverClassName()));

    if (dropTables) {
      createIdGeneratorTables();
    }
    else {
      log.info("Existing tables will be used.");
    }

    isDefaultInMemoryDb = settings.get("url")==null?false:
    	settings.get("url").contains("jdbc:hsqldb:mem:testDb");

  }

  /**
   * 
   * @throws SQLException
   */
  public void shutdownInMemoryDbAndCloseConnections() throws SQLException {
    if (isDefaultInMemoryDb) {
      dataSource.getConnection().createStatement().execute("SHUTDOWN");
    }
    dataSource.close();
  }

  /**
   * 
   * @throws SQLException
   */
  private void createIdGeneratorTables() throws SQLException {

    log.info("Re-creating (drop and create) DAS_ID_GENERATOR");

    final Statement statement = dataSource.getConnection().createStatement();
    try {
      statement.executeUpdate("DROP TABLE DAS_ID_GENERATOR");
    }
    catch (SQLException e) {
      // just try drop any existing DAS_ID_GENERATOR if desired
    }
    // create new DAS_ID_GENERATOR
    statement
        .executeUpdate("CREATE TABLE DAS_ID_GENERATOR(ID_SPACE_NAME VARCHAR(60) NOT NULL, "
            + "SEED NUMERIC(19, 0) NOT NULL, BATCH_SIZE INTEGER NOT NULL,   "
            + "PREFIX VARCHAR(10) DEFAULT NULL, SUFFIX VARCHAR(10) DEFAULT NULL, "
            + "PRIMARY KEY(ID_SPACE_NAME))");
    statement.close();
  }

}