Persistent volumes param (#285)

- Support for persistent volume parameter
- Some refactoring and cosmetics

Author: DragonIsle

.scalafmt.conf

@@ -1,5 +1,5 @@
 version=3.5.9
 continuationIndent.defnSite = 2
 maxColumn = 140
-align = some
-newlines.alwaysBeforeTopLevelStatements = true
+align.preset = some
+runner.dialect = scala212

build.sbt

@@ -12,7 +12,8 @@ lazy val `kubeyml` = (project in file("."))
   .settings(pluginSettings)
   .settings(
     name := "sbt-kubeyml"
-  ).settings(publishSettings)
+  )
+  .settings(publishSettings)
   .settings(releaseSettings)
   .settings(pluginSettings)
   .settings(compilerSettings)
@@ -23,7 +24,6 @@ lazy val site = (project in file("site"))
   .settings(noPublishSettings)
   .dependsOn(`kubeyml`)
 
-
 crossScalaVersions := Seq(scala212)
 
 val circeVersion = "0.14.2"
@@ -38,7 +38,7 @@ libraryDependencies ++= Seq(
   "org.scalacheck" %% "scalacheck" % "1.16.0" % Test,
   "com.github.alexarchambault" %% "scalacheck-shapeless_1.15" % "1.3.0" % Test
 )
-addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.9.11")
+addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.9.9")
 
 lazy val pluginSettings = Seq(
   sbtPlugin := true
@@ -53,15 +53,13 @@ lazy val publishSettings = Seq(
   organizationName := "Vasilis Nicolaou",
   sonatypeProfileName := "org.vaslabs",
   sonatypeProjectHosting := Some(GitHubHosting("vaslabs", "sbt-kubeyml", "[email protected]")),
-  scmInfo := Some(ScmInfo(
-    url("https://github.com/vaslabs/sbt-kubeyml"),
-    "scm:[email protected]:vaslabs/sbt-kubeyml.git")),
+  scmInfo := Some(ScmInfo(url("https://github.com/vaslabs/sbt-kubeyml"), "scm:[email protected]:vaslabs/sbt-kubeyml.git")),
   developers := List(
     Developer(
-      id    = "vaslabs",
-      name  = "Vasilis Nicolaou",
+      id = "vaslabs",
+      name = "Vasilis Nicolaou",
       email = "[email protected]",
-      url   = url("http://vaslabs.org")
+      url = url("http://vaslabs.org")
     )
   ),
   publishConfiguration := publishConfiguration.value.withOverwrite(true),
@@ -99,24 +97,24 @@ lazy val compilerSettings = Seq(
   scalacOptions ++= Seq(
     "-deprecation",
     "-feature",
-    "-language:postfixOps",              //Allow postfix operator notation, such as `1 to 10 toList'
+    "-language:postfixOps", // Allow postfix operator notation, such as `1 to 10 toList'
     "-language:implicitConversions",
     "-language:higherKinds",
     "-Ypartial-unification",
-    "-Ywarn-dead-code",                  // Warn when dead code is identified.
-    "-Ywarn-extra-implicit",             // Warn when more than one implicit parameter section is defined.
-    "-Ywarn-inaccessible",               // Warn about inaccessible types in method signatures.
-    "-Ywarn-infer-any",                  // Warn when a type argument is inferred to be `Any`.
-    "-Ywarn-nullary-override",           // Warn when non-nullary `def f()' overrides nullary `def f'.
-    "-Ywarn-nullary-unit",               // Warn when nullary methods return Unit.
-    "-Ywarn-numeric-widen",              // Warn when numerics are widened.
-    "-Ywarn-unused:implicits",           // Warn if an implicit parameter is unused.
-    "-Ywarn-unused:imports",             // Warn if an import selector is not referenced.
-    "-Ywarn-unused:locals",              // Warn if a local definition is unused.
-    "-Ywarn-unused:params",              // Warn if a value parameter is unused.
-    "-Ywarn-unused:patvars",             // Warn if a variable bound in a pattern is unused.
-    "-Ywarn-unused:privates",            // Warn if a private member is unused.
-    "-Ywarn-value-discard",               // Warn when non-Unit expression results are unused.
+    "-Ywarn-dead-code", // Warn when dead code is identified.
+    "-Ywarn-extra-implicit", // Warn when more than one implicit parameter section is defined.
+    "-Ywarn-inaccessible", // Warn about inaccessible types in method signatures.
+    "-Ywarn-infer-any", // Warn when a type argument is inferred to be `Any`.
+    "-Ywarn-nullary-override", // Warn when non-nullary `def f()' overrides nullary `def f'.
+    "-Ywarn-nullary-unit", // Warn when nullary methods return Unit.
+    "-Ywarn-numeric-widen", // Warn when numerics are widened.
+    "-Ywarn-unused:implicits", // Warn if an implicit parameter is unused.
+    "-Ywarn-unused:imports", // Warn if an import selector is not referenced.
+    "-Ywarn-unused:locals", // Warn if a local definition is unused.
+    "-Ywarn-unused:params", // Warn if a value parameter is unused.
+    "-Ywarn-unused:patvars", // Warn if a variable bound in a pattern is unused.
+    "-Ywarn-unused:privates", // Warn if a private member is unused.
+    "-Ywarn-value-discard", // Warn when non-Unit expression results are unused.
     "-Ywarn-unused:imports",
     "-Xfatal-warnings"
   )
@@ -141,7 +139,7 @@ lazy val docSettings = Seq(
     )
   ),
   ghpagesCleanSite / excludeFilter :=
-    new FileFilter{
+    new FileFilter {
       def accept(f: File) = (ghpagesRepository.value / "CNAME").getCanonicalPath == f.getCanonicalPath
     } || "versions.html"
 )
@@ -153,4 +151,3 @@ lazy val noPublishSettings =
     publishArtifact := false,
     publishTo := None
   )
-

src/main/scala/kubeyml/deployment/Protocol.scala

@@ -42,6 +42,9 @@ case class Deployment(
   private[kubeyml] def addEnv(envs: Map[EnvName, EnvValue]): Deployment =
     this.copy(spec = spec.addContainerEnvs(envs))
 
+  private[kubeyml] def addPersistentVolumes(volumes: Seq[VolumeWithClaim]): Deployment =
+    this.copy(spec = spec.addPersistentVolumes(volumes))
+
   private[kubeyml] def addCommand(cmd: Option[NonEmptyString], args: Seq[String]): Deployment = {
     this.copy(spec = spec.addContainerCmd(cmd, args))
   }
@@ -61,7 +64,6 @@ case class Deployment(
   private[kubeyml] def withDeploymentStrategy(deploymentStrategy: DeploymentStrategy): Deployment =
     this.copy(spec = spec.withDeploymentStrategy(deploymentStrategy))
 
-
 }
 
 case class DeploymentMetadata(
@@ -87,6 +89,9 @@ case class Spec(
   private[deployment] def addContainerEnvs(envs: Map[EnvName, EnvValue]): Spec =
     this.copy(template = template.addContainerEnvs(envs))
 
+  private[deployment] def addPersistentVolumes(volumes: Seq[VolumeWithClaim]): Spec =
+    this.copy(template = template.addPersistentVolumes(volumes))
+
   private[deployment] def addContainerCmd(command: Option[NonEmptyString], args: Seq[String]): Spec =
     this.copy(template = template.addContainerCmd(command, args))
 
@@ -105,7 +110,6 @@ case class Spec(
   private[deployment] def withDeploymentStrategy(deploymentStrategy: DeploymentStrategy): Spec =
     this.copy(strategy = deploymentStrategy)
 
-
 }
 
 case class Selector(
@@ -129,8 +133,8 @@ case class Template(metadata: TemplateMetadata, spec: TemplateSpec) {
     this.copy(spec = spec.addContainerPorts(ports))
 
   private[deployment] def annotate(annotations: Map[String, String]): Template = {
-    require(annotations.forall {
-      case (key, value) => key.nonEmpty && value.nonEmpty
+    require(annotations.forall { case (key, value) =>
+      key.nonEmpty && value.nonEmpty
     })
     this.copy(metadata = metadata.copy(annotations = annotations))
   }
@@ -141,6 +145,9 @@ case class Template(metadata: TemplateMetadata, spec: TemplateSpec) {
   private[deployment] def addContainerEnvs(envs: Map[EnvName, EnvValue]): Template =
     this.copy(spec = spec.addContainerEnvs(envs))
 
+  private[deployment] def addPersistentVolumes(volumes: Seq[VolumeWithClaim]): Template =
+    this.copy(spec = spec.addPersistentVolumes(volumes))
+
   private[deployment] def requestResource(resource: Resource): Template =
     this.copy(spec = spec.requestResource(resource))
 
@@ -159,7 +166,7 @@ case class TemplateMetadata(labels: Labels, annotations: Map[String, String])
 
 case class HostAlias(ip: IPv4, hostnames: List[Host])
 
-case class TemplateSpec(containers: List[Container], hostAliases: List[HostAlias]) {
+case class TemplateSpec(containers: List[Container], volumes: List[Volume], hostAliases: List[HostAlias]) {
 
   private[deployment] def addContainerPorts(ports: List[Port]): TemplateSpec =
     this.copy(containers = containers.map { container =>
@@ -172,6 +179,12 @@ case class TemplateSpec(containers: List[Container], hostAliases: List[HostAlias
   private[deployment] def addContainerEnvs(envs: Map[EnvName, EnvValue]): TemplateSpec =
     this.copy(containers = containers.map(_.addEnvs(envs)))
 
+  private[deployment] def addPersistentVolumes(volumesWithClaim: Seq[VolumeWithClaim]): TemplateSpec =
+    this.copy(
+      containers = containers.map(_.withVolumeMounts(volumesWithClaim.map(vwc => VolumeMount(vwc.mountPath, vwc.name)))),
+      volumes = volumesWithClaim.map(vwc => Volume(vwc.name, PersistentVolumeClaim(vwc.claimName))).toList
+    )
+
   private[deployment] def requestResource(resource: Resource): TemplateSpec =
     this.copy(containers = containers.map(_.requestResource(resource)))
 
@@ -196,6 +209,7 @@ case class Container(
   livenessProbe: Probe,
   readinessProbe: Probe,
   env: Map[EnvName, EnvValue],
+  volumeMounts: Seq[VolumeMount],
   resources: Resources = Resources()
 ) {
 
@@ -219,6 +233,9 @@ case class Container(
   private[deployment] def withResources(limits: Resource, requests: Resource): Container =
     this.copy(resources = resources.copy(limits = limits, requests = requests))
 
+  private[deployment] def withVolumeMounts(volumeMounts: Seq[VolumeMount]): Container =
+    this.copy(volumeMounts = volumeMounts)
+
 }
 
 case class Resources(
@@ -247,6 +264,13 @@ case class Memory(value: Int) {
   require(value > 0)
 }
 
+case class VolumeWithClaim(name: String, claimName: String, mountPath: String)
+
+case class VolumeMount(mountPath: String, name: String)
+
+case class PersistentVolumeClaim(claimName: String)
+case class Volume(name: String, persistentVolumeClaim: PersistentVolumeClaim)
+
 case class EnvName(value: NonEmptyString)
 sealed trait EnvValue
 case class EnvRawValue(value: String) extends EnvValue

src/main/scala/kubeyml/deployment/api/package.scala

@@ -29,7 +29,7 @@ package object api {
     EmptyDeployment
 
   implicit def toNonEmptyString(value: String): NonEmptyString = {
-    require(!value.isEmpty)
+    require(value.nonEmpty)
     NonEmptyString(value)
   }
 
@@ -53,7 +53,7 @@ package object api {
   }
 
   implicit final class DockerisedAppDeploymentOps(val dockerisedAppDeployment: DockerisedAppDeployment) extends AnyVal {
-    import dockerisedAppDeployment._
+    import dockerisedAppDeployment.*
 
     def withProbes(livenessProbe: Probe, readinessProbe: Probe): Deployment = Deployment(
       metadata = DeploymentMetadata(name = dockerisedAppDeployment.service, namespace = namespace),
@@ -76,9 +76,11 @@ package object api {
                 IfNotPresent,
                 livenessProbe,
                 readinessProbe,
-                Map.empty
+                Map.empty,
+                Seq.empty
               )
             ),
+            List.empty,
             List.empty
           )
         ),
@@ -93,7 +95,7 @@ package object api {
 
     def replicas(number: Int): Deployment = deployment.copy(spec = deployment.spec.copy(replicas = number))
 
-    def annotateTemplate(annotations: Map[String, String]) = deployment.annotateSpecTemplate(annotations)
+    def annotateTemplate(annotations: Map[String, String]): Deployment = deployment.annotateSpecTemplate(annotations)
 
     def envFromSecret(variableName: String, name: String, key: String): Deployment =
       deployment.addEnv(Map(EnvName(variableName) -> EnvSecretValue(name, key)))

src/main/scala/kubeyml/deployment/json_support.scala

@@ -42,11 +42,11 @@ object json_support {
 
   implicit val deploymentStrategyEncoder: Encoder[DeploymentStrategy] = Encoder.instance {
     case r: RollingUpdate => rollingUpdateEncoder.apply(r)
-    case Recreate => Json.obj("type" -> "Recreate".asJson)
+    case Recreate         => Json.obj("type" -> "Recreate".asJson)
   }
 
-  implicit val containerCmdEncoder: Encoder[Command] = Encoder.instance {
-    case Command(cmd) => Seq(cmd).asJson
+  implicit val containerCmdEncoder: Encoder[Command] = Encoder.instance { case Command(cmd) =>
+    Seq(cmd).asJson
   }
 
   implicit val imagePullPolicyEncoder: Encoder[ImagePullPolicy] = Encoder.instance {
@@ -127,20 +127,19 @@ object json_support {
 
   implicit val environmentVariablesEncoder: Encoder[Map[EnvName, EnvValue]] = Encoder
     .encodeList[EnvVarDefinition]
-    .contramap(_.toList.map {
-      case (name, value) => EnvVarDefinition(name.value, value)
+    .contramap(_.toList.map { case (name, value) =>
+      EnvVarDefinition(name.value, value)
     })
 
-  implicit val templateSpecEncoder: Encoder[TemplateSpec] = Encoder.instance(
-    ts =>
-      Json.obj(
-        Seq(
-          "containers" -> ts.containers.asJson
-        ) ++ addIfNonEmpty(ts.hostAliases, "hostAliases"): _*
-      )
+  implicit val templateSpecEncoder: Encoder[TemplateSpec] = Encoder.instance(ts =>
+    Json.obj(
+      Seq(
+        "containers" -> ts.containers.asJson
+      ) ++ (addIfNonEmpty(ts.hostAliases, "hostAliases") ++ addIfNonEmpty(ts.volumes, "volumes")): _*
+    )
   )
 
-  private def addIfNonEmpty(aliases: List[HostAlias], key: String): Seq[(String, Json)] =
+  private def addIfNonEmpty[A](aliases: List[A], key: String)(implicit encoder: Encoder[A]): Seq[(String, Json)] =
     if (aliases.isEmpty)
       Seq.empty
     else

src/main/scala/kubeyml/deployment/plugin/Keys.scala

@@ -47,6 +47,8 @@ trait Keys {
   val command = settingKey[Option[NonEmptyString]]("Command for the container")
   val args = settingKey[Seq[String]]("arguments for the container")
 
+  val persistentVolumes = settingKey[Seq[VolumeWithClaim]]("Persistent volume for the container")
+
   val imagePullPolicy = settingKey[ImagePullPolicy]("Pull policy of docker image")
   val deployment = settingKey[Deployment]("The kubernetes deployment description")
 
@@ -76,6 +78,7 @@ object Keys extends Keys {
     annotations := Map.empty,
     replicas := 2,
     envs := Map.empty,
+    persistentVolumes := Seq.empty,
     resourceRequests := Resources().requests,
     resourceLimits := Resources().limits,
     command := None,
@@ -95,6 +98,7 @@ object Keys extends Keys {
         .addCommand(kubeSetting(command).value, kubeSetting(args).value)
         .replicas(kubeSetting(replicas).value)
         .addEnv(kubeSetting(envs).value)
+        .addPersistentVolumes(kubeSetting(persistentVolumes).value)
         .resources(kubeSetting(resourceLimits).value, kubeSetting(resourceRequests).value)
         .pullPolicy(kubeSetting(imagePullPolicy).value)
   )

src/main/scala/kubeyml/plugin/package.scala

@@ -29,9 +29,9 @@ import io.circe.yaml.syntax._
 
 package object plugin {
 
-  private[kubeyml] def writePlan[A](a: A, buildTarget: File, kind: String)(implicit encoder: Encoder[A]) = {
+  private[kubeyml] def writePlan[A](a: A, buildTarget: File, kind: String)(implicit encoder: Encoder[A]): Unit = {
     buildTarget.mkdirs()
-    val file = new File(buildTarget, s"${kind}.yml")
+    val file = new File(buildTarget, s"$kind.yml")
     val printWriter = new PrintWriter(file)
     try {
       printWriter.println(a.asJson.asYaml.spaces4)
@@ -41,8 +41,9 @@ package object plugin {
   }
 
   private[kubeyml] def writePlansInSingle[A, B](a: A, b: B, buildTarget: File, kind: String)(implicit
-                                              encoderA: Encoder[A], encoder: Encoder[B]
-  ) = {
+    encoderA: Encoder[A],
+    encoder: Encoder[B]
+  ): Unit = {
     buildTarget.mkdirs()
     val file = new File(buildTarget, s"${kind}.yml")
     val printWriter = new PrintWriter(file)