#125: Move code into sub-package db (#128)

* moving code into `db` sub-package * tests are not executed in parallel * moved testing classes to own folder
AbsaOSS · Jul 2, 2024 · dcf14b2 · dcf14b2
1 parent d459a60
commit dcf14b2
Show file tree

Hide file tree

Showing 66 changed files with 213 additions and 204 deletions.
diff --git a/.github/workflows/test_filenames_check.yml b/.github/workflows/test_filenames_check.yml
@@ -36,6 +36,6 @@ jobs:
           name-patterns: '*UnitTests.*,*IntegrationTests.*'
           paths: '**/src/test/scala/**'
           report-format: 'console'
-          excludes: 'slick/src/test/scala/za/co/absa/fadb/slick/Actor.scala,slick/src/test/scala/za/co/absa/fadb/slick/ActorSlickConverter.scala,slick/src/test/scala/za/co/absa/fadb/slick/SlickTest.scala,doobie/src/test/scala/za/co/absa/fadb/doobie/DoobieTest.scala,slick/src/test/scala/za/co/absa/fadb/slick/OptionalActorSlickConverter.scala'
+          excludes: '**/src/test/scala/za/co/absa/db/fadb/testing/**'
           verbose-logging: 'false'
           fail-on-violation: 'true'
diff --git a/build.sbt b/build.sbt
@@ -42,12 +42,20 @@ lazy val commonJacocoReportSettings: JacocoReportSettings = JacocoReportSettings
 )
 
 /**
-  * add `za.co.absa.fadb.naming.NamingConvention`  to filter a class
-  * or  `za.co.absa.fadb.naming.NamingConvention*` to filter the class and all related objects
+  * add `za.co.absa.db.fadb.naming.NamingConvention`  to filter a class
+  * or  `za.co.absa.db.fadb.naming.NamingConvention*` to filter the class and all related objects
   */
 lazy val commonJacocoExcludes: Seq[String] = Seq(
 )
 
+lazy val commonSettings = Seq(
+  javacOptions ++= commonJavacOptions,
+  scalacOptions ++= commonScalacOptions,
+  Test / parallelExecution := false,
+  (Compile / compile) := ((Compile / compile) dependsOn printScalaVersion).value, // printScalaVersion is run with compile
+  jacocoExcludes := commonJacocoExcludes
+)
+
 lazy val parent = (project in file("."))
   .aggregate(faDbCore, faDBSlick, faDBDoobie)
   .settings(
@@ -59,42 +67,30 @@ lazy val parent = (project in file("."))
   )
 
 lazy val faDbCore = (project in file("core"))
+  .settings(commonSettings: _*)
   .settings(
     name := "core",
     libraryDependencies ++= coreDependencies(scalaVersion.value),
-    javacOptions ++= commonJavacOptions,
-    scalacOptions ++= commonScalacOptions,
-    (Compile / compile) := ((Compile / compile) dependsOn printScalaVersion).value, // printScalaVersion is run with compile
-  )
-  .settings(
     jacocoReportSettings := commonJacocoReportSettings.withTitle(s"fa-db:core Jacoco Report - scala:${scalaVersion.value}"),
-    jacocoExcludes := commonJacocoExcludes
   )
 
 lazy val faDBSlick = (project in file("slick"))
+  .settings(commonSettings: _*)
   .settings(
     name := "slick",
     libraryDependencies ++= slickDependencies(scalaVersion.value),
-    javacOptions ++= commonJavacOptions,
-    scalacOptions ++= commonScalacOptions,
-    (Compile / compile) := ((Compile / compile) dependsOn printScalaVersion).value, // printScalaVersion is run with compile
-  ).dependsOn(faDbCore)
-  .settings(
     jacocoReportSettings := commonJacocoReportSettings.withTitle(s"fa-db:slick Jacoco Report - scala:${scalaVersion.value}"),
-    jacocoExcludes := commonJacocoExcludes
   )
+  .dependsOn(faDbCore)
 
 lazy val faDBDoobie = (project in file("doobie"))
