org.tentackle.pdo.test.DbTestUtilities Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tentackle-test-pdo Show documentation
Test depdendency to support writing PDO-based tests. Also generates the SQL-scripts for the TT tables and contains some PDO tests. This artifact must be included in test-scope only!
The newest version!
/*
 * Tentackle - https://tentackle.org
 *
 * This library 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 library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.tentackle.pdo.test;

import org.tentackle.common.Service;
import org.tentackle.common.ServiceFactory;
import org.tentackle.common.StringHelper;
import org.tentackle.dbms.Db;
import org.tentackle.dbms.ObjectSequenceId;
import org.tentackle.model.Entity;
import org.tentackle.model.EntityInfo;
import org.tentackle.model.ForeignKey;
import org.tentackle.model.Index;
import org.tentackle.model.Model;
import org.tentackle.model.ModelException;
import org.tentackle.sql.Backend;

import java.util.Collection;
import java.util.HashSet;
import java.util.Set;


interface DbTestUtilitiesHolder {
  DbTestUtilities INSTANCE = ServiceFactory.createService(DbTestUtilities.class, DbTestUtilities.class);
}


/**
 * Low-level session utility methods for tests.
 */
@Service(DbTestUtilities.class)    // defaults to self
public class DbTestUtilities {

  /**
   * The singleton.
   *
   * @return the singleton
   */
  public static DbTestUtilities getInstance() {
    return DbTestUtilitiesHolder.INSTANCE;
  }


  /**
   * Creates the SQL script to populate the database.

   * Used for in-memory test connections.

   * Loads the model from the classpath.
   *
   * @param db the low-level database session
   * @return the SQL script
   * @throws ModelException if model is inconsistent
   * @see Model#loadFromResources(boolean)
   */
  public String createPopulateScript(Db db) throws ModelException {
    Backend backend = db.getBackend();

    StringBuilder script = new StringBuilder();
    if (backend.isSequenceSupported()) {
      script.append(backend.sqlCreateSequence(ObjectSequenceId.DEFAULT_NAME, 1L, 1L))
            .append(backend.getStatementSeparator()).append('\n');
    }

    Model model = Model.getInstance();
    Set schemas = new HashSet<>();

    for (EntityInfo entityInfo : model.loadFromResources(true)) {
      Entity entity = entityInfo.getEntity();
      if (entity.getTableProvidingEntity() == entity && !entity.getOptions().isProvided()) {
        String schema = entity.getSchemaName();   // schema is null if Model.isSchemaNameMapped()
        if (!StringHelper.isAllWhitespace(schema) && schemas.add(schema)) {
          // schema is new: create it
          script.append(backend.sqlCreateSchema(schema)).append(backend.getStatementSeparator()).append('\n');
        }
        script.append(entity.sqlCreateTable(backend));
        for (Index index : entity.getTableIndexes()) {
          script.append(index.sqlCreateIndex(backend, entity));
        }
      }
    }

    Collection foreignKeys = model.getForeignKeys();
    if (!foreignKeys.isEmpty()) {
      for (ForeignKey foreignKey : foreignKeys) {
        script.append(foreignKey.sqlCreateForeignKey(backend));
      }
    }

    return script.toString();
  }


  /**
   * Runs an SQL script.
   *
   * @param db the low-level session
   * @param script the SQL script
   */
  public void runScript(Db db, String script) {
    db.runScript("populate", script);
  }

}