#8 - Implement method ideas #1 (#40)

* #8 - Implement method ideas #1
- Added new method for logging - log-info-response.
- Added logic toRichString for Response and Request.
- Extended Logger to support TRACE. TRACE Level used for printing full content of Response and Request instances.

Author: miroslavpojer

testApi/src/main/resources/log4j2.xml

@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Configuration status="WARN">
+<Configuration status="INFO">
     <Appenders>
         <Console name="Console" target="SYSTEM_OUT">
             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
         </Console>
     </Appenders>
     <Loggers>
-        <Root level="debug">
+        <Root level="INFO">
             <AppenderRef ref="Console"/>
         </Root>
     </Loggers>

testApi/src/main/resources/schema/after.schema.json

@@ -121,7 +121,7 @@
       "properties": {
         "method": {
           "type": "string",
-          "enum": ["assert.response-time-is-below", "assert.response-time-is-above", "assert.status-code-equals", "assert.status-code-is-success", "assert.status-code-is-client-error", "assert.status-code-is-server-error", "assert.header-exists", "assert.header-value-equals", "assert.content-type-is-json", "assert.content-type-is-xml", "assert.content-type-is-html", "assert.cookie-exists", "assert.cookie-value-equals", "assert.cookie-is-secured", "assert.cookie-is-not-secured", "assert.body-equals", "assert.body-contains-text", "assert.body-is-empty", "assert.body-is-not-empty", "assert.body-length-equals", "assert.body-starts-with", "assert.body-ends-with", "assert.body-matches-regex", "assert.body-json-is-json-array", "assert.body-json-is-json-object", "assert.body-json-path-exists", "log.error", "log.warn", "log.info", "log.debug", "extractJson.string-from-list"],
+          "enum": ["assert.response-time-is-below", "assert.response-time-is-above", "assert.status-code-equals", "assert.status-code-is-success", "assert.status-code-is-client-error", "assert.status-code-is-server-error", "assert.header-exists", "assert.header-value-equals", "assert.content-type-is-json", "assert.content-type-is-xml", "assert.content-type-is-html", "assert.cookie-exists", "assert.cookie-value-equals", "assert.cookie-is-secured", "assert.cookie-is-not-secured", "assert.body-equals", "assert.body-contains-text", "assert.body-is-empty", "assert.body-is-not-empty", "assert.body-length-equals", "assert.body-starts-with", "assert.body-ends-with", "assert.body-matches-regex", "assert.body-json-is-json-array", "assert.body-json-is-json-object", "assert.body-json-path-exists", "log.error", "log.warn", "log.info", "log.debug", "log.log-info-response", "extractJson.string-from-list"],
           "description": "The method to be used for the response action. Restricted to specific values."
         }
       },

testApi/src/main/resources/schema/before.schema.json

@@ -119,7 +119,7 @@
       "properties": {
         "method": {
           "type": "string",
-          "enum": ["assert.response-time-is-below", "assert.response-time-is-above", "assert.status-code-equals", "assert.status-code-is-success", "assert.status-code-is-client-error", "assert.status-code-is-server-error", "assert.header-exists", "assert.header-value-equals", "assert.content-type-is-json", "assert.content-type-is-xml", "assert.content-type-is-html", "assert.cookie-exists", "assert.cookie-value-equals", "assert.cookie-is-secured", "assert.cookie-is-not-secured", "assert.body-equals", "assert.body-contains-text", "assert.body-is-empty", "assert.body-is-not-empty", "assert.body-length-equals", "assert.body-starts-with", "assert.body-ends-with", "assert.body-matches-regex", "assert.body-json-is-json-array", "assert.body-json-is-json-object", "assert.body-json-path-exists", "log.error", "log.warn", "log.info", "log.debug", "extractJson.string-from-list"],
+          "enum": ["assert.response-time-is-below", "assert.response-time-is-above", "assert.status-code-equals", "assert.status-code-is-success", "assert.status-code-is-client-error", "assert.status-code-is-server-error", "assert.header-exists", "assert.header-value-equals", "assert.content-type-is-json", "assert.content-type-is-xml", "assert.content-type-is-html", "assert.cookie-exists", "assert.cookie-value-equals", "assert.cookie-is-secured", "assert.cookie-is-not-secured", "assert.body-equals", "assert.body-contains-text", "assert.body-is-empty", "assert.body-is-not-empty", "assert.body-length-equals", "assert.body-starts-with", "assert.body-ends-with", "assert.body-matches-regex", "assert.body-json-is-json-array", "assert.body-json-is-json-object", "assert.body-json-path-exists", "log.error", "log.warn", "log.info", "log.debug", "log.log-info-response", "extractJson.string-from-list"],
           "description": "The method to be used for the response action."
         }
       },

