Merge pull request #535 from postmanlabs/fix/lookRootContentOnData

look for the root content in data array
2022-11-29 22:05:00 +03:00 · 2022-06-08 12:23:40 -05:00
parent 73f550a52b eafe766c8b
commit b1ad029ed1
3 changed files with 217 additions and 135 deletions
--- a/lib/schemapack.js
+++ b/lib/schemapack.js
@@ -668,22 +668,18 @@ class SchemaPack {

    schemaUtils.validateInputMultiFileAPI(input);
    if (!input.rootFiles || input.rootFiles.length === 0) {
-      let rootFiles = await this.detectRootFiles(input);
-      if (rootFiles.output.data) {
-        let inputContent = [];
-        rootFiles.output.data.forEach((rootFile) => {
-          let founInData = input.data.find((dataFile) => { return dataFile.fileName === rootFile.path; });
-          if (founInData) {
-            inputContent.push({ fileName: founInData.fileName, content: founInData.content });
-          }
-        });
-        input.rootFiles = inputContent;
-        return schemaUtils.processRelatedFiles(input);
-      }
+      throw new Error('Input should have at least one root file');
    }
+
    let adaptedRootFiles = input.rootFiles.map((rootFile) => {
-      return { fileName: rootFile.path, content: rootFile.content };
+      let foundInData = input.data.find((file) => { return file.fileName === rootFile.path; });
+      if (!foundInData) {
+        throw new Error('Root file content not found in data array');
+      }
+
+      return { fileName: rootFile.path, content: foundInData.content };
    });
+
    input.rootFiles = adaptedRootFiles;
    return schemaUtils.processRelatedFiles(input);
  }
