Generate test with a form encoded file?

[jpjpjp]

Apologies if I missed this in the docs somehow, but I'm wondering if it's possible to configure portman to generate a request that uploads a file via a form-data/multipart body.

My spec defines such a request, and I've got a portman test which configures the form-date request body as follows:

          - overwriteRequestBody:
              - key: file
                value: "./specs/v2/tests/test-files/test-attachment.png"
                type: file
              - key: notes
                value: "Test file attachment"

Unfortunately, when portman generates a collection using this config, this appears to have no file attached to it when I view the collection in postman:

This is the generated Postman collection, which defines the body:

    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "description": {
            "content": "(Required) The file to attach",
            "type": "text/plain"
          },
          "key": "file",
          "type": "file"
        },
        {
          "description": {
            "content": "Optional notes about the file",
            "type": "text/plain"
          },
          "key": "notes",
          "value": "Test file attachment",
          "type": "text"
        }
      ]
    }

Notice that this appears to be missing the value property for the key file. I get the same output if I remove the type property from my portman configuration.

If I modify the request in Postman and upload the file from the Postman GUI:

The request works as expected. When I export the modified collection, the collection body now looks like this:

  "body": {
	  "mode": "formdata",
	  "formdata": [
		  {
			  "key": "file",
			  "description": "(Required) The file to attach",
			  "type": "file",
			  "src": "/Users/jp/XXXXX/"
		  },
		  {
			  "key": "notes",
			  "value": "labore Duis reprehenderit in tempor",
			  "description": "Optional notes about the file",
			  "type": "text"
		  }
	  ]
  },
  

Is this type of test supported in Portman?

I've attached a simple spec and config that can be used to replicate this issue. The zip also includes the collection generated from this request: npx portman -l form-data-spec.yaml -c form-data-config.yaml

form-data.zip

[thim81]

hi @jpjpjp

We have just released Portman v1.32.0, where we introduce the overwrite of binary files.

OpenAPI Example:

openapi: 3.0.3
info:
  title: 501 - File Upload API
  version: 1.0.0
  description: |-
    A basic API spec to demonstrate file uploads.
servers:
  - url: http://localhost:3000
    description: Local test server
paths:
  /upload:
    post:
      summary: Upload a file
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                reqFile:
                  type: string
                  format: binary
              required:
                - reqFile
      responses:
        '200':
          description: File uploaded successfully

Portman Config:

{
  "version": 1,
  "overwrites": [
    {
      "openApiOperation": "POST::/upload",
      "overwriteRequestBody": [
        {
          "key": "reqFile",
          "value": "./hello.txt",
          "overwrite": true
        }
      ]
    }
  ]
}

Postman Result :

BEFORE overwrite

AFTER overwrite:

Let us know, if this helps to solve your reported case.

[jpjpjp]

Hi @thim81, thank you very much for looking into this use case. I appreciate it.

I can confirm that this is working with the sample I initially provided, and that, when the generated postman collection is run with newman, the file is correctly attached to the request. This meets my use case, so again, thank you!

It may be worth noting, if anyone else sees this thread and wants to try this, that this does NOT work if the collection is run from within Postman. During some trial and error, I noticed that when a file is manually attached in the Postman GUI, the generated curl request has an absolute path to the file; however, even if the absolute path is included in the collection, it still fails. To me, this is a Postman issue, not a portman issue.

EDIT: (FWIW, it DOES work if the newman generated requests is proxied through Inspectr. This is another use case for this incredibly useful tool.)

[thim81]

@jpjpjp I noticed the same behaviour of Newman vs Postman when attaching files. I agree that this feels more like a gap within Postman app.

About Inspectr, I'm always interested in the feedback, so feel free to share it on discord or github.