testApi/src/main/resources/schema/suite.schema.json

@@ -130,7 +130,7 @@
       "properties": {
         "method": {
           "type": "string",
-          "enum": ["assert.response-time-is-below", "assert.response-time-is-above", "assert.status-code-equals", "assert.status-code-is-success", "assert.status-code-is-client-error", "assert.status-code-is-server-error", "assert.header-exists", "assert.header-value-equals", "assert.content-type-is-json", "assert.content-type-is-xml", "assert.content-type-is-html", "assert.cookie-exists", "assert.cookie-value-equals", "assert.cookie-is-secured", "assert.cookie-is-not-secured", "assert.body-equals", "assert.body-contains-text", "assert.body-is-empty", "assert.body-is-not-empty", "assert.body-length-equals", "assert.body-starts-with", "assert.body-ends-with", "assert.body-matches-regex", "assert.body-json-is-json-array", "assert.body-json-is-json-object", "assert.body-json-path-exists", "log.error", "log.warn", "log.info", "log.debug", "extractJson.string-from-list"],
+          "enum": ["assert.response-time-is-below", "assert.response-time-is-above", "assert.status-code-equals", "assert.status-code-is-success", "assert.status-code-is-client-error", "assert.status-code-is-server-error", "assert.header-exists", "assert.header-value-equals", "assert.content-type-is-json", "assert.content-type-is-xml", "assert.content-type-is-html", "assert.cookie-exists", "assert.cookie-value-equals", "assert.cookie-is-secured", "assert.cookie-is-not-secured", "assert.body-equals", "assert.body-contains-text", "assert.body-is-empty", "assert.body-is-not-empty", "assert.body-length-equals", "assert.body-starts-with", "assert.body-ends-with", "assert.body-matches-regex", "assert.body-json-is-json-array", "assert.body-json-is-json-object", "assert.body-json-path-exists", "log.error", "log.warn", "log.info", "log.debug", "log.log-info-response", "extractJson.string-from-list"],
           "description": "The method to be used for the response action."
         }
       },

testApi/src/main/scala/africa/absa/testing/scapi/ScAPIRunner.scala

@@ -47,7 +47,12 @@ object ScAPIRunner {
       case Failure(exception) => throw exception
     }
 
-    Logger.setLevel(if (cmd.debug) Level.DEBUG else Level.INFO)
+    System.setProperty("log4j.configurationFile", "log4j2.xml")
+    cmd match {
+      case c if c.trace => Logger.setLevel(Level.TRACE)
+      case c if c.debug => Logger.setLevel(Level.DEBUG)
+      case _ => Logger.setLevel(Level.INFO)
+    }
     cmd.logConfigInfo()
 
     if (!Files.exists(Paths.get(cmd.testRootPath, "suites"))) throw SuiteLoadFailedException("'suites' directory have to exist in project root.")
@@ -70,6 +75,6 @@ object ScAPIRunner {
 
   def main(args: Array[String]): Unit = {
     val output = run(args)
-    Logger.info(s"\n$output")
+    Logger.info(s"ScAPI Runner output:\n$output")
   }
 }

testApi/src/main/scala/africa/absa/testing/scapi/config/ScAPIRunnerConfig.scala

