#55 Support of XML body in response (#56)

Author: thomaspoignant

README.md

@@ -347,7 +347,7 @@ Assertions are a big part of api-scenario, this is the acceptance tests of your
 |---             |---
 |**source**      | The location of the data to extract for comparison.<br>See [available source type](#available-source-type) to have authorized values.
 |**comparison**  | The type of operation to perform when comparing the extracted data with the target value.  _([see Available comparison type](#available-comparison-type))_.
-|**property**    | The property of the source data to retrieve.<br><ul><li>For **HTTP headers**, this is the name of the header.</li><li>Data from a **JSON** response body can be extracted by specifying the path of the data using standard JavaScript notation.</li><li>Unused for text content, status code, response time and response size.</li>
+|**property**    | The property of the source data to retrieve.<br><ul><li>For **HTTP headers**, this is the name of the header.</li><li>Data from a **JSON / XML** response body can be extracted by specifying the path of the data using standard JavaScript notation.</li><li>Unused for text content, status code, response time and response size.</li>
 |**value**       | The expected value used to compare against the actual value. 
 
 
@@ -385,6 +385,7 @@ Assertions are a big part of api-scenario, this is the acceptance tests of your
 |**Response Headers**             |`response_header`  |Target headers of the response.
 |**Body response _(JSON)_**       |`response_json`    |Target the response body extract in JSON.
 |**Body response _(plain text)_** |`response_text`    |Target the response body extract in plain text.
+|**Body response _(XML)_**        |`response_xml `    |Target the response body extract in XML.
 
 #### Available comparison type
 
@@ -398,7 +399,7 @@ Assertions are a big part of api-scenario, this is the acceptance tests of your
 |**does not contain** 	|`does_not_contain`      |The target value is not found within the actual value.
 |**has key**        |`has_key`                   |Checks for the existence of the expected value within a dictionary's keys. The actual value must point to a dictionary **(JSON only)**.
 |**has value** 	    |`has_value`                 |Checks a list or dictionary for the existence of the expected value in any of the list or dictionary values. The actual value must point to a JSON list or dictionary **(JSON only)**.
-|**is null**        |`is_null`                   |Checks that a value for a given JSON key is null.
+|**is null**        |`is_null`                   |Checks that a value for a given JSON or XML key is null.
 |**is a number**    |`is_a_number`               |Validates the actual value is (or can be cast to) a valid numeric value.
 |**less than** 	    |`is_less_than`              |Validates the actual value is (or can be cast to) a number less than the target value.
 |**less than or equal** |`is_less_than_or_equals`|Validates the actual value is (or can be cast to) a number less than or equal to the target value.

go.mod

@@ -4,6 +4,7 @@ go 1.14
 
 require (
 	github.com/alvaroloes/enumer v1.1.2 // indirect
+	github.com/clbanning/mxj v1.8.4
 	github.com/fatih/color v1.9.0
 	github.com/fsnotify/fsnotify v1.4.9 // indirect
 	github.com/ghodss/yaml v1.0.0

go.sum

@@ -29,6 +29,8 @@ github.com/bketelsen/crypt v0.0.3-0.20200106085610-5cbc8cc4026c/go.mod h1:MKsuJm
 github.com/campoy/jsonenums v0.0.0-20180221195324-eec6d38da64e h1:mvV9x2xFIhLJiVOGQsOJzkOOZ++cP7jELzkUSXGo32M=
 github.com/campoy/jsonenums v0.0.0-20180221195324-eec6d38da64e/go.mod h1:Q9wN7HDfRAAFkNeQbMKz9G8lzkS75y2tTzcE/HMNMrc=
 github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
+github.com/clbanning/mxj v1.8.4 h1:HuhwZtbyvyOw+3Z1AowPkU87JkJUSv751ELWaiTpj8I=
+github.com/clbanning/mxj v1.8.4/go.mod h1:BVjHeAH+rl9rs6f+QIpeRl0tfu10SXn1pUSa5PVGJng=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk=
 github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=

pkg/controller/assertion_ctrl.go

@@ -3,6 +3,8 @@ package controller
 import (
 	"errors"
 	"fmt"
+	"github.com/clbanning/mxj"
+	"github.com/google/go-cmp/cmp"
 	"github.com/jmoiron/jsonq"
 	"github.com/thomaspoignant/api-scenario/pkg/context"
 	"github.com/thomaspoignant/api-scenario/pkg/model"
@@ -49,14 +51,19 @@ func (ctrl *assertionControllerImpl) Assert(assertion model.Assertion, resp mode
 		res.Source = assertion.Source
 		return res
 
+	case model.ResponseXml:
+		res := ctrl.assertResponseXml(assertion, resp.Body)
+		res.Source = assertion.Source
+		return res
+
 	case model.ResponseHeader:
 		res := ctrl.assertResponseHeader(assertion, resp.Header)
 		res.Source = assertion.Source
 		return res
 
 	case model.ResponseText:
 		var res model.ResultAssertion
-
+		assertion.Property = "body"
 		if util.IsNumeric(resp.Body) {
 			bodyAsFloat, _ := strconv.ParseFloat(resp.Body, 64)
 			res = ctrl.assertNumber(assertion, bodyAsFloat)
@@ -101,7 +108,7 @@ func (ctrl *assertionControllerImpl) assertResponseHeader(assertion model.Assert
 	return result
 }
 
-// assertResponseHeader is testing an assertion on the JSON body of the response.
+// assertResponseJson is testing an assertion on the JSON body of the response.
 func (ctrl *assertionControllerImpl) assertResponseJson(assertion model.Assertion, bodyAsString string) model.ResultAssertion {
 
 	if len(bodyAsString) > 0 && !util.IsJson(bodyAsString) {
@@ -114,6 +121,26 @@ func (ctrl *assertionControllerImpl) assertResponseJson(assertion model.Assertio
 		return model.ResultAssertion{Success: false, Message: err.Error(), Err: err, Property: assertion.Property}
 	}
 
+	return ctrl.assertResponseMap(assertion, body)
+}
+
+// assertResponseXml is testing an assertion on the XML body of the response.
+func (ctrl *assertionControllerImpl) assertResponseXml(assertion model.Assertion, bodyAsString string) model.ResultAssertion {
+
+	if len(bodyAsString) == 0 {
+		message := "there is a result and this is not a valid XML api Response"
+		return model.ResultAssertion{Success: false, Message: message, Err: errors.New(message), Property: assertion.Property}
+	}
+
+	body, err := mxj.NewMapXml([]byte(bodyAsString))
+	if err != nil {
+		return model.ResultAssertion{Success: false, Message: err.Error(), Err: err, Property: assertion.Property}
+	}
+
+	return ctrl.assertResponseMap(assertion, body.Old())
+}
+
+func (ctrl *assertionControllerImpl) assertResponseMap(assertion model.Assertion, body map[string]interface{}) model.ResultAssertion {
 	// Convert property from Json syntax to an array of fields
 	jqPath := util.JsonConvertKeyName(assertion.Property)
 
@@ -252,7 +279,11 @@ func (ctrl *assertionControllerImpl) assertString(assertion model.Assertion, api
 
 	case model.IsANumber:
 		success := util.IsNumeric(apiValue)
-		return model.NewResultAssertion(comparison, success, apiValue)
+		var paramToDisplay string
+		if paramToDisplay = assertion.Property; len(paramToDisplay) == 0 {
+			paramToDisplay = apiValue
+		}
+		return model.NewResultAssertion(comparison, success, paramToDisplay)
 
 	case model.EqualNumber:
 		if util.IsNumeric(apiValue) {
@@ -284,7 +315,7 @@ func (ctrl *assertionControllerImpl) assertString(assertion model.Assertion, api
 
 	case model.Empty:
 		success := strings.TrimSpace(apiValue) == ""
-		return model.NewResultAssertion(comparison, success, apiValue)
+		return model.NewResultAssertion(comparison, success, propertyName)
 
 	default:
 		message := fmt.Sprintf(ComparisonNotSupportedMessage, comparison)
@@ -332,7 +363,7 @@ func (ctrl *assertionControllerImpl) assertArray(assertion model.Assertion, apiV
 
 	switch comparison {
 	case model.IsANumber:
-		return model.NewResultAssertion(comparison, false, apiValue)
+		return model.NewResultAssertion(comparison, false, propertyName)
 
 	case model.IsNull:
 		return model.NewResultAssertion(comparison, false, propertyName)
@@ -409,6 +440,14 @@ func (ctrl *assertionControllerImpl) assertMap(assertion model.Assertion, apiVal
 		}
 		return model.NewResultAssertion(comparison, false, propertyName)
 
+	case model.IsNull:
+		// This is a bit hacky but it allows to check null from XML body.
+		nullValue := map[string]interface{}{"-null": "true"}
+		if cmp.Equal(apiValue, nullValue) {
+			return model.NewResultAssertion(comparison, true, propertyName)
+		}
+		return model.NewResultAssertion(comparison, false, propertyName)
+
 	default:
 		message := fmt.Sprintf(ComparisonNotSupportedMessage, comparison)
 		return model.ResultAssertion{Success: false, Message: message, Err: errors.New(message)}