#17: Added support for user defined separators for connection object (#19)

Co-authored-by: jakobbraun <jakob.braun@posteo.de>

Author: morazow

.editorconfig

@@ -8,7 +8,7 @@ charset = utf-8
 indent_size = 2
 end_of_line = lf
 indent_style = space
-max_line_length = 98
+max_line_length = 120
 trim_trailing_whitespace = true
 
 [*.md]

.gitignore

@@ -8,6 +8,9 @@ project/target
 target/
 .history
 .bsp
+.bloop
+.metals
+metals.sbt
 
 # Java
 *.class

doc/changes/changes_0.3.0.md

@@ -1,11 +1,19 @@
-# Import Export UDF Common Scala 0.3.0, released 2021-??-??
+# Import Export UDF Common Scala 0.3.0, released 2021-10-??
 
-Code name:
+Code name: Added custom separators
 
 ## Summary
 
+In this release, we added custom user defined property separators. We also migrated our continuous integration from Travis CI to Github Actions.
+
+## Features
+
+* #17: Added support for user provided separators
+
 ## Refactoring
 
+* #15: Migrated to Github actions
+
 ## Dependency Updates
 
 ### Runtime Dependency Updates
@@ -19,7 +27,7 @@ Code name:
 ### Test Dependency Updates
 
 * Updated `org.mockito:mockito-core:test:3.6.0` to `3.12.4`
-* Updated `org.scalatest:scalatest:test:3.2.2` to `3.2.9`
+* Updated `org.scalatest:scalatest:test:3.2.2` to `3.2.10`
 
 ### Plugin Updates
 
@@ -28,7 +36,7 @@ Code name:
 * Updated `com.timushev.sbt:sbt-updates:0.5.1` to `0.6.0`
 * Updated `com.typesafe.sbt:sbt-git:1.0.0` to `1.0.1`
 * Updated `org.scoverage:sbt-coveralls:1.2.7` to `1.3.1`
-* Updated `org.scoverage:sbt-scoverage:1.6.1` to `1.8.2`
+* Updated `org.scoverage:sbt-scoverage:1.6.1` to `1.9.0`
 * Updated `org.wartremover:sbt-wartremover:2.4.12` to `2.4.16`
 * Updated `org.wartremover:sbt-wartremover-contib:1.3.10` to `1.3.12`
 * Updated `org.xerial.sbt:sbt-sonatype:3.9.4` to `3.9.10`

project/Dependencies.scala

