Release 0.7.4.1

overfullstack · overfullstack · commit c75bd4eb96cd · 2025-03-30T18:49:40.000+05:30
Rename nodeModulesRelativePath to nodeModulesPath

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.4
+:revoman-version: 0.7.4.1
 
 '''
 
@@ -266,7 +266,7 @@ final var pqRundown =
 					.customDynamicVariableGenerator( // <5>
 							"$unitPrice",
 							(ignore1, ignore2, ignore3) -> String.valueOf(Random.Default.nextInt(999) + 1))
-					.nodeModulesRelativePath("js") // <6>
+					.nodeModulesPath("js") // <6>
 					.haltOnFailureOfTypeExcept(
 							HTTP_STATUS,
 							afterAllStepsContainingHeader("ignoreHTTPStatusUnsuccessful")) // <7>
@@ -621,7 +621,7 @@ CAUTION: When a Step qualifies for more than one hook, hooks are executed in the
 * ReṼoman can execute this JavaScript on JVM. This support ensures that the Postman collection used for manual testing can be used *as-is* for the automation also, without any resistance to modify or overhead of maintaining separate versions for manual and automation.
 ** Pre-req JS script is executed as the first step before Unmarshall request.
 ** Post-res JS script is executed right after receiving an HTTP response.
-* ReṼoman supports using `npm` modules inside your Pre-req and Post-res JS scripts. You can install `npm` modules in any folder using traditional commands like `npm install <module>` and supply in the `Kick` config, the relative path of the parent folder that contains the `node_modules` folder using `nodeModulesRelativePath(...)`. Use those `npm` modules inside your scripts with `require(...)`, for example:
+* ReṼoman supports using `npm` modules inside your Pre-req and Post-res JS scripts. You can install `npm` modules in any folder using traditional commands like `npm install <module>` and supply in the `Kick` config, an absolute or relative path (relative to Project directory) to the folder that contains the `node_modules` folder using `nodeModulesPath(...)`. Use those `npm` modules inside your scripts with `require(...)`, for example:
 
 .Install `moment` with npm
 [source,shellscript,indent=0,options="nowrap"]
@@ -642,6 +642,8 @@ pm.environment.set('$randomFutureDate', futureDateTime.format('YYYY-MM-DD'))
 pm.environment.set("$quantity", _.random(1, 10))
 ----
 
+CAUTION: It is not supported to load `node_modules` from jar. For example, `/Users/username/some-path/revoman-root/build/libs/revoman-root-0.40.0.jar!/js` is an invalid path. link:https://graalvm.slack.com/archives/CN9L59P61/p1710937088860679?thread_ts=1710767437.443019&cid=CN9L59P61[Refer this known issue]
+
 [TIP]
 ====
 * `node_modules` Adds a lot of files to check in. You may replace them with a single distribution file
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.4"
+const val VERSION = "0.7.4.1"
 const val ARTIFACT_ID = "revoman"
 const val STAGING_PROFILE_ID = "1ea0a23e61ba7d"
diff --git a/src/integrationTest/java/com/salesforce/revoman/integration/core/bt2bs/MilestoneBillingE2ETest.java b/src/integrationTest/java/com/salesforce/revoman/integration/core/bt2bs/MilestoneBillingE2ETest.java
@@ -9,7 +9,7 @@
 import static com.google.common.truth.Truth.assertThat;
 import static com.salesforce.revoman.integration.core.bt2bs.ReVomanConfigForBT2BS.MILESTONE_CONFIG;
 import static com.salesforce.revoman.integration.core.bt2bs.ReVomanConfigForBT2BS.MILESTONE_SETUP_CONFIG;
-import static com.salesforce.revoman.integration.core.bt2bs.ReVomanConfigForBT2BS.USER_CREATION_AND_SETUP_CONFIG;
+import static com.salesforce.revoman.integration.core.bt2bs.ReVomanConfigForBT2BS.PERSONA_CREATION_AND_SETUP_CONFIG;
 
 import com.salesforce.revoman.ReVoman;
 import java.util.Map;
@@ -24,7 +24,7 @@ void testMilestoneBillingE2E() {
 				ReVoman.revUp(
 						(rundown, ignore) ->
 								assertThat(rundown.firstUnIgnoredUnsuccessfulStepReport()).isNull(),
-						USER_CREATION_AND_SETUP_CONFIG,
+						PERSONA_CREATION_AND_SETUP_CONFIG,
 						MILESTONE_SETUP_CONFIG,
 						MILESTONE_CONFIG);
 		assertThat(CollectionsKt.last(mbRundown).mutableEnv)
diff --git a/src/integrationTest/java/com/salesforce/revoman/integration/core/bt2bs/ReVomanConfigForBT2BS.java b/src/integrationTest/java/com/salesforce/revoman/integration/core/bt2bs/ReVomanConfigForBT2BS.java
@@ -29,15 +29,15 @@ private ReVomanConfigForBT2BS() {}
 
 	// ## User creation and Setup
 	static final String COLLECTION_PATH = "pm-templates/core/milestone/";
-	private static final String USER_CREATION_AND_SETUP_COLLECTION_PATH =
+	private static final String PERSONA_CREATION_AND_SETUP_COLLECTION_PATH =
 			COLLECTION_PATH + "persona-creation-and-setup.postman_collection.json";
-	static final Kick USER_CREATION_AND_SETUP_CONFIG =
+	static final Kick PERSONA_CREATION_AND_SETUP_CONFIG =
 			Kick.configure()
-					.templatePath(USER_CREATION_AND_SETUP_COLLECTION_PATH)
+					.templatePath(PERSONA_CREATION_AND_SETUP_COLLECTION_PATH)
 					.environmentPath(ENV_PATH)
 					.responseConfig(unmarshallCompositeGraphResponse(), unmarshallCompositeResponse())
 					.hooks(ASSERT_COMPOSITE_GRAPH_RESPONSE_SUCCESS, ASSERT_COMPOSITE_RESPONSE_SUCCESS)
-					.nodeModulesRelativePath(NODE_MODULE_RELATIVE_PATH)
+					.nodeModulesPath(NODE_MODULE_RELATIVE_PATH)
 					.haltOnFailureOfTypeExcept(
 							HTTP_STATUS, afterStepContainingHeader(IGNORE_HTTP_STATUS_UNSUCCESSFUL))
 					.insecureHttp(true)
@@ -69,7 +69,7 @@ HTTP_STATUS, afterStepContainingHeader(IGNORE_HTTP_STATUS_UNSUCCESSFUL))
 					.haltOnFailureOfTypeExcept(
 							HTTP_STATUS, afterStepContainingHeader(IGNORE_HTTP_STATUS_UNSUCCESSFUL))
 					.globalCustomTypeAdapter(IDAdapter.INSTANCE)
-					.nodeModulesRelativePath(NODE_MODULE_RELATIVE_PATH)
+					.nodeModulesPath(NODE_MODULE_RELATIVE_PATH)
 					.off();
 
 	// ## Milestone Config
@@ -86,6 +86,6 @@ HTTP_STATUS, afterStepContainingHeader(IGNORE_HTTP_STATUS_UNSUCCESSFUL))
 					.haltOnFailureOfTypeExcept(
 							HTTP_STATUS, afterStepContainingHeader(IGNORE_HTTP_STATUS_UNSUCCESSFUL))
 					.globalCustomTypeAdapter(IDAdapter.INSTANCE)
-					.nodeModulesRelativePath(NODE_MODULE_RELATIVE_PATH)
+					.nodeModulesPath(NODE_MODULE_RELATIVE_PATH)
 					.off();
 }
diff --git a/src/integrationTest/java/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java b/src/integrationTest/java/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java
@@ -78,7 +78,7 @@ void revUpPQ() {
 								.customDynamicVariableGenerator( // <5>
 										"$unitPrice",
 										(ignore1, ignore2, ignore3) -> String.valueOf(Random.Default.nextInt(999) + 1))
-								.nodeModulesRelativePath("js") // <6>
+								.nodeModulesPath("js") // <6>
 								.haltOnFailureOfTypeExcept(
 										HTTP_STATUS, afterStepContainingHeader("ignoreHTTPStatusUnsuccessful")) // <7>
 								.requestConfig( // <8>
diff --git a/src/integrationTest/java/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java b/src/integrationTest/java/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java
@@ -29,7 +29,7 @@ void restfulApiDev() {
 						Kick.configure()
 								.templatePath(PM_COLLECTION_PATH) // <2>
 								.environmentPath(PM_ENVIRONMENT_PATH) // <3>
-								.nodeModulesRelativePath("js")
+								.nodeModulesPath("js")
 								.off());
 		assertThat(rundown.firstUnIgnoredUnsuccessfulStepReport()).isNull(); // <4>
 		assertThat(rundown.stepReports).hasSize(4); // <5>
diff --git a/src/integrationTest/kotlin/com/salesforce/revoman/integration/apigee/ApigeeKtTest.kt b/src/integrationTest/kotlin/com/salesforce/revoman/integration/apigee/ApigeeKtTest.kt
@@ -16,9 +16,7 @@ class ApigeeKtTest {
   @Test
   fun `xml2js apigee`() {
     val rundown =
-      ReVoman.revUp(
-        Kick.configure().templatePath(PM_COLLECTION_PATH).nodeModulesRelativePath("js").off()
-      )
+      ReVoman.revUp(Kick.configure().templatePath(PM_COLLECTION_PATH).nodeModulesPath("js").off())
     assertThat(rundown.stepReports).hasSize(1)
     assertThat(rundown.firstUnsuccessfulStepReport).isNull()
     assertThat(rundown.mutableEnv["city"]).isEqualTo("San Jose")
diff --git a/src/integrationTest/kotlin/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevKtTest.kt b/src/integrationTest/kotlin/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevKtTest.kt
@@ -20,7 +20,7 @@ class RestfulAPIDevKtTest {
         Kick.configure()
           .templatePath(PM_COLLECTION_PATH) // <2>
           .environmentPath(PM_ENVIRONMENT_PATH) // <3>
-          .nodeModulesRelativePath("js")
+          .nodeModulesPath("js")
           .off()
       )
     assertThat(rundown.firstUnsuccessfulStepReport).isNull()
diff --git a/src/main/kotlin/com/salesforce/revoman/ReVoman.kt b/src/main/kotlin/com/salesforce/revoman/ReVoman.kt
@@ -113,12 +113,7 @@ object ReVoman {
         kick.dynamicEnvironmentsFlattened(),
       )
     val pm =
-      PostmanSDK(
-        moshiReVoman,
-        kick.nodeModulesRelativePath(),
-        regexReplacer,
-        environment.toMutableMap(),
-      )
+      PostmanSDK(moshiReVoman, kick.nodeModulesPath(), regexReplacer, environment.toMutableMap())
     val stepNameToReport =
       executeStepsSerially(pmStepsDeepFlattened, kick, moshiReVoman, regexReplacer, pm)
     return Rundown(stepNameToReport, pm.environment, kick.haltOnFailureOfTypeExcept())
diff --git a/src/main/kotlin/com/salesforce/revoman/input/config/KickDef.kt b/src/main/kotlin/com/salesforce/revoman/input/config/KickDef.kt
@@ -37,7 +37,7 @@ internal interface KickDef {
 
   fun dynamicEnvironments(): List<Map<String, String>>
 
-  fun nodeModulesRelativePath(): String?
+  fun nodeModulesPath(): String?
 
   @Value.Derived
   fun dynamicEnvironmentsFlattened(): Map<String, String> =
diff --git a/src/main/kotlin/com/salesforce/revoman/input/json/adapters/salesforce/CompositeGraphResponse.kt b/src/main/kotlin/com/salesforce/revoman/input/json/adapters/salesforce/CompositeGraphResponse.kt
@@ -66,7 +66,7 @@ data class CompositeGraphResponse(val graphs: List<Graph>) {
       @Json(ignore = true)
       @get:JvmName("firstErrorReferenceId")
       val firstErrorReferenceId: String? by lazy { errorResponses.firstOrNull()?.referenceId }
-      
+
       @Json(ignore = true)
       @get:JvmName("firstErrorResponse")
       val firstErrorResponse: CompositeErrorResponse? by lazy { errorResponses.firstOrNull() }
diff --git a/src/main/kotlin/com/salesforce/revoman/input/json/adapters/salesforce/CompositeResponse.kt b/src/main/kotlin/com/salesforce/revoman/input/json/adapters/salesforce/CompositeResponse.kt
@@ -147,7 +147,7 @@ data class CompositeResponse(val compositeResponse: List<Response>) {
   @Json(ignore = true)
   @get:JvmName("firstErrorReferenceId")
   val firstErrorReferenceId: String? by lazy { errorResponses.firstOrNull()?.referenceId }
-  
+
   @Json(ignore = true)
   @get:JvmName("firstErrorResponse")
   val firstErrorResponse: ErrorResponse? by lazy { errorResponses.firstOrNull() }
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/postman/PostmanSDK.kt b/src/main/kotlin/com/salesforce/revoman/internal/postman/PostmanSDK.kt
@@ -30,8 +30,8 @@ import org.intellij.lang.annotations.Language
  */
 class PostmanSDK(
   private val moshiReVoman: MoshiReVoman,
-  nodeModulesRelativePath: String? = null,
-  val regexReplacer: RegexReplacer = RegexReplacer(),
+  nodeModulesPath: String? = null,
+  internal val regexReplacer: RegexReplacer = RegexReplacer(),
   mutableEnv: MutableMap<String, Any?> = mutableMapOf(),
 ) {
   @JvmField val environment: PostmanEnvironment<Any?> = PostmanEnvironment(mutableEnv, moshiReVoman)
@@ -43,23 +43,24 @@ class PostmanSDK(
   lateinit var rundown: Rundown
   @JvmField val xml2Json = Xml2Json { xml -> moshiReVoman.fromJson(U.xmlToJson(xml)) }
   // * NOTE 28 Apr 2024 gopala.akshintala: This has to be initialized at last
-  private val jsEvaluator: JSEvaluator = JSEvaluator(nodeModulesRelativePath)
+  private val jsEvaluator: JSEvaluator = JSEvaluator(nodeModulesPath)
 
   @SuppressWarnings("kotlin:S6517")
   @FunctionalInterface // DON'T REMOVE THIS. Polyglot won't work without this
   fun interface Xml2Json {
     @Suppress("unused") fun xml2Json(xml: String): Any?
   }
 
-  inner class JSEvaluator(nodeModulesRelativePath: String? = null) {
+  inner class JSEvaluator(nodeModulesPath: String? = null) {
     private val jsContext: Context
     private var imports = ""
 
     init {
       val options = buildMap {
-        if (!nodeModulesRelativePath.isNullOrBlank()) {
+        if (!nodeModulesPath.isNullOrBlank()) {
+          logger.info { "nodeModulesPath: $nodeModulesPath" }
           put("js.commonjs-require", "true")
-          put("js.commonjs-require-cwd", nodeModulesRelativePath)
+          put("js.commonjs-require-cwd", nodeModulesPath)
           imports = "var _ = require('lodash')\n"
         }
         put("js.esm-eval-returns-exports", "true")
diff --git a/src/test/kotlin/com/salesforce/revoman/internal/postman/RegexReplacerTest.kt b/src/test/kotlin/com/salesforce/revoman/internal/postman/RegexReplacerTest.kt
@@ -88,8 +88,7 @@ class RegexReplacerTest {
   @OptIn(ExperimentalStdlibApi::class)
   @Test
   fun `duplicate dynamic variables for random value generation should have different values`() {
-    val regexReplacer = RegexReplacer()
-    val pm = PostmanSDK(mockk(), regexReplacer = regexReplacer)
+    val pm = PostmanSDK(mockk())
     val jsonStr =
       $$"""
       {
@@ -98,7 +97,7 @@ class RegexReplacerTest {
       }
       """
         .trimIndent()
-    val resultStr = regexReplacer.replaceVariablesRecursively(jsonStr, pm)!!
+    val resultStr = pm.regexReplacer.replaceVariablesRecursively(jsonStr, pm)!!
     val result = Moshi.Builder().build().adapter<Map<String, String>>().fromJson(resultStr)!!
     result["key1"]!! shouldNotBeEqual result["key2"]!!
   }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class RestfulAPIDevKtTest {`
`20`	`20`	`Kick.configure()`
`21`	`21`	`.templatePath(PM_COLLECTION_PATH) // <2>`
`22`	`22`	`.environmentPath(PM_ENVIRONMENT_PATH) // <3>`
`23`		`- .nodeModulesRelativePath("js")`
	`23`	`+ .nodeModulesPath("js")`
`24`	`24`	`.off()`
`25`	`25`	`)`
`26`	`26`	`assertThat(rundown.firstUnsuccessfulStepReport).isNull()`