Feature/8 implement methods

project/Dependencies.scala

@@ -26,6 +26,7 @@ object Dependencies {
   private val commonsIoVersion = "2.13.0"
   private val requestsVersion = "0.8.0"
   private val loggerVersion = "2.14.1"
+  private val scalaXmlVersion = "1.3.0"
 
   def getScalaDependency(scalaVersion: String): ModuleID = "org.scala-lang" % "scala-library" % scalaVersion
 
@@ -40,6 +41,7 @@ object Dependencies {
     "com.lihaoyi"               %% "requests"               % requestsVersion,
     "org.apache.logging.log4j"  % "log4j-core"              % loggerVersion,
     "org.apache.logging.log4j"  % "log4j-api"               % loggerVersion,
+    "org.scala-lang.modules"    %% "scala-xml"              % scalaXmlVersion,
 
     // test
     "org.scalameta"             %% "munit"                  % munitVersion          % Test

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

@@ -124,7 +124,7 @@
       "properties": {
         "method": {
           "type": "string",
-          "enum": ["assert.status-code", "assert.body-contains", "log.info", "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-contains-text", "log.error", "log.warn", "log.info", "log.debug", "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

@@ -122,7 +122,7 @@
       "properties": {
         "method": {
           "type": "string",
-          "enum": ["assert.status-code", "assert.body-contains", "log.info", "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-contains-text", "log.error", "log.warn", "log.info", "log.debug", "extractJson.string-from-list"],
           "description": "The method to be used for the response action."
         }
       },

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

@@ -133,7 +133,7 @@
       "properties": {
         "method": {
           "type": "string",
-          "enum": ["assert.status-code", "assert.body-contains", "log.info", "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-contains-text", "log.error", "log.warn", "log.info", "log.debug", "extractJson.string-from-list"],
           "description": "The method to be used for the response action."
         }
       },
@@ -156,7 +156,7 @@
             {
               "properties": {
                 "method": {
-                  "const": "assert.status-code"
+                  "const": "assert.status-code-equals"
                 }
               },
               "required": ["code"]
@@ -190,7 +190,7 @@
                   {
                     "properties": {
                       "method": {
-                        "const": "assert.status-code"
+                        "const": "assert.status-code-equals"
                       }
                     }
                   },

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

@@ -19,9 +19,9 @@ package africa.absa.testing.scapi.json
 trait Requestable {
   def name: String
 
-  def headers: Set[Header]
+  def headers: Seq[Header]
 
-  def actions: Set[Action]
+  def actions: Seq[Action]
 
-  def responseActions: Set[ResponseAction]
+  def responseActions: Seq[ResponseAction]
 }

testApi/src/main/scala/africa/absa/testing/scapi/model/Method.scala

@@ -27,9 +27,9 @@ import africa.absa.testing.scapi.json.{Action, Header, Requestable, ResponseActi
  * @param responseActions The set of responseAction objects for the method.
  */
 case class Method(name: String,
-                  headers: Set[Header],
-                  actions: Set[Action],
-                  responseActions: Set[ResponseAction]) extends Requestable {
+                  headers: Seq[Header],
+                  actions: Seq[Action],
+                  responseActions: Seq[ResponseAction]) extends Requestable {
   /**
    * Method to resolve references within the Method instance.
    *

testApi/src/main/scala/africa/absa/testing/scapi/model/SuiteTestScenario.scala

@@ -29,10 +29,10 @@ import africa.absa.testing.scapi.json.{Action, Header, Requestable, ResponseActi
  * @param only The control if test should be only be running when set to true.
  */
 case class SuiteTestScenario(name: String,
-                             categories: Set[String],
-                             headers: Set[Header],
-                             actions: Set[Action],
-                             responseActions: Set[ResponseAction],
+                             categories: Seq[String],
+                             headers: Seq[Header],
+                             actions: Seq[Action],
+                             responseActions: Seq[ResponseAction],
                              only: Option[Boolean] = Some(false)) extends Requestable {
   /**
    * Method to resolve references within the SuiteTestScenario instance.

testApi/src/main/scala/africa/absa/testing/scapi/rest/request/RequestHeaders.scala

@@ -35,7 +35,7 @@ object RequestHeaders {
    * @param headersSet A set of Header objects to be processed.
    * @return A Map where the key is the header name (lowercase) and the value is the resolved header value.
    */
-  def buildHeaders(headersSet: Set[Header]): Map[String, String] = {
+  def buildHeaders(headersSet: Seq[Header]): Map[String, String] = {
     headersSet.foldLeft(Map.empty[String, String]) {
       (acc, header) => header.name.toLowerCase match {
         case CONTENT_TYPE => acc + (header.name -> RuntimeCache.resolve(header.value))

testApi/src/main/scala/africa/absa/testing/scapi/rest/request/sender/ScAPIRequestSender.scala

@@ -18,11 +18,35 @@ package africa.absa.testing.scapi.rest.request.sender
 
 import africa.absa.testing.scapi.rest.response.Response
 
+import java.net.HttpCookie
+
 /**
  * ScAPIRequestSender is an implementation of the RequestSender interface.
  * It provides the capability to send different types of HTTP requests including GET, POST, PUT, and DELETE.
  */
 object ScAPIRequestSender extends RequestSender {
+
+  private def sendRequest(requestFunc: => requests.Response, url: String, headers: Map[String, String], verifySslCerts: Boolean, data: String, params: Map[String, String]): Response = {
+    val startTime = System.nanoTime()
+    val response = requestFunc
+    val endTime = System.nanoTime()
+
+    val extractedCookies: Map[String, (String, Boolean)] = response.cookies.view.map {
+      case (name, cookie: HttpCookie) =>
+        (name, (cookie.getValue, cookie.getSecure))
+    }.toMap
+
+    Response(
+      response.statusCode,
+      response.text(),
+      url = response.url,
+      statusMessage = response.statusMessage,
+      response.headers,
+      cookies = extractedCookies,
+      (endTime - startTime) / 1_000_000
+    )
+  }
+
   /**
    * Sends a GET request to the provided URL with the given headers, SSL certificate verification setting, data, and parameters.
    *
@@ -34,8 +58,7 @@ object ScAPIRequestSender extends RequestSender {
    * @return Response Returns the response from the GET request.
    */
   override def get(url: String, headers: Map[String, String], verifySslCerts: Boolean, data: String, params: Map[String, String]): Response = {
-    val response = requests.get(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params)
-    Response(response.statusCode, response.text(), response.headers.toMap)
+    sendRequest(requests.get(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params), url, headers, verifySslCerts, data, params)
   }
 
   /**
@@ -49,8 +72,7 @@ object ScAPIRequestSender extends RequestSender {
    * @return Response Returns the response from the POST request.
    */
   override def post(url: String, headers: Map[String, String], verifySslCerts: Boolean, data: String, params: Map[String, String]): Response = {
-    val response = requests.post(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params)
-    Response(response.statusCode, response.text(), response.headers.toMap)
+    sendRequest(requests.post(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params), url, headers, verifySslCerts, data, params)
   }
 
   /**
@@ -64,8 +86,7 @@ object ScAPIRequestSender extends RequestSender {
    * @return Response Returns the response from the PUT request.
    */
   override def put(url: String, headers: Map[String, String], verifySslCerts: Boolean, data: String, params: Map[String, String]): Response = {
-    val response = requests.put(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params)
-    Response(response.statusCode, response.text(), response.headers.toMap)
+    sendRequest(requests.put(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params), url, headers, verifySslCerts, data, params)
   }
 
   /**
@@ -79,7 +100,6 @@ object ScAPIRequestSender extends RequestSender {
    * @return Response Returns the response from the DELETE request.
    */
   override def delete(url: String, headers: Map[String, String], verifySslCerts: Boolean, data: String, params: Map[String, String]): Response = {
-    val response = requests.delete(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params)
-    Response(response.statusCode, response.text(), response.headers.toMap)
+    sendRequest(requests.delete(url = url, headers = headers, verifySslCerts = verifySslCerts, data = data, params = params), url, headers, verifySslCerts, data, params)
   }
 }