Adding Salesforce tests (#48)

Co-authored-by: Benjamin Gaidioz <[email protected]>

Author: miguelbranco80

.github/workflows/ci.yaml

@@ -33,4 +33,4 @@ jobs:
       options: --user 1001:1001
     steps:
       - uses: actions/checkout@v4
-      - run: sbt clean test
+      - run: sbt clean compile Test/compile

README.md

@@ -5,15 +5,16 @@
 
 ## Options
 
-| Name                  | Description                       | Default | Required |
-|-----------------------|-----------------------------------|---------|----------|
-| `api_version`         | Salesforce API version            |         | Yes      |
-| `username`            | Salesforce username               |         | Yes      |
-| `password`            | Salesforce password               |         | Yes      |
-| `security_token`      | Salesforce security token         |         | Yes      |
-| `client_id`           | Salesforce client id              |         | Yes      |
-| `url`                 | Salesforce URL                    |         | Yes      |
-| `add_dynamic_columns` | Add dynamic columns to the schema | `true`  | No       |
+| Name                  | Description                                  | Default | Required |
+|-----------------------|----------------------------------------------|---------|----------|
+| `api_version`         | Salesforce API version                       |         | Yes      |
+| `username`            | Salesforce username                          |         | Yes      |
+| `password`            | Salesforce password                          |         | Yes      |
+| `security_token`      | Salesforce security token                    |         | Yes      |
+| `client_id`           | Salesforce client id                         |         | Yes      |
+| `url`                 | Salesforce URL                               |         | Yes      |
+| `add_dynamic_columns` | Add dynamic columns to the schema            | `true`  | No       |
+| `dynamic_objects`     | List of dynamic objects to add to the schema |         | No       |
 
 ## How to use
 

build.sbt

@@ -1,15 +1,15 @@
-import com.typesafe.sbt.packager.docker.{Cmd, LayeredMapping}
+import java.nio.file.Paths
+
 import sbt.*
 import sbt.Keys.*
 
-import java.nio.file.Paths
+import com.typesafe.sbt.packager.docker.{Cmd, LayeredMapping}
 
 ThisBuild / credentials += Credentials(
   "GitHub Package Registry",
   "maven.pkg.github.com",
   "raw-labs",
-  sys.env.getOrElse("GITHUB_TOKEN", "")
-)
+  sys.env.getOrElse("GITHUB_TOKEN", ""))
 
 lazy val commonSettings = Seq(
   homepage := Some(url("https://www.raw-labs.com/")),
@@ -19,17 +19,11 @@ lazy val commonSettings = Seq(
   // Use cached resolution of dependencies
   // http://www.scala-sbt.org/0.13/docs/Cached-Resolution.html
   updateOptions := updateOptions.in(Global).value.withCachedResolution(true),
-  resolvers += "RAW Labs GitHub Packages" at "https://maven.pkg.github.com/raw-labs/_"
-)
+  resolvers += "RAW Labs GitHub Packages" at "https://maven.pkg.github.com/raw-labs/_")
 
 lazy val buildSettings = Seq(
   scalaVersion := "2.13.15",
-  javacOptions ++= Seq(
-    "-source",
-    "21",
-    "-target",
-    "21"
-  ),
+  javacOptions ++= Seq("-source", "21", "-target", "21"),
   scalacOptions ++= Seq(
     "-feature",
     "-unchecked",
@@ -38,27 +32,23 @@ lazy val buildSettings = Seq(
     "-Ywarn-dead-code",
     "-Ywarn-macros:after", // Fix for false warning of unused implicit arguments in traits/interfaces.
     "-Ypatmat-exhaust-depth",
-    "160"
-  )
-)
+    "160"))
 
 lazy val compileSettings = Seq(
   Compile / doc / sources := Seq.empty,
   Compile / packageDoc / mappings := Seq(),
   Compile / packageSrc / publishArtifact := true,
   Compile / packageDoc / publishArtifact := false,
   Compile / packageBin / packageOptions += Package.ManifestAttributes(
-    "Automatic-Module-Name" -> name.value.replace('-', '.')
-  ),
+    "Automatic-Module-Name" -> name.value.replace('-', '.')),
   // Ensure Java annotations get compiled first, so that they are accessible from Scala.
