com.github.tototoshi.play2.flyway.Plugin.scala Maven / Gradle / Ivy
/*
* Copyright 2013 Toshiyuki Takahashi
*
* 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 com.github.tototoshi.play2.flyway
import play.api._
import play.api.mvc._
import play.api.mvc.Results._
import org.flywaydb.core.Flyway
import org.flywaydb.core.api.MigrationInfo
import play.core._
import java.io.FileNotFoundException
import org.flywaydb.core.internal.util.jdbc.DriverDataSource
import scala.collection.JavaConverters._
class Plugin(implicit app: Application) extends play.api.Plugin
with HandleWebCommandSupport
with PluginConfiguration
with FileUtils {
private val configReader = new ConfigReader(app)
private val allDatabaseNames = configReader.getDatabaseConfigurations.keys
private val flywayPrefixToMigrationScript = "db/migration"
private def initOnMigrate(dbName: String): Boolean =
app.configuration.getBoolean(s"db.${dbName}.migration.initOnMigrate").getOrElse(false)
private def validateOnMigrate(dbName: String): Boolean =
app.configuration.getBoolean(s"db.${dbName}.migration.validateOnMigrate").getOrElse(true)
private def placeholderPrefix(dbName: String): Option[String] =
app.configuration.getString(s"db.${dbName}.migration.placeholderPrefix")
private def placeholderSuffix(dbName: String): Option[String] =
app.configuration.getString(s"db.${dbName}.migration.placeholderSuffix")
private def placeholders(dbName: String): Map[String, String] = {
app.configuration.getConfig(s"db.${dbName}.migration.placeholders").map { config =>
config.subKeys.map { key => (key -> config.getString(key).getOrElse("")) }.toMap
}.getOrElse(Map.empty)
}
private def encoding(dbName: String): String = {
app.configuration.getString(s"db.${dbName}.migration.encoding").getOrElse("UTF-8")
}
private def migrationFileDirectoryExists(path: String): Boolean = {
app.resource(path) match {
case Some(r) => {
Logger.debug(s"Directory for migration files found. ${path}")
true
}
case None => {
Logger.warn(s"Directory for migration files not found. ${path}")
false
}
}
}
private lazy val flyways: Map[String, Flyway] = {
for {
(dbName, configuration) <- configReader.getDatabaseConfigurations
migrationFilesLocation = s"db/migration/${dbName}"
if migrationFileDirectoryExists(migrationFilesLocation)
} yield {
val flyway = new Flyway
flyway.setDataSource(new DriverDataSource(getClass.getClassLoader, configuration.driver, configuration.url, configuration.user, configuration.password))
flyway.setLocations(migrationFilesLocation)
flyway.setValidateOnMigrate(validateOnMigrate(dbName))
flyway.setEncoding(encoding(dbName))
if (initOnMigrate(dbName)) {
flyway.setInitOnMigrate(true)
}
for (prefix <- placeholderPrefix(dbName)) {
flyway.setPlaceholderPrefix(prefix)
}
for (suffix <- placeholderSuffix(dbName)) {
flyway.setPlaceholderSuffix(suffix)
}
flyway.setPlaceholders(placeholders(dbName).asJava)
dbName -> flyway
}
}
override lazy val enabled: Boolean =
!app.configuration.getString("flywayplugin").exists(_ == "disabled")
private def migrationDescriptionToShow(dbName: String, migration: MigrationInfo): String = {
app.resourceAsStream(s"${flywayPrefixToMigrationScript}/${dbName}/${migration.getScript}").map { in =>
s"""|--- ${migration.getScript} ---
|${readInputStreamToString(in)}""".stripMargin
}.getOrElse(throw new FileNotFoundException(s"Migration file not found. ${migration.getScript}"))
}
private def checkState(dbName: String): Unit = {
flyways.get(dbName).foreach { flyway =>
val pendingMigrations = flyway.info().pending
if (!pendingMigrations.isEmpty) {
throw InvalidDatabaseRevision(
dbName,
pendingMigrations.map(migration => migrationDescriptionToShow(dbName, migration)).mkString("\n"))
}
}
}
override def onStart(): Unit = {
for (dbName <- allDatabaseNames) {
if (Play.isTest || app.configuration.getBoolean(s"db.${dbName}.migration.auto").getOrElse(false)) {
migrateAutomatically(dbName)
} else {
checkState(dbName)
}
}
}
override def onStop(): Unit = {
}
private def migrateAutomatically(dbName: String): Unit = {
flyways.get(dbName).foreach { flyway =>
flyway.migrate()
}
}
private def getRedirectUrlFromRequest(request: RequestHeader): String = {
(for {
urls <- request.queryString.get("redirect")
url <- urls.headOption
} yield url).getOrElse("/")
}
override def handleWebCommand(request: RequestHeader, sbtLink: BuildLink, path: java.io.File): Option[SimpleResult] = {
val css = {
}
val js = {
}
val header = {
}
request.path match {
case migratePath(dbName) => {
for {
flyway <- flyways.get(dbName)
} yield {
flyway.migrate()
sbtLink.forceReload()
Redirect(getRedirectUrlFromRequest(request))
}
}
case cleanPath(dbName) => {
flyways.get(dbName).foreach(_.clean())
Some(Redirect(getRedirectUrlFromRequest(request)))
}
case versionedInitPath(dbName, version) => {
flyways.get(dbName).foreach(_.setInitVersion(version))
flyways.get(dbName).foreach(_.init())
Some(Redirect(getRedirectUrlFromRequest(request)))
}
case showInfoPath(dbName) => {
val description = for {
flyway <- flyways.get(dbName).toList
info <- flyway.info().all()
} yield {
val sql = app.resourceAsStream(s"${flywayPrefixToMigrationScript}/${dbName}/${info.getScript}").map { in =>
readInputStreamToString(in)
}.getOrElse("")
val status = {
if (info.getState.isApplied) {
applied
} else if (info.getState.isFailed) {
failed
} else if (info.getState.isResolved) {
resolved
}
}
{ info.getScript }
({ status }
)
{ sql }
}
def withRedirectParam(path: String) = path + "?redirect=" + java.net.URLEncoder.encode(request.path, "utf-8")
val initLinks = for {
flyway <- flyways.get(dbName).toList
info <- flyway.info().all()
} yield {
val version = info.getVersion().getVersion()
version: { version }
}
val migratePathWithRedirectParam = withRedirectParam(migratePath(dbName))
val cleanPathWithRedirectParam = withRedirectParam(cleanPath(dbName))
val html =
play-flyway
{ css }
{ header }
{ js }
Some(Ok(html).as("text/html"))
}
case "/@flyway" => {
val links = for {
(dbName, flyway) <- flyways
path = s"/@flyway/${dbName}"
} yield {
}
val html =
play-flyway
{ css }
{ header }
<< Back to app
{ links }
{ js }
Some(Ok(html).as("text/html"))
}
case _ => {
None
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy