Release: 0.42.4

- `revUp` override to accept vararg Kicks
- Rename TestsJs to PostResJs everywhere

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.42.3.1
+:revoman-version: 0.42.4
 
 '''
 

buildSrc/src/main/kotlin/Config.kt

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

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

@@ -14,8 +14,8 @@ import arrow.core.merge
 import com.salesforce.revoman.input.bufferFileInResources
 import com.salesforce.revoman.input.config.Kick
 import com.salesforce.revoman.internal.exe.deepFlattenItems
+import com.salesforce.revoman.internal.exe.executePostResJS
 import com.salesforce.revoman.internal.exe.executePreReqJS
-import com.salesforce.revoman.internal.exe.executeTestsJS
 import com.salesforce.revoman.internal.exe.fireHttpRequest
 import com.salesforce.revoman.internal.exe.postHookExe
 import com.salesforce.revoman.internal.exe.preHookExe
@@ -43,6 +43,23 @@ import org.http4k.core.Request
 import org.http4k.format.ConfigurableMoshi
 
 object ReVoman {
+  @JvmStatic
+  @OptIn(ExperimentalStdlibApi::class)
+  fun revUp(vararg kicks: Kick): List<Rundown> =
+    kicks
+      .fold(mapOf<String, String>() to listOf<Rundown>()) { (accumulatedMutableEnv, rundowns), kick
+        ->
+        val rundown =
+          revUp(
+            kick.overrideDynamicEnvironments(
+              kick.dynamicEnvironmentsFlattened(),
+              accumulatedMutableEnv
+            )
+          )
+        rundown.mutableEnv.mutableEnvCopyWithValuesOfType<String>() to (rundowns + rundown)
+      }
+      .second
+
   @JvmStatic
   @OptIn(ExperimentalStdlibApi::class)
   fun revUp(kick: Kick): Rundown {
@@ -101,7 +118,7 @@ object ReVoman {
         pm.rundown =
           Rundown(stepReports + preStepReport, kick.haltOnFailureOfTypeExcept(), pm.environment)
         pm.environment.putAll(regexReplacer.replaceVariablesInEnv(pm))
-        val currentStepReport: StepReport = // --------### PRE-REQUEST-JS ###--------
+        val currentStepReport: StepReport = // --------### PRE-REQ-JS ###--------
           executePreReqJS(step, itemWithRegex, pm)
             .mapLeft { preStepReport.copy(requestInfo = left(it)) }
             .flatMap { // --------### UNMARSHALL-REQUEST ###--------
@@ -133,10 +150,10 @@ object ReVoman {
                   )
                 }
             }
-            .flatMap { sr: StepReport -> // --------### TESTS-JS ###--------
+            .flatMap { sr: StepReport -> // --------### PRE-RES-JS ###--------
               pm.currentStepReport = sr
               pm.rundown = pm.rundown.copy(stepReports = pm.rundown.stepReports + sr)
-              executeTestsJS(step, itemWithRegex, pm)
+              executePostResJS(step, itemWithRegex, pm)
                 .mapLeft { sr.copy(responseInfo = left(it)) }
                 .map { sr }
             }

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

@@ -12,24 +12,22 @@ import arrow.core.Either.Right
 import com.salesforce.revoman.internal.postman.PostmanSDK
 import com.salesforce.revoman.internal.postman.template.Item
 import com.salesforce.revoman.internal.postman.template.Request
-import com.salesforce.revoman.output.ExeType.PRE_REQUEST_JS
-import com.salesforce.revoman.output.ExeType.TESTS_JS
+import com.salesforce.revoman.output.ExeType.POST_RES_JS
+import com.salesforce.revoman.output.ExeType.PRE_REQ_JS
 import com.salesforce.revoman.output.report.Step
 import com.salesforce.revoman.output.report.StepReport
-import com.salesforce.revoman.output.report.failure.RequestFailure.PreRequestJSFailure
-import com.salesforce.revoman.output.report.failure.ResponseFailure.TestsJSFailure
+import com.salesforce.revoman.output.report.failure.RequestFailure.PreReqJSFailure
+import com.salesforce.revoman.output.report.failure.ResponseFailure.PostResJSFailure
 
 internal fun executePreReqJS(
   currentStep: Step,
   item: Item,
   pm: PostmanSDK
-): Either<PreRequestJSFailure, Unit> {
+): Either<PreReqJSFailure, Unit> {
   val preReqJS = item.event?.find { it.listen == "prerequest" }?.script?.exec?.joinToString("\n")
   return if (!preReqJS.isNullOrBlank()) {
-    runChecked(currentStep, PRE_REQUEST_JS) {
-        executePreReqJSWithPolyglot(preReqJS, item.request, pm)
-      }
-      .mapLeft { PreRequestJSFailure(it, pm.currentStepReport.requestInfo!!.get()) }
+    runChecked(currentStep, PRE_REQ_JS) { executePreReqJSWithPolyglot(preReqJS, item.request, pm) }
+      .mapLeft { PreReqJSFailure(it, pm.currentStepReport.requestInfo!!.get()) }
   } else {
     Right(Unit)
   }
@@ -40,18 +38,18 @@ private fun executePreReqJSWithPolyglot(preReqJS: String, pmRequest: Request, pm
   pm.evaluateJS(preReqJS)
 }
 
-internal fun executeTestsJS(
+internal fun executePostResJS(
   currentStep: Step,
   item: Item,
   pm: PostmanSDK
-): Either<TestsJSFailure, Unit> {
-  val testsJS = item.event?.find { it.listen == "test" }?.script?.exec?.joinToString("\n")
-  return if (!testsJS.isNullOrBlank()) {
-    runChecked(currentStep, TESTS_JS) {
-        executeTestsJSWithPolyglot(testsJS, item.request, pm.currentStepReport, pm)
+): Either<PostResJSFailure, Unit> {
+  val postResJs = item.event?.find { it.listen == "test" }?.script?.exec?.joinToString("\n")
+  return if (!postResJs.isNullOrBlank()) {
+    runChecked(currentStep, POST_RES_JS) {
+        executePostResJSWithPolyglot(postResJs, item.request, pm.currentStepReport, pm)
       }
       .mapLeft {
-        TestsJSFailure(
+        PostResJSFailure(
           it,
           pm.currentStepReport.requestInfo!!.get(),
           pm.currentStepReport.responseInfo!!.get()
@@ -62,13 +60,13 @@ internal fun executeTestsJS(
   }
 }
 
-private fun executeTestsJSWithPolyglot(
-  testsJs: String,
+private fun executePostResJSWithPolyglot(
+  postResJS: String,
   pmRequest: Request,
   stepReport: StepReport,
   pm: PostmanSDK
 ) {
   val httpResponse = stepReport.responseInfo!!.get().httpMsg
   pm.setRequestAndResponse(pm.from(pmRequest), httpResponse)
-  pm.evaluateJS(testsJs, mapOf("responseBody" to httpResponse.bodyString()))
+  pm.evaluateJS(postResJS, mapOf("responseBody" to httpResponse.bodyString()))
 }

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

@@ -22,7 +22,7 @@ import org.graalvm.polyglot.Value
 import org.http4k.format.ConfigurableMoshi
 
 /**
- * SDK to use in TestsJs, to be compatible with the Postman API reference:
+ * SDK to execute pre-req and post-res js scripts, to be compatible with the Postman API reference:
  * https://learning.postman.com/docs/writing-scripts/script-references/postman-sandbox-api-reference/
  */
 class PostmanSDK(
@@ -66,7 +66,8 @@ class PostmanSDK(
         Context.newBuilder("js")
           .allowExperimentalOptions(true)
           // ! TODO 07 Dec 2024 gopala.akshintala: Using this for core compatability
-          .allowIO(true) 
+          .allowIO(true)
+          .allowExperimentalOptions(true)
           .options(options)
           .allowHostAccess(HostAccess.ALL)
           .allowHostClassLookup { true }

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

@@ -10,10 +10,10 @@ package com.salesforce.revoman.output
 enum class ExeType(private val exeName: String) {
   UNMARSHALL_REQUEST("unmarshall-request"),
   PRE_HOOK("pre-hook"),
-  PRE_REQUEST_JS("pre-request-js"),
+  PRE_REQ_JS("pre-req-js"),
   HTTP_REQUEST("http-request"),
   HTTP_STATUS("http-status"),
-  TESTS_JS("tests-js"),
+  POST_RES_JS("post-res-js"),
   UNMARSHALL_RESPONSE("unmarshall-response"),
   POST_HOOK("post-hook");
 

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

@@ -44,6 +44,9 @@ data class PostmanEnvironment<ValueT : Any?>(
         .toMutableMap()
     )
 
+  inline fun <reified T> mutableEnvCopyWithValuesOfType(): PostmanEnvironment<T> =
+    mutableEnvCopyWithValuesOfType(T::class.java)
+
   fun <T> mutableEnvCopyWithKeysStartingWith(
     type: Class<T>,
     vararg prefixes: String
@@ -57,6 +60,10 @@ data class PostmanEnvironment<ValueT : Any?>(
         .toMutableMap()
     )
 
+  inline fun <reified T> mutableEnvCopyWithKeysStartingWith(
+    vararg prefixes: String
+  ): PostmanEnvironment<T> = mutableEnvCopyWithKeysStartingWith(T::class.java, *prefixes)
+
   fun <T> mutableEnvCopyExcludingKeys(
     type: Class<T>,
     whiteListKeys: Set<String>

src/main/kotlin/com/salesforce/revoman/output/report/failure/RequestFailure.kt

@@ -8,19 +8,19 @@
 package com.salesforce.revoman.output.report.failure
 
 import com.salesforce.revoman.output.ExeType.HTTP_REQUEST
-import com.salesforce.revoman.output.ExeType.PRE_REQUEST_JS
+import com.salesforce.revoman.output.ExeType.PRE_REQ_JS
 import com.salesforce.revoman.output.ExeType.UNMARSHALL_REQUEST
 import com.salesforce.revoman.output.report.TxnInfo
 import org.http4k.core.Request
 
 sealed class RequestFailure : ExeFailure() {
   abstract val requestInfo: TxnInfo<Request>
 
-  data class PreRequestJSFailure(
+  data class PreReqJSFailure(
     override val failure: Throwable,
     override val requestInfo: TxnInfo<Request>,
   ) : RequestFailure() {
-    override val exeType = PRE_REQUEST_JS
+    override val exeType = PRE_REQ_JS
   }
 
   data class UnmarshallRequestFailure(

src/main/kotlin/com/salesforce/revoman/output/report/failure/ResponseFailure.kt

@@ -7,7 +7,7 @@
  */
 package com.salesforce.revoman.output.report.failure
 
-import com.salesforce.revoman.output.ExeType.TESTS_JS
+import com.salesforce.revoman.output.ExeType.POST_RES_JS
 import com.salesforce.revoman.output.ExeType.UNMARSHALL_RESPONSE
 import com.salesforce.revoman.output.report.TxnInfo
 import org.http4k.core.Request
@@ -17,12 +17,12 @@ sealed class ResponseFailure : ExeFailure() {
   abstract val requestInfo: TxnInfo<Request>
   abstract val responseInfo: TxnInfo<Response>
 
-  data class TestsJSFailure(
+  data class PostResJSFailure(
     override val failure: Throwable,
     override val requestInfo: TxnInfo<Request>,
     override val responseInfo: TxnInfo<Response>,
   ) : ResponseFailure() {
-    override val exeType = TESTS_JS
+    override val exeType = POST_RES_JS
   }
 
   data class UnmarshallResponseFailure(