move utils module here from gocd-s3-artifacts plugin

build.sbt

@@ -68,7 +68,7 @@ lazy val utils = (project in file(".")).
     site.addMappingsToSiteDir(mappings in(ScalaUnidoc, packageDoc), "latest/api"),
     git.remoteRepo := "[email protected]:indix/utils.git"
   ).
-  aggregate(coreUtils, storeUtils, sparkUtils)
+  aggregate(coreUtils, storeUtils, sparkUtils, gocdUtils)
 
 lazy val coreUtils = (project in file("util-core")).
   settings(commonSettings: _*).
@@ -118,3 +118,22 @@ lazy val sparkUtils = (project in file("util-spark")).
       "org.bdgenomics.utils" %% "utils-misc" % "0.2.13"
     )
   )
+
+lazy val gocdUtils = (project in file("util-gocd")).
+  settings(commonSettings: _*).
+  settings(publishSettings: _*).
+  settings(
+    name := "util-gocd",
+    crossScalaVersions := Seq("2.10.6", "2.11.11"),
+    libraryDependencies ++= Seq(
+      "org.apache.commons" % "commons-lang3" % "3.1",
+      "commons-io" % "commons-io" % "1.3.2",
+      "com.amazonaws" % "aws-java-sdk-s3" % "1.11.127",
+      "cd.go.plugin" % "go-plugin-api" % "17.2.0" % Provided,
+      "com.google.code.gson" % "gson" % "2.2.3",
+      "junit" % "junit" % "4.12" % Test,
+      "com.novocode" % "junit-interface" % "0.11" % Test,
+      "org.mockito" % "mockito-all" % "1.10.19" % Test,
+      "org.scalatest" %% "scalatest" % "3.0.3" % Test
+    )
+  )

publish.sh

@@ -5,6 +5,7 @@ set -ex
 sbt "project coreUtils" +publishSigned
 sbt "project sparkUtils" +publishSigned
 sbt "project storeUtils" +publishSigned
+sbt "project gocdUtils" +publishSigned
 sbt sonatypeReleaseAll
 
 echo "Released"

util-gocd/src/main/scala/com/indix/gocd/models/Artifact.scala

@@ -0,0 +1,25 @@
+package com.indix.gocd.models
+
+/**
+  * S3 Artifact
+  *
+  * A gocd pipeline can create an s3 artifact at a location that can
+  * be identified using the pipeline details like pipeline name,
+  * stage name, job name, etc
+  *
+  * @param pipelineName
+  * @param stageName
+  * @param jobName
+  * @param revision
+  */
+case class Artifact(pipelineName: String, stageName: String, jobName: String, revision: Option[Revision] = None) {
+
+  def withRevision(revision: Revision): Artifact = Artifact(pipelineName, stageName, jobName, Some(revision))
+
+  def prefix: String = String.format("%s/%s/%s/", pipelineName, stageName, jobName)
+
+  def prefixWithRevision: String = {
+    if (revision.isDefined) String.format("%s/%s/%s/%s/", pipelineName, stageName, jobName, revision.get.revision)
+    else prefix
+  }
+}

util-gocd/src/main/scala/com/indix/gocd/models/ResponseMetadataConstants.scala

@@ -0,0 +1,9 @@
+package com.indix.gocd.models
+
+object ResponseMetadataConstants {
+  val TRACEBACK_URL = "traceback_url"
+  val USER = "user"
+  val REVISION_COMMENT = "revision_comment"
+  val COMPLETED = "completed"
+  val GO_PIPELINE_LABEL = "go_pipeline_label"
+}

util-gocd/src/main/scala/com/indix/gocd/models/Revision.scala

@@ -0,0 +1,33 @@
+package com.indix.gocd.models
+
+/**
+  * Represents revision
+  * Parses revision string to populate fields
+  *
+  * @param revision
+  */
+case class Revision(revision: String) extends Ordered[Revision] {
+
+  val parts: Seq[String] = revision.split("\\.")
+  val major: Int = Integer.valueOf(parts.head)
+  val minor: Int = Integer.valueOf(parts(1))
+  val patch: Int = {
+    if (parts.size == 3) Integer.valueOf(parts(2))
+    else 0
+  }
+
+  override def compare(that: Revision): Int = {
+  val majorDiff = this.major.compareTo(that.major)
+      val minorDiff = this.minor.compareTo(that.minor)
+      val patchDiff = this.patch.compareTo(that.patch)
+
+      if (majorDiff != 0) majorDiff
+      else if (minorDiff != 0) minorDiff
+      else if (patchDiff != 0) patchDiff
+      else 0
+  }
+}
+
+object Revision {
+  def base: Revision = Revision("0.0.0")
+}