@@ -13,7 +13,7 @@ object Dependencies {
   private val SLF4JSimpleVersion = "1.7.32"
 
   // Test dependencies versions
-  private val ScalaTestVersion = "3.2.9"
+  private val ScalaTestVersion = "3.2.10"
   private val ScalaTestPlusVersion = "1.0.0-M2"
   private val MockitoCoreVersion = "3.12.4"
 

project/plugins.sbt

@@ -16,7 +16,7 @@ addSbtPlugin("com.thoughtworks.sbt-api-mappings" % "sbt-api-mappings" % "3.0.0")
 
 // Adds Scala Code Coverage (Scoverage) used during unit tests
 // http://github.com/scoverage/sbt-scoverage
-addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.8.2")
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.9.0")
 
 // Adds SBT Coveralls plugin for uploading Scala code coverage to
 // https://coveralls.io

src/main/scala/com/exasol/common/AbstractProperties.scala

@@ -1,22 +1,17 @@
 package com.exasol.common
 
-import scala.collection.SortedMap
-
-import com.exasol.{ExaConnectionInformation, ExaMetadata}
+import com.exasol.ExaConnectionInformation
+import com.exasol.ExaMetadata
+import com.exasol.common.CommonConstants._
 
 /**
- * An abstract class that holds the user provided key-value parameters
- * when using the user-defined-functions (UDFs).
+ * An abstract class that holds the user provided key-value parameters when using the user-defined-functions (UDFs).
  *
- * This only represents the raw string key-value pairs. Specific
- * implementations should extends this class to support required UDF
- * key-value parameters.
+ * This only represents the raw string key-value pairs. Specific implementations should extends this class to support
+ * required UDF key-value parameters.
  */
 abstract class AbstractProperties(private val properties: Map[String, String]) {
 
-  /** An optional property key name for the named connection object. */
-  final val CONNECTION_NAME_PROPERTY: String = "CONNECTION_NAME"
-
   /**
    * Checks whether the key-value properties map is empty.
    */
@@ -55,37 +50,29 @@ abstract class AbstractProperties(private val properties: Map[String, String]) {
 
   /** Checks if the Exasol named connection property is provided. */
   final def hasNamedConnection(): Boolean =
-    containsKey(CONNECTION_NAME_PROPERTY)
+    containsKey(CONNECTION_NAME)
+
+  private[this] def getPropertySeparator(): String =
+    get(CONNECTION_PROPERTY_SEPARATOR).fold(CONNECTION_PROPERTY_SEPARATOR_DEFAULT_VALUE)(identity)
+
+  private[this] def getKeyValueAssignment(): String =
+    get(CONNECTION_KEYVALUE_ASSIGNMENT).fold(CONNECTION_KEYVALUE_ASSIGNMENT_DEFAULT_VALUE)(identity)
 
   /**
-   * Parses the connection object password into key-value map pairs.
+   * Parses the connection object password into key-value pairs.
+   *
+   * If the connection object contains the username, it is mapped to the {@code keyForUsername}
+   * parameter. However, this value is overwritten if the provided key is available in password
+   * string of connection object.
    *
-   * If the connection object contains the username, it is mapped to the
-   * {@code keyForUsername} parameter. However, this value is
-   * overwritten if the provided key is available in password string of
-   * connection object.
+   * Users can set also property separators using {@code CONNECTION_SEPARATOR} and {@code
+   * CONNECTION_KEYVALUE_ASSIGNMENT} parameters.
    */
-  final def parseConnectionInfo(
-    keyForUsername: String,
-    exaMetadata: Option[ExaMetadata]
-  ): Map[String, String] = {
+  final def parseConnectionInfo(keyForUsername: String, exaMetadata: Option[ExaMetadata]): Map[String, String] = {
     val connection = getConnectionInformation(exaMetadata)
     val username = connection.getUser()
     val password = connection.getPassword();
-    val map = password
-      .split(";")
-      .map { str =>
-        val idx = str.indexOf('=')
-        if (idx < 0) {
-          throw new IllegalArgumentException(
-            "Connection object password does not contain key=value pairs!"
-          )
-        }
-        str.substring(0, idx).strip().replace("\n", "") ->
-          str.substring(idx + 1).strip().replace("\n", "")
-      }
-      .toMap
-
+    val map = PropertiesParser(getPropertySeparator(), getKeyValueAssignment()).mapFromString(password)
     if (username.isEmpty()) {
       map
     } else {
@@ -94,15 +81,12 @@ abstract class AbstractProperties(private val properties: Map[String, String]) {
   }
 
   /**
-   * Returns an Exasol [[ExaConnectionInformation]] named connection
-   * information.
+   * Returns an Exasol [[ExaConnectionInformation]] named connection information.
    */
-  private[common] final def getConnectionInformation(
-    exaMetadata: Option[ExaMetadata]
-  ): ExaConnectionInformation =
+  private[common] final def getConnectionInformation(exaMetadata: Option[ExaMetadata]): ExaConnectionInformation =
     exaMetadata.fold {
       throw new IllegalArgumentException("Exasol metadata is None!")
-    }(_.getConnection(getString(CONNECTION_NAME_PROPERTY)))
+    }(_.getConnection(getString(CONNECTION_NAME)))
 
   /**
    * Returns the value of the key as a String.
@@ -124,17 +108,14 @@ abstract class AbstractProperties(private val properties: Map[String, String]) {
   /**
    * Returns a string listing of all key-value property pairs.
    *
-   * The resulting string contains key-value pairs in a sorted order by
-   * keys.
+   * The resulting string contains key-value pairs in a sorted order by keys.
    *
-   * @param keyValueSeparator The separator between each key-value pairs
-   * @param propertySeparator The separator between each key-value pair strings
-   * @return The string value of properties with provided separators
+   * @param propertySeparator a separator between each key-value pair strings
+   * @param keyValueAssignment an assignment between each key-value pairs
+   * @return a string value of properties with provided separators
    */
-  final def mkString(keyValueSeparator: String, propertySeparator: String): String =
-    (SortedMap.empty[String, String] ++ properties)
-      .map { case (k, v) => s"$k$keyValueSeparator$v" }
-      .mkString(propertySeparator)
+  final def mkString(propertySeparator: String, keyValueAssignment: String): String =
+    PropertiesParser(propertySeparator, keyValueAssignment).mapToString(properties)
 
   @SuppressWarnings(Array("org.wartremover.warts.Return"))
   // scalastyle:off

src/main/scala/com/exasol/common/CommonConstants.scala

@@ -0,0 +1,9 @@
+package com.exasol.common
+
+object CommonConstants {
+  val CONNECTION_NAME: String = "CONNECTION_NAME"
+  val CONNECTION_PROPERTY_SEPARATOR: String = "CONNECTION_SEPARATOR"
+  val CONNECTION_PROPERTY_SEPARATOR_DEFAULT_VALUE: String = ";"
+  val CONNECTION_KEYVALUE_ASSIGNMENT: String = "CONNECTION_KEYVALUE_ASSIGNMENT"
+  val CONNECTION_KEYVALUE_ASSIGNMENT_DEFAULT_VALUE: String = "="
+}

src/main/scala/com/exasol/common/CommonProperties.scala

@@ -0,0 +1,51 @@
+package com.exasol.common
+
+import scala.collection.SortedMap
+
+/**
+ * A class that reads, serializes and deserializes key value properties to a string.
+ *
+ * For example, given {@code "key1=A;key2=B"} parses to a map of {@code Map('key1' -> 'A', 'key2' -> 'B')}.
+ *
+ * @param propertySeparator a separator for properties
+ * @param keyValueAssignment an assignment for key value pairs
+ */
+final case class PropertiesParser(private val propertySeparator: String, private val keyValueAssignment: String) {
+
+  /**
+   * Parses properly separated input string into key-value properties map.
+   *
+   * @return a map of key value pairs
+   */
+  def mapFromString(string: String): Map[String, String] =
+    string
+      .split(propertySeparator)
+      .map(splitStringToTuple)
+      .toMap
+
+  /**
+   * Deserializes a key-value properties map into a string.
+   *
+   * The resulting string contains key-value pairs in a sorted order by keys.
+   *
+   * @return a string value of properties with provided separators
+   */
+  def mapToString(map: Map[String, String]): String =
+    (SortedMap.empty[String, String] ++ map)
+      .map { case (k, v) => s"$k$keyValueAssignment$v" }
+      .mkString(propertySeparator)
+
+  private[this] def splitStringToTuple(string: String): Tuple2[String, String] = {
+    val idx = string.indexOf(keyValueAssignment)
+    if (idx < 0) {
+      throw new IllegalArgumentException(
+        s"Properties input string does not contain key-value assignment '$keyValueAssignment'."
+      )
+    }
+    stripAndReplace(string.substring(0, idx)) -> stripAndReplace(string.substring(idx + keyValueAssignment.length()))
+  }
+
+  private[this] def stripAndReplace(string: String): String =
+    string.strip().replace("\n", "").replace("\r", "")
+
+}

src/main/scala/com/exasol/common/PropertiesParser.scala

@@ -105,7 +105,7 @@ class AvroComplexTypesTest extends AnyFunSuite {
     val thrown = intercept[IllegalArgumentException] {
       AvroRow(record)
     }
-    assert(thrown.getMessage.contains("Unsupported Avro Array type"))
+    assert(thrown.getMessage().contains("Unsupported Avro Array type"))
   }
 
   test("parse avro map type") {
@@ -195,7 +195,7 @@ class AvroComplexTypesTest extends AnyFunSuite {
     val thrown = intercept[IllegalArgumentException] {
       AvroRow(record)
     }
-    assert(thrown.getMessage.contains("Unsupported Avro Record type"))
+    assert(thrown.getMessage().contains("Unsupported Avro Record type"))
   }
 
 }