refactor to use oas flag

Author: unandyala

src/download/exchangeDirectoryParser.test.ts

@@ -5,7 +5,7 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { extractFiles } from "./exchangeDirectoryParser";
+import { extractFiles, extractFile } from "./exchangeDirectoryParser";
 
 import { expect, default as chai } from "chai";
 import chaiAsPromised from "chai-as-promised";
@@ -33,6 +33,33 @@ before(() => {
   chai.use(chaiAsPromised);
 });
 
+describe("extractFile", () => {
+  it("should reject with an error message when trying to extract an invalid zip file", async () => {
+    const directory = tmp.dirSync();
+    const invalidZipPath = path.join(directory.name, "invalid.zip");
+
+    // Create a file that looks like a zip but isn't valid
+    fs.writeFileSync(invalidZipPath, "This is not a valid zip file");
+
+    await expect(extractFile(invalidZipPath)).to.be.rejectedWith(
+      `Failed to extract ${invalidZipPath}, probably not a zip file`
+    );
+  });
+
+  it("should successfully extract a valid zip file", async () => {
+    const directory = tmp.dirSync();
+    const zipPath = path.join(directory.name, "api1.zip");
+
+    // Create a valid zip file
+    await createZipFile(directory, "api1.zip");
+
+    const extractedPath = await extractFile(zipPath);
+
+    expect(fs.existsSync(extractedPath)).to.be.true;
+    expect(fs.existsSync(path.join(extractedPath, "exchange.json"))).to.be.true;
+  });
+});
+
 describe("extractFiles", () => {
   it("should extract a zip file into the specified directory", async () => {
     const directory = tmp.dirSync();

src/download/exchangeDownloader.test.ts

@@ -8,7 +8,7 @@ import {
   downloadRestApi,
   downloadRestApis,
   searchExchange,
-  getLatestCleanApiVersions,
+  getVersionByDeployment,
   getSpecificApi,
   getAsset,
   runFetch,
@@ -34,10 +34,10 @@ const assetSearchResults = require("../../testResources/download/resources/asset
 const getAssetWithVersion = require("../../testResources/download/resources/getAssetWithVersion");
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const getAssetWithoutVersion = require("../../testResources/download/resources/getAsset");
+const getAssetWithVersionV2 = require("../../testResources/download/resources/getAssetWithVersionV2");
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const getAssetWithMultipleVersionGroups = require("../../testResources/download/resources/getAssetWithMultipleVersionGroups.json");
+const getAssetWithoutVersion = require("../../testResources/download/resources/getAsset");
 
 const REST_API: RestApi = {
   id: "8888888/test-api/1.0.0",
@@ -234,56 +234,50 @@ describe("exchangeDownloader", () => {
     });
   });
 
-  describe("getLatestCleanApiVersions", () => {
+  describe("getVersionByDeployment", () => {
     const scope = nock("https://anypoint.mulesoft.com/exchange/api/v1/assets");
 
-    it("should return the latest version", async () => {
+    it("should return a version if no deployment is specified", async () => {
       scope.get("/8888888/test-api").reply(200, getAssetWithoutVersion);
 
       return expect(
-        getLatestCleanApiVersions("AUTH_TOKEN", REST_API)
-      ).to.eventually.deep.equal(["0.1.1"]);
+        getVersionByDeployment("AUTH_TOKEN", REST_API)
+      ).to.eventually.equal("0.0.7");
     });
 
-    it("should return undefined if the asset does not exist", async () => {
-      scope.get("/8888888/test-api").reply(404, "Not Found");
+    it("should return a version if a deployment exists", async () => {
+      scope.get("/8888888/test-api").reply(200, getAssetWithoutVersion);
 
-      return expect(getLatestCleanApiVersions("AUTH_TOKEN", REST_API)).to
-        .eventually.be.undefined;
+      return expect(
+        getVersionByDeployment("AUTH_TOKEN", REST_API, /production/i)
+      ).to.eventually.equal("0.0.7");
     });
 
-    it("should return undefined if the asset does not have a version groups", async () => {
-      const assetWithoutVersion = _.cloneDeep(getAssetWithoutVersion);
-      delete assetWithoutVersion.versionGroups;
-
-      scope.get("/8888888/test-api").reply(200, assetWithoutVersion);
+    it("should return the base version if the deployment does not exist", async () => {
+      scope.get("/8888888/test-api").reply(200, getAssetWithoutVersion);
 
-      return expect(getLatestCleanApiVersions("AUTH_TOKEN", REST_API)).to
-        .eventually.be.undefined;
+      return expect(
+        getVersionByDeployment("AUTH_TOKEN", REST_API, /NOT AVAILABLE/i)
+      ).to.eventually.equal(getAssetWithoutVersion.version);
     });
 
-    it("should return latest versions from all the version groups", async () => {
-      scope
-        .get("/8888888/test-api")
-        .reply(200, getAssetWithMultipleVersionGroups);
+    it("should return undefined if the asset does not exist", async () => {
+      scope.get("/8888888/test-api").reply(404, "Not Found");
 
       return expect(
-        getLatestCleanApiVersions("AUTH_TOKEN", REST_API)
-      ).to.eventually.deep.equal(["2.0.10", "1.8.19"]);
+        getVersionByDeployment("AUTH_TOKEN", REST_API, /NOT AVAILABLE/i)
+      ).to.eventually.be.undefined;
     });
 
-    it("should return undefined if the version groups does not have a version", async () => {
-      const assetWithoutVersion = _.cloneDeep(
-        getAssetWithMultipleVersionGroups
-      );
-      delete assetWithoutVersion.versionGroups[0].versions;
-      delete assetWithoutVersion.versionGroups[1].versions;
+    it("should return undefined if the asset does not have a version", async () => {
+      const assetWithoutVersion = _.cloneDeep(getAssetWithoutVersion);
+      delete assetWithoutVersion.version;
 
       scope.get("/8888888/test-api").reply(200, assetWithoutVersion);
 
       return expect(
-        getLatestCleanApiVersions("AUTH_TOKEN", REST_API)
-      ).to.eventually.deep.equal([]);
+        getVersionByDeployment("AUTH_TOKEN", REST_API, /NOT AVAILABLE/i)
+      ).to.eventually.be.undefined;
     });
   });
 
@@ -345,11 +339,11 @@ describe("exchangeDownloader", () => {
         .reply(200, [assetSearchResults[0]]);
     });
 
-    it("searches Exchange and filters by latest version", () => {
+    it("searches Exchange and filters by deployment", () => {
       scope
         .get("/shop-products-categories-api-v1")
         .reply(200, getAssetWithVersion)
-        .get("/shop-products-categories-api-v1/0.1.1")
+        .get("/shop-products-categories-api-v1/0.0.1")
         .reply(200, getAssetWithVersion);
 
       return expect(search("searchString")).to.eventually.deep.equal([
@@ -360,22 +354,76 @@ describe("exchangeDownloader", () => {
     it("works when an asset does not exist", () => {
       scope.get("/shop-products-categories-api-v1").reply(404, "Not Found");
 
-      return expect(search("searchString")).to.eventually.deep.equal([]);
+      return expect(search("searchString")).to.eventually.deep.equal([
+        {
+          id: null,
+          name: "Shopper Products",
+          description:
+            "Enable developers to add functionality that shows product details in shopping apps.",
+          updatedDate: null,
+          groupId: "893f605e-10e2-423a-bdb4-f952f56eb6d8",
+          assetId: "shop-products-categories-api-v1",
+          version: null,
+          categories: {
+            "API layer": ["Process"],
+            "CC API Family": ["Product"],
+            "CC Version Status": ["Beta"],
+            "CC API Visibility": ["External"],
+          },
+          fatRaml: {
+            classifier: "fat-raml",
+            packaging: "zip",
+            createdDate: null,
+            md5: null,
+            sha1: null,
+            mainFile: "shop-products-categories-api-v1.raml",
+          },
+          fatOas: null,
+        },
+      ]);
     });
 
-    it("searches Exchange and returns multiple version groups", () => {
+    it("works when there are no matches for the specified deployment", () => {
+      const asset = _.cloneDeep(shopperCustomersAsset);
+      asset.id = "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-customers/0.0.7";
+      asset.version = "0.0.7";
+      asset.fatRaml = {
+        classifier: "fat-raml",
+        packaging: "zip",
+        externalLink: "https://short.url/test",
+        createdDate: "2020-02-05T21:26:01.199Z",
+        md5: "87b3ad2b2aa17639b52f0cc83c5a8d40",
+        sha1: "f2b9b2de50b7250616e2eea8843735b57235c22b",
+        mainFile: "shopper-customers.raml",
+      };
+
       scope
         .get("/shop-products-categories-api-v1")
-        .reply(200, getAssetWithMultipleVersionGroups)
-        .get("/shop-products-categories-api-v1/1.8.19")
-        .reply(200, getAssetWithVersion)
-        .get("/shop-products-categories-api-v1/2.0.10")
-        .reply(200, getAssetWithVersion);
+        .reply(200, getAssetWithoutVersion)
+        .get("/shop-products-categories-api-v1/0.0.7")
+        .reply(200, getAssetWithoutVersion);
 
-      return expect(search("searchString")).to.eventually.deep.equal([
-        shopperCustomersAsset,
-        shopperCustomersAsset,
-      ]);
+      return expect(search("searchString")).to.eventually.deep.equal([asset]);
+    });
+
+    /**
+     * Returns root asset version when production tag is not found
+     * on V2 API response. The actual deployed version is available
+     * under otherVersions attributes, that has no external link to download
+     * and no environmentName attribute to match
+     */
+    it("returns the root asset version without production tag on V2 response", () => {
+      const asset = _.cloneDeep(shopperCustomersAsset);
+      asset.id = "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-customers/0.5.0";
+      asset.version = "0.5.0";
+      asset.fatRaml.externalLink = "https://somewhere/fatraml.zip";
+      scope
+        .get("/shop-products-categories-api-v1")
+        .reply(200, getAssetWithVersionV2)
+        .get("/shop-products-categories-api-v1/0.5.0")
+        .reply(200, getAssetWithVersionV2);
+
+      return expect(search("searchString")).to.eventually.deep.equal([asset]);
     });
   });