chore(tests): Restructure unit test directories (#1587)

Author: dpogue

.github/workflows/ci.yml

@@ -126,7 +126,7 @@ jobs:
         run: |
           npm ci
           npm run lint
-          npm run unit-tests
+          npm run cover
         env:
           CI: true
 

eslint.config.js

@@ -26,7 +26,7 @@ module.exports = defineConfig([
     globalIgnores([
         '**/coverage/',
         'templates/project/',
-        'tests/spec/unit/fixtures/'
+        'tests/spec/fixtures/'
     ]),
     ...nodeConfig,
     ...nodeTestConfig.map(config => ({

package.json

@@ -16,11 +16,10 @@
   "scripts": {
     "prepare": "cordova-js build > templates/project/www/cordova.js",
     "pretest": "npm run lint",
-    "test": "npm run coverage && npm run objc-tests",
-    "coverage": "c8 jasmine --config=tests/spec/coverage.json",
-    "e2e-tests": "jasmine tests/spec/create.spec.js",
-    "objc-tests": "xcodebuild -quiet test -workspace tests/cordova-ios.xcworkspace -scheme CordovaTestApp -destination \"platform=iOS Simulator,name=${CDV_IOS_SIM:-iPhone 16e}\" -destination-timeout 300 -derivedDataPath \"`mktemp -d 2>/dev/null || mktemp -d -t 'cordova-ios'`\"",
-    "unit-tests": "jasmine --config=tests/spec/unit.json",
+    "test": "npm run cover && npm run test:xcode",
+    "test:unit": "jasmine --config=tests/spec/unit.json",
+    "test:xcode": "xcodebuild -quiet test -workspace tests/cordova-ios.xcworkspace -scheme CordovaTestApp -destination \"platform=iOS Simulator,name=${CDV_IOS_SIM:-iPhone 16e}\" -destination-timeout 300 -derivedDataPath \"`mktemp -d 2>/dev/null || mktemp -d -t 'cordova-ios'`\"",
+    "cover": "c8 npm run test:unit",
     "lint": "eslint ."
   },
   "author": "Apache Software Foundation",

tests/spec/unit/Api.spec.js tests/spec/Api.spec.jstests/spec/unit/Api.spec.js renamed to tests/spec/Api.spec.js

@@ -21,24 +21,15 @@ const path = require('node:path');
 const fs = require('node:fs');
 const EventEmitter = require('node:events');
 const PluginManager = require('cordova-common').PluginManager;
-const Api = require('../../../lib/Api');
-const check_reqs = require('../../../lib/check_reqs');
+const Api = require('../../lib/Api');
+const check_reqs = require('../../lib/check_reqs');
+const run_mod = require('../../lib/run');
 
-// The lib/run module pulls in simctl, which has a hard requirement that it
-// be run on a Mac OS - simply requiring the module is enough to trigger the
-// environment checks. These checks will blow up on Windows + Linux.
-// So, conditionally pull in the module, and conditionally test the `run`
-// method (more below).
-let run_mod;
-if (process.platform === 'darwin') {
-    run_mod = require('../../../lib/run');
-}
-
-const projectFile = require('../../../lib/projectFile');
-const BridgingHeader_mod = require('../../../lib/BridgingHeader.js');
-const SwiftPackage_mod = require('../../../lib/SwiftPackage.js');
-const Podfile_mod = require('../../../lib/Podfile');
-const PodsJson_mod = require('../../../lib/PodsJson');
+const projectFile = require('../../lib/projectFile');
+const BridgingHeader_mod = require('../../lib/BridgingHeader.js');
+const SwiftPackage_mod = require('../../lib/SwiftPackage.js');
+const Podfile_mod = require('../../lib/Podfile');
+const PodsJson_mod = require('../../lib/PodsJson');
 const FIXTURES = path.join(__dirname, 'fixtures');
 const iosProjectFixture = path.join(FIXTURES, 'ios-config-xml');
 
@@ -78,34 +69,29 @@ describe('Platform Api', () => {
             });
         });
 
-        // See the comment at the top of this file, in the list of requires,
-        // for information on why we conditionall run this test.
-        // tl;dr run_mod requires the simctl module, which requires mac OS.
-        if (process.platform === 'darwin') {
-            describe('run', () => {
-                beforeEach(() => {
-                    spyOn(check_reqs, 'run').and.returnValue(Promise.resolve());
-                });
-                it('should call into lib/run module', () => {
-                    spyOn(run_mod, 'run');
-                    return api.run().then(() => {
-                        expect(run_mod.run).toHaveBeenCalled();
-                    });
+        describe('run', () => {
+            beforeEach(() => {
+                spyOn(check_reqs, 'run').and.returnValue(Promise.resolve());
+            });
+            it('should call into lib/run module', () => {
+                spyOn(run_mod, 'run');
+                return api.run().then(() => {
+                    expect(run_mod.run).toHaveBeenCalled();
                 });
             });
+        });
 
-            describe('listTargets', () => {
-                beforeEach(() => {
-                    spyOn(check_reqs, 'run').and.returnValue(Promise.resolve());
-                });
-                it('should call into lib/run module', () => {
-                    spyOn(run_mod, 'runListDevices');
-                    return api.listTargets().then(() => {
-                        expect(run_mod.runListDevices).toHaveBeenCalled();
-                    });
+        describe('listTargets', () => {
+            beforeEach(() => {
+                spyOn(check_reqs, 'run').and.returnValue(Promise.resolve());
+            });
+            it('should call into lib/run module', () => {
+                spyOn(run_mod, 'runListDevices');
+                return api.listTargets().then(() => {
+                    expect(run_mod.runListDevices).toHaveBeenCalled();
                 });
             });
-        }
+        });
 
         describe('addPlugin', () => {
             const my_plugin = {

tests/spec/unit/BridgingHeader.spec.js tests/spec/BridgingHeader.spec.jstests/spec/unit/BridgingHeader.spec.js renamed to tests/spec/BridgingHeader.spec.js

@@ -20,7 +20,7 @@
 const fs = require('node:fs');
 const path = require('node:path');
 
-const BridgingHeader = require(path.resolve(__dirname, '..', '..', '..', 'lib', 'BridgingHeader.js')).BridgingHeader;
+const BridgingHeader = require(path.resolve(__dirname, '..', '..', 'lib', 'BridgingHeader.js')).BridgingHeader;
 const fixtureBridgingHeader = fs.readFileSync(path.resolve(__dirname, 'fixtures', 'test-Bridging-Header.h'), 'utf-8');
 
 describe('unit tests for BridgingHeader module', () => {

tests/spec/unit/Plugman/common.spec.js tests/spec/Plugman/common.spec.jstests/spec/unit/Plugman/common.spec.js renamed to tests/spec/Plugman/common.spec.js

@@ -21,7 +21,7 @@ const path = require('node:path');
 const tmp = require('tmp');
 const rewire = require('rewire');
 
-const common = rewire('../../../../lib/plugman/pluginHandlers');
+const common = rewire('../../../lib/plugman/pluginHandlers');
 
 tmp.setGracefulCleanup();
 

…/spec/unit/Plugman/pluginHandler.spec.js tests/spec/Plugman/pluginHandler.spec.jstests/spec/unit/Plugman/pluginHandler.spec.js renamed to tests/spec/Plugman/pluginHandler.spec.js tests/spec/unit/Plugman/pluginHandler.spec.js renamed to tests/spec/Plugman/pluginHandler.spec.js

@@ -25,9 +25,9 @@ const tmp = require('tmp');
 tmp.setGracefulCleanup();
 
 const PluginInfo = require('cordova-common').PluginInfo;
-const Api = require('../../../../lib/Api');
-const projectFile = require('../../../../lib/projectFile');
-const pluginHandlers = require('../../../../lib/plugman/pluginHandlers');
+const Api = require('../../../lib/Api');
+const projectFile = require('../../../lib/projectFile');
+const pluginHandlers = require('../../../lib/plugman/pluginHandlers');
 
 const tempdir = tmp.dirSync({ unsafeCleanup: true });
 const temp = path.join(tempdir.name, 'plugman');

tests/spec/unit/Podfile.spec.js tests/spec/Podfile.spec.jstests/spec/unit/Podfile.spec.js renamed to tests/spec/Podfile.spec.js

@@ -22,7 +22,7 @@ const fs = require('node:fs');
 const CordovaError = require('cordova-common').CordovaError;
 
 const PROJECT_NAME = 'testProj';
-const Podfile = require(path.resolve(__dirname, '..', '..', '..', 'lib', 'Podfile.js')).Podfile;
+const Podfile = require(path.resolve(__dirname, '..', '..', 'lib', 'Podfile.js')).Podfile;
 const fixturePodfile = path.resolve(__dirname, 'fixtures', PROJECT_NAME, 'platforms', 'ios', 'Podfile');
 const fixturePodXcconfigDebug = path.resolve(__dirname, 'fixtures', PROJECT_NAME, 'platforms', 'ios', 'pods-debug.xcconfig');
 const fixturePodXcconfigRelease = path.resolve(__dirname, 'fixtures', PROJECT_NAME, 'platforms', 'ios', 'pods-release.xcconfig');

tests/spec/unit/PodsJson.spec.js tests/spec/PodsJson.spec.jstests/spec/unit/PodsJson.spec.js renamed to tests/spec/PodsJson.spec.js

@@ -21,7 +21,7 @@ const fs = require('node:fs');
 const path = require('node:path');
 const CordovaError = require('cordova-common').CordovaError;
 
-const PodsJson = require(path.resolve(__dirname, '..', '..', '..', 'lib', 'PodsJson.js')).PodsJson;
+const PodsJson = require(path.resolve(__dirname, '..', '..', 'lib', 'PodsJson.js')).PodsJson;
 const fixturePodsJson = path.resolve(__dirname, 'fixtures', 'testProj', 'platforms', 'ios', 'pods.json');
 
 // tests are nested in a describe to ensure clean up happens after all unit tests are run

tests/spec/unit/SwiftPackage.spec.js tests/spec/SwiftPackage.spec.jstests/spec/unit/SwiftPackage.spec.js renamed to tests/spec/SwiftPackage.spec.js

@@ -20,13 +20,13 @@
 const fs = require('node:fs');
 const path = require('node:path');
 const tmp = require('tmp');
-const SwiftPackage = require('../../../lib/SwiftPackage.js').SwiftPackage;
-const Api = require('../../../lib/Api');
+const SwiftPackage = require('../../lib/SwiftPackage.js').SwiftPackage;
+const Api = require('../../lib/Api');
 const EventEmitter = require('node:events').EventEmitter;
 const ConfigParser = require('cordova-common').ConfigParser;
 const PluginInfo = require('cordova-common').PluginInfo;
-const Podfile_mod = require('../../../lib/Podfile');
-const PodsJson_mod = require('../../../lib/PodsJson');
+const Podfile_mod = require('../../lib/Podfile');
+const PodsJson_mod = require('../../lib/PodsJson');
 
 tmp.setGracefulCleanup();
 
@@ -138,7 +138,7 @@ describe('SwiftPackage', () => {
             const content = fs.readFileSync(pkgPath, 'utf8');
 
             // Because we don't have the full project here, it behaves as if linked
-            const packageLoc = path.dirname(require.resolve('../../../package.json'));
+            const packageLoc = path.dirname(require.resolve('../../package.json'));
             const relativeLink = path.relative(path.dirname(pkgPath), packageLoc).replaceAll(path.sep, path.posix.sep);
 
             expect(content).toContain(`package(name: "cordova-ios", path: "${relativeLink}"`);