+  .settings(commonSettings: _*)
   .settings(
     name := "doobie",
     libraryDependencies ++= doobieDependencies(scalaVersion.value),
-    javacOptions ++= commonJavacOptions,
-    scalacOptions ++= commonScalacOptions,
-  ).dependsOn(faDbCore)
-  .settings(
     jacocoReportSettings := commonJacocoReportSettings.withTitle(s"fa-db:doobie Jacoco Report - scala:${scalaVersion.value}"),
-    jacocoExcludes := commonJacocoExcludes
   )
+  .dependsOn(faDbCore)
 
 lazy val flywaySettings = project
   .enablePlugins(FlywayPlugin)

diff --git a/...main/scala/za/co/absa/fadb/DBEngine.scala → ...n/scala/za/co/absa/db/fadb/DBEngine.scala b/...main/scala/za/co/absa/fadb/DBEngine.scala → ...n/scala/za/co/absa/db/fadb/DBEngine.scala
@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
 import cats.Monad
 import cats.implicits.toFunctorOps
-import za.co.absa.fadb.status.FailedOrRow
+import za.co.absa.db.fadb.status.FailedOrRow
 
 import scala.language.higherKinds
 

diff --git a/...in/scala/za/co/absa/fadb/DBFunction.scala → ...scala/za/co/absa/db/fadb/DBFunction.scala b/...in/scala/za/co/absa/fadb/DBFunction.scala → ...scala/za/co/absa/db/fadb/DBFunction.scala
@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
 import cats.MonadError
 import cats.implicits.toFlatMapOps
-import za.co.absa.fadb.status.aggregation.StatusAggregator
-import za.co.absa.fadb.status.handling.StatusHandling
-import za.co.absa.fadb.status.{FailedOrRows, FailedOrRow, Row}
+import za.co.absa.db.fadb.status.aggregation.StatusAggregator
+import za.co.absa.db.fadb.status.handling.StatusHandling
+import za.co.absa.db.fadb.status.{FailedOrRows, FailedOrRow, Row}
 
 import scala.language.higherKinds
 

