StepReport.envSnapShotInPostmanEnvJSONFormat()

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

Author: overfullstack

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

@@ -121,7 +121,11 @@ object ReVoman {
         logger.info { "***** Executing Step: $step *****" }
         val itemWithRegex = step.rawPMStep
         val preStepReport =
-          StepReport(step, Right(TxnInfo(httpMsg = itemWithRegex.request.toHttpRequest())))
+          StepReport(
+            step,
+            Right(TxnInfo(httpMsg = itemWithRegex.request.toHttpRequest())),
+            moshiReVoman = moshiReVoman,
+          )
         pm.info = Info(step.name)
         pm.currentStepReport = preStepReport
         pm.rundown =

src/main/kotlin/com/salesforce/revoman/output/report/StepReport.kt

@@ -9,6 +9,7 @@ package com.salesforce.revoman.output.report
 
 import arrow.core.Either.Left
 import arrow.core.Either.Right
+import com.salesforce.revoman.internal.postman.template.Environment.Companion.fromMap
 import com.salesforce.revoman.output.ExeType
 import com.salesforce.revoman.output.postman.PostmanEnvironment
 import com.salesforce.revoman.output.report.TxnInfo.Companion.uriPathContains
@@ -23,6 +24,7 @@ import io.vavr.control.Either.left
 import io.vavr.control.Either.right
 import org.http4k.core.Request
 import org.http4k.core.Response
+import org.http4k.format.ConfigurableMoshi
 
 data class StepReport
 internal constructor(
@@ -31,20 +33,23 @@ internal constructor(
   @JvmField val preHookFailure: PreHookFailure? = null,
   @JvmField val responseInfo: Either<out ResponseFailure, TxnInfo<Response>>? = null,
   @JvmField val postHookFailure: PostHookFailure? = null,
-  @JvmField val envSnapshot: PostmanEnvironment<Any?> = PostmanEnvironment()
+  private val moshiReVoman: ConfigurableMoshi,
+  @JvmField val envSnapshot: PostmanEnvironment<Any?> = PostmanEnvironment(),
 ) {
   internal constructor(
     step: Step,
     requestInfo: arrow.core.Either<RequestFailure, TxnInfo<Request>>? = null,
     preHookFailure: PreHookFailure? = null,
     responseInfo: arrow.core.Either<ResponseFailure, TxnInfo<Response>>? = null,
-    postHookFailure: PostHookFailure? = null
+    postHookFailure: PostHookFailure? = null,
+    moshiReVoman: ConfigurableMoshi,
   ) : this(
     step,
     requestInfo?.toVavr(),
     preHookFailure,
     responseInfo?.toVavr(),
     postHookFailure,
+    moshiReVoman,
   )
 
   @JvmField
@@ -60,6 +65,11 @@ internal constructor(
   @JvmField
   val isHttpStatusSuccessful: Boolean = failure?.fold({ it !is PostHookFailure }, { true }) != true
 
+  @get:JvmName("envSnapShotInPostmanEnvJSONFormat")
+  val envSnapShotInPostmanEnvJSONFormat: String by lazy {
+    moshiReVoman.prettify(moshiReVoman.asFormatString(fromMap(envSnapshot, moshiReVoman)))
+  }
+
   companion object {
     private fun failure(
       requestInfo: Either<out ExeFailure, TxnInfo<Request>>? = null,
@@ -110,7 +120,7 @@ internal constructor(
     @JvmStatic
     fun Either<out RequestFailure, TxnInfo<Request>>?.containsHeader(
       key: String,
-      value: String
+      value: String,
     ): Boolean = this?.fold({ false }, { it.containsHeader(key, value) }) ?: false
   }
 

src/test/kotlin/com/salesforce/revoman/output/report/StepReportTest.kt

@@ -15,6 +15,7 @@ import com.salesforce.revoman.internal.postman.template.Url
 import com.salesforce.revoman.output.report.failure.HookFailure.PostHookFailure
 import com.salesforce.revoman.output.report.failure.RequestFailure.HttpRequestFailure
 import io.kotest.matchers.shouldBe
+import io.mockk.mockk
 import org.http4k.core.Method.POST
 import org.http4k.core.Response
 import org.http4k.core.Status.Companion.BAD_REQUEST
@@ -29,7 +30,11 @@ class StepReportTest {
       Request(method = POST.toString(), url = Url("https://overfullstack.github.io/"))
     val requestInfo = TxnInfo(String::class.java, "fakeRequest", rawRequest.toHttpRequest())
     val stepReportSuccess =
-      StepReport(Step("1.3.7", Item(request = rawRequest)), Right(requestInfo))
+      StepReport(
+        Step("1.3.7", Item(request = rawRequest)),
+        Right(requestInfo),
+        moshiReVoman = mockk(),
+      )
     println(stepReportSuccess)
     stepReportSuccess.isHttpStatusSuccessful shouldBe true
   }
@@ -42,7 +47,8 @@ class StepReportTest {
     val stepReportHttpFailure =
       StepReport(
         Step("1.3.7", Item(request = rawRequest)),
-        Left(HttpRequestFailure(RuntimeException("fakeRTE"), requestInfo))
+        Left(HttpRequestFailure(RuntimeException("fakeRTE"), requestInfo)),
+        moshiReVoman = mockk(),
       )
     println(stepReportHttpFailure)
     stepReportHttpFailure.isHttpStatusSuccessful shouldBe false
@@ -60,7 +66,8 @@ class StepReportTest {
         Step("", Item(request = rawRequest)),
         Right(requestInfo),
         null,
-        Right(badResponseInfo)
+        Right(badResponseInfo),
+        moshiReVoman = mockk(),
       )
     println(stepReportBadRequest)
     stepReportBadRequest.isHttpStatusSuccessful shouldBe false
@@ -78,7 +85,8 @@ class StepReportTest {
         Right(requestInfo),
         null,
         Right(responseInfo),
-        PostHookFailure(RuntimeException("fakeRTE"))
+        PostHookFailure(RuntimeException("fakeRTE")),
+        mockk(),
       )
     println(stepReportPostHookFailure)
     stepReportPostHookFailure.isHttpStatusSuccessful shouldBe true