Problem with Specmatic Stub for application/xml Content Type #1151

premsvmm · 2024-06-20T15:06:02Z

premsvmm
Jun 20, 2024

Open API Spec:

openapi: 3.0.0
info:
  title: Testing API
  version: 1.0.0
  description: |
    Testing XML
paths:
  /ReqListKeys:
    post:
      summary: Request list of keys
      operationId: reqListKeys
      requestBody:
        required: true
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ReqListKeys'
      responses:
        '200':
          description: Successful response
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/RespListKeys'
components:
  schemas:
    ReqListKeys:
      type: object
      xml:
        name: "ReqListKeys"
        namespace: "http://xyz.org/upi/schema//"
        prefix: "upi"
      properties:
        Head:
          $ref: '#/components/schemas/Head'
    Head:
      type: object
      xml:
        name: "Head"
      properties:
        msgId:
          type: string
          xml:
            name: "msgId"
            attribute: true
        orgId:
          type: string
          xml:
            name: "orgId"
            attribute: true
        prodType:
          type: string
          xml:
            name: "prodType"
            attribute: true
        ts:
          type: string
          xml:
            name: "ts"
            attribute: true
        ver:
          type: string
          enum: [1.0, 2.0]
          xml:
            name: "ver"
            attribute: true
    RespListKeys:
      type: object
      xml:
        name: "RespListKeys"
        namespace: "http://xyz.org/upi/schema/"
        prefix: "ns2"
      properties:
        Head:
          $ref: '#/components/schemas/Head'

example-1.json

{
    "http-request": {
        "path": "/ReqListKeys",
        "method": "POST",
        "headers": {
            "Content-Type": "application/xml"
        },
        "body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<upi:ReqListKeys xmlns:upi=\"http://xyz.org/upi/schema/\">\n    <Head msgId=\"abcde\" orgId=\"157776\" prodType=\"UPI\" ts=\"1970-01-01T05:30:00+05:30\" ver=\"2.0\"/>\n</upi:ReqListKeys>"
    },
    "http-response": {
        "status": 200,
        "body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ns2:RespListKeys xmlns:ns2=\"http://xyz.org/upi/schema/\">\n    <Head msgId=\"syz\" orgId=\"org\" ts=\"2024-05-27T15:35:12+05:30\" ver=\"2.0\"/>\n</ns2:RespListKeys>\n",
        "status-text": "OK",
        "headers": {
            "Content-Type": "application/xml"
        }
    }
}

running stub using the command specmatic stub api-spec/xmltest/xml.yaml

specmatic --version
1.3.26

Request payload:

curl --location --request POST 'http://0.0.0.0:62366/ReqListKeys' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<upi:ReqListKeys xmlns:upi="http://xyz.org/upi/schema/">
    <Head msgId="abcde" orgId="157776" prodType="UPI" ts="1970-01-01T05:30:00+05:30" ver="2.0"/>
</upi:ReqListKeys>'

Response:

In scenario "Request list of keys. Response: Successful response"
API: POST /ReqListKeys -> 200

   REQUEST.BODY.ReqListKeys.Head
  
     Attribute named msgId in the request was not in the contract

The Open API spec appears correct, but the example JSON file consistently fails with the error Attribute named msgId in the request was not in the contract. I need assistance to resolve this issue.

Answered by joelrosario

Jun 26, 2024

Hi @premsvmm, thanks a lot for reporting this issue. There was a bug in the way Specmatic was handling attributes when one XML object referred to another XML object. This has been fixed in Specmatic's latest release, 1.3.30.

Here are the logs from my test, using your sample specification.

Logs from the Specmatic stub server:

Using default Specmatic
Loading xml-spec.yaml
API Specification Summary: xml-spec.yaml
  OpenAPI Version: 3.0.0
  API Paths: 1, API Operations: 1
  Schema components: 3, Security Schemes: none

  Loading stub expectations from /Users/joelrosario/tmp/razorpay/xml-spec_data
  Reading the following stub files:
    /Users/joelrosario/tmp/razorpay/xml-spec_data/example-1.j…

View full answer

joelrosario · 2024-06-26T10:14:28Z

joelrosario
Jun 26, 2024
Maintainer

Hi @premsvmm, thanks a lot for reporting this issue. There was a bug in the way Specmatic was handling attributes when one XML object referred to another XML object. This has been fixed in Specmatic's latest release, 1.3.30.

Here are the logs from my test, using your sample specification.

Logs from the Specmatic stub server:

Using default Specmatic
Loading xml-spec.yaml
API Specification Summary: xml-spec.yaml
  OpenAPI Version: 3.0.0
  API Paths: 1, API Operations: 1
  Schema components: 3, Security Schemes: none

  Loading stub expectations from /Users/joelrosario/tmp/razorpay/xml-spec_data
  Reading the following stub files:
    /Users/joelrosario/tmp/razorpay/xml-spec_data/example-1.json

Stub server is running on http://0.0.0.0:9000. Ctrl + C to stop.

--------------------
  Contract matched: xml-spec.yaml

  Request at 2024-6-26 3:40:57.52
    POST /ReqListKeys
    Host: localhost:9000
    User-Agent: curl/8.6.0
    Accept: */*
    Content-Type: application/xml
    Content-Length: 208
    
    <upi:ReqListKeys xmlns:upi="http://xyz.org/upi/schema/"><Head msgId="abcde" orgId="157776" prodType="UPI" ts="1970-01-01T05:30:00+05:30" ver="2.0"/></upi:ReqListKeys>

  Response at 2024-6-26 3:40:57.59
    200 OK
    Content-Type: application/xml
    X-Specmatic-Result: success
    
    <ns2:RespListKeys xmlns:ns2="http://xyz.org/upi/schema/"><Head msgId="syz" orgId="org" ts="2024-05-27T15:35:12+05:30" ver="2.0"/></ns2:RespListKeys>

Logs from the curl command invoking the stub with the expected XML request:

 ~/tmp/razorpay  curl -X POST -H 'Content-Type: application/xml' -d '<?xml version="1.0" encoding="UTF-8"?><upi:ReqListKeys xmlns:upi="http://xyz.org/upi/schema/">    <Head msgId="abcde" orgId="157776" prodType="UPI" ts="1970-01-01T05:30:00+05:30" ver="2.0"/></upi:ReqListKeys>' http://localhost:9000/ReqListKeys
<ns2:RespListKeys xmlns:ns2="http://xyz.org/upi/schema/"><Head msgId="syz" orgId="org" ts="2024-05-27T15:35:12+05:30" ver="2.0"/></ns2:RespListKeys>

Please reach out to us if you any questions about this.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Problem with Specmatic Stub for application/xml Content Type #1151

{{title}}

Replies: 1 comment

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Select a reply

Problem with Specmatic Stub for application/xml Content Type #1151

premsvmm Jun 20, 2024

Replies: 1 comment

joelrosario Jun 26, 2024 Maintainer

premsvmm
Jun 20, 2024

joelrosario
Jun 26, 2024
Maintainer