feat: support Jackson 3.x

Author: gaeljw

CHANGELOG.md

@@ -11,6 +11,9 @@ See also the [CHANGELOG](https://github.com/cucumber/cucumber-jvm/blob/master/CH
 
 ### Added
 
+- [Scala] Support for Jackson 3.x with `Jackson3DefaultDataTableEntryTransformer` trait
+ - Jackson 2.x is still supported with `JacksonDefaultDataTableEntryTransformer` trait
+
 ### Changed
 
 ### Deprecated

build.sbt

@@ -42,6 +42,7 @@ scalaVersion := scala213
 
 val cucumberVersion = "7.30.0"
 val jacksonVersion = "2.20.0"
+val jackson3Version = "3.0.0"
 val mockitoScalaVersion = "1.17.45"
 val junit4Version = "4.13.2"
 
@@ -83,7 +84,8 @@ lazy val root = (project in file("."))
  .aggregate(
  cucumberScala.projectRefs ++
  integrationTestsCommon.projectRefs ++
- integrationTestsJackson.projectRefs ++
+ integrationTestsJackson2.projectRefs ++
+ integrationTestsJackson3.projectRefs ++
  integrationTestsPicoContainer.projectRefs ++
  examplesJunit4.projectRefs ++
  examplesJunit5.projectRefs: _*
@@ -99,6 +101,7 @@ lazy val cucumberScala = (projectMatrix in file("cucumber-scala"))
  "io.cucumber" % "cucumber-core" % cucumberVersion,
  // Users have to provide it (for JacksonDefaultDataTableTransformer)
  "com.fasterxml.jackson.module" %% "jackson-module-scala" % jacksonVersion % Provided,
+ "tools.jackson.module" %% "jackson-module-scala" % jackson3Version % Provided,
  "org.junit.jupiter" % "junit-jupiter" % junitBom.key.value % Test,
  ("org.mockito" %% "mockito-scala" % mockitoScalaVersion % Test)
  .cross(CrossVersion.for3Use2_13)
@@ -158,12 +161,12 @@ lazy val integrationTestsCommon =
  .dependsOn(cucumberScala % Test)
  .jvmPlatform(scalaVersions = Seq(scala3, scala213, scala212))
 
-lazy val integrationTestsJackson =
- (projectMatrix in file("integration-tests/jackson"))
+lazy val integrationTestsJackson2 =
+ (projectMatrix in file("integration-tests/jackson2"))
  .settings(commonSettings)
  .settings(junit5SbtSupport)
  .settings(
- name := "integration-tests-jackson",
+ name := "integration-tests-jackson2",
  libraryDependencies ++= Seq(
  "org.junit.platform" % "junit-platform-suite" % junitBom.key.value % Test,
  "io.cucumber" % "cucumber-junit-platform-engine" % cucumberVersion % Test,
@@ -174,6 +177,22 @@ lazy val integrationTestsJackson =
  .dependsOn(cucumberScala % Test)
  .jvmPlatform(scalaVersions = Seq(scala3, scala213, scala212))
 
+lazy val integrationTestsJackson3 =
+ (projectMatrix in file("integration-tests/jackson3"))
+ .settings(commonSettings)
+ .settings(junit5SbtSupport)
+ .settings(
+ name := "integration-tests-jackson3",
+ libraryDependencies ++= Seq(
+ "org.junit.platform" % "junit-platform-suite" % junitBom.key.value % Test,
+ "io.cucumber" % "cucumber-junit-platform-engine" % cucumberVersion % Test,
+ "tools.jackson.module" %% "jackson-module-scala" % jackson3Version % Test
+ ),
+ publishArtifact := false
+ )
+ .dependsOn(cucumberScala % Test)
+ .jvmPlatform(scalaVersions = Seq(scala3, scala213, scala212))
+
 lazy val integrationTestsPicoContainer =
  (projectMatrix in file("integration-tests/picocontainer"))
  .settings(commonSettings)

cucumber-scala/src/main/scala/io/cucumber/scala/Jackson3DefaultDataTableEntryTransformer.scala

@@ -0,0 +1,48 @@
+package io.cucumber.scala
+
+import tools.jackson.databind.ObjectMapper
+import tools.jackson.databind.json.JsonMapper
+import tools.jackson.module.scala.ScalaModule
+
+/** <p>This trait register a `DefaultDataTableEntryTransformer` using Jackson
+ * `ObjectMapper`. </p>
+ *
+ * <p>The `[empty]` string is used as default empty string replacement. You can
+ * override it if you need to.</p>
+ *
+ * <p>Note: Jackson is not included with Cucumber Scala, you have to add the
+ * dependency: `tools.jackson.module:jackson-module-scala` to your project if
+ * you want to use this trait.</p>
+ *
+ * <p>For Jackson 2.x, use `JacksonDefaultDataTableEntryTransformer`
+ * instead.</p>
+ */
+trait Jackson3DefaultDataTableEntryTransformer extends ScalaDsl {
+
+ /** Define the string to be used as replacement for empty. Default is
+ * `[empty]`.
+ */
+ def emptyStringReplacement: String = "[empty]"
+
+ /** Create the Jackson ObjectMapper to be used. Default is a simple JsonMapper
+ * with ScalaModule (including all builtin modules) registered.
+ */
+ def createObjectMapper(): ObjectMapper = {
+ val scalaModule = ScalaModule
+ .builder()
+ .addAllBuiltinModules()
+ .build()
+ JsonMapper.builder().addModule(scalaModule).build()
+ }
+
+ private lazy val objectMapper: ObjectMapper = createObjectMapper()
+
+ DefaultDataTableEntryTransformer(emptyStringReplacement) {
+ (fromValue: Map[String, String], toValueType: java.lang.reflect.Type) =>
+ objectMapper.convertValue[AnyRef](
+ fromValue,
+ objectMapper.constructType(toValueType)
+ )
+ }
+
+}

cucumber-scala/src/main/scala/io/cucumber/scala/JacksonDefaultDataTableEntryTransformer.scala

@@ -10,8 +10,11 @@ import com.fasterxml.jackson.module.scala.DefaultScalaModule
  * override it if you need to.</p>
  *
  * <p>Note: Jackson is not included with Cucumber Scala, you have to add the
- * dependency: `com.fasterxml.jackson.module:jackson-module-scala_2.xx` to your
+ * dependency: `com.fasterxml.jackson.module:jackson-module-scala` to your
  * project if you want to use this trait.</p>
+ *
+ * <p>For Jackson 3.x, use `Jackson3DefaultDataTableEntryTransformer`
+ * instead.</p>
  */
 trait JacksonDefaultDataTableEntryTransformer extends ScalaDsl {
 

docs/build.md

@@ -12,7 +12,8 @@ The project contains several subprojects:
 - `cucumber-scala`: contains the codebase of the Cucumber Scala implementation
 - `integration-tests`: contains integration tests projects
  - `common`: general integration tests
- - `jackson`: Jackson integration specific tests
+ - `jackson2`: Jackson 2.x integration specific tests
+ - `jackson3`: Jackson 3.x integration specific tests
  - `picocontainer`: Picocontainer integration specific tests
 - `examples`: contains a sample project
 

docs/default_jackson_datatable_transformer.md

@@ -6,32 +6,54 @@ It can be used to automatically convert DataTables to case classes without defin
 
 ## Add Jackson dependency
 
+### Jackson 2.x
+
 To use this optional transformer, you need to have Jackson Scala in your dependencies.
 
 ```xml
 <dependency>
  <groupId>com.fasterxml.jackson.module</groupId>
  <artifactId>jackson-module-scala_2.13</artifactId>
- <version>2.13.3</version>
+ <version>2.20.0</version>
  <scope>test</scope>
 </dependency>
 ```
 
 Or:
 ```sbt
-libraryDependencies += "com.fasterxml.jackson.module" %% "jackson-module-scala" % "2.13.3" % Test
+libraryDependencies += "com.fasterxml.jackson.module" %% "jackson-module-scala" % "2.20.0" % Test
 ```
 
-
 The current version of Cucumber Scala has been tested against Jackson Module Scala **version 2.20.0**.
 
+### Jackson 3.x
+
+To use this optional transformer, you need to have Jackson Scala in your dependencies.
+
+```xml
+<dependency>
+ <groupId>tools.jackson.module</groupId>
+ <artifactId>jackson-module-scala_2.13</artifactId>
+ <version>3.0.0</version>
+ <scope>test</scope>
+</dependency>
+```
+
+Or:
+```sbt
+libraryDependencies += "tools.jackson.module" %% "jackson-module-scala" % "3.0.0" % Test
+```
+
+The current version of Cucumber Scala has been tested against Jackson Module Scala **version 3.0.0**.
+
 ## Add the transformer
 
-The transformer has to be added to your glue code by extending the `JacksonDefaultDataTableEntryTransformer` trait.
+The transformer has to be added to your glue code by extending the `JacksonDefaultDataTableEntryTransformer` (Jackson 2.x)
+or `Jackson3DefaultDataTableEntryTransformer` (Jackson 3.x) trait.
 
 For instance:
 ```scala
-class MySteps extends ScalaDsl with EN with JacksonDefaultDataTableEntryTransformer {
+class MySteps extends ScalaDsl with EN with Jackson3DefaultDataTableEntryTransformer {
  // Your usual glue code
 }
 ```