feat(sbt): 🔨 refactor project structure

Signed-off-by: Felipe Bonezi <[email protected]>
felipebonezi · Oct 22, 2022 · 4fc46d3 · 4fc46d3
1 parent d5e925e
commit 4fc46d3
Show file tree

Hide file tree

Showing 29 changed files with 310 additions and 110 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/workflows/continouos-integration.yml b/.github/workflows/continouos-integration.yml
@@ -37,7 +37,34 @@ jobs:
           path: ${{github.workspace}}/target/scalastyle-report/
 
   build:
-    name: Build & Analyze
+    name: Build
+    if: "(github.event.release || github.event.release.prerelease) == false"
+    needs: [ validate ]
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        distribution: [ 'corretto' ]
+        jdk: [ '8' ]
+        scala: [ '2.12.17', '2.13.10' ]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: ${{ matrix.distribution }}
+          java-version: ${{ matrix.jdk }}
+          cache: 'sbt'
+
+      - name: Perform Build / Test
+        run: sbt ++${{ matrix.scala }} compile test
+
+  optional-build:
+    name: Build (Optional)
     if: "(github.event.release || github.event.release.prerelease) == false"
     continue-on-error: ${{ matrix.experimental }}
     needs: [ validate ]
@@ -47,7 +74,7 @@ jobs:
       fail-fast: true
       matrix:
         distribution: [ 'corretto' ]
-        jdk: [ '8', '11' ]
+        jdk: [ '11' ]
         scala: [ '2.12.17', '2.13.10' ]
         experimental: [ false ]
         include:
@@ -70,6 +97,13 @@ jobs:
       - name: Perform Build / Test
         run: sbt ++${{ matrix.scala }} compile test
 
+  ready:
+    name: Ready to Merge
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Ready to merge!"
+
   publish:
     name: Publish to Sonatype
     if: "github.event.release || github.event.release.prerelease"

diff --git a/build.sbt b/build.sbt
@@ -18,13 +18,13 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-import Common.repoName
+import Common._
 import Dependencies.scala212
 import Dependencies.scala213
 
 lazy val root = project
   .in(file("."))
-  .aggregate(actuator)
+  .aggregate(core, actuator, jdbc, slick, redis)
   .settings(
     name               := "play-actuator-root",
     crossScalaVersions := Nil,
@@ -34,10 +34,20 @@ lazy val root = project
 lazy val core = project
   .in(file("play-actuator-core"))
   .settings(
-    scalaVersion       := scala213,
-    crossScalaVersions := Seq(scala212, scala213),
-    libraryDependencies ++= Dependencies.core,
-    publish / skip := true
+    name                               := s"$repoName-core",
+    organization                       := "io.github.felipebonezi",
+    scalaVersion                       := scala213,
+    crossScalaVersions                 := Seq(scala212, scala213),
+    versionScheme                      := Some("early-semver"),
+    ThisBuild / sonatypeCredentialHost := "s01.oss.sonatype.org",
+    ThisBuild / sonatypeRepository     := "https://s01.oss.sonatype.org/service/local",
+    scmInfo := Some(
+      ScmInfo(
+        url(s"https://github.com/felipebonezi/$repoName/play-actuator-core"),
+        s"scm:git:[email protected]:felipebonezi/$repoName.git"
+      )
+    ),
+    libraryDependencies ++= Dependencies.core
   )
 
 lazy val actuator = project
@@ -57,29 +67,72 @@ lazy val actuator = project
         s"scm:git:[email protected]:felipebonezi/$repoName.git"
       )
     ),
-    Dependencies.actuator,
+    Dependencies.actuator
   )
   .enablePlugins(Common)
 
-lazy val database = project
-  .in(file("play-actuator-indicators/database"))
+lazy val jdbc = project
+  .in(file("play-actuator-indicators/database/jdbc"))
   .dependsOn(core)
   .settings(
-    scalaVersion       := scala213,
-    crossScalaVersions := Seq(scala212, scala213),
-    Dependencies.db,
-    publish / skip := true
+    name                               := s"$jdbcIndicatorName",
+    organization                       := "io.github.felipebonezi",
+    scalaVersion                       := scala213,
+    crossScalaVersions                 := Seq(scala212, scala213),
+    versionScheme                      := Some("early-semver"),
+    ThisBuild / sonatypeCredentialHost := "s01.oss.sonatype.org",
+    ThisBuild / sonatypeRepository     := "https://s01.oss.sonatype.org/service/local",
+    scmInfo := Some(
+      ScmInfo(
+        url(s"https://github.com/felipebonezi/$repoName/play-actuator-indicators/database/jdbc"),
+        s"scm:git:[email protected]:felipebonezi/$repoName.git"
+      )
+    ),
+    Dependencies.jdbc
   )
