org.tentackle.sql.maven.BackendInfoParameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tentackle-sql-maven-plugin Show documentation
Maven Plugin for Tentackle SQL Backend
There is a newer version: 21.16.1.0
Show newest version
/*
 * Tentackle - http://www.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.sql.maven;

import java.io.File;
import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;
import java.util.function.Predicate;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.shared.model.fileset.FileSet;
import org.tentackle.sql.BackendInfo;

/**
 * Maven parameter to create a {@link BackendInfo}.
 *
 *  * <backends>
 *   <backend>
 *     <url>jdbc:mysql://localhost/muz</url>
 *     <user>muz</user>
 *     <password>muz</password>
 *     <schemaNames>muz, tx</schemaNames>
 *   </backend>
 * </backends>
 * 
 *
 * is equivalent to:
 *
 *  * <backends>
 *   <backend>
 *     <url>jdbc:mysql://localhost/muz</url>
 *     <user>muz</user>
 *     <password>muz</password>
 *     <schemas>
 *       <schema>muz</schema>
 *       <schema>tx</schema>
 *     </schemas>
 *   </backend>
 * </backends>
 * 
 *
 * @author harald
 */
public class BackendInfoParameter {

  /** the jdbc url. */
  public String url;

  /** the username. */
  public String user;

  /** the password. */
  public String password;

  /** allowed schemas. */
  public List schemas;

  /** alternate way to set schemas as a comma-separated string. */
  public String schemaNames;

  /** optional migration hints. */
  public List migrationHints;

  /**
   * Optional minimum version number.

   * This is usually the version of the database model.
   * 
   * There are 2 kinds of filters:
   * 

   * Strings holding a fixed version number, e.g. 3.1.0
   * String starting with 'SELECT' which is an SQL-select returning a version number (the current database version)
   * 
   * If given, the version number will be applied to the directories of the hint-files.
   */
  public String minVersion;


  /**
   * Creates a backend info from this parameter.
   *
   * @param logger the maven logger
   * @return the backend info
   */
  public BackendInfo createBackendInfo(Log logger) {
    if (schemaNames != null) {
      schemas = new ArrayList<>();
      StringTokenizer stok = new StringTokenizer(schemaNames, ",");
      while (stok.hasMoreTokens()) {
        schemas.add(stok.nextToken().trim());
      }
    }
    char[] passwd = password == null ? null : password.toCharArray();
    String[] schemaArray = null;
    if (schemas != null && !schemas.isEmpty()) {
      schemaArray = schemas.toArray(new String[schemas.size()]);
    }
    return new BackendInfo(url, user, passwd, schemaArray);
  }


  /**
   * Load the migration hints.
   *
   * @param backendInfo the backend info
   * @param logger the maven logger
   * @param verbose true if verbose
   * @param resourceDirs resource dirs, null if none
   * @return the hints the migration hints
   * @throws MojoExecutionException if failed
   */
  public MigrationHints loadMigrationHints(BackendInfo backendInfo, Log logger, boolean verbose, List resourceDirs) throws MojoExecutionException {
    MigrationHints hints = new MigrationHints();
    if (minVersion != null && minVersion.toUpperCase().startsWith("SELECT ")) {
      String effectiveFilter = null;
      try (Connection con = backendInfo.connect()) {
        try (Statement stmt = con.createStatement()) {
          ResultSet rs = stmt.executeQuery(minVersion);
          if (rs.next()) {
            effectiveFilter = rs.getString(1);
          }
        }
        if (effectiveFilter == null) {
          throw new MojoExecutionException(minVersion + " returned no results!");
        }
        minVersion = effectiveFilter;
      }
      catch (SQLException sx) {
        throw new MojoExecutionException("cannot retrieve filter from database", sx);
      }
    }
    if (minVersion != null) {
      logger.debug("applying filter '" + minVersion + "'");
    }
    hints.load(migrationHints, createFilter(minVersion), logger, verbose, resourceDirs);
    return hints;
  }


  /**
   * Creates a filter according to the version.
   *
   * @param version the minimum version, null if none
   * @return the filter, null if version is null
   */
  public Predicate createFilter(String version) {
    return version == null ? null : new VersionFileFilter(version);
  }

}