- CustomDynamicVariableGenerator shall receive rundown in the hook

- Major refactoring

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

Author: overfullstack

build.gradle.kts

@@ -35,6 +35,7 @@ dependencies {
   compileOnly(libs.jetbrains.annotations)
   testImplementation(libs.truth)
   testImplementation(libs.json.assert)
+  testImplementation(libs.mockk)
 }
 
 testing {

docs/revoman.exe.log

@@ -12,3 +12,5 @@ org.gradle.parallel=true
 org.gradle.jvmargs=-XX:+UseParallelGC
 
 moshix.generateProguardRules=false
+
+kapt.include.compile.classpath=false

gradle.properties

@@ -25,6 +25,7 @@ spring = "5.3.31" # 5.3.31 Compatable with Java 11
 json-assert = "1.5.1"
 nexus-publish = "2.0.0-rc-2"
 kotlinx-datetime = "0.6.0-RC.2"
+mockk = "1.13.10"
 
 # Common dependencies
 junit = "5.10.2"
@@ -66,6 +67,7 @@ mockito-core = { module = "org.mockito:mockito-core", version.ref = "mockito" }
 spring-beans = { module = "org.springframework:spring-beans", version.ref = "spring" }
 json-assert = { module = "org.skyscreamer:jsonassert", version.ref = "json-assert" }
 kotlinx-datetime = { module = "org.jetbrains.kotlinx:kotlinx-datetime-jvm", version.ref = "kotlinx-datetime" }
+mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 
 # Gradle plugins
 kotlin-gradle = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }

libs.versions.toml

@@ -67,8 +67,14 @@ void revUpPQ() {
                         "$quoteFieldsToQuery", "LineItemCount, CalculationStatus",
                         "$qliFieldsToQuery", "Id, Product2Id",
                         "$qlrFieldsToQuery", "Id, QuoteId, MainQuoteLineId, AssociatedQuoteLineId"))
-                .customDynamicVariable( // <5>
-                    "$quantity", ignore -> String.valueOf(Random.Default.nextInt(10) + 1))
+                .customDynamicVariableGenerators(
+                    Map.of( // <5>
+                        "$quantity",
+                            (ignore1, ignore2, ignore3) ->
+                                String.valueOf(Random.Default.nextInt(10) + 1),
+                        "$requestName",
+                            (ignore1, currentStepReport, ignore3) ->
+                                currentStepReport.step.rawPMStep.getName()))
                 .haltOnFailureOfTypeExcept(
                     HTTP_STATUS,
                     afterAllStepsContainingHeader("ignoreHTTPStatusUnsuccessful")) // <6>

src/integrationTest/java/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java

@@ -25,12 +25,14 @@ import com.salesforce.revoman.internal.exe.unmarshallResponse
 import com.salesforce.revoman.internal.json.initMoshi
 import com.salesforce.revoman.internal.postman.Info
 import com.salesforce.revoman.internal.postman.RegexReplacer
-import com.salesforce.revoman.internal.postman.initPmEnvironment
+import com.salesforce.revoman.internal.postman.dynamicVariableGenerator
+import com.salesforce.revoman.internal.postman.mergeEnvs
 import com.salesforce.revoman.internal.postman.pm
 import com.salesforce.revoman.internal.postman.template.Template
 import com.salesforce.revoman.output.Rundown
 import com.salesforce.revoman.output.report.Step
 import com.salesforce.revoman.output.report.StepReport
+import com.salesforce.revoman.output.report.StepReport.Companion.toArrow
 import com.salesforce.revoman.output.report.StepReport.Companion.toVavr
 import com.salesforce.revoman.output.report.TxnInfo
 import com.squareup.moshi.Moshi