diff --git a/...la/za/co/absa/fadb/DBFunctionFabric.scala → ...za/co/absa/db/fadb/DBFunctionFabric.scala b/...la/za/co/absa/fadb/DBFunctionFabric.scala → ...za/co/absa/db/fadb/DBFunctionFabric.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
 /**
  *  This trait serves the purpose of introducing functions that are common to all DB Function objects and mix-in traits

diff --git a/...main/scala/za/co/absa/fadb/DBSchema.scala → ...n/scala/za/co/absa/db/fadb/DBSchema.scala b/...main/scala/za/co/absa/fadb/DBSchema.scala → ...n/scala/za/co/absa/db/fadb/DBSchema.scala
@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
-import za.co.absa.fadb.naming.NamingConvention
+import za.co.absa.db.fadb.naming.NamingConvention
 
 /**
  *  An abstract class, an ancestor to represent a database schema
  *  The database name of the schema is derived from the class name based on the provided naming convention
  *  @param schemaNameOverride - in case the class name would not match the database schema name, this gives the
- *  @param namingConvention   - the [[za.co.absa.fadb.naming.NamingConvention NamingConvention]]
+ *  @param namingConvention   - the [[za.co.absa.db.fadb.naming.NamingConvention NamingConvention]]
  *                           prescribing how to convert a class name into a db object name
  */
 abstract class DBSchema(schemaNameOverride: Option[String] = None)(implicit val namingConvention: NamingConvention) {
@@ -46,7 +46,7 @@ abstract class DBSchema(schemaNameOverride: Option[String] = None)(implicit val
 
   /**
    *  Function to convert a class to the associated DB object name, based on the class' name. For transformation from the
-   *  class name to usual db name the schema's [[za.co.absa.fadb.naming.NamingConvention NamingConvention]] is used.
+   *  class name to usual db name the schema's [[za.co.absa.db.fadb.naming.NamingConvention NamingConvention]] is used.
    *  @param c  - class which name to use to get the DB object name
    *  @return   - the db object name
    */

diff --git a/...rc/main/scala/za/co/absa/fadb/Query.scala → ...main/scala/za/co/absa/db/fadb/Query.scala b/...rc/main/scala/za/co/absa/fadb/Query.scala → ...main/scala/za/co/absa/db/fadb/Query.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
-import za.co.absa.fadb.status.{FailedOrRow, Row}
+import za.co.absa.db.fadb.status.{FailedOrRow, Row}
 
 /**
  *  The basis for all query types of [[DBEngine]] implementations

diff --git a/...bsa/fadb/exceptions/NamingException.scala → .../db/fadb/exceptions/NamingException.scala b/...bsa/fadb/exceptions/NamingException.scala → .../db/fadb/exceptions/NamingException.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.exceptions
+package za.co.absa.db.fadb.exceptions
 
 /**
  *  Exception thrown when a naming convention is not found for a given string

diff --git a/...bsa/fadb/exceptions/StatusException.scala → .../db/fadb/exceptions/StatusException.scala b/...bsa/fadb/exceptions/StatusException.scala → .../db/fadb/exceptions/StatusException.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.exceptions
+package za.co.absa.db.fadb.exceptions
 
-import za.co.absa.fadb.status.FunctionStatus
+import za.co.absa.db.fadb.status.FunctionStatus
 
 /**
  *  Represents an exception that is returned when the function status is not successful.

diff --git a/.../fadb/naming/ExplicitNamingRequired.scala → .../fadb/naming/ExplicitNamingRequired.scala b/.../fadb/naming/ExplicitNamingRequired.scala → .../fadb/naming/ExplicitNamingRequired.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.naming
+package za.co.absa.db.fadb.naming
 
-import za.co.absa.fadb.exceptions.NamingException
+import za.co.absa.db.fadb.exceptions.NamingException
 
 /**
  *  `ExplicitNamingRequired` is a `NamingConvention` that throws a `NamingConvention` for any string.

diff --git a/.../za/co/absa/fadb/naming/LettersCase.scala → .../co/absa/db/fadb/naming/LettersCase.scala b/.../za/co/absa/fadb/naming/LettersCase.scala → .../co/absa/db/fadb/naming/LettersCase.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.naming
+package za.co.absa.db.fadb.naming
 
 /**
  *  `LettersCase` is a sealed trait that represents different cases of letters.

diff --git a/...o/absa/fadb/naming/NamingConvention.scala → ...bsa/db/fadb/naming/NamingConvention.scala b/...o/absa/fadb/naming/NamingConvention.scala → ...bsa/db/fadb/naming/NamingConvention.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.naming
+package za.co.absa.db.fadb.naming
 
 /**
  *  `NamingConvention` is a base trait that defines the interface for different naming conventions.

diff --git a/...b/naming/implementations/AsIsNaming.scala → ...b/naming/implementations/AsIsNaming.scala b/...b/naming/implementations/AsIsNaming.scala → ...b/naming/implementations/AsIsNaming.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.naming.implementations
+package za.co.absa.db.fadb.naming.implementations
 
-import za.co.absa.fadb.naming.{LettersCase, NamingConvention}
+import za.co.absa.db.fadb.naming.{LettersCase, NamingConvention}
 import LettersCase.AsIs
 
 /**

diff --git a/...ing/implementations/SnakeCaseNaming.scala → ...ing/implementations/SnakeCaseNaming.scala b/...ing/implementations/SnakeCaseNaming.scala → ...ing/implementations/SnakeCaseNaming.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.naming.implementations
+package za.co.absa.db.fadb.naming.implementations
 
-import za.co.absa.fadb.naming.{LettersCase, NamingConvention}
+import za.co.absa.db.fadb.naming.{LettersCase, NamingConvention}
 import LettersCase.LowerCase
 
 /**

diff --git a/...in/scala/za/co/absa/fadb/status/README.md → ...scala/za/co/absa/db/fadb/status/README.md b/...in/scala/za/co/absa/fadb/status/README.md → ...scala/za/co/absa/db/fadb/status/README.md
diff --git a/...status/aggregation/StatusAggregator.scala → ...status/aggregation/StatusAggregator.scala b/...status/aggregation/StatusAggregator.scala → ...status/aggregation/StatusAggregator.scala
@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.status.aggregation
+package za.co.absa.db.fadb.status.aggregation
 
-import za.co.absa.fadb.exceptions.StatusException
-import za.co.absa.fadb.status.{FailedOrRows, FailedOrRow, Row}
+import za.co.absa.db.fadb.exceptions.StatusException
+import za.co.absa.db.fadb.status.{FailedOrRows, FailedOrRow, Row}
 
 /**
  *  `StatusAggregator` is a base trait that defines the interface for aggregating the error statuses of a function

diff --git a/...ations/ByFirstErrorStatusAggregator.scala → ...ations/ByFirstErrorStatusAggregator.scala b/...ations/ByFirstErrorStatusAggregator.scala → ...ations/ByFirstErrorStatusAggregator.scala
@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.status.aggregation.implementations
+package za.co.absa.db.fadb.status.aggregation.implementations
 
-import za.co.absa.fadb.status.aggregation.StatusAggregator
-import za.co.absa.fadb.status.{FailedOrRows, FailedOrRow}
+import za.co.absa.db.fadb.status.aggregation.StatusAggregator
+import za.co.absa.db.fadb.status.{FailedOrRows, FailedOrRow}
 
 /**
   *  `ByFirstErrorStatusAggregator` is a trait that extends the `StatusAggregator` interface.

diff --git a/...ntations/ByFirstRowStatusAggregator.scala → ...ntations/ByFirstRowStatusAggregator.scala b/...ntations/ByFirstRowStatusAggregator.scala → ...ntations/ByFirstRowStatusAggregator.scala
@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.status.aggregation.implementations
+package za.co.absa.db.fadb.status.aggregation.implementations
 
-import za.co.absa.fadb.status.aggregation.StatusAggregator
-import za.co.absa.fadb.status.{FailedOrRows, FailedOrRow}
+import za.co.absa.db.fadb.status.aggregation.StatusAggregator
+import za.co.absa.db.fadb.status.{FailedOrRows, FailedOrRow}
 
 /**
   *  `ByFirstRowStatusAggregator` is a trait that extends the `StatusAggregator` interface.

diff --git a/...ns/ByMajorityErrorsStatusAggregator.scala → ...ns/ByMajorityErrorsStatusAggregator.scala b/...ns/ByMajorityErrorsStatusAggregator.scala → ...ns/ByMajorityErrorsStatusAggregator.scala
@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.status.aggregation.implementations
+package za.co.absa.db.fadb.status.aggregation.implementations
 
-import za.co.absa.fadb.status.aggregation.StatusAggregator
-import za.co.absa.fadb.status.{FailedOrRows, FailedOrRow}
+import za.co.absa.db.fadb.status.aggregation.StatusAggregator
+import za.co.absa.db.fadb.status.{FailedOrRows, FailedOrRow}
 
 /**
   *  `ByMajorityErrorsStatusAggregator` is a trait that extends the `StatusAggregator` interface.

diff --git a/...fadb/status/handling/StatusHandling.scala → ...fadb/status/handling/StatusHandling.scala b/...fadb/status/handling/StatusHandling.scala → ...fadb/status/handling/StatusHandling.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.status.handling
+package za.co.absa.db.fadb.status.handling
 
-import za.co.absa.fadb.status.{FailedOrRow, Row}
+import za.co.absa.db.fadb.status.{FailedOrRow, Row}
 
 /**
  *  `StatusHandling` is a base trait that defines the interface for handling the status of a function invocation.

diff --git a/...lementations/StandardStatusHandling.scala → ...lementations/StandardStatusHandling.scala b/...lementations/StandardStatusHandling.scala → ...lementations/StandardStatusHandling.scala
@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.status.handling.implementations
+package za.co.absa.db.fadb.status.handling.implementations
 
-import za.co.absa.fadb.exceptions._
-import za.co.absa.fadb.status.{FailedOrRow, Row}
-import za.co.absa.fadb.status.handling.StatusHandling
+import za.co.absa.db.fadb.exceptions._
+import za.co.absa.db.fadb.status.{FailedOrRow, Row}
+import za.co.absa.db.fadb.status.handling.StatusHandling
 
 /**
  *  `StandardStatusHandling` is a trait that extends the `StatusHandling` interface.

diff --git a/...entations/UserDefinedStatusHandling.scala → ...entations/UserDefinedStatusHandling.scala b/...entations/UserDefinedStatusHandling.scala → ...entations/UserDefinedStatusHandling.scala
@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb.status.handling.implementations
+package za.co.absa.db.fadb.status.handling.implementations
 
-import za.co.absa.fadb.exceptions.OtherStatusException
-import za.co.absa.fadb.status.handling.StatusHandling
-import za.co.absa.fadb.status.{FailedOrRow, Row}
+import za.co.absa.db.fadb.exceptions.OtherStatusException
+import za.co.absa.db.fadb.status.handling.StatusHandling
+import za.co.absa.db.fadb.status.{FailedOrRow, Row}
 
 /**
  *  Trait represents user defined status handling

diff --git a/...cala/za/co/absa/fadb/status/package.scala → ...a/za/co/absa/db/fadb/status/package.scala b/...cala/za/co/absa/fadb/status/package.scala → ...a/za/co/absa/db/fadb/status/package.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
-import za.co.absa.fadb.exceptions.StatusException
+import za.co.absa.db.fadb.exceptions.StatusException
 
 package object status {
 

diff --git a/...absa/fadb/DBFunctionFabricUnitTests.scala → ...a/db/fadb/DBFunctionFabricUnitTests.scala b/...absa/fadb/DBFunctionFabricUnitTests.scala → ...a/db/fadb/DBFunctionFabricUnitTests.scala
@@ -1,8 +1,8 @@
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
 import org.scalatest.funsuite.AnyFunSuiteLike
 
-import za.co.absa.fadb.naming.implementations.SnakeCaseNaming.Implicits._
+import za.co.absa.db.fadb.naming.implementations.SnakeCaseNaming.Implicits._
 
 class DBFunctionFabricUnitTests extends AnyFunSuiteLike {
 

diff --git a/...za/co/absa/fadb/DBFunctionUnitTests.scala → ...co/absa/db/fadb/DBFunctionUnitTests.scala b/...za/co/absa/fadb/DBFunctionUnitTests.scala → ...co/absa/db/fadb/DBFunctionUnitTests.scala
@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
 import cats.MonadError
 import cats.implicits._
 import org.scalatest.funsuite.AnyFunSuite
-import za.co.absa.fadb.DBFunction.DBSingleResultFunction
-import za.co.absa.fadb.naming.implementations.SnakeCaseNaming.Implicits.namingConvention
-import za.co.absa.fadb.status.FailedOrRow
+import za.co.absa.db.fadb.DBFunction.DBSingleResultFunction
+import za.co.absa.db.fadb.naming.implementations.SnakeCaseNaming.Implicits.namingConvention
+import za.co.absa.db.fadb.status.FailedOrRow
 
 import scala.concurrent.ExecutionContext.Implicits.global
 import scala.concurrent.Future

diff --git a/...a/za/co/absa/fadb/DBSchemaUnitTests.scala → ...a/co/absa/db/fadb/DBSchemaUnitTests.scala b/...a/za/co/absa/fadb/DBSchemaUnitTests.scala → ...a/co/absa/db/fadb/DBSchemaUnitTests.scala
@@ -13,11 +13,11 @@
  * limitations under the License.
  */
 
-package za.co.absa.fadb
+package za.co.absa.db.fadb
 
 import org.scalatest.funsuite.AnyFunSuite
-import za.co.absa.fadb.naming.NamingConvention
-import za.co.absa.fadb.naming.implementations.SnakeCaseNaming.Implicits.namingConvention
+import za.co.absa.db.fadb.naming.NamingConvention
+import za.co.absa.db.fadb.naming.implementations.SnakeCaseNaming.Implicits.namingConvention
 
 class DBSchemaUnitTests extends AnyFunSuite {