#680 Shade ANTLR for cobol-parser so that it won't clash with Spark's ANTLR runtime.

Also, the shading of dependent libraries is improved for 'sbt assembly'.

Author: yruslan

build.sbt

@@ -61,28 +61,34 @@ lazy val cobrix = (project in file("."))
   .aggregate(cobolParser, cobolConverters, sparkCobol)
 
 lazy val cobolParser = (project in file("cobol-parser"))
+  .enablePlugins(ShadingPlugin)
+  .enablePlugins(AutomateHeaderPlugin)
   .settings(
     name := "cobol-parser",
     libraryDependencies ++= CobolParserDependencies :+ getScalaDependency(scalaVersion.value),
+    shadedDependencies ++= CobolParserShadedDependencies,
+    shadingRules ++= Seq (
+      ShadingRule.moveUnder("org.antlr.v4.runtime", "za.co.absa.cobrix.cobol.parser.shaded")
+    ),
+    validNamespaces ++= Set("za"),
     releasePublishArtifactsAction := PgpKeys.publishSigned.value,
-    assemblySettings
-  )
-  .settings(
+    assemblySettings,
     jacocoReportSettings := commonJacocoReportSettings.withTitle("cobrix:cobol-parser Jacoco Report"),
     jacocoExcludes := commonJacocoExcludes
-  ).enablePlugins(AutomateHeaderPlugin)
+  )
 
 lazy val cobolConverters = (project in file("cobol-converters"))
+  .dependsOn(cobolParser)
   .disablePlugins(sbtassembly.AssemblyPlugin)
+  .enablePlugins(AutomateHeaderPlugin)
   .settings(
     name := "cobol-converters",
     libraryDependencies ++= CobolConvertersDependencies :+ getScalaDependency(scalaVersion.value),
     // No need to publish this artifact since it has test only at the moment
     publishArtifact := false,
     publish := {},
     publishLocal := {}
-  ).dependsOn(cobolParser)
-  .enablePlugins(AutomateHeaderPlugin)
+  )
 
 lazy val sparkCobol = (project in file("spark-cobol"))
   .settings(
@@ -144,7 +150,11 @@ lazy val assemblySettings = Seq(
   assembly / assemblyOption:= (assembly / assemblyOption).value.copy(includeScala = false),
   assembly / assemblyShadeRules:= Seq(
     // Spark may rely on a different version of ANTLR runtime. Renaming the package helps avoid the binary incompatibility
-    ShadeRule.rename("org.antlr.**" -> "za.co.absa.cobrix.shaded.org.antlr.@1").inAll,
+    ShadeRule.rename("org.antlr.**" -> "za.co.absa.cobrix.cobol.parser.shaded.org.antlr.@1").inAll,
+    // Shading all 3rd party libraries used by 'spark-cobol' in order to avoid binary conflicts.
+    ShadeRule.rename("macrocompat.**" -> "za.co.absa.cobrix.spark.cobol.shaded.macrocompat.@1").inAll,
+    ShadeRule.rename("scodec.**" -> "za.co.absa.cobrix.spark.cobol.shaded.scodec.@1").inAll,
+    ShadeRule.rename("shapeless.**" -> "za.co.absa.cobrix.spark.cobol.shaded.shapeless.@1").inAll,
     // The SLF4j API and implementation are provided by Spark
     ShadeRule.zap("org.slf4j.**").inAll
   ),

project/Dependencies.scala

@@ -72,7 +72,7 @@ object Dependencies {
 
   val CobolParserDependencies: Seq[ModuleID] = Seq(
     // compile
-    "org.scodec"   %% "scodec-core"    % scodecCoreVersion,
+    "org.scodec"   %% "scodec-core"    % scodecCoreVersion excludeAll(ExclusionRule(organization = "org.scala-lang")),
     "org.antlr"     % "antlr4-runtime" % antlrValue,
     "org.slf4j"     % "slf4j-api"      % slf4jVersion,
 
@@ -82,6 +82,10 @@ object Dependencies {
     "org.slf4j"      % "slf4j-simple"   % slf4jVersion     % Test
   )
 
+  val CobolParserShadedDependencies: Set[ModuleID] = Set(
+    "org.antlr"      % "antlr4-runtime" % slf4jVersion
+  )
+
   val CobolConvertersDependencies: Seq[ModuleID] = Seq(
     // compile
     "org.slf4j"   % "slf4j-api"         % slf4jVersion,

project/plugins.sbt

@@ -3,6 +3,7 @@ addSbtPlugin("com.github.sbt"    % "sbt-release"   % "1.1.0")
 addSbtPlugin("org.scoverage"     % "sbt-scoverage" % "1.6.0")
 addSbtPlugin("de.heikoseeberger" % "sbt-header"    % "5.2.0")
 addSbtPlugin("com.eed3si9n"      % "sbt-assembly"  % "0.15.0")
+addSbtPlugin("io.get-coursier"   % "sbt-shading"   % "2.1.5")
 
 // sbt-jacoco - workaround related dependencies required to download
 lazy val ow2Version = "9.5"