@@ -697,24 +693,17 @@ class SchemaPack {
   */
  async bundle() {
    const input = this.input;
-
    schemaUtils.validateInputMultiFileAPI(input);
    if (!input.rootFiles || input.rootFiles.length === 0) {
-      let rootFiles = await this.detectRootFiles(input);
-      if (rootFiles.output.data) {
-        let inputContent = [];
-        rootFiles.output.data.forEach((rootFile) => {
-          let founInData = input.data.find((dataFile) => { return dataFile.fileName === rootFile.path; });
-          if (founInData) {
-            inputContent.push({ fileName: founInData.fileName, content: founInData.content });
-          }
-        });
-        input.rootFiles = inputContent;
-        return schemaUtils.processRelatedFiles(input, true);
-      }
+      throw new Error('Input should have at least one root file');
    }
    let adaptedRootFiles = input.rootFiles.map((rootFile) => {
-      return { fileName: rootFile.path, content: rootFile.content };
+      let foundInData = input.data.find((file) => { return file.fileName === rootFile.path; });
+      if (!foundInData) {
+        throw new Error('Root file content not found in data array');
+      }
+
+      return { fileName: rootFile.path, content: foundInData.content };
    });
    input.rootFiles = adaptedRootFiles;
    return schemaUtils.processRelatedFiles(input, true);
--- a/test/unit/bundle.test.js
+++ b/test/unit/bundle.test.js
@@ -35,11 +35,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -63,11 +66,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -91,11 +97,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -123,13 +132,16 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/v1.yaml',
-            content: contentRootFile
+            path: '/v1.yaml'
          }
        ],
        options: {},
        bundleFormat: 'JSON',
        data: [
+          {
+            path: '/v1.yaml',
+            content: contentRootFile
+          },
          {
            path: '/responses.yaml',
            content: responses
@@ -175,13 +187,16 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        options: {},
        bundleFormat: 'JSON',
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/responses.yaml',
            content: responses
@@ -230,13 +245,16 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/spec/swagger.yaml',
-            content: contentRootFile
+            path: '/spec/swagger.yaml'
          }
        ],
        options: {},
        bundleFormat: 'yaml',
        data: [
+          {
+            path: '/spec/swagger.yaml',
+            content: contentRootFile
+          },
          {
            path: '/spec/NewPet.yaml',
            content: newPet
@@ -319,13 +337,16 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        options: {},
        bundleFormat: 'JSON',
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -352,13 +373,16 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        options: {},
        bundleFormat: 'JSON',
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -384,13 +408,16 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/wrongRoot.yaml',
-            content: contentRootFile
+            path: '/wrongRoot.yaml'
          }
        ],
        options: {},
        bundleFormat: 'JSON',
        data: [
+          {
+            path: '/wrongRoot.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -424,11 +451,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user/user.yaml',
            content: user
@@ -476,11 +506,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/responses.yaml',
            content: responses
@@ -536,11 +569,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -565,11 +601,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -600,13 +639,16 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        options: {},
        bundleFormat: 'JSON',
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/schemas/index.yaml',
            content: schemasIndex
@@ -636,11 +678,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/tags/tags.yaml',
            content: tags
@@ -664,11 +709,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/info/info.yaml',
            content: info
@@ -693,11 +741,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/paths/paths.yaml',
            content: paths
@@ -726,11 +777,14 @@ describe('bundle files method - 3.0', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/root.yaml',
-            content: contentRootFile
+            path: '/root.yaml'
          }
        ],
        data: [
+          {
+            path: '/root.yaml',
+            content: contentRootFile
+          },
          {
            path: '/paths/paths.yaml',
            content: paths
@@ -749,14 +803,8 @@ describe('bundle files method - 3.0', function () {
    expect(JSON.stringify(res.output.data[0].bundledContent, null, 2)).to.be.equal(expected);
  });

-  it('Should take the root file from data array', async function () {
+  it('Should throw error when root files is undefined', async function () {
    let contentRootFile = fs.readFileSync(sameRefDiffSource + '/root.yaml', 'utf8'),
-      user = fs.readFileSync(sameRefDiffSource + '/schemas/user/user.yaml', 'utf8'),
-      client = fs.readFileSync(sameRefDiffSource + '/schemas/client/client.yaml', 'utf8'),
-      specialUser = fs.readFileSync(sameRefDiffSource + '/schemas/user/special.yaml', 'utf8'),
-      specialClient = fs.readFileSync(sameRefDiffSource + '/schemas/client/special.yaml', 'utf8'),
-      magic = fs.readFileSync(sameRefDiffSource + '/schemas/client/magic.yaml', 'utf8'),
-      expected = fs.readFileSync(sameRefDiffSource + '/expected.json', 'utf8'),
      input = {
        type: 'multiFile',
        specificationVersion: '3.0',
@@ -764,38 +812,20 @@ describe('bundle files method - 3.0', function () {
          {
            path: '/root.yaml',
            content: contentRootFile
-          },
-          {
-            path: '/schemas/user/user.yaml',
-            content: user
-          },
-          {
-            path: '/schemas/user/special.yaml',
-            content: specialUser
-          },
-          {
-            path: '/schemas/client/client.yaml',
-            content: client
-          },
-          {
-            path: '/schemas/client/special.yaml',
-            content: specialClient
-          },
-          {
-            path: '/schemas/client/magic.yaml',
-            content: magic
          }
        ],
        options: {},
        bundleFormat: 'JSON'
      };
-    const res = await Converter.bundle(input);
-    expect(res).to.not.be.empty;
-    expect(res.result).to.be.true;
-    expect(JSON.stringify(res.output.data[0].bundledContent, null, 2)).to.be.equal(expected);
+    try {
+      await Converter.bundle(input);
+    }
+    catch (error) {
+      expect(error.message).to.equal('Input should have at least one root file');
+    }
  });

-  it('Should throw error when input has not root files', async function () {
+  it('Should throw error when root files is empty array', async function () {
    let user = fs.readFileSync(schemaFromResponse + '/schemas/user.yaml', 'utf8'),
      input = {
        type: 'multiFile',
@@ -832,6 +862,14 @@ describe('bundle files method - 3.0', function () {
        type: 'multiFile',
        specificationVersion: '3.0',
        rootFiles: [
+          {
+            path: '/root.yaml'
+          },
+          {
+            path: '/root2.yaml'
+          }
+        ],
+        data: [
          {
            path: '/root.yaml',
            content: contentRootFile
@@ -839,9 +877,7 @@ describe('bundle files method - 3.0', function () {
          {
            path: '/root2.yaml',
            content: contentRootFile2
-          }
-        ],
-        data: [
+          },
          {
            path: '/schemas/user.yaml',
            content: user
@@ -872,6 +908,33 @@ describe('bundle files method - 3.0', function () {
    expect(JSON.stringify(res.output.data[0].bundledContent, null, 2)).to.be.equal(expected);
    expect(JSON.stringify(res.output.data[1].bundledContent, null, 2)).to.be.equal(expected2);
  });
+
+  it('Should throw error when root is not present in data array', async function () {
+    let user = fs.readFileSync(schemaFromResponse + '/schemas/user.yaml', 'utf8'),
+      input = {
+        type: 'multiFile',
+        specificationVersion: '3.0',
+        rootFiles: [
+          {
+            path: '/root.yaml'
+          }
+        ],
+        data: [
+          {
+            path: '/schemas/user.yaml',
+            content: user
+          }
+        ],
+        options: {},
+        bundleFormat: 'JSON'
+      };
+    try {
+      await Converter.bundle(input);
+    }
+    catch (error) {
+      expect(error.message).to.equal('Root file content not found in data array');
+    }
+  });
 });


--- a/test/unit/detectRelatedFiles.test.js
+++ b/test/unit/detectRelatedFiles.test.js
@@ -52,13 +52,11 @@ describe('detectRelatedFiles method', function () {
    }
  });

-  it('should locate root and return empty data when there is no ref', async function () {
+  it('should throw error when rootfiles is undefined', async function () {
    let contentFile = fs.readFileSync(validPetstore, 'utf8'),
      input = {
        type: 'multiFile',
        specificationVersion: '3.0',
-        rootFiles: [
-        ],
        data: [
          {
            path: '/petstore.yaml',
@@ -66,12 +64,12 @@ describe('detectRelatedFiles method', function () {
          }
        ]
      };
-    const res = await Converter.detectRelatedFiles(input);
-    expect(res).to.not.be.empty;
-    expect(res.result).to.be.true;
-    expect(res.output.data[0].rootFile.path).to.equal('/petstore.yaml');
-    expect(res.output.data[0].relatedFiles.length).to.equal(0);
-    expect(res.output.data[0].missingRelatedFiles.length).to.equal(0);
+    try {
+      await Converter.detectRelatedFiles(input);
+    }
+    catch (error) {
+      expect(error.message).to.equal('Input should have at least one root file');
+    }
  });

  it('should return adjacent and missing nodes', async function () {
@@ -82,11 +80,14 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/missedRef.yaml',
-            content: contentFileMissedRef
+            path: '/missedRef.yaml'
          }
        ],
        data: [
+          {
+            path: '/missedRef.yaml',
+            content: contentFileMissedRef
+          },
          {
            path: '/Pet.yaml',
            content: contentFilePet
@@ -110,11 +111,14 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: 'refToRoot.yaml',
-            content: contentFilRefToRoot
+            path: 'refToRoot.yaml'
          }
        ],
        data: [
+          {
+            path: 'refToRoot.yaml',
+            content: contentFilRefToRoot
+          },
          {
            path: 'NewPet.yaml',
            content: contentFilePet
@@ -137,11 +141,13 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/deepObjectLengthProperty.yaml',
-            content: contentFileMissedRef
+            path: '/deepObjectLengthProperty.yaml'
          }
        ],
-        data: [{}]
+        data: [{
+          path: '/deepObjectLengthProperty.yaml',
+          content: contentFileMissedRef
+        }]
      },
      res = await Converter.detectRelatedFiles(input);
    expect(res).to.not.be.empty;
@@ -161,11 +167,14 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: 'circularRef.yaml',
-            content: contentCircularRef
+            path: 'circularRef.yaml'
          }
        ],
        data: [
+          {
+            path: 'circularRef.yaml',
+            content: contentCircularRef
+          },
          {
            path: 'oldPet.yaml',
            content: contentFileOldPet
@@ -197,11 +206,14 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: 'separatedFiles/spec/swagger.yaml',
-            content: swaggerRootContent
+            path: 'separatedFiles/spec/swagger.yaml'
          }
        ],
        data: [
+          {
+            path: 'separatedFiles/spec/swagger.yaml',
+            content: swaggerRootContent
+          },
          {
            path: 'separatedFiles/spec/Pet.yaml',
            content: petContent
@@ -235,15 +247,20 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.1',
        rootFiles: [
          {
-            path: '/petstore.yaml',
-            content: contentFilePet
+            path: '/petstore.yaml'
          },
          {
-            path: '/hopService.yaml',
-            content: contentFileHop
+            path: '/hopService.yaml'
          }
        ],
-        data: [{}]
+        data: [{
+          path: '/petstore.yaml',
+          content: contentFilePet
+        },
+        {
+          path: '/hopService.yaml',
+          content: contentFileHop
+        }]
      };
    const res = await Converter.detectRelatedFiles(input);
    expect(res).to.not.be.empty;
@@ -258,15 +275,20 @@ describe('detectRelatedFiles method', function () {
        type: 'multiFile',
        rootFiles: [
          {
-            path: '/petstore.yaml',
-            content: contentFilePet
+            path: '/petstore.yaml'
          },
          {
-            path: '/hopService.yaml',
-            content: contentFileHop
+            path: '/hopService.yaml'
          }
        ],
-        data: [{}]
+        data: [{
+          path: '/petstore.yaml',
+          content: contentFilePet
+        },
+        {
+          path: '/hopService.yaml',
+          content: contentFileHop
+        }]
      };
    const res = await Converter.detectRelatedFiles(input);
    expect(res).to.not.be.empty;
@@ -281,11 +303,13 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/openapi.yaml',
-            content: contentFile
+            path: '/openapi.yaml'
          }
        ],
-        data: [{}]
+        data: [{
+          path: '/openapi.yaml',
+          content: contentFile
+        }]
      };
    const res = await Converter.detectRelatedFiles(input);
    expect(res).to.not.be.empty;
@@ -302,11 +326,14 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/openapi.yaml',
-            content: contentRootFile
+            path: '/openapi.yaml'
          }
        ],
        data: [
+          {
+            path: '/openapi.yaml',
+            content: contentRootFile
+          },
          {
            path: '/resources/pets.yaml',
            content: contentFileResPets
@@ -332,11 +359,14 @@ describe('detectRelatedFiles method', function () {
        specificationVersion: '3.0',
        rootFiles: [
          {
-            path: '/openapi.yaml',
-            content: contentRootFile
+            path: '/openapi.yaml'
          }
        ],
        data: [
+          {
+            path: '/openapi.yaml',
+            content: contentRootFile
+          },
          {
            path: '/resources/pets.yaml',
            content: contentFileResPets