#26: Move code into sub package db

README.md

@@ -1,10 +1,19 @@
 # Balta
 
-Scala library to write Postgres DB code tests with
+Balta makes testing DB entities from Scala easier. It's primarily focused on testing the behavior of [Postgres functions](https://www.postgresql.org/docs/current/xfunc.html).
+
+---
+
+### Build Status
+
+[![Build](https://github.com/AbsaOSS/balta/workflows/Build/badge.svg)](https://github.com/AbsaOSS/balta/actions)
+
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.db/balta_2.12/badge.svg)](https://search.maven.org/search?q=g:za.co.absa.db.balta)
+
+---
 
 Balta is a Scala library to help creating database tests, particularly testing Database functions. It is based on the 
-popular [ScalaTest](http://www.scalatest.org/) library and uses [PostgreSQL](https://www.postgresql.org/) as the 
-database engine.
+popular [ScalaTest](http://www.scalatest.org/) library and uses [PostgreSQL](https://www.postgresql.org/) as the database engine.
 
 It's a natural complement to the use of [Fa-Db library](https://github.com/AbsaOSS/fa-db) in applications.
 

balta/src/main/scala/za/co/absa/balta/DBTestSuite.scala → balta/src/main/scala/za/co/absa/db/balta/DBTestSuite.scala

@@ -14,17 +14,17 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta
+package za.co.absa.db.balta
 
 import org.scalactic.source
 import org.scalatest.Tag
 import org.scalatest.funsuite.AnyFunSuite
-import za.co.absa.balta.classes.DBFunction.DBFunctionWithPositionedParamsOnly
-import za.co.absa.balta.classes.setter.{AllowedParamTypes, Params}
-import za.co.absa.balta.classes.setter.Params.{NamedParams, OrderedParams}
-import za.co.absa.balta.classes.{ConnectionInfo, DBConnection, DBFunction, DBTable, QueryResult}
+import za.co.absa.db.balta.classes.DBFunction.DBFunctionWithPositionedParamsOnly
+import classes.setter.{AllowedParamTypes, Params}
+import za.co.absa.db.balta.classes.setter.Params.{NamedParams, OrderedParams}
+import classes.{DBConnection, DBFunction, DBTable, QueryResult}
+import za.co.absa.db.balta.classes.simple.ConnectionInfo
 
-import java.sql.DriverManager
 import java.time.OffsetDateTime
 import java.util.Properties
 
@@ -39,13 +39,7 @@ abstract class DBTestSuite extends AnyFunSuite {
 
   /* the DB connection is ``lazy`, so it actually can be created only when needed and therefore the credentials
   overridden in the successor */
-  protected lazy implicit val dbConnection: DBConnection = {
-    createConnection(
-      connectionInfo.dbUrl,
-      connectionInfo.username,
-      connectionInfo.password
-    )
-  }
+  protected lazy implicit val dbConnection: DBConnection = DBConnection(connectionInfo)
 
   /**
    * This is the connection info for the DB. It can be overridden in the derived classes to provide specific credentials
@@ -152,12 +146,6 @@ abstract class DBTestSuite extends AnyFunSuite {
   }
 
   // private functions
-  private def createConnection(url: String, username: String, password: String): DBConnection = {
-    val conn = DriverManager.getConnection(url, username, password)
-    conn.setAutoCommit(false)
-    new DBConnection(conn)
-  }
-
   private def readConnectionInfoFromConfig = {
     val properties = new Properties()
     properties.load(getClass.getResourceAsStream("/database.properties"))

balta/src/main/scala/za/co/absa/db/balta/classes/DBConnection.scala

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023 ABSA Group Limited
+ *
+ * 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 za.co.absa.db.balta.classes
+
+import za.co.absa.db.balta.classes.simple.ConnectionInfo
+
+import java.sql.{Connection, DriverManager}
+
+class DBConnection(val connection: Connection) extends AnyVal
+
+object DBConnection {
+  def apply(connectionInfo: =>ConnectionInfo): DBConnection = {
+    val connection = DriverManager.getConnection(connectionInfo.dbUrl, connectionInfo.username, connectionInfo.password)
+    connection.setAutoCommit(false)
+    new DBConnection(connection)
+  }
+}

balta/src/main/scala/za/co/absa/balta/classes/DBFunction.scala → balta/src/main/scala/za/co/absa/db/balta/classes/DBFunction.scala

@@ -14,10 +14,11 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes
+package za.co.absa.db.balta.classes
 
-import za.co.absa.balta.classes.DBFunction.{DBFunctionWithNamedParamsToo, DBFunctionWithPositionedParamsOnly, ParamsMap}
-import za.co.absa.balta.classes.setter.{AllowedParamTypes, SetterFnc}
+import DBFunction.{DBFunctionWithNamedParamsToo, DBFunctionWithPositionedParamsOnly, ParamsMap}
+import za.co.absa.db.balta.classes.setter.{AllowedParamTypes, SetterFnc}
+import za.co.absa.db.balta.classes.setter.{AllowedParamTypes, SetterFnc}
 
 import scala.collection.immutable.ListMap
 

balta/src/main/scala/za/co/absa/balta/classes/DBQuerySupport.scala → balta/src/main/scala/za/co/absa/db/balta/classes/DBQuerySupport.scala

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes
+package za.co.absa.db.balta.classes
 
-import za.co.absa.balta.classes.setter.SetterFnc
+import za.co.absa.db.balta.classes.setter.SetterFnc
 
 /**
  * This is a based trait providing the ability to run an SQL query and verify the result via a provided function.

balta/src/main/scala/za/co/absa/balta/classes/DBTable.scala → balta/src/main/scala/za/co/absa/db/balta/classes/DBTable.scala

@@ -14,10 +14,12 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes
+package za.co.absa.db.balta.classes
 
-import za.co.absa.balta.classes.setter.{AllowedParamTypes, Params, SetterFnc}
-import za.co.absa.balta.classes.setter.Params.NamedParams
+import za.co.absa.db.balta.classes.setter.{AllowedParamTypes, Params, SetterFnc}
+import za.co.absa.db.balta.classes.setter.Params.NamedParams
+import za.co.absa.db.balta.classes.setter.Params.NamedParams
+import za.co.absa.db.balta.classes.setter.{AllowedParamTypes, Params}
 
 /**
   * This class represents a database table. It allows to perform INSERT, SELECT and COUNT operations on the table easily.

balta/src/main/scala/za/co/absa/balta/classes/QueryResult.scala → balta/src/main/scala/za/co/absa/db/balta/classes/QueryResult.scala

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes
+package za.co.absa.db.balta.classes
 
 import java.sql.ResultSet
 

balta/src/main/scala/za/co/absa/balta/classes/QueryResultRow.scala → balta/src/main/scala/za/co/absa/db/balta/classes/QueryResultRow.scala

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes
+package za.co.absa.db.balta.classes
 
 import org.postgresql.util.PGobject
+import za.co.absa.db.balta.classes.simple.JsonBString
 
 import java.sql.{Date, ResultSet, Time}
 import java.time.{Instant, OffsetDateTime}

balta/src/main/scala/za/co/absa/balta/classes/setter/AllowedParamTypes.scala → balta/src/main/scala/za/co/absa/db/balta/classes/setter/AllowedParamTypes.scala

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes.setter
+package za.co.absa.db.balta.classes.setter
 
-import za.co.absa.balta.classes.JsonBString
+import za.co.absa.db.balta.classes.simple.JsonBString
 
-import java.time.{Instant, OffsetDateTime, LocalTime, LocalDate}
+import java.time.{Instant, LocalDate, LocalTime, OffsetDateTime}
 import java.util.UUID
 
 /**

balta/src/main/scala/za/co/absa/balta/classes/setter/CustomDBType.scala → balta/src/main/scala/za/co/absa/db/balta/classes/setter/CustomDBType.scala

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes.setter
+package za.co.absa.db.balta.classes.setter
 
 /**
  * This is a case class representing a custom DB type.

balta/src/main/scala/za/co/absa/balta/classes/setter/Params.scala → balta/src/main/scala/za/co/absa/db/balta/classes/setter/Params.scala

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes.setter
+package za.co.absa.db.balta.classes.setter
 
 import scala.collection.immutable.ListMap
 

balta/src/main/scala/za/co/absa/balta/classes/setter/SetterFnc.scala → balta/src/main/scala/za/co/absa/db/balta/classes/setter/SetterFnc.scala

@@ -14,13 +14,12 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta.classes.setter
-
-import za.co.absa.balta.classes.JsonBString
+package za.co.absa.db.balta.classes.setter
 
 import java.sql.{Date, PreparedStatement, Time, Timestamp, Types => SqlTypes}
 import java.util.UUID
 import org.postgresql.util.PGobject
+import za.co.absa.db.balta.classes.simple.JsonBString
 
 import java.time.{Instant, LocalDate, LocalTime, OffsetDateTime, ZoneId, ZoneOffset}
 

balta/src/main/scala/za/co/absa/db/balta/classes/simple/ConnectionInfo.scala

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2023 ABSA Group Limited
+ *
+ * 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 za.co.absa.db.balta.classes.simple
+
+/**
+ * This is a function that sets a parameter of a prepared statement.
+ *
+ * @param dbUrl       - the JDBC URL of the database
+ * @param username    - the username to use when connecting to the database
+ * @param password    - the password to use when connecting to the database
+ * @param persistData - whether to persist the data to the database (usually false for tests, set to true for
+ *                    debugging purposes)
+ */
+case class ConnectionInfo(
+                           dbUrl: String,
+                           username: String,
+                           password: String,
+                           persistData: Boolean
+                         )

balta/src/main/scala/za/co/absa/db/balta/classes/simple/JsonBString.scala

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2023 ABSA Group Limited
+ *
+ * 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 za.co.absa.db.balta.classes.simple
+
+case class JsonBString(value: String) extends AnyVal

balta/src/main/scala/za/co/absa/balta/implicits/package.scala → balta/src/main/scala/za/co/absa/db/balta/implicits/package.scala

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package za.co.absa.balta
+package za.co.absa.db.balta
 
-import za.co.absa.balta.classes.DBConnection
+import za.co.absa.db.balta.classes.DBConnection
 
 import java.sql.Connection
 import scala.language.implicitConversions

build.sbt

@@ -16,8 +16,6 @@
 
 import Dependencies._
 
-ThisBuild / organization := "za.co.absa"
-
 lazy val scala211 = "2.11.12"
 lazy val scala212 = "2.12.18"
 lazy val scala213 = "2.13.11"

publish.sbt

@@ -49,6 +49,8 @@ ThisBuild / developers := List(
   )
 )
 
+ThisBuild / organization := "za.co.absa.db"
+
 ThisBuild / organizationName := "ABSA Group Limited"
 ThisBuild / organizationHomepage := Some(url("https://www.absa.africa"))