- Add Step information to environment set logger

- Minor doc updates

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

Author: overfullstack

README.adoc

@@ -125,7 +125,7 @@ In the case of collision between variable keys, the precedence order to derive a
 
 [.lead]
 You can _kick off_ this *Template-Driven Testing* by invoking `ReVoman.revUp()`,
-supplying your Postman templates and environments, and all your customizations through a configuration:
+supplying your Postman templates and environments, and all your customizations through a *Configuration*:
 
 [source,java,indent=0,tabsize=2,options="nowrap"]
 ----
@@ -337,6 +337,11 @@ include::{integrationtestdir}/com/salesforce/revoman/integration/core/pq/PQE2EWi
 <14> Run more assertions on the <<Rundown>>
 endif::[]
 
+== Reuse Config
+
+You can define a base common config and reuse it by overriding certain properties using the `override...()` methods,
+which are present for each config attribute
+
 == Debugging UX
 
 [.lead]
@@ -365,7 +370,8 @@ Here is the failure hierarchy of what can go wrong in this process
 image::failure-hierarchy.png[Failure Hierarchy]
 
 [.lead]
-ReṼoman logs all the key operations that happen inside its source-code.
+ReṼoman logs all the key operations that happen inside its source-code,
+including how the environment variables are being mutated by a step in its <<Pre-req and Post-res scripts>>.
 Watch your console to check what's going on in the execution or troubleshoot from CI/CD logs
 
 NOTE: link:docs/revoman.exe.log[📝Sample log] printed during execution

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

@@ -15,6 +15,8 @@ import com.salesforce.revoman.internal.postman.template.Url
 import com.salesforce.revoman.output.Rundown
 import com.salesforce.revoman.output.postman.PostmanEnvironment
 import com.salesforce.revoman.output.report.StepReport
+import io.exoquery.pprint
+import io.github.oshai.kotlinlogging.KotlinLogging
 import org.graalvm.polyglot.Context
 import org.graalvm.polyglot.HostAccess
 import org.graalvm.polyglot.Source
@@ -36,6 +38,7 @@ class PostmanSDK(
   lateinit var request: Request
   lateinit var response: Response
   lateinit var currentStepReport: StepReport
+  @Suppress("unused")
   @JvmField val variables: Variables = Variables()
   lateinit var rundown: Rundown
   @JvmField val xml2Json = Xml2Json { xml -> moshiReVoman.asA(U.xmlToJson(xml)) }
@@ -112,14 +115,21 @@ class PostmanSDK(
     evaluateJS("jsonStr => JSON.parse(jsonStr)").execute(jsonStr)
 
   inner class Variables {
-    fun has(variableKey: String) = environment.containsKey(variableKey)
+    fun has(key: String) = environment.containsKey(key)
+
+    fun get(key: String) = environment[key]
 
-    fun get(variableKey: String) = environment[variableKey]
+    fun set(key: String, value: String) {
+      logger.info { "pm environment variable set through JS in Step: ${currentStepReport.step} - key: $key, value: ${pprint(value)}" }
+      environment.set(key, value)
+    }
 
-    fun set(variableKey: String, value: String) {
-      environment.set(variableKey, value)
+    fun unset(key: String) {
+      logger.info { "pm environment variable unset through JS in Step: ${currentStepReport.step} - key: $key" }
+      environment.unset(key)
     }
 
+    @Suppress("unused")
     fun replaceIn(stringToReplace: String): String =
       regexReplacer.replaceVariablesRecursively(stringToReplace, this@PostmanSDK) ?: ""
   }
@@ -161,3 +171,5 @@ class PostmanSDK(
 }
 
 data class Info(@JvmField val requestName: String)
+
+private val logger = KotlinLogging.logger {}

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

@@ -32,7 +32,7 @@ constructor(
 
   fun set(key: String, value: ValueT) {
     mutableEnv[key] = value
-    logger.info { "pm environment variable set through JS - key: $key, value: ${pprint(value)}" }
+    logger.info { "pm environment variable set - key: $key, value: ${pprint(value)}" }
   }
 
   @Suppress("unused")