-  compileOrder := CompileOrder.JavaThenScala
-)
+  compileOrder := CompileOrder.JavaThenScala)
 
 lazy val testSettings = Seq(
   // Ensuring tests are run in a forked JVM for isolation.
   Test / fork := true,
   // Disabling parallel execution of tests.
-  //Test / parallelExecution := false,
+  // Test / parallelExecution := false,
   // Pass system properties starting with "raw." to the forked JVMs.
   Test / javaOptions ++= {
     import scala.collection.JavaConverters.*
@@ -73,10 +63,8 @@ lazy val testSettings = Seq(
   // Set up heap dump options for out-of-memory errors.
   Test / javaOptions ++= Seq(
     "-XX:+HeapDumpOnOutOfMemoryError",
-    s"-XX:HeapDumpPath=${Paths.get(sys.env.getOrElse("SBT_FORK_OUTPUT_DIR", "target/test-results")).resolve("heap-dumps")}"
-  ),
-  Test / publishArtifact := true
-)
+    s"-XX:HeapDumpPath=${Paths.get(sys.env.getOrElse("SBT_FORK_OUTPUT_DIR", "target/test-results")).resolve("heap-dumps")}"),
+  Test / publishArtifact := true)
 
 val isCI = sys.env.getOrElse("CI", "false").toBoolean
 
@@ -85,31 +73,28 @@ lazy val publishSettings = Seq(
   publish / skip := false,
   publishMavenStyle := true,
   publishTo := Some("GitHub raw-labs Apache Maven Packages" at "https://maven.pkg.github.com/raw-labs/das-salesforce"),
-  publishConfiguration := publishConfiguration.value.withOverwrite(isCI)
-)
+  publishConfiguration := publishConfiguration.value.withOverwrite(isCI))
 
-lazy val strictBuildSettings = commonSettings ++ compileSettings ++ buildSettings ++ testSettings ++ Seq(
-  scalacOptions ++= Seq(
-    "-Xfatal-warnings"
-  )
-)
+lazy val strictBuildSettings =
+  commonSettings ++ compileSettings ++ buildSettings ++ testSettings ++ Seq(scalacOptions ++= Seq("-Xfatal-warnings"))
 
 lazy val root = (project in file("."))
   .settings(
     name := "das-salesforce",
     strictBuildSettings,
     publishSettings,
     libraryDependencies ++= Seq(
+      // DAS
       "com.raw-labs" %% "das-server-scala" % "0.4.1" % "compile->compile;test->test",
       "com.raw-labs" %% "protocol-das" % "1.0.0" % "compile->compile;test->test",
+      // Salesforce client
       "com.frejo" % "force-rest-api" % "0.0.45",
+      // Jackson
       "joda-time" % "joda-time" % "2.12.7",
       "com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.18.2",
       "com.fasterxml.jackson.datatype" % "jackson-datatype-jdk8" % "2.18.2",
       "com.fasterxml.jackson.datatype" % "jackson-datatype-joda" % "2.18.2",
-      "com.fasterxml.jackson.module" %% "jackson-module-scala" % "2.18.2"
-    )
-  )
+      "com.fasterxml.jackson.module" %% "jackson-module-scala" % "2.18.2"))
 
 val amzn_jdk_version = "21.0.4.7-1"
 val amzn_corretto_bin = s"java-21-amazon-corretto-jdk_${amzn_jdk_version}_amd64.deb"
