Release 0.7.9

overfullstack · overfullstack · commit 519100774363 · 2025-04-14T12:10:38.000+05:30
- Fix variable resolution by prepending dynamic environment
- Add @JvmSynthetic to hide internal methods

Signed-off-by: Gopal S Akshintala &lt;gopala.akshintala@salesforce.com&gt;
diff --git a/README.adoc b/README.adoc
@@ -18,7 +18,7 @@ endif::[]
 :pmtemplates: src/integrationTest/resources/pm-templates
 :imagesdir: docs/images
 :prewrap!:
-:revoman-version: 0.7.8.1
+:revoman-version: 0.7.9
 
 '''
 
@@ -128,25 +128,7 @@ ____
 ==== Why Postman Templates?
 
 The exported Postman collection JSON file is referred to as a Postman template, as it contains some placeholders/variables in the `+{{variable-key}}+` pattern. You can read more about it https://learning.postman.com/docs/sending-requests/variables/[here].
-This is a popular and proven pattern that interconnects multiple requests like a Graph. This is not unique to Postman, but Postman is popular and familiar in the dev community and has a full-blown UI, which makes it an attractive choice to support Postman templates. But that said, ReṼoman is modular, and the implementation is not coupled with any Postman related contracts. *In the future, we can think of supporting more template formats*
-
-==== Variable support in ReṼoman
-
-* Variables, e.g., `+{{variable-key}}+`
-* Nested variables, e.g., `+{{variable-key{{nested-variable-key}}}}+`
-* link:{sourcedir}/com/salesforce/revoman/internal/postman/DynamicVariableGenerator.kt[Dynamic variables],
-e.g., `{{$randomUUID}}`, `{{$randomEmail}}`
-* <<Custom Dynamic variables>>
-
-[#_variable_resolution_precedence]
-==== Variable resolution precedence
-In the case of collision between variable keys, the precedence order to derive a value to replace any key is:
-
-* Custom Dynamic variables
-* Generated Dynamic variables
-* Dynamic Environment supplied through config + Environment built during execution + Postman environment supplied as a file through config
-
-TIP: For Dynamic variables, which gets populated from Java code, use $ sign within a variable to indicate it needs to be populated during manual testing.E.g.: `{{$unitPrice}}`
+This is a popular and proven pattern that interconnects multiple endpoint requests like a Graph. This is not unique to Postman, but Postman is popular and familiar in the dev community and has a full-blown UI, which makes it an attractive choice to start with supporting Postman templates. But that said, ReṼoman is modular, and the implementation is not coupled with any Postman related contracts. *In the future, we can think of supporting more template formats*
 
 [.lead]
 You can _kick off_ this *Template-Driven Testing* by invoking `ReVoman.revUp()`,
@@ -362,7 +344,26 @@ include::{integrationtestdir}/com/salesforce/revoman/integration/core/pq/PQE2EWi
 <14> Run more assertions on the <<Rundown>>
 endif::[]
 
-== Config
+=== Variables
+
+* Variables, e.g., `+{{variable-key}}+`
+* Nested variables, e.g., `+{{variable-key{{nested-variable-key}}}}+`
+* link:{sourcedir}/com/salesforce/revoman/internal/postman/DynamicVariableGenerator.kt[Dynamic variables],
+e.g., `{{$randomUUID}}`, `{{$randomEmail}}`
+* <<Custom Dynamic variables>>
+
+==== Variable resolution precedence
+In the case of collision between variable keys, the precedence order to derive a value to replace any key is:
+
+* <<Custom Dynamic variables>>
+* link:{sourcedir}/com/salesforce/revoman/internal/postman/DynamicVariableGenerator.kt[Dynamic variables]
+* Environment built during execution
+* Dynamic Environment supplied through config
+* Postman Environment supplied as a file path through config
+
+TIP: Variable naming Convention: For Dynamic variables, which gets populated from Java code, use `$` sign within a variable to indicate it needs to be populated during manual testing, e.g.: `{{$unitPrice}}`.
+
+=== Config management
 
 [.lead]
 Config built using `Kick.configure()` is *Immutable*.
@@ -377,7 +378,7 @@ CAUTION: The new instance created from common config using `override...()` repla
 
 [source,java,indent=0,tabsize=2,options="nowrap"]
 ----
-POKEMON_COMMON_CONFIG.overrideHooks(kotlin.collections.CollectionsKt.plus(POKEMON_COMMON_CONFIG.hooks(), post(.../*My Hooks*/))
+COMMON_CONFIG.overrideHooks(kotlin.collections.CollectionsKt.plus(COMMON_CONFIG.hooks(), post(.../*My Hooks*/))
 ----
 
 * You can also construct a new instance by accumulating attributes from other instances using `from()` method, like below:
@@ -389,7 +390,6 @@ Kick.configure().from(configInstance1).from(configInstance2)...off();
 
 CAUTION: Iterable attributes (like `List`, `Map` etc) accept an `Iterable`. If you are particular about the order, make sure to pass an Ordered instance of `Iterable` (like `ArrayList`)
 
-[#_debugging_dx]
 == Troubleshooting DX
 
 [#_ide_debugger_view]
diff --git a/buildSrc/src/main/kotlin/Config.kt b/buildSrc/src/main/kotlin/Config.kt
@@ -6,6 +6,6 @@
  * ************************************************************************************************
  */
 const val GROUP_ID = "com.salesforce.revoman"
-const val VERSION = "0.7.8.1"
+const val VERSION = "0.7.9"
 const val ARTIFACT_ID = "revoman"
 const val STAGING_PROFILE_ID = "1ea0a23e61ba7d"
diff --git a/src/integrationTest/kotlin/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevKtTest.kt b/src/integrationTest/kotlin/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevKtTest.kt
@@ -16,7 +16,8 @@ class RestfulAPIDevKtTest {
   @Test
   fun `execute restful-api dev pm collection`() {
     val rundown =
-      ReVoman.revUp( // <1>
+      ReVoman.revUp(
+        // <1>
         Kick.configure()
           .templatePath(PM_COLLECTION_PATH) // <2>
           .environmentPath(PM_ENVIRONMENT_PATH) // <3>
diff --git a/src/integrationTest/resources/pm-templates/core/milestone/env.postman_environment.json b/src/integrationTest/resources/pm-templates/core/milestone/env.postman_environment.json
@@ -4,19 +4,19 @@
   "values": [
     {
       "key" : "baseUrl",
-      "value" : "https://localhost:6101/",
+      "value" : "https://orgfarm-fe6a79aee6.test1.my.pc-rnd.salesforce.com/",
       "type" : "default",
       "enabled" : true
     },
     {
       "key" : "username",
-      "value" : "blng1@256.org",
+      "value" : "epic.cdfddbbc08b7@orgfarm.out",
       "type" : "default",
       "enabled" : true
     },
     {
       "key" : "password",
-      "value" : "123456",
+      "value" : "orgfarm1234",
       "type" : "default",
       "enabled" : true
     },
diff --git a/src/main/kotlin/com/salesforce/revoman/ReVoman.kt b/src/main/kotlin/com/salesforce/revoman/ReVoman.kt
@@ -31,7 +31,7 @@ import com.salesforce.revoman.internal.postman.Info
 import com.salesforce.revoman.internal.postman.PostmanSDK
 import com.salesforce.revoman.internal.postman.RegexReplacer
 import com.salesforce.revoman.internal.postman.dynamicVariableGenerator
-import com.salesforce.revoman.internal.postman.mergeEnvs
+import com.salesforce.revoman.internal.postman.template.Environment.Companion.mergeEnvs
 import com.salesforce.revoman.internal.postman.template.Template
 import com.salesforce.revoman.output.Rundown
 import com.salesforce.revoman.output.report.Step
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/HttpRequest.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/HttpRequest.kt
@@ -32,6 +32,7 @@ import org.http4k.core.then
 import org.http4k.filter.ClientFilters
 import org.http4k.filter.DebuggingFilters
 
+@JvmSynthetic
 internal fun fireHttpRequest(
   currentStep: Step,
   auth: Auth?,
@@ -54,7 +55,7 @@ private fun prepareHttpClient(bearerToken: String?, insecureHttp: Boolean): Http
     .then(if (insecureHttp) ApacheClient(client = insecureApacheHttpClient()) else ApacheClient())
 
 /** Only for Testing. DO NOT USE IN PROD */
-fun insecureApacheHttpClient(): CloseableHttpClient =
+private fun insecureApacheHttpClient(): CloseableHttpClient =
   SSLContextBuilder()
     .loadTrustMaterial(null) { _, _ -> true }
     .build()
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/PmJsEval.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/PmJsEval.kt
@@ -19,6 +19,7 @@ import com.salesforce.revoman.output.report.StepReport
 import com.salesforce.revoman.output.report.failure.RequestFailure.PreReqJSFailure
 import com.salesforce.revoman.output.report.failure.ResponseFailure.PostResJSFailure
 
+@JvmSynthetic
 internal fun executePreReqJS(
   currentStep: Step,
   itemWithRegex: Item,
@@ -41,6 +42,7 @@ private fun executePreReqJSWithPolyglot(preReqJS: String, pmRequest: Request, pm
   pm.evaluateJS(preReqJS)
 }
 
+@JvmSynthetic
 internal fun executePostResJS(
   currentStep: Step,
   item: Item,
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/PostStepHook.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/PostStepHook.kt
@@ -18,6 +18,7 @@ import com.salesforce.revoman.output.report.StepReport
 import com.salesforce.revoman.output.report.failure.HookFailure.PostStepHookFailure
 import io.github.oshai.kotlinlogging.KotlinLogging
 
+@JvmSynthetic
 internal fun postStepHookExe(kick: Kick, pm: PostmanSDK): PostStepHookFailure? =
   pickPostStepHooks(kick.postStepHooks(), pm.currentStepReport, pm.rundown)
     .map { postStepHook ->
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/PreStepHook.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/PreStepHook.kt
@@ -20,6 +20,7 @@ import com.salesforce.revoman.output.report.failure.HookFailure.PreStepHookFailu
 import io.github.oshai.kotlinlogging.KotlinLogging
 import org.http4k.core.Request
 
+@JvmSynthetic
 internal fun preStepHookExe(
   currentStep: Step,
   kick: Kick,
@@ -36,6 +37,7 @@ internal fun preStepHookExe(
     .firstOrNull { it.isLeft() }
     ?.leftOrNull()
 
+@JvmSynthetic
 private fun pickPreStepHooks(
   preStepHooks: List<HookConfig>,
   currentStep: Step,
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallRequest.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallRequest.kt
@@ -23,6 +23,7 @@ import org.http4k.core.ContentType.Companion.APPLICATION_JSON
 import org.http4k.core.Request
 import org.http4k.lens.contentType
 
+@JvmSynthetic
 internal fun unmarshallRequest(
   currentStep: Step,
   pmRequest: com.salesforce.revoman.internal.postman.template.Request,
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallResponse.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallResponse.kt
@@ -22,6 +22,7 @@ import org.http4k.core.ContentType.Companion.APPLICATION_JSON
 import org.http4k.core.Response
 import org.http4k.lens.contentType
 
+@JvmSynthetic
 internal fun unmarshallResponse(
   kick: Kick,
   moshiReVoman: MoshiReVoman,
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/postman/Postman.kt b/src/main/kotlin/com/salesforce/revoman/internal/postman/Postman.kt
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/postman/RegexReplacer.kt b/src/main/kotlin/com/salesforce/revoman/internal/postman/RegexReplacer.kt
@@ -21,14 +21,12 @@ class RegexReplacer(
   private val dynamicVariableGenerator: (String, PostmanSDK) -> String? = ::dynamicVariableGenerator,
 ) {
   /**
-   * <p>
-   * Order of Variable resolution
-   * <ul>
-   * <li>Custom Dynamic Variables</li>
-   * <li>Generated Dynamic variables</li>
-   * <li>Dynamic Environment supplied through config + Environment built during execution + Postman
-   *   environment supplied as a file through config</li>
-   * </ul>
+   * ## Order of Variable resolution
+   * - Custom Dynamic Variables
+   * - Dynamic variables
+   * - Environment built during execution
+   * - Dynamic Environment supplied through config
+   * - Postman Environment supplied as a file through config
    */
   internal fun replaceVariablesRecursively(stringWithRegex: String?, pm: PostmanSDK): String? =
     stringWithRegex?.let {
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/postman/template/Environment.kt b/src/main/kotlin/com/salesforce/revoman/internal/postman/template/Environment.kt
@@ -7,9 +7,15 @@
  */
 package com.salesforce.revoman.internal.postman.template
 
+import com.salesforce.revoman.input.bufferFile
+import com.salesforce.revoman.input.bufferInputStream
 import com.salesforce.revoman.internal.json.AlwaysSerializeNulls
 import com.salesforce.revoman.internal.json.MoshiReVoman
 import com.squareup.moshi.JsonClass
+import com.squareup.moshi.Moshi
+import com.squareup.moshi.adapter
+import java.io.InputStream
+import kotlin.collections.plus
 
 @JsonClass(generateAdapter = true)
 internal data class Environment(val name: String?, val values: List<EnvValue>) {
@@ -34,5 +40,24 @@ internal data class Environment(val name: String?, val values: List<EnvValue>) {
         }
       return Environment(POSTMAN_ENV_NAME, values)
     }
+
+    @OptIn(ExperimentalStdlibApi::class)
+    internal fun mergeEnvs(
+      pmEnvironmentPaths: Set<String>,
+      pmEnvironmentInputStreams: List<InputStream>,
+      dynamicEnvironment: Map<String, String?>,
+    ): Map<String, String?> {
+      val envAdapter = Moshi.Builder().build().adapter<Environment>()
+      val envFromEnvFiles =
+        (pmEnvironmentPaths.map { bufferFile(it) } +
+            pmEnvironmentInputStreams.map { bufferInputStream(it) })
+          .flatMap { envWithRegex ->
+            envAdapter.fromJson(envWithRegex)?.values?.filter { it.enabled } ?: emptyList()
+          }
+          .associate { it.key to it.value }
+      // * NOTE 10/09/23 gopala.akshintala: dynamicEnvironment keys replace envFromEnvFiles when
+      // clashed
+      return envFromEnvFiles + dynamicEnvironment
+    }
   }
 }
diff --git a/src/test/kotlin/com/salesforce/revoman/internal/postman/RegexReplacerTest.kt b/src/test/kotlin/com/salesforce/revoman/internal/postman/RegexReplacerTest.kt
@@ -8,6 +8,7 @@
 package com.salesforce.revoman.internal.postman
 
 import com.salesforce.revoman.input.config.CustomDynamicVariableGenerator
+import com.salesforce.revoman.internal.postman.template.Environment.Companion.mergeEnvs
 import com.squareup.moshi.Moshi
 import com.squareup.moshi.adapter
 import io.kotest.matchers.equals.shouldNotBeEqual
@@ -34,7 +35,7 @@ class RegexReplacerTest {
 
   @OptIn(ExperimentalStdlibApi::class)
   @Test
-  fun `dynamic variables - Body + dynamic env`() {
+  fun `dynamic variables replacement in JSON string and dynamic env`() {
     val epoch = System.currentTimeMillis().toString()
     val dummyDynamicVariableGenerator = { key: String, _: PostmanSDK ->
       if (key == $$"$epoch") epoch else null
