Release 0.5.4

Fix TxnInfo bug

Signed-off-by: Gopal S Akshintala <[email protected]>

Author: overfullstack

README.adoc

@@ -18,7 +18,7 @@ endif::[]
 :pmtemplates: src/integrationTest/resources/pm-templates
 :imagesdir: docs/images
 :prewrap!:
-:revoman-version: 0.5.3
+:revoman-version: 0.5.4
 
 '''
 
@@ -409,7 +409,7 @@ The configuration offers methods through which the execution strategy can be con
 [#_pre_step_and_post_step_hooks]
 === Pre-Step and Post-Step Hooks
 
-A hook lets you fiddle with the execution by plugging in your code before or after a Step execution.
+A hook lets you fiddle with the execution by plugging in your custom code before or after a Step execution.
 
 [#_step_picks]
 You can pass a `PreTxnStepPick/PostTxnStepPick` which is a `Predicate` used
@@ -442,9 +442,12 @@ Add them to the config as below:
 )
 ----
 
-You can do things like assertion on the rundown, response validation,
+* You can do things like assertion on the rundown, response validation,
 or even <<#_mutable_environment,mutate the environment>> with a value you programmatically derived,
 such that the execution of later steps picks up those changes.
+* Reserve hooks for plugging in your custom code or asserting and fail-fast in the middle of execution.
+If your assertions can wait till the final rundown,
+it's cleaner to write them after the `revUp()` returns the rundown instead of adding hooks for each step
 
 [#_plug_in_your_java_code_in_between_postman_execution]
 ==== Plug-in your Java code in-between Postman execution

buildSrc/src/main/kotlin/Config.kt

@@ -6,6 +6,6 @@
  * ************************************************************************************************
  */
 const val GROUP_ID = "com.salesforce.revoman"
-const val VERSION = "0.5.3"
+const val VERSION = "0.5.4"
 const val ARTIFACT_ID = "revoman"
 const val STAGING_PROFILE_ID = "1ea0a23e61ba7d"

src/main/kotlin/com/salesforce/revoman/output/postman/PostmanEnvironment.kt

@@ -108,16 +108,18 @@ constructor(
   fun <T : Any> getTypedObj(key: String, objType: Type): T? {
     val value = mutableEnv[key]
     return when {
+      value == null -> null
       objType.rawType.isInstance(value) -> value
       else -> moshiReVoman.asA(moshiReVoman.asFormatString(value as Any), objType.rawType.kotlin)
     }
-      as T
+      as T?
   }
 
   inline fun <reified T : Any> getObj(key: String): T? {
     val value = mutableEnv[key]
-    return when {
-      value is T -> value
+    return when (value) {
+      null,
+      is T -> value
       else -> moshiReVoman.asA(moshiReVoman.asFormatString(value as Any), T::class)
     }
   }

src/main/kotlin/com/salesforce/revoman/output/report/TxnInfo.kt

@@ -33,10 +33,8 @@ constructor(
     typesToIgnore: Set<Class<out Any>> = emptySet(),
   ): T? =
     when {
-      customAdapters.isEmpty() &&
-        customAdaptersWithType.isEmpty() &&
-        typesToIgnore.isEmpty() &&
-        this.txnObjType == Any::class.java -> (txnObjType as? Class<T>)?.cast(txnObj)
+      customAdapters.isEmpty() && customAdaptersWithType.isEmpty() && typesToIgnore.isEmpty() ->
+        (txnObjType as? Class<T>)?.cast(txnObj)
       else ->
         jsonToPojo(
           txnObjType,
@@ -55,10 +53,8 @@ constructor(
     typesToIgnore: Set<Class<out Any>> = emptySet(),
   ): T? =
     when {
-      customAdapters.isEmpty() &&
-        customAdaptersWithType.isEmpty() &&
-        typesToIgnore.isEmpty() &&
-        txnObjType == Any::class.java -> txnObj as? T
+      customAdapters.isEmpty() && customAdaptersWithType.isEmpty() && typesToIgnore.isEmpty() ->
+        txnObj as? T
       else ->
         jsonToPojo(
           T::class.java,

src/test/java/com/salesforce/revoman/output/postman/PostmanEnvironmentTest.java

@@ -9,6 +9,8 @@
 
 import static com.google.common.truth.Truth.assertThat;
 
+import com.squareup.moshi.Types;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import org.junit.jupiter.api.DisplayName;
@@ -34,4 +36,24 @@ void multiLevelFiltering() {
 		assertThat(filteredEnv)
 				.containsExactlyEntriesIn(Map.of("mockTaxAdapterId", "mockTaxAdapterId"));
 	}
+
+	@Test
+	@DisplayName("get Typed Obj")
+	void getTypedObj() {
+		final var env =
+				io.vavr.collection.HashMap.of(
+						"key1", 1, "key2", "2", "key3", List.of(1, 2, 3), "key4", Map.of("4", 4), "key5", null);
+		final var pm = new PostmanEnvironment<>(env.toJavaMap());
+		assertThat(pm.<Integer>getTypedObj("key1", Integer.class)).isEqualTo(env.get("key1").get());
+		assertThat(pm.<String>getTypedObj("key2", String.class)).isEqualTo(env.get("key2").get());
+		assertThat(
+						pm.<List<Integer>>getTypedObj(
+								"key3", Types.newParameterizedType(List.class, Integer.class)))
+				.containsExactlyElementsIn((Iterable<?>) env.get("key3").get());
+		assertThat(
+						pm.<Map<String, Integer>>getTypedObj(
+								"key4", Types.newParameterizedType(Map.class, String.class, Integer.class)))
+				.containsExactlyEntriesIn((Map<?, ?>) env.get("key4").get());
+		assertThat(pm.<Object>getTypedObj("key5", Object.class)).isNull();
+	}
 }

src/test/kotlin/com/salesforce/revoman/output/report/PostmanEnvironmentKtTest.kt

@@ -9,6 +9,9 @@ package com.salesforce.revoman.output.report
 
 import com.salesforce.revoman.input.readFileInResourcesToString
 import com.salesforce.revoman.output.postman.PostmanEnvironment
+import io.kotest.matchers.equals.shouldBeEqual
+import io.kotest.matchers.maps.shouldContainExactly
+import io.kotest.matchers.shouldBe
 import org.junit.jupiter.api.Test
 import org.skyscreamer.jsonassert.JSONAssert
 import org.skyscreamer.jsonassert.JSONCompareMode
@@ -32,4 +35,22 @@ class PostmanEnvironmentKtTest {
       JSONCompareMode.STRICT,
     )
   }
+
+  @Test
+  fun `get Typed Obj`() {
+    val env =
+      mutableMapOf(
+        "key1" to 1,
+        "key2" to "2",
+        "key3" to listOf(1, 2, 3),
+        "key4" to mapOf("4" to 4),
+        "key5" to null,
+      )
+    val pm = PostmanEnvironment<Any?>(env)
+    pm.getObj<Int>("key1")!! shouldBeEqual env["key1"] as Int
+    pm.getObj<String>("key2")!! shouldBeEqual env["key2"] as String
+    pm.getObj<List<Int>>("key3")!! shouldBeEqual env["key3"] as List<Int>
+    pm.getObj<Map<String, Int>>("key4")!! shouldContainExactly env["key4"] as Map<String, Int>
+    pm.getObj<Any>("key5") shouldBe null
+  }
 }