util-gocd/src/main/scala/com/indix/gocd/models/RevisionStatus.scala

@@ -0,0 +1,31 @@
+package com.indix.gocd.models
+
+import java.text.SimpleDateFormat
+import java.util.Date
+
+import com.amazonaws.util.StringUtils
+
+/**
+  * Used to display the status of revisions in gocd
+  *
+  * @param revision
+  * @param lastModified
+  * @param trackbackUrl
+  * @param user
+  * @param revisionLabel
+  */
+case class RevisionStatus(revision: Revision, lastModified: Date, trackbackUrl: String, user: String, revisionLabel: String = "") {
+
+  val DATE_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
+
+  def toMap: Map[String, String] = {
+    Map(
+      "revision" -> revision.revision,
+      "timestamp" -> new SimpleDateFormat(DATE_PATTERN).format(lastModified),
+      "user" -> user,
+      "revisionComment" -> String.format("Original revision number: %s", if (StringUtils.isNullOrEmpty(revisionLabel)) "unavailable"
+      else revisionLabel),
+      "trackbackUrl" -> trackbackUrl
+    )
+  }
+}

util-gocd/src/main/scala/com/indix/gocd/utils/Constants.scala

@@ -0,0 +1,38 @@
+package com.indix.gocd.utils
+
+object Constants {
+  val METADATA_USER = "user"
+  val METADATA_TRACEBACK_URL = "traceback_url"
+  val COMPLETED = "completed"
+
+  val GO_ARTIFACTS_S3_BUCKET = "GO_ARTIFACTS_S3_BUCKET"
+  val GO_SERVER_DASHBOARD_URL = "GO_SERVER_DASHBOARD_URL"
+
+  val SOURCEDESTINATIONS = "sourceDestinations"
+  val DESTINATION_PREFIX = "destinationPrefix"
+  val ARTIFACTS_BUCKET = "artifactsBucket"
+
+  val AWS_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
+  val AWS_ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID"
+  val AWS_REGION = "AWS_REGION"
+  val AWS_USE_IAM_ROLE = "AWS_USE_IAM_ROLE"
+  val AWS_STORAGE_CLASS = "AWS_STORAGE_CLASS"
+  val STORAGE_CLASS_STANDARD = "standard"
+  val STORAGE_CLASS_STANDARD_IA = "standard-ia"
+  val STORAGE_CLASS_RRS = "rrs"
+  val STORAGE_CLASS_GLACIER = "glacier"
+
+  val GO_PIPELINE_LABEL = "GO_PIPELINE_LABEL"
+
+  val MATERIAL_TYPE = "MaterialType"
+  val REPO = "Repo"
+  val PACKAGE = "Package"
+  val MATERIAL = "Material"
+  val JOB = "Job"
+  val STAGE = "Stage"
+  val SOURCE = "Source"
+  val SOURCE_PREFIX = "SourcePrefix"
+  val DESTINATION = "Destination"
+
+  val REQUIRED_FIELD_MESSAGE = "This field is required"
+}

util-gocd/src/main/scala/com/indix/gocd/utils/Context.scala

@@ -0,0 +1,20 @@
+package com.indix.gocd.utils
+
+import java.nio.file.Paths
+
+import com.thoughtworks.go.plugin.api.task.JobConsoleLogger
+
+import scala.collection.JavaConverters._
+
+case class Context(environmentVariables: Map[String, String], workingDir: String, console: JobConsoleLogger) {
+
+  def printMessage(message: String): Unit = console.printLine(message)
+
+  def printEnvironment(): Unit = console.printEnvironment(environmentVariables.asJava)
+
+  def getAbsoluteWorkingDir: String = Paths.get("").toAbsolutePath.resolve(workingDir).toString
+}
+
+object Context {
+  def apply(context: Map[String, _]): Context = Context(context("environmentVariables").asInstanceOf[Map[String, String]], context("workingDirectory").asInstanceOf[String], JobConsoleLogger.getConsoleLogger)
+}

util-gocd/src/main/scala/com/indix/gocd/utils/GoEnvironment.scala

