test: add test case for fs.ReadStream (#2219)

Refs #2209

Author: char0n

test/http/data/file1.txt

@@ -0,0 +1 @@
+test file data1

test/http/data/file2.txt

@@ -0,0 +1 @@
+test file data2

test/http/http-multipart.js

@@ -1,6 +1,8 @@
-import fetchMock from 'fetch-mock';
+import path from 'path';
 import { Readable } from 'stream';
-import { File } from 'formdata-node';
+import fetchMock from 'fetch-mock';
+import { File, Blob } from 'formdata-node';
+import { fileFromPathSync } from 'formdata-node/lib/cjs/fileFromPath';
 
 import { buildRequest } from '../../src/execute';
 import sampleMultipartOpenApi2 from '../data/sample-multipart-oas2';
@@ -258,11 +260,47 @@ describe('buildRequest - openapi 3.0', () => {
     });
   });
 
+  describe('formData with fs.createReadStream', () => {
+    /**
+     * fs.ReadStream is not supported as a value in FormData according to the spec.
+     * `fileFromPathSync` helper should be used to load files from Node.js env
+     * that are further used as values for FormData.
+     */
+    const file1 = fileFromPathSync(path.join(__dirname, 'data', 'file1.txt'));
+    const file2 = fileFromPathSync(path.join(__dirname, 'data', 'file2.txt'));
+
+    const req = buildRequest({
+      spec: sampleMultipartOpenApi3,
+      operationId: 'post_land_content_uploadImage',
+      requestBody: {
+        imageId: 'id',
+        'images[]': [file1, file2],
+      },
+    });
+
+    test('should return FormData entry list and item entries (in order)', async () => {
+      expect(req).toMatchObject({
+        method: 'POST',
+        url: '/api/v1/land/content/uploadImage',
+        credentials: 'same-origin',
+        headers: {
+          'Content-Type': expect.stringMatching(/^multipart\/form-data/),
+        },
+      });
+      expect(req.body).toBeInstanceOf(Readable);
+      const itemEntries = req.formdata.getAll('images[]');
+
+      expect(itemEntries.length).toEqual(2);
+      expect(await itemEntries[0].text()).toEqual(await file1.text());
+      expect(await itemEntries[1].text()).toEqual(await file2.text());
+    });
+  });
+
   describe('formData with File/Blob', () => {
     const file1 = new File(['test file data1'], 'file1.txt', {
       type: 'text/plain',
     });
-    const file2 = new File(['test file data2'], 'file2.txt', {
+    const file2 = new Blob(['test file data2'], {
       type: 'text/plain',
     });
 

test/oas3/execute/data/payload.txt

@@ -0,0 +1 @@
+this is a test

test/oas3/execute/main.js

@@ -1203,7 +1203,7 @@ describe('buildRequest - OpenAPI Specification 3.0', () => {
   });
   describe('special media types', () => {
     describe('file-as-body types', () => {
-      it('should preserve blobs for application/octet-stream', () => {
+      it('should preserve Buffer for application/octet-stream', () => {
         const spec = {
           openapi: '3.0.0',
           paths: {
@@ -1241,6 +1241,88 @@ describe('buildRequest - OpenAPI Specification 3.0', () => {
 
         expect(req.body.toString('base64')).toEqual('dGhpcyBpcyBhIHRlc3Q=');
       });
+
+      it('should preserve fs.ReadStream for application/octet-stream', () => {
+        const spec = {
+          openapi: '3.0.0',
+          paths: {
+            '/one': {
+              get: {
+                operationId: 'getMe',
+                requestBody: {
+                  content: {
+                    'application/octet-stream': {
+                      schema: {
+                        type: 'string',
+                        format: 'binary',
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        };
+
+        // when
+        const readStream = fs.createReadStream(path.join(__dirname, 'data', 'payload.txt'));
+
+        const req = buildRequest({
+          spec,
+          operationId: 'getMe',
+          requestBody: readStream,
+        });
+
+        expect(req).toMatchObject({
+          method: 'GET',
+          url: '/one',
+          credentials: 'same-origin',
+          headers: {},
+        });
+
+        expect(req.body).toStrictEqual(readStream);
+      });
+
+      it('should preserve fs.ReadStream for application/octet-stream', () => {
+        const spec = {
+          openapi: '3.0.0',
+          paths: {
+            '/one': {
+              get: {
+                operationId: 'getMe',
+                requestBody: {
+                  content: {
+                    'application/octet-stream': {
+                      schema: {
+                        type: 'string',
+                        format: 'binary',
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        };
+
+        // when
+        const readStream = fs.createReadStream(path.join(__dirname, 'data', 'payload.txt'));
+
+        const req = buildRequest({
+          spec,
+          operationId: 'getMe',
+          requestBody: readStream,
+        });
+
+        expect(req).toMatchObject({
+          method: 'GET',
+          url: '/one',
+          credentials: 'same-origin',
+          headers: {},
+        });
+
+        expect(req.body).toStrictEqual(readStream);
+      });
     });
   });
 });