+  .enablePlugins(Common)
+
+lazy val slick = project
+  .in(file("play-actuator-indicators/database/slick"))
+  .dependsOn(core)
+  .settings(
+    name                               := s"$slickIndicatorName",
+    organization                       := "io.github.felipebonezi",
+    scalaVersion                       := scala213,
+    crossScalaVersions                 := Seq(scala212, scala213),
+    versionScheme                      := Some("early-semver"),
+    ThisBuild / sonatypeCredentialHost := "s01.oss.sonatype.org",
+    ThisBuild / sonatypeRepository     := "https://s01.oss.sonatype.org/service/local",
+    scmInfo := Some(
+      ScmInfo(
+        url(s"https://github.com/felipebonezi/$repoName/play-actuator-indicators/database/slick"),
+        s"scm:git:[email protected]:felipebonezi/$repoName.git"
+      )
+    ),
+    Dependencies.slick
+  )
+  .enablePlugins(Common)
 
 lazy val redis = project
-  .in(file("play-actuator-indicators/redis"))
+  .in(file("play-actuator-indicators/database/redis"))
   .dependsOn(core)
   .settings(
-    scalaVersion       := scala213,
-    crossScalaVersions := Seq(scala212, scala213),
-    Dependencies.redis,
-    publish / skip := true
+    name                               := s"$redisIndicatorName",
+    organization                       := "io.github.felipebonezi",
+    scalaVersion                       := scala213,
+    crossScalaVersions                 := Seq(scala212, scala213),
+    versionScheme                      := Some("early-semver"),
+    ThisBuild / sonatypeCredentialHost := "s01.oss.sonatype.org",
+    ThisBuild / sonatypeRepository     := "https://s01.oss.sonatype.org/service/local",
+    scmInfo := Some(
+      ScmInfo(
+        url(s"https://github.com/felipebonezi/$repoName/play-actuator-indicators/database/redis"),
+        s"scm:git:[email protected]:felipebonezi/$repoName.git"
+      )
+    ),
+    Dependencies.redis
   )
