Release 0.5.3

- Move `postmanEnvJSONFormat()` to PostmanEnvironment
- Add `getTypedObj()` to PostmanEnvironment
- Add infix overload for `getTypedTxnObj()` in TxnInfo

Signed-off-by: Gopal S Akshintala <gopala.akshintala@salesforce.com>

Author: overfullstack

README.adoc

@@ -18,7 +18,7 @@ endif::[]
 :pmtemplates: src/integrationTest/resources/pm-templates
 :imagesdir: docs/images
 :prewrap!:
-:revoman-version: 0.5.2
+:revoman-version: 0.5.3
 
 '''
 
@@ -304,7 +304,7 @@ assertThat(pqRundown.mutableEnv)
 <7> <<Execution Control>>
 <8> <<#_type_safety_with_flexible_json_pojo_marshallingserialization_and_unmarshallingdeserialization, Request Config>>
 <9> <<#_type_safety_with_flexible_json_pojo_marshallingserialization_and_unmarshallingdeserialization, Response Config>>
-<10> <<#_pre_and_post_step_hooks>>
+<10> <<#_pre_step_and_post_step_hooks>>
 <11> <<Response Validations>>
 <12> <<#_type_safety_with_flexible_json_pojo_marshallingserialization_and_unmarshallingdeserialization, Global Custom Type Adapters>>
 <13> Ignore Java cert issues when firing HTTP calls
@@ -327,7 +327,7 @@ include::{integrationtestdir}/com/salesforce/revoman/integration/core/pq/PQE2EWi
 <7> <<Execution Control>>
 <8> <<#_type_safety_with_flexible_json_pojo_marshallingserialization_and_unmarshallingdeserialization, Request Config>>
 <9> <<#_type_safety_with_flexible_json_pojo_marshallingserialization_and_unmarshallingdeserialization, Response Config>>
-<10> <<#_pre_and_post_step_hooks>>
+<10> <<#_pre_step_and_post_step_hooks>>
 <11> <<Response Validations>>
 <12> <<#_type_safety_with_flexible_json_pojo_marshallingserialization_and_unmarshallingdeserialization, Global Custom Type Adapters>>
 <13> Ignore Java cert issues when firing HTTP calls
@@ -406,33 +406,45 @@ The configuration offers methods through which the execution strategy can be con
 * `runOnlySteps`, `skipSteps` — All these accept a `predicate` of type `ExeStepPick`, which is invoked passing the current `Step` instance to decide whether to execute or skip a step.
 ** There are some `ExeStepPick` predicates bundled with ReṼoman under `ExeStepPick.PickUtils` e.g `withName`, `inFolder` etc. You can write a custom predicate of your own too.
 
-[#_pre_and_post_step_hooks]
-=== Pre- and Post-Step Hooks
+[#_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.
 
 [#_step_picks]
-You can pass a `PreTxnStepPick/PostTxnStepPick` which is a `Predicate` used to qualify a step for Pre-/Post-Hook respectively. ReṼoman comes bundled with some predicates under the namespace `PreTxnStepPick.PickUtils/PostTxnStepPick.PickUtils` e.g `beforeStepContainingURIPathOfAny`, `afterStepName` etc. If those don't fit your needs, you can write your own custom predicates too.
+You can pass a `PreTxnStepPick/PostTxnStepPick` which is a `Predicate` used
+to qualify a step for Pre-Step/Post-Step Hook respectively.
+ReṼoman comes
+bundled with some predicates under the namespace `PreTxnStepPick.PickUtils`/`PostTxnStepPick.PickUtils` e.g `beforeStepContainingURIPathOfAny`,
+`afterStepName` etc. If those don't fit your needs, you can write your own custom predicates like below:
+
+[source,java,indent=0,options="nowrap"]
+----
+final var preTxnStepPick = (currentStep, requestInfo, rundown) -> LOGGER.info("Picked `preLogHook` before stepName: {}", currentStep)
+final var postTxnStepPick = (stepReport, rundown) -> LOGGER.info("Picked `postLogHook` after stepName: {}", stepReport.step.displayName)
+----
+
+Add them to the config as below:
 
 [source,java,indent=0,options="nowrap"]
 ----
 .hooks(
 	pre(
-			PreTxnStepPick,
+			preTxnStepPick,
 			(currentStepName, requestInfo, rundown) -> {
-				//...callback-code...
+				//...code...
 			}),
 	post(
-			PostTxnStepPick,
+			postTxnStepPick,
 			(currentStepName, rundown) -> {
-				//...callback-code...
+				//...code...
 			})
 )
 ----
 
 You can do things like assertion on the rundown, response validation,
-or environment and even <<#_mutable_environment,mutate the environment>>,
-such that the execution of subsequent steps picks up those changes.
+or even <<#_mutable_environment,mutate the environment>> with a value you programmatically derived,
+such that the execution of later steps picks up those changes.
 
 [#_plug_in_your_java_code_in_between_postman_execution]
 ==== Plug-in your Java code in-between Postman execution
@@ -465,7 +477,7 @@ so the later steps can pick up value for `+{{xyzId}}+` variable from the environ
 npm install moment
 ----
 
-.Use inside pre- / post-script
+.Use inside pre-req and post-res scripts
 [source,javascript,indent=0,options="nowrap"]
 ----
 var moment = require("moment");
@@ -491,12 +503,12 @@ CAUTION: The recommendation is not to add too much code in <<Pre-req and Post-re
 === Mutable Environment
 
 * Environment is the only mutable-shared state across step executions, which can be used for data passing between the consumer and the library.
-* This can be mutated (set key-value pairs) through <<Pre-req and Post-res scripts>> (using `pm.environment.set()`) and <<#_pre_and_post_step_hooks,Pre-/Post-Hooks>> (using the reference `rundown.mutableEnv`) during execution.
+* This can be mutated (set key-value pairs) through <<Pre-req and Post-res scripts>> (using `pm.environment.set()`) and <<#_pre_step_and_post_step_hooks,Pre-/Post-Hooks>> (using the reference `rundown.mutableEnv`) during execution.
 
 ==== Read Mutable Environment as Postman Environment JSON format
 
 You may want to troubleshoot manually with Postman using the Mutable environment built during the ReṼoman execution.
-`rundown.envInPostmanEnvJSONFormat()` converts the mutable environment into a Postman JSON format,
+`rundown.mutableEnv.postmanEnvJSONFormat()` converts the mutable environment into a Postman JSON format,
 so you can copy and import that conveniently into Postman.
 
 ==== `pmEnvSnapshot` in each StepReport
@@ -568,13 +580,13 @@ The future looks bright with multiple impactful features in the pipeline:
 
 === How to Debug a step in the middle of an Execution?
 
-* You can add a <<#_pre_and_post_step_hooks,pre-hook>> to the Step you are interested and add a debug point inside that. This gets hit before ReṼoman fires the request in that Step
+* You can add a <<#_pre_step_and_post_step_hooks,pre-hook>> to the Step you are interested and add a debug point inside that. This gets hit before ReṼoman fires the request in that Step
 * You can get more adventurous by attaching revoman jar sources and directly adding conditional debug points inside this library source-code. You can search for logs in the source-code that indicate key operations to add conditional debug points with conditions like StepName etc.
 
 === Is there a way to add Metadata to a Postman collection Step?
 
 * You can add key-value pairs to a Step's HTTP Headers section (e.g., `ignoreHTTPStatusUnsuccessful=true`).
-* You can use this information in <<#_step_picks,Step Picks>> or <<#_pre_and_post_step_hooks>> to identify a particular step to execute any conditional logic
+* You can use this information in <<#_step_picks,Step Picks>> or <<#_pre_step_and_post_step_hooks>> to identify a particular step to execute any conditional logic
 
 === Do I need to migrate all my existing TestUtils to Postman Collections?
 

buildSrc/src/main/kotlin/Config.kt

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

src/main/kotlin/com/salesforce/revoman/ReVoman.kt

@@ -121,7 +121,7 @@ object ReVoman {
       )
     val stepNameToReport =
       executeStepsSerially(pmStepsDeepFlattened, kick, moshiReVoman, regexReplacer, pm)
-    return Rundown(stepNameToReport, pm.environment, kick.haltOnFailureOfTypeExcept(), moshiReVoman)
+    return Rundown(stepNameToReport, pm.environment, kick.haltOnFailureOfTypeExcept())
   }
 
   private fun executeStepsSerially(
@@ -140,20 +140,11 @@ object ReVoman {
         logger.info { "***** Executing Step: $step *****" }
         val itemWithRegex = step.rawPMStep
         val preStepReport =
-          StepReport(
-            step,
-            Right(TxnInfo(httpMsg = itemWithRegex.request.toHttpRequest())),
-            moshiReVoman = moshiReVoman,
-          )
+          StepReport(step, Right(TxnInfo(httpMsg = itemWithRegex.request.toHttpRequest())))
         pm.info = Info(step.name)
         pm.currentStepReport = preStepReport
         pm.rundown =
-          Rundown(
-            stepReports + preStepReport,
-            pm.environment,
-            kick.haltOnFailureOfTypeExcept(),
-            moshiReVoman,
-          )
+          Rundown(stepReports + preStepReport, pm.environment, kick.haltOnFailureOfTypeExcept())
         pm.environment.putAll(regexReplacer.replaceVariablesInEnv(pm))
         val currentStepReport: StepReport = // --------### PRE-REQ-JS ###--------
           executePreReqJS(step, itemWithRegex, pm)

src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallRequest.kt

@@ -35,7 +35,7 @@ internal fun unmarshallRequest(
     kick
       .requestConfig()
       .firstOrNull {
-        it.preTxnStepPick.pick(currentStep, TxnInfo(null, null, httpRequest), pm.rundown)
+        it.preTxnStepPick.pick(currentStep, TxnInfo(httpMsg = httpRequest), pm.rundown)
       }
       ?.also { logger.info { "$currentStep RequestConfig found : ${pprint(it)}" } }
       ?.objType ?: Any::class.java
@@ -50,7 +50,7 @@ internal fun unmarshallRequest(
       logger.info {
         "$currentStep No JSON found in the Request body or content-type header didn't match ${APPLICATION_JSON.value}"
       }
-      Right(TxnInfo(null, null, httpRequest, false))
+      Right(TxnInfo(httpMsg = httpRequest, isJson = false))
     }
   }.map { TxnInfo(requestType, it, pmRequest.toHttpRequest()) }
 }

src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallResponse.kt

@@ -55,7 +55,7 @@ internal fun unmarshallResponse(
       logger.info {
         "${pm.currentStepReport.step} No JSON found in the Response body or content-type didn't match ${APPLICATION_JSON.value}"
       }
-      Right(TxnInfo(null, null, httpResponse, false))
+      Right(TxnInfo(httpMsg = httpResponse, isJson = false))
     }
   }
 }

src/main/kotlin/com/salesforce/revoman/internal/json/adapters/TypeAdapter.kt

@@ -10,7 +10,6 @@ package com.salesforce.revoman.internal.json.adapters
 import com.squareup.moshi.FromJson
 import com.squareup.moshi.ToJson
 import java.lang.reflect.Type
-import java.util.*
 
 object TypeAdapter {
   @ToJson fun toJson(type: Type): String = type.toString()

src/main/kotlin/com/salesforce/revoman/internal/postman/PostmanSDK.kt

@@ -31,7 +31,7 @@ class PostmanSDK(
   val regexReplacer: RegexReplacer = RegexReplacer(),
   mutableEnv: MutableMap<String, Any?> = mutableMapOf(),
 ) {
-  @JvmField val environment: PostmanEnvironment<Any?> = PostmanEnvironment(mutableEnv)
+  @JvmField val environment: PostmanEnvironment<Any?> = PostmanEnvironment(mutableEnv, moshiReVoman)
   lateinit var info: Info
   lateinit var request: Request
   lateinit var response: Response

src/main/kotlin/com/salesforce/revoman/output/Rundown.kt

@@ -8,25 +8,17 @@
 package com.salesforce.revoman.output
 
 import com.salesforce.revoman.input.config.StepPick.PostTxnStepPick
-import com.salesforce.revoman.internal.postman.template.Environment.Companion.fromMap
 import com.salesforce.revoman.output.postman.PostmanEnvironment
 import com.salesforce.revoman.output.report.Folder.Companion.FOLDER_DELIMITER
 import com.salesforce.revoman.output.report.StepReport
-import org.http4k.format.ConfigurableMoshi
 
 data class Rundown(
   @JvmField val stepReports: List<StepReport> = emptyList(),
   @JvmField val mutableEnv: PostmanEnvironment<Any?>,
   private val stepsToIgnoreForFailurePick: Map<ExeType, PostTxnStepPick>?,
-  private val moshiReVoman: ConfigurableMoshi,
 ) {
   @get:JvmName("immutableEnv") val immutableEnv: Map<String, Any?> by lazy { mutableEnv.toMap() }
 
-  @get:JvmName("envInPostmanEnvJSONFormat")
-  val envInPostmanEnvJSONFormat: String by lazy {
-    moshiReVoman.prettify(moshiReVoman.asFormatString(fromMap(mutableEnv, moshiReVoman)))
-  }
-
   @get:JvmName("firstUnsuccessfulStepReport")
   val firstUnsuccessfulStepReport: StepReport? by lazy {
     stepReports.firstOrNull { !it.isSuccessful }

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

@@ -7,16 +7,29 @@
  */
 package com.salesforce.revoman.output.postman
 
+import com.salesforce.revoman.internal.json.initMoshi
+import com.salesforce.revoman.internal.postman.template.Environment.Companion.fromMap
+import com.squareup.moshi.rawType
 import io.exoquery.pprint
 import io.github.oshai.kotlinlogging.KotlinLogging
-
-/** This is more like a value class (wrapper) on mutableEnv providing some useful utilities */
-data class PostmanEnvironment<ValueT : Any?>(
-  internal val mutableEnv: MutableMap<String, ValueT> = mutableMapOf()
+import java.lang.reflect.Type
+import org.http4k.format.ConfigurableMoshi
+
+/** This is a Wrapper on `mutableEnv` map, providing some useful utilities */
+data class PostmanEnvironment<ValueT : Any?>
+@JvmOverloads
+constructor(
+  val mutableEnv: MutableMap<String, ValueT> = mutableMapOf(),
+  val moshiReVoman: ConfigurableMoshi = initMoshi(),
 ) : MutableMap<String, ValueT> by mutableEnv {
 
   @get:JvmName("immutableEnv") val immutableEnv: Map<String, ValueT> by lazy { mutableEnv.toMap() }
 
+  @get:JvmName("postmanEnvJSONFormat")
+  val postmanEnvJSONFormat: String by lazy {
+    moshiReVoman.prettify(moshiReVoman.asFormatString(fromMap(mutableEnv, moshiReVoman)))
+  }
+
   fun set(key: String, value: ValueT) {
     mutableEnv[key] = value
     logger.info { "pm environment variable set through JS - key: $key, value: ${pprint(value)}" }
@@ -41,7 +54,8 @@ data class PostmanEnvironment<ValueT : Any?>(
       mutableEnv
         .filter { type.isInstance(it.value) }
         .mapValues { type.cast(it.value) }
-        .toMutableMap()
+        .toMutableMap(),
+      moshiReVoman,
     )
 
   inline fun <reified T> mutableEnvCopyWithValuesOfType(): PostmanEnvironment<T> =
@@ -57,7 +71,8 @@ data class PostmanEnvironment<ValueT : Any?>(
           type.isInstance(it.value) && prefixes.any { prefix -> it.key.startsWith(prefix) }
         }
         .mapValues { type.cast(it.value) }
-        .toMutableMap()
+        .toMutableMap(),
+      moshiReVoman,
     )
 
   inline fun <reified T> mutableEnvCopyWithKeysStartingWith(
@@ -72,7 +87,8 @@ data class PostmanEnvironment<ValueT : Any?>(
       mutableEnv
         .filter { type.isInstance(it.value) && !whiteListKeys.contains(it.key) }
         .mapValues { type.cast(it.value) }
-        .toMutableMap()
+        .toMutableMap(),
+      moshiReVoman,
     )
 
   fun <T> mutableEnvCopyWithKeysNotStartingWith(
@@ -85,9 +101,27 @@ data class PostmanEnvironment<ValueT : Any?>(
           type.isInstance(it.value) && prefixes.all { suffix -> !it.key.startsWith(suffix) }
         }
         .mapValues { type.cast(it.value) }
-        .toMutableMap()
+        .toMutableMap(),
+      moshiReVoman,
     )
 
+  fun <T : Any> getTypedObj(key: String, objType: Type): T? {
+    val value = mutableEnv[key]
+    return when {
+      objType.rawType.isInstance(value) -> value
+      else -> moshiReVoman.asA(moshiReVoman.asFormatString(value as Any), objType.rawType.kotlin)
+    }
+      as T
+  }
+
+  inline fun <reified T : Any> getObj(key: String): T? {
+    val value = mutableEnv[key]
+    return when {
+      value is T -> value
+      else -> moshiReVoman.asA(moshiReVoman.asFormatString(value as Any), T::class)
+    }
+  }
+
   fun <T> mutableEnvCopyWithKeysEndingWith(
     type: Class<T>,
     vararg suffixes: String,
@@ -96,7 +130,8 @@ data class PostmanEnvironment<ValueT : Any?>(
       mutableEnv
         .filter { type.isInstance(it.value) && suffixes.any { suffix -> it.key.endsWith(suffix) } }
         .mapValues { type.cast(it.value) }
-        .toMutableMap()
+        .toMutableMap(),
+      moshiReVoman,
     )
 
   fun <T> mutableEnvCopyWithKeysNotEndingWith(
@@ -107,7 +142,8 @@ data class PostmanEnvironment<ValueT : Any?>(
       mutableEnv
         .filter { type.isInstance(it.value) && suffixes.all { suffix -> !it.key.endsWith(suffix) } }
         .mapValues { type.cast(it.value) }
-        .toMutableMap()
+        .toMutableMap(),
+      moshiReVoman,
     )
 
   fun <T> valuesForKeysStartingWith(type: Class<T>, prefix: String): Set<T> =

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

@@ -9,7 +9,6 @@ package com.salesforce.revoman.output.report
 
 import arrow.core.Either.Left
 import arrow.core.Either.Right
-import com.salesforce.revoman.internal.postman.template.Environment.Companion.fromMap
 import com.salesforce.revoman.output.ExeType
 import com.salesforce.revoman.output.postman.PostmanEnvironment
 import com.salesforce.revoman.output.report.TxnInfo.Companion.uriPathContains
@@ -24,7 +23,6 @@ import io.vavr.control.Either.left
 import io.vavr.control.Either.right
 import org.http4k.core.Request
 import org.http4k.core.Response
-import org.http4k.format.ConfigurableMoshi
 
 data class StepReport
 internal constructor(
@@ -33,7 +31,6 @@ internal constructor(
   @JvmField val preStepHookFailure: PreStepHookFailure? = null,
   @JvmField val responseInfo: Either<out ResponseFailure, TxnInfo<Response>>? = null,
   @JvmField val postStepHookFailure: PostStepHookFailure? = null,
-  private val moshiReVoman: ConfigurableMoshi,
   @JvmField val envSnapshot: PostmanEnvironment<Any?> = PostmanEnvironment(),
 ) {
   internal constructor(
@@ -42,14 +39,12 @@ internal constructor(
     preStepHookFailure: PreStepHookFailure? = null,
     responseInfo: arrow.core.Either<ResponseFailure, TxnInfo<Response>>? = null,
     postStepHookFailure: PostStepHookFailure? = null,
-    moshiReVoman: ConfigurableMoshi,
   ) : this(
     step,
     requestInfo?.toVavr(),
     preStepHookFailure,
     responseInfo?.toVavr(),
     postStepHookFailure,
-    moshiReVoman,
   )
 
   @JvmField
@@ -66,11 +61,6 @@ internal constructor(
   val isHttpStatusSuccessful: Boolean =
     failure?.fold({ it !is PostStepHookFailure }, { true }) != true
 
-  @get:JvmName("envSnapShotInPostmanEnvJSONFormat")
-  val envSnapShotInPostmanEnvJSONFormat: String by lazy {
-    moshiReVoman.prettify(moshiReVoman.asFormatString(fromMap(envSnapshot, moshiReVoman)))
-  }
-
   companion object {
     private fun failure(
       requestInfo: Either<out ExeFailure, TxnInfo<Request>>? = null,