@@ -0,0 +1,85 @@
+package com.indix.gocd.utils
+
+import java.util.regex.Pattern
+
+import com.indix.gocd.utils.Constants.{AWS_USE_IAM_ROLE, GO_SERVER_DASHBOARD_URL}
+import org.apache.commons.lang3.BooleanUtils
+import org.apache.commons.lang3.StringUtils.isNotEmpty
+
+import scala.collection.JavaConversions._
+
+class GoEnvironment(input: Option[Map[String, String]] = None) {
+
+  val environment: Map[String, String] = {
+    if (input.isDefined)
+      System.getenv().toMap ++ input.get
+    else
+      System.getenv().toMap
+  }
+  val envPat: Pattern = Pattern.compile("\\$\\{(\\w+)\\}")
+
+  def putAll(existing: Map[String, String]): GoEnvironment = new GoEnvironment(Some(existing ++ environment))
+
+  def asMap: Map[String, String] = environment
+
+  def get(name: String): String = environment(name)
+
+  def getOrElse(name: String, defaultValue: String): String = environment.getOrElse(name, defaultValue)
+
+  def has(name: String): Boolean = environment.containsKey(name) && isNotEmpty(get(name))
+
+  def isAbsent(name: String): Boolean = !has(name)
+
+  def traceBackUrl: String = {
+    val serverUrl = get(GO_SERVER_DASHBOARD_URL)
+    val pipelineName = get("GO_PIPELINE_NAME")
+    val pipelineCounter = get("GO_PIPELINE_COUNTER")
+    val stageName = get("GO_STAGE_NAME")
+    val stageCounter = get("GO_STAGE_COUNTER")
+    val jobName = get("GO_JOB_NAME")
+    String.format("%s/go/tab/build/detail/%s/%s/%s/%s/%s", serverUrl, pipelineName, pipelineCounter, stageName, stageCounter, jobName)
+  }
+
+  def triggeredUser: String = get("GO_TRIGGER_USER")
+
+  def replaceVariables(str: String): String = {
+    val m = envPat.matcher(str)
+    val sb = new StringBuffer
+    while (m.find()) {
+      val replacement = environment.get(m.group(1))
+      if (replacement.isDefined) {
+        m.appendReplacement(sb, replacement.get)
+      }
+    }
+    m.appendTail(sb)
+    sb.toString
+  }
+
+  /**
+    * Version Format on S3 is <code>pipeline/stage/job/pipeline_counter.stage_counter</code>
+    */
+  def artifactsLocationTemplate: String = {
+    val pipeline = get("GO_PIPELINE_NAME")
+    val stageName = get("GO_STAGE_NAME")
+    val jobName = get("GO_JOB_NAME")
+    val pipelineCounter = get("GO_PIPELINE_COUNTER")
+    val stageCounter = get("GO_STAGE_COUNTER")
+    artifactsLocationTemplate(pipeline, stageName, jobName, pipelineCounter, stageCounter)
+  }
+
+  def artifactsLocationTemplate(pipeline: String, stageName: String, jobName: String, pipelineCounter: String, stageCounter: String): String = String.format("%s/%s/%s/%s.%s", pipeline, stageName, jobName, pipelineCounter, stageCounter)
+
+  private val validUseIamRoleValues: List[String] = List("true", "false", "yes", "no", "on", "off")
+
+  def hasAWSUseIamRole: Boolean = {
+    if (!has(AWS_USE_IAM_ROLE)) false
+    val useIamRoleValue = get(AWS_USE_IAM_ROLE)
+    val result = BooleanUtils.toBooleanObject(useIamRoleValue)
+    if (result == null) throw new IllegalArgumentException(getEnvInvalidFormatMessage(AWS_USE_IAM_ROLE, useIamRoleValue, validUseIamRoleValues.mkString("[", ", ", "]")))
+    else result.booleanValue
+  }
+
+  private def getEnvInvalidFormatMessage(environmentVariable: String, value: String, expected: String) = String.format("Unexpected value in %s environment variable; was %s, but expected one of the following %s", environmentVariable, value, expected)
+
+  def this() = this(None)
+}

util-gocd/src/main/scala/com/indix/gocd/utils/MaterialResult.scala

@@ -0,0 +1,22 @@
+package com.indix.gocd.utils
+
+import com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse
+
+case class MaterialResult(success: Boolean, messages: Seq[String]) {
+
+  def toMap = Map(
+    "status" -> {
+      if (success) "success" else "failure"
+    },
+    "messages" -> messages
+  )
+
+  def responseCode: Int = DefaultGoApiResponse.SUCCESS_RESPONSE_CODE
+}
+
+object MaterialResult {
+
+  def apply(success: Boolean) : MaterialResult = MaterialResult(success, Seq())
+
+  def apply(success: Boolean, message: String) : MaterialResult = MaterialResult(success, Seq(message))
+}

util-gocd/src/main/scala/com/indix/gocd/utils/TaskExecutionResult.scala

@@ -0,0 +1,10 @@
+package com.indix.gocd.utils
+
+import com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse
+
+case class TaskExecutionResult(success: Boolean, message: String, exception: Option[Exception] = None) {
+
+  def toMap = Map("success" -> success, "message" -> message)
+
+  def responseCode: Int = DefaultGoApiResponse.SUCCESS_RESPONSE_CODE
+}