Merge pull request #217 from edvmorango/docker-services

Support for docker-services

Author: eed3si9n

src/main/scala/sbtghactions/GenerativePlugin.scala

@@ -392,6 +392,47 @@ ${indent(rendered.mkString("\n"), 1)}"""
         ""
     }
 
+    val renderedServicesPre = job.services.map{ case JobService(id, image, credentials, env, volumes, ports, options)  =>
+        if (credentials.isEmpty && env.isEmpty && volumes.isEmpty && ports.isEmpty && options.isEmpty) {
+          s"container: ${wrap(image)}"
+        } else {
+          val renderedImage = s"image: ${wrap(image)}"
+
+          val renderedCredentials = credentials match {
+            case Some((username, password)) =>
+              s"\ncredentials:\n${indent(s"username: ${wrap(username)}\npassword: ${wrap(password)}", 1)}"
+
+            case None =>
+              ""
+          }
+
+          val renderedEnv = if (!env.isEmpty)
+            "\n" + compileEnv(env)
+          else
+            ""
+
+          val renderedVolumes = if (!volumes.isEmpty)
+            s"\nvolumes:${compileList(volumes.toList map { case (l, r) => s"$l:$r" }, 1)}"
+          else
+            ""
+
+          val renderedPorts = if (!ports.isEmpty)
+            s"\nports:${compileList(ports.map(_.toString), 1)}"
+          else
+            ""
+
+          val renderedOptions = if (!options.isEmpty)
+            s"\noptions: ${wrap(options.mkString(" "))}"
+          else
+            ""
+
+          s"$id:\n${indent(renderedImage + renderedCredentials + renderedEnv + renderedVolumes + renderedPorts + renderedOptions, 1)}"
+        }
+    }
+
+    val renderedServices = if(renderedServicesPre.isEmpty) ""  else  s"\nservices:\n${indent(renderedServicesPre.mkString("\n"),1)}"
+
+
     val renderedEnvPre = compileEnv(job.env)
     val renderedEnv = if (renderedEnvPre.isEmpty)
       ""
@@ -480,7 +521,7 @@ strategy:${renderedFailFast}
     os:${compileList(job.oses, 3)}
     scala:${compileList(job.scalas, 3)}
     java:${compileList(job.javas.map(_.render), 3)}${renderedMatrices}
-runs-on: ${runsOn}${renderedEnvironment}${renderedContainer}${renderedTimeout}${renderedPerm}${renderedEnv}
+runs-on: ${runsOn}${renderedEnvironment}${renderedContainer}${renderedServices}${renderedTimeout}${renderedPerm}${renderedEnv}
 steps:
 ${indent(job.steps.map(compileStep(_, sbt, job.sbtStepPreamble, declareShell = declareShell)).mkString("\n\n"), 1)}"""
 

src/main/scala/sbtghactions/JobService.scala

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2020-2021 Daniel Spiewak
+ *
+ * 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 sbtghactions
+
+final case class JobService(
+    id: String,
+    image: String,
+    credentials: Option[(String, String)] = None,
+    env: Map[String, String] = Map(),
+    volumes: Map[String, String] = Map(),
+    ports: List[String] = Nil,
+    options: List[String] = Nil
+)

src/main/scala/sbtghactions/WorkflowJob.scala

@@ -37,4 +37,6 @@ final case class WorkflowJob(
     runsOnExtraLabels: List[String] = List(),
     container: Option[JobContainer] = None,
     environment: Option[JobEnvironment] = None,
-    timeout: Option[FiniteDuration] = None)
+    timeout: Option[FiniteDuration] = None,
+    services: List[JobService] = List()
+)

src/test/scala/sbtghactions/GenerativePluginSpec.scala

@@ -231,6 +231,57 @@ class GenerativePluginSpec extends Specification {
         "") mustEqual expected
     }
 
+    "render a simple container with services" in {
+      val expected = header + s"""
+        |name: test5
+        |
+        |on:
+        |  pull_request:
+        |    branches: [main]
+        |  push:
+        |    branches: [main]
+        |
+        |jobs:
+        |  build:
+        |    name: Build and Test
+        |    strategy:
+        |      matrix:
+        |        os: [ubuntu-latest]
+        |        scala: [2.13.10]
+        |        java: [zulu@8]
+        |    runs-on: $${{ matrix.os }}
+        |    services:
+        |      dbservice:
+        |        image: 'someimage:1.0'
+        |        ports: ['20720:20720']
+        |      cacheservice:
+        |        image: 'someimage:3.0'
+        |        ports: ['35720:35720']
+        |    steps:
+        |      - run: echo yikes
+        |""".stripMargin
+
+
+      compileWorkflow(
+          "test5",
+          List("main"),
+          Nil,
+          Paths.None,
+          PREventType.Defaults,
+          None,
+          Map(),
+          List(
+            WorkflowJob(
+              "build",
+              "Build and Test",
+              List(WorkflowStep.Run(List("echo yikes"))),
+              services = List(
+                JobService(id = "dbservice", image = "someimage:1.0", ports = List("20720:20720")),
+                JobService(id = "cacheservice", image = "someimage:3.0", ports = List("35720:35720"))
+                ))),
+          "")  mustEqual expected
+    }
+
     "render a container with all the trimmings" in {
       val expected = header + s"""
         |name: test4