Test refactoring and cleanup (#420)

patrick-tolosa · web-flow · commit 0c64356a5869 · 2020-07-19T10:58:30.000+03:00
- Clean up all of mocha CLI arguments (they were redundant)
- Add a single test entrypoint (setup.js) where we load all the global dependencies
- Remove all require('expect) from all files (they were not needed now)
- Remove all dotEnv require (not needed anymore, initiated through setup.js)
- Organize remaining tests to integration/unit folders respectfuly.
- Separated some tests into their own files
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -7,7 +7,8 @@ module.exports = {
     "extends": "airbnb-base",
     "globals": {
         "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
+        "SharedArrayBuffer": "readonly",
+        "expect" :"readonly"
     },
     "parserOptions": {
         "ecmaVersion": 2018
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
   "main": "cloudinary.js",
   "dependencies": {
     "cloudinary-core": "^2.10.2",
-    "core-js": "3.6.3",
+    "core-js": "3.6.5",
     "lodash": "^4.17.11",
     "q": "^1.5.1"
   },
@@ -57,7 +57,7 @@
   "types": "types",
   "scripts": {
     "test": "tools/scripts/test.sh",
-    "test:unit": "mocha --ui bdd -R spec --recursive test/unit",
+    "test:unit": "mocha --recursive test/unit",
     "test-with-temp-cloud": "tools/scripts/tests-with-temp-cloud.sh",
     "dtslint": "tools/scripts/ditslint.sh",
     "lint": "tools/scripts/lint.sh",
diff --git a/test/integration/api/admin/api_spec.js b/test/integration/api/admin/api_spec.js
@@ -1,8 +1,3 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require("expect.js");
 const sinon = require('sinon');
 const ClientRequest = require('_http_client').ClientRequest;
 const http = require('http');
diff --git a/test/integration/api/admin/structured_metadata_spec.js b/test/integration/api/admin/structured_metadata_spec.js
@@ -1,9 +1,8 @@
-const expect = require("expect.js");
 const Q = require('q');
 const sinon = require('sinon');
-const cloudinary = require("../cloudinary");
-const helper = require("./spechelper");
-const TIMEOUT = require('./testUtils/testConstants').TIMEOUT;
+const cloudinary = require("../../../../cloudinary");
+const helper = require("../../../spechelper");
+const TIMEOUT = require('../../../testUtils/testConstants').TIMEOUT;
 
 const TEST_ID = Date.now();
 
diff --git a/test/integration/api/provisioning/account_spec.js b/test/integration/api/provisioning/account_spec.js
@@ -1,11 +1,5 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require("expect.js");
 const cloudinary = require("../../../../cloudinary");
 const TIMEOUT = require('../../../testUtils/testConstants').TIMEOUT;
-
 let runOnlyForInternalPRs = process.env.TRAVIS_SECURE_ENV_VARS ? describe : describe.skip;
 
 
diff --git a/test/integration/api/search/search_spec.js b/test/integration/api/search/search_spec.js
@@ -1,14 +1,6 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require('expect.js');
 const Q = require('q');
 const cloudinary = require('../../../../cloudinary');
 const helper = require("../../../spechelper");
-
-
-
 const testConstants = require('../../../testUtils/testConstants');
 
 const {
diff --git a/test/integration/api/uploader/archivespec.js b/test/integration/api/uploader/archivespec.js
@@ -1,19 +1,14 @@
-require('dotenv').load({
-  silent: true
-});
-
 const https = require('https');
-const expect = require("expect.js");
 const last = require('lodash/last');
 const sinon = require("sinon");
 const execSync = require('child_process').execSync;
 const Q = require('q');
 const fs = require('fs');
 const os = require('os');
-const cloudinary = require("../cloudinary");
-const helper = require("./spechelper");
+const cloudinary = require("../../../../cloudinary");
+const helper = require("../../../spechelper");
 
-const testConstants = require('./testUtils/testConstants');
+const testConstants = require('../../../testUtils/testConstants');
 
 const {
   TIMEOUT,
diff --git a/test/integration/api/uploader/uploader_spec.js b/test/integration/api/uploader/uploader_spec.js
@@ -1,10 +1,5 @@
-require('dotenv').load({
-  silent: true
-});
-
 const https = require('https');
 const http = require('http');
-const expect = require("expect.js");
 const sinon = require('sinon');
 const fs = require('fs');
 const Q = require('q');
diff --git a/test/integration/cache_spec.js b/test/integration/cache_spec.js
@@ -1,18 +1,18 @@
 var options;
 const { describe, before, it } = require('mocha');
-const expect = require("expect.js");
+
 const path = require('path');
-const helper = require("./spechelper");
-const cloudinary = require('../cloudinary').v2;
+const helper = require("../spechelper");
+const cloudinary = require('../../cloudinary').v2;
 
-const FileKeyValueStorage = require(`../${helper.libPath}/cache/FileKeyValueStorage`);
-const KeyValueCacheAdapter = require(`../${helper.libPath}/cache/KeyValueCacheAdapter`);
+const FileKeyValueStorage = require(`../../${helper.libPath}/cache/FileKeyValueStorage`);
+const KeyValueCacheAdapter = require(`../../${helper.libPath}/cache/KeyValueCacheAdapter`);
 
 const Cache = cloudinary.Cache;
 const IMAGE_FILE = helper.IMAGE_FILE;
 const PUBLIC_ID = "dummy";
 const BREAKPOINTS = [5, 3, 7, 5];
-const testConstants = require('./testUtils/testConstants');
+const testConstants = require('../testUtils/testConstants');
 
 const {
   TIMEOUT,
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -1,3 +1,3 @@
---require expect.js
+--require './test/setup.js'
 -R spec
---ui bdd
+--ui bdd
diff --git a/test/setup.js b/test/setup.js
@@ -0,0 +1,9 @@
+global.expect = require('expect.js');
+require('./testUtils/testBootstrap');
+
+
+require('dotenv').load({
+  silent: true
+});
+
+
diff --git a/test/spechelper.js b/test/spechelper.js
@@ -1,4 +1,3 @@
-const expect = require('expect.js');
 const isFunction = require('lodash/isFunction');
 const querystring = require('querystring');
 const sinon = require('sinon');
@@ -7,7 +6,6 @@ const Q = require('q');
 const http = require('http');
 const https = require('https');
 // Load all our custom assertions
-require('./testUtils/testBootstrap');
 
 const cloudinary = require("../cloudinary");
 
diff --git a/test/streaming_profiles_spec.js b/test/streaming_profiles_spec.js
@@ -1,14 +1,8 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require("expect.js");
 const keys = require('lodash/keys');
 const Q = require('q');
 const cloudinary = require("../cloudinary");
 const helper = require("./spechelper");
 const TIMEOUT = require('./testUtils/testConstants').TIMEOUT;
-
 const api = cloudinary.v2.api;
 
 describe('Cloudinary::Api', function () {
diff --git a/test/testUtils/assertions/beADatasource.js b/test/testUtils/assertions/beADatasource.js
@@ -1,4 +1,3 @@
-const expect = require('expect.js');
 const isEmpty = require("lodash/isEmpty");
 const includes = require('lodash/includes');
 
diff --git a/test/testUtils/assertions/beAMetadataField.js b/test/testUtils/assertions/beAMetadataField.js
@@ -1,4 +1,3 @@
-const expect = require('expect.js');
 const includes = require('lodash/includes');
 
 /**
diff --git a/test/testUtils/assertions/beServedByCloudinary.js b/test/testUtils/assertions/beServedByCloudinary.js
@@ -1,4 +1,3 @@
-const expect = require('expect.js');
 const cloneDeep = require('lodash/cloneDeep');
 const http = require('http');
 const https = require('https');
diff --git a/test/testUtils/assertions/emptyOptions.js b/test/testUtils/assertions/emptyOptions.js
@@ -1,4 +1,3 @@
-const expect = require('expect.js');
 const isEmpty = require("lodash/isEmpty");
 const cloneDeep = require('lodash/cloneDeep');
 const utils = require('../../../cloudinary').utils;
diff --git a/test/testUtils/assertions/produceUrl.js b/test/testUtils/assertions/produceUrl.js
@@ -1,4 +1,3 @@
-const expect = require('expect.js');
 const cloneDeep = require('lodash/cloneDeep');
 const cloudinary = require('../../../cloudinary');
 
diff --git a/test/unit/access_control_spec.js b/test/unit/access_control_spec.js
@@ -1,11 +1,5 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require("expect.js");
 const isString = require('lodash/isString');
-const cloudinary = require("../cloudinary");
-
+const cloudinary = require("../../cloudinary");
 const build_upload_params = cloudinary.utils.build_upload_params;
 
 const ACL = {
diff --git a/test/unit/authToken/authTokenImageTag_spec.js b/test/unit/authToken/authTokenImageTag_spec.js
@@ -1,8 +1,3 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require("expect.js");
 const cloudinary = require("../../../cloudinary.js");
 const commonAuthSetupAndTeardown = require('./utils/commonAuthSetupAndTeardown');
 
diff --git a/test/unit/authToken/authTokenURL_spec.js b/test/unit/authToken/authTokenURL_spec.js
@@ -1,8 +1,3 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require("expect.js");
 const cloudinary = require("../../../cloudinary.js");
 const commonAuthSetupAndTeardown = require('./utils/commonAuthSetupAndTeardown');
 
diff --git a/test/unit/authToken/authTokenUtils_spec.js b/test/unit/authToken/authTokenUtils_spec.js
@@ -1,8 +1,3 @@
-require('dotenv').load({
-  silent: true
-});
-
-const expect = require("expect.js");
 const cloudinary = require("../../../cloudinary.js");
 const commonAuthSetupAndTeardown = require('./utils/commonAuthSetupAndTeardown');
 
diff --git a/test/unit/cache/FileKeyValueCache_spec.js b/test/unit/cache/FileKeyValueCache_spec.js
@@ -1,4 +1,3 @@
-const expect = require("expect.js");
 const fs = require('fs');
 const path = require('path');
 const helper = require("../../spechelper");
diff --git a/test/unit/cache/KeyValueCacheAdapter_spec.js b/test/unit/cache/KeyValueCacheAdapter_spec.js
@@ -1,8 +1,5 @@
-const expect = require("expect.js");
 const helper = require("../../spechelper");
-
 const DummyCacheStorage = require('./DummyCacheStorage');
-
 const KeyValueCacheAdapter = require(`../../../${helper.libPath}/cache/KeyValueCacheAdapter`);
 
 var cache;
diff --git a/test/unit/cloudinaryUtils/getUserAgent.spec.js b/test/unit/cloudinaryUtils/getUserAgent.spec.js
@@ -0,0 +1,17 @@
+
+const cloudinary = require("../../../cloudinary.js");
+
+describe("getUserAgent", function () {
+  var platform = "";
+  before(function () {
+    platform = cloudinary.utils.userPlatform;
+    cloudinary.utils.userPlatform = "";
+  });
+  after(function () {
+    cloudinary.utils.userPlatform = platform;
+  });
+  it("should add a user platform to USER_AGENT", function () {
+    cloudinary.utils.userPlatform = "Spec/1.0 (Test)";
+    expect(cloudinary.utils.getUserAgent()).to.match(/Spec\/1.0 \(Test\) CloudinaryNodeJS\/[\d.]+/);
+  });
+});
diff --git a/test/unit/cloudinary_spec.js b/test/unit/cloudinary_spec.js
@@ -1,6 +1,5 @@
-const expect = require("expect.js");
-const cloudinary = require("../cloudinary.js");
-const createTestConfig = require('./testUtils/createTestConfig');
+const cloudinary = require("../../cloudinary.js");
+const createTestConfig = require('../testUtils/createTestConfig');
 
 describe("cloudinary", function () {
   beforeEach(function () {
@@ -793,92 +792,4 @@ describe("cloudinary", function () {
     result = cloudinary.utils.url("sample.jpg", options);
     expect(result).to.eql('http://res.cloudinary.com/test123/image/upload/s--v2fTPYTu--/sample.jpg');
   });
-  describe("getUserAgent", function () {
-    var platform = "";
-    before(function () {
-      platform = cloudinary.utils.userPlatform;
-      cloudinary.utils.userPlatform = "";
-    });
-    after(function () {
-      cloudinary.utils.userPlatform = platform;
-    });
-    it("should add a user platform to USER_AGENT", function () {
-      cloudinary.utils.userPlatform = "Spec/1.0 (Test)";
-      expect(cloudinary.utils.getUserAgent()).to.match(/Spec\/1.0 \(Test\) CloudinaryNodeJS\/[\d.]+/);
-    });
-  });
-  describe("config", function () {
-    let cloudinaryUrlBackup;
-    let accountUrlBackup;
-    before(function () {
-      cloudinaryUrlBackup = process.env.CLOUDINARY_URL;
-      accountUrlBackup = process.env.CLOUDINARY_ACCOUNT_URL;
-    });
-    describe("CLOUDINARY_URL", function () {
-      after(function () {
-        process.env.CLOUDINARY_URL = cloudinaryUrlBackup || '';
-        cloudinary.config(true);
-      });
-      it("should allow nested values in CLOUDINARY_URL", function () {
-        process.env.CLOUDINARY_URL = "cloudinary://key:secret@test123?foo[bar]=value";
-        cloudinary.config(true);
-        const foo = cloudinary.config().foo;
-        expect(foo && foo.bar).to.eql('value');
-      });
-      it("should load a properly formatted CLOUDINARY_URL", function () {
-        process.env.CLOUDINARY_URL = "cloudinary://123456789012345:ALKJdjklLJAjhkKJ45hBK92baj3@test";
-        cloudinary.config(true);
-      });
-      it("should not be sensitive to case in CLOUDINARY_URL's protocol", function () {
-        process.env.CLOUDINARY_URL = "CLouDiNaRY://123456789012345:ALKJdjklLJAjhkKJ45hBK92baj3@test";
-        cloudinary.config(true);
-      });
-      it("should throw error when CLOUDINARY_URL doesn't start with 'cloudinary://'", function () {
-        process.env.CLOUDINARY_URL = "https://123456789012345:ALKJdjklLJAjhkKJ45hBK92baj3@test?cloudinary=foo";
-        try {
-          cloudinary.config(true);
-          expect().fail();
-        } catch (err) {
-          expect(err.message).to.eql("Invalid CLOUDINARY_URL protocol. URL should begin with 'cloudinary://'");
-        }
-      });
-      it("should not throw an error when CLOUDINARY_URL environment variable is missing", function () {
-        delete process.env.CLOUDINARY_URL;
-        cloudinary.config(true);
-      });
-    });
-    describe("CLOUDINARY_ACCOUNT_URL", function () {
-      after(function () {
-        process.env.CLOUDINARY_ACCOUNT_URL = accountUrlBackup || '';
-        cloudinary.config(true);
-      });
-      it("should allow nested values in CLOUDINARY_ACCOUNT_URL", function () {
-        process.env.CLOUDINARY_ACCOUNT_URL = "account://key:secret@test123?foo[bar]=value";
-        cloudinary.config(true);
-        const foo = cloudinary.config().foo;
-        expect(foo && foo.bar).to.eql('value');
-      });
-      it("should load a properly formatted CLOUDINARY_ACCOUNT_URL", function () {
-        process.env.CLOUDINARY_ACCOUNT_URL = "account://635412789012345:ALKJdjklLJAjhkKJ45hBK92tam2@test1";
-        cloudinary.config(true);
-      });
-      it("should not be sensitive to case in CLOUDINARY_ACCOUNT_URL's protocol", function () {
-        process.env.CLOUDINARY_ACCOUNT_URL = "aCCouNT://635283989012345:ALKGssklLJAjhkKJ45hBK92tas5@test1";
-        cloudinary.config(true);
-      });
-      it("should throw error when CLOUDINARY_ACCOUNT_URL doesn't start with 'account://'", function () {
-        process.env.CLOUDINARY_ACCOUNT_URL = "https://635283989012345:ALKGssklLJAjhkKJ45hBK92tas5@test1?account=foo";
-        try {
-          cloudinary.config(true);
-          expect().fail();
-        } catch (err) {
-          expect(err.message).to.eql("Invalid CLOUDINARY_ACCOUNT_URL protocol. URL should begin with 'account://'");
-        }
-      });
-      it("should not throw an error when CLOUDINARY_ACCOUNT_URL environment variable is missing", function () {
-        delete process.env.CLOUDINARY_ACCOUNT_URL;
-        cloudinary.config(true);
-      });
-    });
-  });
 });
diff --git a/test/unit/config.spec.js b/test/unit/config.spec.js
diff --git a/test/unit/sdkAnalytics/imageTagWithAnalytics.spec.js b/test/unit/sdkAnalytics/imageTagWithAnalytics.spec.js
diff --git a/test/unit/tags/image_spec.js b/test/unit/tags/image_spec.js
diff --git a/test/unit/tags/source_tag_spec.js b/test/unit/tags/source_tag_spec.js
diff --git a/test/unit/url/video_url_spec.js b/test/unit/url/video_url_spec.js
diff --git a/test/utils/get_sdk_versionID_spec.js b/test/utils/get_sdk_versionID_spec.js
diff --git a/test/utils/utils_spec.js b/test/utils/utils_spec.js
diff --git a/tools/scripts/test.es5.sh b/tools/scripts/test.es5.sh
diff --git a/tools/scripts/test.es6.sh b/tools/scripts/test.es6.sh

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-const expect = require('expect.js');`
`2`	`1`	`const isEmpty = require("lodash/isEmpty");`
`3`	`2`	`const includes = require('lodash/includes');`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-const expect = require('expect.js');`
`2`	`1`	`const cloneDeep = require('lodash/cloneDeep');`
`3`	`2`	`const http = require('http');`
`4`	`3`	`const https = require('https');`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-const expect = require("expect.js");`
`2`	`1`	`const fs = require('fs');`
`3`	`2`	`const path = require('path');`
`4`	`3`	`const helper = require("../../spechelper");`