+  .enablePlugins(Common)
 
 addCommandAlias(
   "validateCode",

diff --git a/play-actuator-core/src/main/scala/play/actuator/health/Health.scala b/play-actuator-core/src/main/scala/play/actuator/health/Health.scala
@@ -20,7 +20,11 @@
  */
 package play.actuator.health
 import play.actuator.ActuatorEnum.Status
-import play.api.libs.json.{JsNull, JsNumber, JsString, Json, Writes}
+import play.api.libs.json.JsNull
+import play.api.libs.json.JsNumber
+import play.api.libs.json.JsString
+import play.api.libs.json.Json
+import play.api.libs.json.Writes
 
 case class Health(name: String, status: Status, details: Map[String, Any]) {
   override def toString: String = s"Health(status=$status, details=$details)"

diff --git a/...ealth/indicator/BaseHealthIndicator.scala → ...or/health/indicator/HealthIndicator.scala b/...ealth/indicator/BaseHealthIndicator.scala → ...or/health/indicator/HealthIndicator.scala
@@ -21,7 +21,7 @@
 package play.actuator.health.indicator
 import play.actuator.health.HealthBuilder
 
-abstract class BaseHealthIndicator {
+trait HealthIndicator {
 
   def info(builder: HealthBuilder): Unit
 

diff --git a/play-actuator-indicators/database/jdbc/src/main/resources/reference.conf b/play-actuator-indicators/database/jdbc/src/main/resources/reference.conf
@@ -0,0 +1,11 @@
+play {
+  actuator {
+    indicator {
+      health {
+        database = true
+      }
+    }
+  }
+}
+
+play.modules.enabled += "play.actuator.ActuatorJdbcModule"
diff --git a/.../health/indicator/DatabaseIndicator.scala → ...la/play/actuator/ActuatorJdbcModule.scala b/.../health/indicator/DatabaseIndicator.scala → ...la/play/actuator/ActuatorJdbcModule.scala
@@ -18,7 +18,24 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-package actuator.health.indicator
-import play.actuator.health.indicator.BaseHealthIndicator
+package play.actuator
 
-trait DatabaseIndicator extends BaseHealthIndicator {}
+import com.google.inject.AbstractModule
+import com.google.inject.name.Names
+import play.actuator.health.indicator.DatabaseJdbcIndicator
+import play.actuator.health.indicator.HealthIndicator
+import play.api.Configuration
+import play.api.Environment
+
+class ActuatorJdbcModule(environment: Environment, config: Configuration) extends AbstractModule {
+
+  override def configure(): Unit = {
+    val confKey = "play.actuator.health.indicators.database"
+    if (config.getOptional[Boolean](confKey).getOrElse(false)) {
+      bind(classOf[HealthIndicator])
+        .annotatedWith(Names.named("databaseIndicator"))
+        .to(classOf[DatabaseJdbcIndicator])
+    }
+  }
+
+}
diff --git a/...lth/indicator/DatabaseJdbcIndicator.scala → ...lth/indicator/DatabaseJdbcIndicator.scala b/...lth/indicator/DatabaseJdbcIndicator.scala → ...lth/indicator/DatabaseJdbcIndicator.scala
@@ -18,17 +18,17 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-package actuator.health.indicator
+package play.actuator.health.indicator
 
-import actuator.health.indicator.DatabaseJdbcIndicator.DB_TIMEOUT_SECS
 import play.actuator.ActuatorEnum
 import play.actuator.health.HealthBuilder
+import play.actuator.health.indicator.DatabaseJdbcIndicator.DB_TIMEOUT_SECS
 import play.api.db.Database
 
 import java.sql.Connection
 import javax.inject.Inject
 
-class DatabaseJdbcIndicator @Inject() (database: Database) extends DatabaseIndicator {
+class DatabaseJdbcIndicator @Inject() (database: Database) extends HealthIndicator {
 
   private var connectionRef: Option[Connection] = None
 

diff --git a/play-actuator-indicators/database/redis/src/main/resources/reference.conf b/play-actuator-indicators/database/redis/src/main/resources/reference.conf
@@ -0,0 +1,11 @@
+play {
+  actuator {
+    indicator {
+      health {
+        redis = true
+      }
+    }
+  }
+}
+
+play.modules.enabled += "play.actuator.ActuatorRedisModule"
diff --git a/...actuator-indicators/database/redis/src/main/scala/play/actuator/ActuatorRedisModule.scala b/...actuator-indicators/database/redis/src/main/scala/play/actuator/ActuatorRedisModule.scala
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2022 Felipe Bonezi <https://about.me/felipebonezi>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package play.actuator
+
+import com.google.inject.AbstractModule
+import com.google.inject.name.Names
+import play.actuator.ActuatorEnum.Up
+import play.actuator.health.HealthBuilder
+import play.actuator.health.indicator.HealthIndicator
+import play.actuator.health.indicator.RedisHealthIndicator
+import play.api.Configuration
+import play.api.Environment
+
+class ActuatorRedisModule(environment: Environment, config: Configuration) extends AbstractModule {
+
+  override def configure(): Unit = {
+    val confKey = "play.actuator.health.indicators.redis"
+    if (config.getOptional[Boolean](confKey).getOrElse(false)) {
+      bind(classOf[HealthIndicator])
+        .annotatedWith(Names.named("redisIndicator"))
+        .to(classOf[RedisHealthIndicator])
+    }
+  }
+
+}
diff --git a/...health/indicator/PlayRedisIndicator.scala → ...alth/indicator/RedisHealthIndicator.scala b/...health/indicator/PlayRedisIndicator.scala → ...alth/indicator/RedisHealthIndicator.scala
@@ -18,7 +18,7 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-package actuator.health.indicator
+package play.actuator.health.indicator
 
 import com.typesafe.config.Config
 import play.actuator.ActuatorEnum
@@ -29,10 +29,10 @@ import javax.inject.Inject
 import scala.concurrent.Await
 import scala.concurrent.duration.DurationInt
 
-class PlayRedisIndicator @Inject() (
+class RedisHealthIndicator @Inject() (
     config: Config,
     connector: RedisConnector
-) extends RedisIndicator {
+) extends HealthIndicator {
 
   override def info(builder: HealthBuilder): Unit = {
     if (this.config.getString("play.cache.redis.recovery") != "log-and-fail") {

diff --git a/play-actuator-indicators/database/slick/src/main/resources/reference.conf b/play-actuator-indicators/database/slick/src/main/resources/reference.conf
@@ -0,0 +1,11 @@
+play {
+  actuator {
+    indicator {
+      health {
+        database = true
+      }
+    }
+  }
+}
+
+play.modules.enabled += "play.actuator.ActuatorSlickModule"
diff --git a/...tor/health/indicator/RedisIndicator.scala → ...a/play/actuator/ActuatorSlickModule.scala b/...tor/health/indicator/RedisIndicator.scala → ...a/play/actuator/ActuatorSlickModule.scala
@@ -18,7 +18,24 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-package actuator.health.indicator
-import play.actuator.health.indicator.BaseHealthIndicator
+package play.actuator
 
-trait RedisIndicator extends BaseHealthIndicator {}
+import com.google.inject.AbstractModule
+import com.google.inject.name.Names
+import play.actuator.health.indicator.DatabaseSlickIndicator
+import play.actuator.health.indicator.HealthIndicator
+import play.api.Configuration
+import play.api.Environment
+
+class ActuatorSlickModule(environment: Environment, config: Configuration) extends AbstractModule {
+
+  override def configure(): Unit = {
+    val confKey = "play.actuator.health.indicators.database"
+    if (config.getOptional[Boolean](confKey).getOrElse(false)) {
+      bind(classOf[HealthIndicator])
+        .annotatedWith(Names.named("databaseIndicator"))
+        .to(classOf[DatabaseSlickIndicator])
+    }
+  }
+
+}