net.adamcin.vltpack.mojo.ITServerReadyMojo.scala Maven / Gradle / Ivy

Go to download
package net.adamcin.vltpack.mojo

import dispatch._
import net.adamcin.vltpack.HttpParameters
import org.apache.maven.plugin.MojoFailureException
import org.apache.maven.plugins.annotations.{LifecyclePhase, Mojo, Parameter}

/**
 * Waits for server readiness before continuing on to integration-test phase. Fails the build if
 * the configured timeout is exceeded.
 * @author Mark Adamcin
 * @since 1.0.0
 */
@Mojo(
  name = "IT-server-ready",
  defaultPhase = LifecyclePhase.PRE_INTEGRATION_TEST,
  threadSafe = true
)
class ITServerReadyMojo
  extends BaseITMojo
  with HttpParameters {

  /**
   * Set to true to skip this goal
   */
  @Parameter(property = "vltpack.skip.IT-server-ready")
  val skip = false

  /**
   * Number of seconds to wait while pinging the configured IT server for the expected response
   */
  @Parameter(defaultValue = "60")
  val timeout = 60

  /**
   * The server path to ping.
   */
  @Parameter(defaultValue = "/libs/granite/core/content/login.html")
  val serverReadyPath = "/"

  /**
   * The content that is expected anywhere in the response text.
   */
  @Parameter(defaultValue = "QUICKSTART_HOMEPAGE")
  val expectedContent = ""

  def checkContent(response: Future[String]): Future[Boolean] = {
    response.fold(
      (ex) => {
        getLog.info("server ready check exception: " + ex.getMessage)
        false
      },
      (content) => if (content contains expectedContent) {
        getLog.info("server ready check succeeded")
        true
      } else {
        getLog.info("server ready check failed to return expected content")
        false
      }
    )
  }

  override def execute() {
    skipWithTestsOrExecute(skip) {
      val until = System.currentTimeMillis() + (timeout * 1000)
      if (!waitForResponse(0)(until, () => urlForPath(serverReadyPath).subject OK as.String, checkContent)) {
        throw new MojoFailureException("Server failed to respond as expected within " + timeout + " seconds.")
      }
    }
  }
}