@@ -23,18 +23,20 @@ import scopt.OptionParser
 import scala.util.{Failure, Success, Try}
 
 /**
- * Case class that represents the configuration provided by command line parameters for ScAPIRunner
+ * Case class that represents the configuration provided by command line parameters for ScAPIRunner.
  *
- * @param envPath       Path to the environment definition. Default is empty string.
- * @param testRootPath  Path to the root directory of test definitions. Default is empty string.
+ * @param envPath       Path to the environment definition. Default is an empty string.
+ * @param testRootPath  Path to the root directory of test definitions. Default is an empty string.
  * @param filter        Filter rule for selecting test definitions files. Default is "(.*)".
  * @param categories    Test categories to include in the test suite. Default is all categories "*".
  * @param threadCount   Maximum number of threads used to run the test suite. Default is '1'.
  * @param fileFormat    Format of definition files. Default is 'json'.
- * @param report        Path to the report output directory. Default is empty string.
- * @param validateOnly  Validate input definitions only. Default is 'false'.
+ * @param report        Path to the report output directory. Default is an empty string.
+ * @param debug         Enable debug mode. Default is 'false'.
+ * @param trace         Enable trace mode for more detailed logging. Default is 'false'.
+ * @param validateOnly  Validate input definitions only, without executing tests. Default is 'false'.
  *
- * @constructor Create a new configuration with a env, testRootPath, filter, categories, threadCount, fileFormat, report, validateOnly.
+ * @constructor Create a new configuration with envPath, testRootPath, filter, categories, threadCount, fileFormat, report, debug, trace, and validateOnly.
  */
 case class ScAPIRunnerConfig(envPath: String = "",
                              testRootPath: String = "",
@@ -44,6 +46,7 @@ case class ScAPIRunnerConfig(envPath: String = "",
                              fileFormat: String = DefaultFileFormat,
                              report: String = DefaultReport,
                              debug: Boolean = false,
+                             trace: Boolean = false,
                              validateOnly: Boolean = false) {
   /**
    * Method to log configuration information
@@ -60,6 +63,7 @@ case class ScAPIRunnerConfig(envPath: String = "",
        |--fileFormat: $fileFormat
        |--threadCount: $threadCount
        |--debug: $debug
+       |--trace: $trace
        |--validate only: $validateOnly
   """.stripMargin)
   }
@@ -143,6 +147,11 @@ object ScAPIRunnerConfig {
       .action((_, config) => { config.copy(debug = true) })
       .text("Activate debug regime.")
 
+    opt[Unit]("trace")
+      .optional()
+      .action((_, config) => { config.copy(trace = true) })
+      .text("Activate trace regime.")
+
     opt[Unit]("validate-only")
       .optional()
       .action((_, config) => { config.copy(validateOnly = true) })

testApi/src/main/scala/africa/absa/testing/scapi/json/ReferenceResolver.scala

@@ -251,6 +251,17 @@ case class ResponseAction private(group: ResponseActionGroupType,
   def resolveByRuntimeCache(): ResponseAction = this.copy(
     params = this.params.map { case (k, v) => k -> RuntimeCache.resolve(v) }
   )
+
+  def toRichString: String = {
+    val paramsString = params.map { case (name, value) => s"  $name: $value" }.mkString("\n")
+
+    s"""
+       |Group: $group
+       |Name: $name
+       |Params:
+       |$paramsString
+       |""".stripMargin
+  }
 }
 
 /**

testApi/src/main/scala/africa/absa/testing/scapi/logging/Logger.scala

@@ -16,6 +16,7 @@
 
 package africa.absa.testing.scapi.logging
 
+import org.apache.logging.log4j.core.config.Configurator
 import org.apache.logging.log4j.{Level, LogManager}
 
 object Logger {
@@ -32,6 +33,7 @@ object Logger {
         .map(_.getClassName)
         .getOrElse("unknown")
       val logger = LogManager.getLogger(callerClassName)
+      Configurator.setLevel(logger.getName, level)
 
       if (logger.isEnabled(messageLevel)) logger.log(messageLevel, message)
     }
@@ -52,4 +54,8 @@ object Logger {
   def error(message: String): Unit = {
     log(Level.ERROR, message)
   }
+
+  def trace(message: String): Unit = {
+    log(Level.TRACE, message)
+  }
 }

testApi/src/main/scala/africa/absa/testing/scapi/rest/RestClient.scala

@@ -16,6 +16,7 @@
 
 package africa.absa.testing.scapi.rest
 
+import africa.absa.testing.scapi.logging.Logger
 import africa.absa.testing.scapi.rest.request.sender.RequestSender
 import africa.absa.testing.scapi.rest.response.Response
 
@@ -41,6 +42,19 @@ class RestClient(requestSender: RequestSender) {
    * @throws IllegalArgumentException If the method is not 'get', 'post', 'put' or 'delete'.
    */
   def sendRequest(method: String, url: String, body: String, headers: Map[String, String], params: Map[String, String], verifySslCerts: Boolean = false): Response = {
+    Logger.trace(
+      s"""Sending $method request to
+         |URL: $url
+         |Headers:
+         |${headers.map { case (name, value) => s"  $name: $value" }.mkString("\n")}
+         |Params:
+         |${params.map { case (name, value) => s"  $name: $value" }.mkString("\n")}
+         |Body:
+         |$body
+         |Verify SSL Certs: $verifySslCerts
+         |""".stripMargin
+    )
+
     method.toLowerCase match {
       case "get" => requestSender.get(url = url, headers = headers, verifySslCerts = verifySslCerts, data = body, params = params)
       case "post" => requestSender.post(url = url, headers = headers, verifySslCerts = verifySslCerts, data = body, params = params)

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/Response.scala

@@ -30,7 +30,25 @@ case class Response(statusCode: Int,
                     statusMessage: String,
                     headers: Map[String, Seq[String]],
                     cookies: Map[String, CookieValue],
-                    duration: Long)
+                    duration: Long) {
+
+  def toRichString: String = {
+    val headerString = headers.map { case (name, value) => s"  $name: $value" }.mkString("\n")
+    val cookieString = cookies.map { case (name, value) => s"  $name: $value" }.mkString("\n")
+
+    s"""
+       |URL: $url
+       |Status: $statusCode $statusMessage
+       |Duration: ${duration}ms
+       |Headers:
+       |$headerString
+       |Cookies:
+       |$cookieString
+       |Body:
+       |$body
+       |""".stripMargin
+  }
+}
 
 /**
  * A singleton object that is responsible for managing and handling responses.
@@ -54,15 +72,19 @@ object Response {
   }
 
   /**
-   * Performs actions on the given Response based on a set of Assertions.
-   * Each response action is resolved by the runtime cache before being used.
-   * The appropriate group's performAssertions method is called based on the group type of each Assertion.
-   * Returns true only if all assertions return true, and false as soon as any assertion returns false.
+   * Executes a sequence of response actions on the provided Response object based on a set of ResponseActions.
+   * Each response action is resolved using runtime cache before execution.
+   * This method delegates the assertion execution to the corresponding performAssertions method
+   * based on the group type of each ResponseAction within the sequence.
+   * The method returns successfully only if all assertions pass.
+   * If any assertion fails, the method returns a failed Try with an appropriate exception.
    *
-   * @param response   The response on which actions will be performed.
-   * @param responseActions The set of response actions that dictate what actions will be performed on the response.
-   * @return           Boolean indicating whether all response actions passed (true) or any response action failed (false). TODO
-   * @throws IllegalArgumentException If an response action group is not supported.
+   * @param response        The HTTP response object on which the actions will be performed.
+   * @param responseActions A sequence of ResponseAction objects representing the actions and assertions
+   *                        to be performed on the response.
+   * @return                A Try[Unit] indicating success if all response actions pass, or containing
+   *                        an exception if any response action fails.
+   * @throws IllegalArgumentException If an unsupported response action group is encountered.
    */
   def perform(response: Response, responseActions: Seq[ResponseAction]): Try[Unit] = {
     def logParameters(response: Response, resolvedResponseAction: ResponseAction, exception: Option[Throwable] = None): Unit = {
@@ -80,7 +102,7 @@ object Response {
            |    Method->'${resolvedResponseAction.name}',
            |    Params->'$filteredParams',
            |  Actual Response:
-           |    $response""".stripMargin
+           |    ${response.toRichString}""".stripMargin
       val exceptionLog = exception.map(e => s"\nException: ${e.getMessage}").getOrElse("")
       Logger.debug(s"Response-${resolvedResponseAction.group}: '${resolvedResponseAction.name}' - error details:$baseLog$exceptionLog")
     }