@@ -122,17 +107,16 @@ lazy val dockerSettings = strictBuildSettings ++ Seq(
     "vendor" -> "RAW Labs SA",
     "product" -> "das-salesforce-server",
     "image-type" -> "final",
-    "org.opencontainers.image.source" -> "https://github.com/raw-labs/das-salesforce"
-  ),
+    "org.opencontainers.image.source" -> "https://github.com/raw-labs/das-salesforce"),
   Docker / daemonUser := "raw",
   dockerExposedVolumes := Seq("/var/log/raw"),
   dockerExposedPorts := Seq(50051),
   dockerEnvVars := Map("PATH" -> s"${(Docker / defaultLinuxInstallLocation).value}/bin:$$PATH"),
   // We remove the automatic switch to USER 1001:0.
   // We we want to run as root to install the JDK, also later we will switch to a non-root user.
   dockerCommands := dockerCommands.value.filterNot {
-    case Cmd("USER", args@_*) => args.contains("1001:0")
-    case cmd => false
+    case Cmd("USER", args @ _*) => args.contains("1001:0")
+    case cmd                    => false
   },
   dockerCommands ++= Seq(
     Cmd(
@@ -145,13 +129,8 @@ lazy val dockerSettings = strictBuildSettings ++ Seq(
       && dpkg --install $amzn_corretto_bin \\
       && rm -f $amzn_corretto_bin \\
       && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \\
-          wget gnupg software-properties-common"""
-    ),
-    Cmd(
-      "USER",
-      "raw"
-    )
-  ),
+          wget gnupg software-properties-common"""),
+    Cmd("USER", "raw")),
   dockerEnvVars += "LANG" -> "C.UTF-8",
   dockerEnvVars += "JAVA_HOME" -> "/usr/lib/jvm/java-21-amazon-corretto",
   Compile / doc / sources := Seq.empty, // Do not generate scaladocs
@@ -165,11 +144,11 @@ lazy val dockerSettings = strictBuildSettings ++ Seq(
       case ClasspathPattern(classpath) => s"""
                                              |declare -r app_classpath="$${app_home}/../conf:$classpath"
                                              |""".stripMargin
-      case _@entry => entry
+      case _ @entry => entry
     }
   },
   Docker / dockerLayerMappings := (Docker / dockerLayerMappings).value.map {
-    case lm@LayeredMapping(Some(1), file, path) => {
+    case lm @ LayeredMapping(Some(1), file, path) => {
       val fileName = java.nio.file.Paths.get(path).getFileName.toString
       if (!fileName.endsWith(".jar")) {
         // If it is not a jar, put it on the top layer. Configuration files and other small files.
@@ -182,7 +161,7 @@ lazy val dockerSettings = strictBuildSettings ++ Seq(
         lm
       }
     }
-    case lm@_ => lm
+    case lm @ _ => lm
   },
   Compile / mainClass := Some("com.rawlabs.das.server.DASServer"),
   Docker / dockerAutoremoveMultiStageIntermediateImages := false,
@@ -193,22 +172,15 @@ lazy val dockerSettings = strictBuildSettings ++ Seq(
     val baseAlias = dockerAlias.value.withRegistryHost(Some(devRegistry))
 
     releaseRegistry match {
-      case Some(releaseReg) => Seq(
-        baseAlias,
-        dockerAlias.value.withRegistryHost(Some(releaseReg))
-      )
-      case None => Seq(baseAlias)
+      case Some(releaseReg) => Seq(baseAlias, dockerAlias.value.withRegistryHost(Some(releaseReg)))
+      case None             => Seq(baseAlias)
     }
-  }
-)
+  })
 
 lazy val docker = (project in file("docker"))
-  .dependsOn(
-    root % "compile->compile;test->test"
-  )
+  .dependsOn(root % "compile->compile;test->test")
   .enablePlugins(JavaAppPackaging, DockerPlugin)
   .settings(
     strictBuildSettings,
     dockerSettings,
-    libraryDependencies += "com.raw-labs" %% "das-server-scala" % "0.4.1" % "compile->compile;test->test"
-  )
+    libraryDependencies += "com.raw-labs" %% "das-server-scala" % "0.4.1" % "compile->compile;test->test")

project/plugins.sbt

@@ -8,6 +8,8 @@ libraryDependencies += "commons-io" % "commons-io" % "2.11.0"
 
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.0")
 
+addSbtPlugin("nl.gn0s1s" % "sbt-dotenv" % "3.1.1")
+
 addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.10.4")
 
 addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0")

src/main/scala/com/rawlabs/das/salesforce/DASSalesforceConnector.scala

@@ -36,13 +36,26 @@ class DASSalesforceConnector(options: Map[String, String]) extends StrictLogging
     registerModule(DefaultScalaModule)
   }
 
-  private val apiConfig = new ApiConfig()
-    .setApiVersionString(options("api_version"))
-    .setUsername(options("username"))
-    .setPassword(options("password") + options("security_token"))
-    .setClientId(options("client_id"))
-    .setForceURL(options("url"))
-    .setObjectMapper(jsonMapper)
+  private val apiVersion = {
+    val v = options.getOrElse("api_version", throw new DASSdkInvalidArgumentException("api_version is required"))
+    if (v.startsWith("v")) v else s"v$v"
+  }
+
+  private val apiConfig = {
+    val userName = options.getOrElse("username", throw new DASSdkInvalidArgumentException("username is required"))
+    val password = options.getOrElse("password", throw new DASSdkInvalidArgumentException("password is required"))
+    val securityToken =
+      options.getOrElse("security_token", throw new DASSdkInvalidArgumentException("security_token is required"))
+    val clientId = options.getOrElse("client_id", throw new DASSdkInvalidArgumentException("client_id is required"))
+    val url = options.getOrElse("url", throw new DASSdkInvalidArgumentException("url is required"))
+    new ApiConfig()
+      .setApiVersionString(apiVersion)
+      .setUsername(userName)
+      .setPassword(password + securityToken)
+      .setClientId(clientId)
+      .setForceURL(url)
+      .setObjectMapper(jsonMapper)
+  }
 
   private val forceApi: ForceApi =
     withSalesforceException {