@@ -44,11 +46,7 @@ object ReVoman {
   @JvmStatic
   @OptIn(ExperimentalStdlibApi::class)
   fun revUp(kick: Kick): Rundown {
-    initPmEnvironment(
-      kick.environmentPaths(),
-      kick.dynamicEnvironmentsFlattened(),
-      kick.customDynamicVariables()
-    )
+    val environment = mergeEnvs(kick.environmentPaths(), kick.dynamicEnvironmentsFlattened())
     val pmTemplateAdapter = Moshi.Builder().build().adapter<Template>()
     val pmStepsDeepFlattened =
       kick
@@ -61,21 +59,25 @@ object ReVoman {
     val stepNameToReport =
       executeStepsSerially(
         pmStepsDeepFlattened,
+        environment,
         kick,
         initMoshi(
           kick.customAdaptersForMarshalling(),
           kick.customAdaptersFromRequestConfig() + kick.customAdaptersFromResponseConfig(),
           kick.typesToIgnoreForMarshalling()
         )
       )
-    return Rundown(stepNameToReport, pm.environment, kick.haltOnFailureOfTypeExcept())
+    return Rundown(stepNameToReport, kick.haltOnFailureOfTypeExcept())
   }
 
   private fun executeStepsSerially(
     pmStepsFlattened: List<Step>,
+    environment: Map<String, String?>,
     kick: Kick,
     moshiReVoman: ConfigurableMoshi,
   ): List<StepReport> {
+    pm.environment.clear()
+    pm.environment.putAll(environment)
     var haltExecution = false
     return pmStepsFlattened
       .asSequence()
@@ -85,46 +87,65 @@ object ReVoman {
         logger.info { "***** Executing Step: $step *****" }
         val itemWithRegex = step.rawPMStep
         pm.info = Info(step.name)
+        val stepReport = StepReport(step)
+        val rundown = Rundown(stepReports + stepReport, kick.haltOnFailureOfTypeExcept())
+        val regexReplacer =
+          RegexReplacer(
+            pm.environment,
+            kick.customDynamicVariableGenerators(),
+            ::dynamicVariableGenerator
+          )
+        pm.environment.putAll(regexReplacer.replaceVariablesInEnv(stepReport, rundown))
         val pmRequest: com.salesforce.revoman.internal.postman.template.Request =
-          RegexReplacer(pm.environment, kick.customDynamicVariables())
-            .replaceRegex(itemWithRegex.request)
+          regexReplacer.replaceVariablesInRequest(itemWithRegex.request, stepReport, rundown)
         val currentStepReport: StepReport = // --------### UNMARSHALL-REQUEST ###--------
           unmarshallRequest(step, pmRequest, kick, moshiReVoman, stepReports)
             .mapLeft { StepReport(step, Left(it)) }
             .flatMap { requestInfo: TxnInfo<Request> -> // --------### PRE-HOOKS ###--------
               preHookExe(step, kick, requestInfo, stepReports)?.let {
                 Left(StepReport(step, Right(requestInfo), it))
-              } ?: Right(requestInfo)
+              } ?: Right(StepReport(step, Right(requestInfo)))
             }
-            .flatMap { requestInfo: TxnInfo<Request> -> // --------### HTTP-REQUEST ###--------
-              val item = RegexReplacer(pm.environment).replaceRegex(itemWithRegex)
+            .flatMap { sr: StepReport -> // --------### HTTP-REQUEST ###--------
+              val item =
+                regexReplacer.replaceVariablesInPmItem(
+                  itemWithRegex,
+                  sr,
+                  Rundown(stepReports + sr, kick.haltOnFailureOfTypeExcept())
+                )
               val httpRequest = item.request.toHttpRequest()
               fireHttpRequest(step, item.auth, httpRequest, kick.insecureHttp())
                 .mapLeft { StepReport(step, Left(it)) }
                 .map {
-                  StepReport(step, Right(requestInfo.copy(httpMsg = httpRequest)), null, Right(it))
+                  StepReport(
+                    step,
+                    sr.requestInfo?.toArrow()?.map { txnInfo ->
+                      txnInfo.copy(httpMsg = httpRequest)
+                    },
+                    null,
+                    Right(it)
+                  )
                 }
             }
-            .flatMap { stepReport: StepReport -> // --------### TESTS-JS ###--------
+            .flatMap { sr: StepReport -> // --------### TESTS-JS ###--------
               executeTestsJS(
                   step,
                   itemWithRegex.event,
-                  kick.customDynamicVariables(),
+                  regexReplacer,
                   pmRequest,
-                  stepReport
+                  sr,
+                  Rundown(stepReports + sr, kick.haltOnFailureOfTypeExcept())
                 )
-                .mapLeft { stepReport.copy(responseInfo = left(it)) }
-                .map { stepReport }
+                .mapLeft { sr.copy(responseInfo = left(it)) }
+                .map { sr }
             }
-            .flatMap { stepReport: StepReport -> // ---### UNMARSHALL RESPONSE ###---
-              unmarshallResponse(stepReport, kick, moshiReVoman, stepReports)
-                .mapLeft { stepReport.copy(responseInfo = Left(it).toVavr()) }
-                .map { stepReport.copy(responseInfo = Right(it).toVavr()) }
+            .flatMap { sr: StepReport -> // ---### UNMARSHALL RESPONSE ###---
+              unmarshallResponse(sr, kick, moshiReVoman, stepReports)
+                .mapLeft { sr.copy(responseInfo = Left(it).toVavr()) }
+                .map { sr.copy(responseInfo = Right(it).toVavr()) }
             }
-            .map { stepReport: StepReport -> // --------### POST-HOOKS ###--------
-              stepReport.copy(
-                postHookFailure = postHookExe(stepReport, kick, stepReports + stepReport)
-              )
+            .map { sr: StepReport -> // --------### POST-HOOKS ###--------
+              sr.copy(postHookFailure = postHookExe(sr, kick, stepReports + sr))
             }
             .merge()
             .copy(

src/integrationTest/resources/pm-templates/pq/[sm] pq.postman_collection.json

@@ -11,6 +11,8 @@ import com.salesforce.revoman.input.config.StepPick.ExeStepPick
 import com.salesforce.revoman.input.config.StepPick.PostTxnStepPick
 import com.salesforce.revoman.input.config.StepPick.PreTxnStepPick
 import com.salesforce.revoman.output.ExeType
+import com.salesforce.revoman.output.Rundown
+import com.salesforce.revoman.output.report.StepReport
 import com.squareup.moshi.JsonAdapter
 import com.squareup.moshi.JsonAdapter.Factory
 import io.vavr.control.Either
@@ -34,7 +36,7 @@ internal interface KickDef {
     if (dynamicEnvironments().isEmpty()) emptyMap()
     else dynamicEnvironments().reduce { acc, map -> acc + map }
 
-  fun customDynamicVariables(): Map<String, (String) -> String>
+  fun customDynamicVariableGenerators(): Map<String, CustomDynamicVariableGenerator>
 
   @Value.Default fun haltOnAnyFailure(): Boolean = false
 
@@ -93,6 +95,10 @@ internal interface KickDef {
   }
 }
 
+fun interface CustomDynamicVariableGenerator {
+  fun generate(variableName: String, currentStepReport: StepReport, rundown: Rundown): String
+}
+
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.SOURCE)
 @Value.Style(

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

@@ -24,7 +24,7 @@ import org.immutables.value.Value
  * @param jsonFilePath The path to the JSON file
  * @param customAdapters A list of custom JSON adapters to be used during the parsing process
  * @param customAdaptersWithType A map of custom JSON adapters with their respective types
- * @param typesToSkip A set of types to be skipped during the parsing process
+ * @param skipTypes A set of types to be skipped during the parsing process
  * @param <PojoT> The type of the POJO to be created
  * @return the parsed POJO or null if the parsing fails
  */
@@ -34,9 +34,9 @@ fun <PojoT : Any> jsonFileToPojo(
   jsonFilePath: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToSkip: Set<Class<out Any>> = emptySet()
+  skipTypes: Set<Class<out Any>> = emptySet()
 ): PojoT? {
-  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToSkip, pojoType)
+  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, skipTypes, pojoType)
   return jsonAdapter.fromJson(bufferFileInResources(jsonFilePath))
 }
 
@@ -46,22 +46,16 @@ fun <PojoT : Any> jsonFileToPojo(jsonFile: JsonFile<PojoT>): PojoT? =
     jsonFile.jsonFilePath(),
     jsonFile.customAdapters(),
     jsonFile.customAdaptersWithType(),
-    jsonFile.typesToSkip()
+    jsonFile.skipTypes()
   )
 
 inline fun <reified PojoT : Any> jsonFileToPojo(
   jsonFilePath: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToSkip: Set<Class<out Any>> = emptySet()
+  skipTypes: Set<Class<out Any>> = emptySet()
 ): PojoT? =
-  jsonFileToPojo(
-    PojoT::class.java,
-    jsonFilePath,
-    customAdapters,
-    customAdaptersWithType,
-    typesToSkip
-  )
+  jsonFileToPojo(PojoT::class.java, jsonFilePath, customAdapters, customAdaptersWithType, skipTypes)
 
 /**
  * A generic function that parses a JSON string into a POJO (Plain Old Java Object) of type PojoT.
@@ -71,7 +65,7 @@ inline fun <reified PojoT : Any> jsonFileToPojo(
  * @param jsonStr The JSON string to be parsed.
  * @param customAdapters A list of custom adapters to be used during the parsing process.
  * @param customAdaptersWithType A map of custom adapters with their respective types.
- * @param typesToSkip A set of classes to be skipped during the parsing process.
+ * @param skipTypes A set of classes to be skipped during the parsing process.
  * @return The parsed POJO of type PojoT.
  */
 @JvmOverloads
@@ -80,9 +74,9 @@ fun <PojoT : Any> jsonToPojo(
   jsonStr: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToSkip: Set<Class<out Any>> = emptySet()
+  skipTypes: Set<Class<out Any>> = emptySet()
 ): PojoT? {
-  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToSkip, pojoType)
+  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, skipTypes, pojoType)
   return jsonAdapter.fromJson(jsonStr)
 }
 
@@ -92,16 +86,16 @@ fun <PojoT : Any> jsonToPojo(jsonString: JsonString<PojoT>): PojoT? =
     jsonString.jsonString(),
     jsonString.customAdapters(),
     jsonString.customAdaptersWithType(),
-    jsonString.typesToSkip()
+    jsonString.skipTypes()
   )
 
 inline fun <reified PojoT : Any> jsonToPojo(
   jsonStr: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToSkip: Set<Class<out Any>> = emptySet()
+  skipTypes: Set<Class<out Any>> = emptySet()
 ): PojoT? =
-  jsonToPojo(PojoT::class.java, jsonStr, customAdapters, customAdaptersWithType, typesToSkip)
+  jsonToPojo(PojoT::class.java, jsonStr, customAdapters, customAdaptersWithType, skipTypes)
 
 /**
  * Generate a JSON string from a POJO object.
@@ -110,7 +104,7 @@ inline fun <reified PojoT : Any> jsonToPojo(
  * @param pojo The POJO object to be converted to JSON.
  * @param customAdapters A list of custom adapters for Moshi to use during the conversion.
  * @param customAdaptersWithType A map of custom adapters with their respective types.
- * @param typesToSkip A set of classes to ignore during the conversion.
+ * @param skipTypes A set of classes to ignore during the conversion.
  * @param indent An optional string for pretty-printing the JSON output.
  * @param <PojoT> The type of the POJO object.
  * @return A JSON string or null if the input is null.
@@ -121,10 +115,10 @@ fun <PojoT : Any> pojoToJson(
   pojo: PojoT,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToSkip: Set<Class<out Any>> = emptySet(),
+  skipTypes: Set<Class<out Any>> = emptySet(),
   indent: String? = "  "
 ): String? {
-  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToSkip, pojoType)
+  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, skipTypes, pojoType)
   return (indent?.let { jsonAdapter.indent(indent) } ?: jsonAdapter).toJson(pojo)
 }
 
@@ -134,27 +128,27 @@ fun <PojoT : Any> pojoToJson(config: Pojo<PojoT>): String? =
     config.pojo(),
     config.customAdapters(),
     config.customAdaptersWithType(),
-    config.typesToSkip(),
+    config.skipTypes(),
     config.indent()
   )
 
 inline fun <reified PojoT : Any> pojoToJson(
   pojo: PojoT,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToSkip: Set<Class<out Any>> = emptySet(),
+  skipTypes: Set<Class<out Any>> = emptySet(),
   indent: String? = "  "
 ): String? =
-  pojoToJson(PojoT::class.java, pojo, customAdapters, customAdaptersWithType, typesToSkip, indent)
+  pojoToJson(PojoT::class.java, pojo, customAdapters, customAdaptersWithType, skipTypes, indent)
 
 @SuppressWarnings("kotlin:S3923")
 private fun <PojoT : Any> initMoshi(
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToSkip: Set<Class<out Any>> = emptySet(),
+  skipTypes: Set<Class<out Any>> = emptySet(),
   pojoType: Type
 ): JsonAdapter<PojoT> {
-  val moshiBuilder = buildMoshi(customAdapters, customAdaptersWithType, typesToSkip)
+  val moshiBuilder = buildMoshi(customAdapters, customAdaptersWithType, skipTypes)
   return moshiBuilder.build().adapter(pojoType)
 }
 
@@ -169,7 +163,7 @@ internal interface PojoDef<PojoT> {
 
   fun customAdaptersWithType(): Map<Type, List<Either<JsonAdapter<Any>, Factory>>>
 
-  fun typesToSkip(): Set<Class<out Any>>
+  fun skipTypes(): Set<Class<out Any>>
 
   @Value.Default fun indent(): String = "  "
 }
@@ -196,7 +190,7 @@ internal interface JsonConfig<PojoT> {
 
   fun customAdaptersWithType(): Map<Type, List<Either<JsonAdapter<Any>, Factory>>>
 
-  fun typesToSkip(): Set<Class<out Any>>
+  fun skipTypes(): Set<Class<out Any>>
 }
 
 @ConfigForJson

src/main/kotlin/com/salesforce/revoman/input/config/KickDef.kt

@@ -14,7 +14,6 @@ import arrow.core.Either.Left
 import arrow.core.Either.Right
 import com.salesforce.revoman.input.config.Kick
 import com.salesforce.revoman.input.config.StepPick.ExeStepPick
-import com.salesforce.revoman.internal.postman.pm
 import com.salesforce.revoman.internal.postman.template.Item
 import com.salesforce.revoman.output.ExeType
 import com.salesforce.revoman.output.Rundown
@@ -109,11 +108,7 @@ internal fun shouldHaltExecution(
           currentStepReport.exeTypeForFailure == exeType &&
             postTxnPick.pick(
               currentStepReport,
-              Rundown(
-                stepReports + currentStepReport,
-                pm.environment,
-                kick.haltOnFailureOfTypeExcept(),
-              ),
+              Rundown(stepReports + currentStepReport, kick.haltOnFailureOfTypeExcept()),
             )
         }
         ?.any { it }