spec/cordova/util.spec.js - cordova-lib - Git at Google

 /**
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.
 */

 const fs = require('node:fs');
 const path = require('node:path');
 const util = require('../../src/cordova/util');
 const helpers = require('../helpers');

 const cwd = process.cwd();
 const origPWD = process.env.PWD;

 describe('util module', function () {
     let temp;
     beforeEach(() => {
         temp = helpers.tmpDir('cordova.util.spec');
     });
     afterEach(() => {
         process.chdir(__dirname);
         fs.rmSync(temp, { recursive: true, force: true });
     });

     describe('isCordova method', function () {
         let somedir, anotherdir;
         beforeEach(() => {
             // Base test directory setup
             somedir = path.join(temp, 'somedir');
             anotherdir = path.join(somedir, 'anotherdir');
             fs.mkdirSync(anotherdir, { recursive: true });
         });
         afterEach(function () {
             process.env.PWD = origPWD;
             process.chdir(cwd);
         });
         it('Test 002 : should return false if it cannot find a Cordova project directory up the directory tree', function () {
             expect(util.isCordova(somedir)).toEqual(false);
         });
         it('Test 003 : should recognize a Cordova project directory', function () {
             fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
             fs.writeFileSync(path.join(somedir, 'www', 'config.xml'), '', 'utf8');
             expect(util.isCordova(somedir)).toEqual(somedir);
         });
         it('Test 004 : should ignore PWD when it is undefined', function () {
             delete process.env.PWD;
             fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
             fs.writeFileSync(path.join(somedir, 'config.xml'), '', 'utf8');
             process.chdir(anotherdir);
             expect(util.isCordova()).toEqual(somedir);
         });
         it('Test 005 : should use PWD when available', function () {
             fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
             fs.writeFileSync(path.join(somedir, 'www', 'config.xml'), '', 'utf8');
             process.env.PWD = anotherdir;
             process.chdir(path.sep);
             expect(util.isCordova()).toEqual(somedir);
         });
         it('Test 006 : should use cwd as a fallback when PWD is not a cordova dir', function () {
             fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
             fs.writeFileSync(path.join(somedir, 'www', 'config.xml'), '', 'utf8');
             process.env.PWD = path.sep;
             process.chdir(anotherdir);
             expect(util.isCordova()).toEqual(somedir);
         });
         it('Test 007 : should ignore platform www/config.xml', function () {
             fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
             fs.mkdirSync(path.join(anotherdir, 'www'), { recursive: true });
             fs.writeFileSync(path.join(anotherdir, 'www', 'config.xml'), '', 'utf8');
             fs.writeFileSync(path.join(somedir, 'config.xml'), '', 'utf8');
             expect(util.isCordova(anotherdir)).toEqual(somedir);
         });
     });
     describe('listPlatforms method', function () {
         it('Test 009 : should only return supported platform directories present in a cordova project dir', function () {
             const platforms = path.join(temp, 'platforms');

             fs.mkdirSync(path.join(platforms, 'android'), { recursive: true });
             fs.mkdirSync(path.join(platforms, 'ios'), { recursive: true });
             fs.mkdirSync(path.join(platforms, 'wp8'), { recursive: true });
             fs.mkdirSync(path.join(platforms, 'atari'), { recursive: true });

             // create a typical platforms.json file, it should not be returned as a platform
             fs.writeFileSync(path.join(platforms, 'platforms.json'), '{}', 'utf8');

             const res = util.listPlatforms(temp);
             expect(res.length).toEqual(4);
         });
     });
     describe('getInstalledPlatformsWithVersions method', function () {
         it('Test 010 : should get the supported platforms in the cordova project dir along with their reported versions', function () {
             const PLATFORM = 'cordova-android';
             const platformPath = path.join(temp, 'platforms', PLATFORM);

             return helpers.getFixture('androidApp').copyTo(platformPath)
                 .then(_ => util.getInstalledPlatformsWithVersions(temp))
                 .then(versions => expect(versions[PLATFORM]).toBe('12.0.1'));
         });
     });
     describe('getPlatformVersion method', () => {
         it('should get the version from a legacy platform', () => {
             const PLATFORM_VERSION = '1.2.3-dev';

             fs.mkdirSync(path.join(temp, 'cordova'), { recursive: true });
             fs.writeFileSync(path.join(temp, 'cordova', 'version'), `
                 #!/usr/bin/env node
                 console.log('${PLATFORM_VERSION}');
             `.trim(), 'utf8');

             const version = util.getPlatformVersion(temp);
             expect(version).toBe(PLATFORM_VERSION);
         });
     });
     describe('findPlugins method', function () {
         let pluginsDir, plugins;

         function expectFindPluginsToReturn (expectedPlugins) {
             expect(util.findPlugins(pluginsDir))
                 .toEqual(jasmine.arrayWithExactContents(expectedPlugins));
         }

         beforeEach(function () {
             pluginsDir = path.join(temp, 'plugins');
             plugins = ['foo', 'bar', 'baz'];

             plugins.forEach(plugin => {
                 fs.mkdirSync(path.join(pluginsDir, plugin), { recursive: true });
             });
         });

         it('Test 011 : should only return plugin directories present in a cordova project dir', function () {
             expectFindPluginsToReturn(plugins);
         });

         it('Test 012 : should not return ".svn" directories', function () {
             fs.mkdirSync(path.join(pluginsDir, '.svn'), { recursive: true });
             expectFindPluginsToReturn(plugins);
         });

         it('Test 013 : should not return "CVS" directories', function () {
             fs.mkdirSync(path.join(pluginsDir, 'CVS'), { recursive: true });
             expectFindPluginsToReturn(plugins);
         });

         it('Test 031 : should return plugin symlinks', function () {
             const linkedPluginPath = path.join(temp, 'linked-plugin');
             const pluginLinkPath = path.join(pluginsDir, 'plugin-link');
             fs.mkdirSync(linkedPluginPath, { recursive: true });
             fs.symlinkSync(linkedPluginPath, pluginLinkPath);
             expectFindPluginsToReturn(plugins.concat('plugin-link'));
         });

         it('Test 032 : should work with scoped plugins', () => {
             fs.mkdirSync(path.join(pluginsDir, '@baz/foo'), { recursive: true });
             expectFindPluginsToReturn(plugins.concat('@baz/foo'));
         });
     });

     describe('preprocessOptions method', function () {
         let isCordova, listPlatforms;
         const DEFAULT_OPTIONS = {
             // 'android' is here because we create a spy
             // for listPlatforms below that returns 'android'
             platforms: ['android'],
             verbose: false
         };

         beforeEach(function () {
             isCordova = spyOn(util, 'isCordova').and.returnValue('/fake/path');
             listPlatforms = spyOn(util, 'listPlatforms').and.returnValue(['android']);
         });

         it('Test 014 : should throw if called outside of cordova project', function () {
             isCordova.and.returnValue(false);
             expect(function () { util.preProcessOptions(); }).toThrow();
         });

         it('Test 015 : should throw when no platforms added to project', function () {
             listPlatforms.and.returnValue([]);
             expect(function () { util.preProcessOptions(); }).toThrow();
         });

         it('Test 016 : should return default options when no arguments passed', function () {
             expect(util.preProcessOptions()).toEqual(jasmine.objectContaining(DEFAULT_OPTIONS));
         });

         it('Test 017 : should accept single string argument as platform name', function () {
             expect(util.preProcessOptions('ios')).toEqual(jasmine.objectContaining({ platforms: ['ios'] }));
         });

         it('Test 018 : should accept array of strings as platform names', function () {
             expect(util.preProcessOptions(['ios', 'windows'])).toEqual(jasmine.objectContaining({ platforms: ['ios', 'windows'] }));
         });

         it('Test 019 : should fall back to installed platform if input doesn\'t contain platforms list', function () {
             expect(util.preProcessOptions({ verbose: true }))
                 .toEqual(jasmine.objectContaining({ platforms: ['android'], verbose: true }));
         });

         it('Test 020 : should pick buildConfig if no option is provided, but buildConfig.json exists', function () {
             spyOn(fs, 'existsSync').and.returnValue(true);
             // Using path.join below to normalize path separators
             expect(util.preProcessOptions())
                 .toEqual(jasmine.objectContaining({ options: { buildConfig: path.join('/fake/path/build.json') } }));
         });

         describe('getPlatformApiFunction', function () {
             it('Test 030 : successfully find platform Api', function () {
                 const FIXTURE_PROJECT = path.join(__dirname, 'fixtures/projects/platformApi/');
                 const API_PATH = path.join(FIXTURE_PROJECT, 'platforms/windows/cordova/Api.js');

                 const Api = util.getPlatformApiFunction(API_PATH, 'windows');
                 expect(Api.createPlatform().platform).toBe('windows');
             });

             it('successfully loads platform Api from node_modules', () => {
                 const Api = util.getPlatformApiFunction(null, 'android');
                 expect(Api).toBe(require('cordova-android'));
             });
         });
     });
 });
	/**
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	*/

	const fs = require('node:fs');
	const path = require('node:path');
	const util = require('../../src/cordova/util');
	const helpers = require('../helpers');

	const cwd = process.cwd();
	const origPWD = process.env.PWD;

	describe('util module', function () {
	let temp;
	beforeEach(() => {
	temp = helpers.tmpDir('cordova.util.spec');
	});
	afterEach(() => {
	process.chdir(__dirname);
	fs.rmSync(temp, { recursive: true, force: true });
	});

	describe('isCordova method', function () {
	let somedir, anotherdir;
	beforeEach(() => {
	// Base test directory setup
	somedir = path.join(temp, 'somedir');
	anotherdir = path.join(somedir, 'anotherdir');
	fs.mkdirSync(anotherdir, { recursive: true });
	});
	afterEach(function () {
	process.env.PWD = origPWD;
	process.chdir(cwd);
	});
	it('Test 002 : should return false if it cannot find a Cordova project directory up the directory tree', function () {
	expect(util.isCordova(somedir)).toEqual(false);
	});
	it('Test 003 : should recognize a Cordova project directory', function () {
	fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
	fs.writeFileSync(path.join(somedir, 'www', 'config.xml'), '', 'utf8');
	expect(util.isCordova(somedir)).toEqual(somedir);
	});
	it('Test 004 : should ignore PWD when it is undefined', function () {
	delete process.env.PWD;
	fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
	fs.writeFileSync(path.join(somedir, 'config.xml'), '', 'utf8');
	process.chdir(anotherdir);
	expect(util.isCordova()).toEqual(somedir);
	});
	it('Test 005 : should use PWD when available', function () {
	fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
	fs.writeFileSync(path.join(somedir, 'www', 'config.xml'), '', 'utf8');
	process.env.PWD = anotherdir;
	process.chdir(path.sep);
	expect(util.isCordova()).toEqual(somedir);
	});
	it('Test 006 : should use cwd as a fallback when PWD is not a cordova dir', function () {
	fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
	fs.writeFileSync(path.join(somedir, 'www', 'config.xml'), '', 'utf8');
	process.env.PWD = path.sep;
	process.chdir(anotherdir);
	expect(util.isCordova()).toEqual(somedir);
	});
	it('Test 007 : should ignore platform www/config.xml', function () {
	fs.mkdirSync(path.join(somedir, 'www'), { recursive: true });
	fs.mkdirSync(path.join(anotherdir, 'www'), { recursive: true });
	fs.writeFileSync(path.join(anotherdir, 'www', 'config.xml'), '', 'utf8');
	fs.writeFileSync(path.join(somedir, 'config.xml'), '', 'utf8');
	expect(util.isCordova(anotherdir)).toEqual(somedir);
	});
	});
	describe('listPlatforms method', function () {
	it('Test 009 : should only return supported platform directories present in a cordova project dir', function () {
	const platforms = path.join(temp, 'platforms');

	fs.mkdirSync(path.join(platforms, 'android'), { recursive: true });
	fs.mkdirSync(path.join(platforms, 'ios'), { recursive: true });
	fs.mkdirSync(path.join(platforms, 'wp8'), { recursive: true });
	fs.mkdirSync(path.join(platforms, 'atari'), { recursive: true });

	// create a typical platforms.json file, it should not be returned as a platform
	fs.writeFileSync(path.join(platforms, 'platforms.json'), '{}', 'utf8');

	const res = util.listPlatforms(temp);
	expect(res.length).toEqual(4);
	});
	});
	describe('getInstalledPlatformsWithVersions method', function () {
	it('Test 010 : should get the supported platforms in the cordova project dir along with their reported versions', function () {
	const PLATFORM = 'cordova-android';
	const platformPath = path.join(temp, 'platforms', PLATFORM);

	return helpers.getFixture('androidApp').copyTo(platformPath)
	.then(_ => util.getInstalledPlatformsWithVersions(temp))
	.then(versions => expect(versions[PLATFORM]).toBe('12.0.1'));
	});
	});
	describe('getPlatformVersion method', () => {
	it('should get the version from a legacy platform', () => {
	const PLATFORM_VERSION = '1.2.3-dev';

	fs.mkdirSync(path.join(temp, 'cordova'), { recursive: true });
	fs.writeFileSync(path.join(temp, 'cordova', 'version'), `
	#!/usr/bin/env node
	console.log('${PLATFORM_VERSION}');
	`.trim(), 'utf8');

	const version = util.getPlatformVersion(temp);
	expect(version).toBe(PLATFORM_VERSION);
	});
	});
	describe('findPlugins method', function () {
	let pluginsDir, plugins;

	function expectFindPluginsToReturn (expectedPlugins) {
	expect(util.findPlugins(pluginsDir))
	.toEqual(jasmine.arrayWithExactContents(expectedPlugins));
	}

	beforeEach(function () {
	pluginsDir = path.join(temp, 'plugins');
	plugins = ['foo', 'bar', 'baz'];

	plugins.forEach(plugin => {
	fs.mkdirSync(path.join(pluginsDir, plugin), { recursive: true });
	});
	});

	it('Test 011 : should only return plugin directories present in a cordova project dir', function () {
	expectFindPluginsToReturn(plugins);
	});

	it('Test 012 : should not return ".svn" directories', function () {
	fs.mkdirSync(path.join(pluginsDir, '.svn'), { recursive: true });
	expectFindPluginsToReturn(plugins);
	});

	it('Test 013 : should not return "CVS" directories', function () {
	fs.mkdirSync(path.join(pluginsDir, 'CVS'), { recursive: true });
	expectFindPluginsToReturn(plugins);
	});

	it('Test 031 : should return plugin symlinks', function () {
	const linkedPluginPath = path.join(temp, 'linked-plugin');
	const pluginLinkPath = path.join(pluginsDir, 'plugin-link');
	fs.mkdirSync(linkedPluginPath, { recursive: true });
	fs.symlinkSync(linkedPluginPath, pluginLinkPath);
	expectFindPluginsToReturn(plugins.concat('plugin-link'));
	});

	it('Test 032 : should work with scoped plugins', () => {
	fs.mkdirSync(path.join(pluginsDir, '@baz/foo'), { recursive: true });
	expectFindPluginsToReturn(plugins.concat('@baz/foo'));
	});
	});

	describe('preprocessOptions method', function () {
	let isCordova, listPlatforms;
	const DEFAULT_OPTIONS = {
	// 'android' is here because we create a spy
	// for listPlatforms below that returns 'android'
	platforms: ['android'],
	verbose: false
	};

	beforeEach(function () {
	isCordova = spyOn(util, 'isCordova').and.returnValue('/fake/path');
	listPlatforms = spyOn(util, 'listPlatforms').and.returnValue(['android']);
	});

	it('Test 014 : should throw if called outside of cordova project', function () {
	isCordova.and.returnValue(false);
	expect(function () { util.preProcessOptions(); }).toThrow();
	});

	it('Test 015 : should throw when no platforms added to project', function () {
	listPlatforms.and.returnValue([]);
	expect(function () { util.preProcessOptions(); }).toThrow();
	});

	it('Test 016 : should return default options when no arguments passed', function () {
	expect(util.preProcessOptions()).toEqual(jasmine.objectContaining(DEFAULT_OPTIONS));
	});

	it('Test 017 : should accept single string argument as platform name', function () {
	expect(util.preProcessOptions('ios')).toEqual(jasmine.objectContaining({ platforms: ['ios'] }));
	});

	it('Test 018 : should accept array of strings as platform names', function () {
	expect(util.preProcessOptions(['ios', 'windows'])).toEqual(jasmine.objectContaining({ platforms: ['ios', 'windows'] }));
	});

	it('Test 019 : should fall back to installed platform if input doesn\'t contain platforms list', function () {
	expect(util.preProcessOptions({ verbose: true }))
	.toEqual(jasmine.objectContaining({ platforms: ['android'], verbose: true }));
	});

	it('Test 020 : should pick buildConfig if no option is provided, but buildConfig.json exists', function () {
	spyOn(fs, 'existsSync').and.returnValue(true);
	// Using path.join below to normalize path separators
	expect(util.preProcessOptions())
	.toEqual(jasmine.objectContaining({ options: { buildConfig: path.join('/fake/path/build.json') } }));
	});

	describe('getPlatformApiFunction', function () {
	it('Test 030 : successfully find platform Api', function () {
	const FIXTURE_PROJECT = path.join(__dirname, 'fixtures/projects/platformApi/');
	const API_PATH = path.join(FIXTURE_PROJECT, 'platforms/windows/cordova/Api.js');

	const Api = util.getPlatformApiFunction(API_PATH, 'windows');
	expect(Api.createPlatform().platform).toBe('windows');
	});

	it('successfully loads platform Api from node_modules', () => {
	const Api = util.getPlatformApiFunction(null, 'android');
	expect(Api).toBe(require('cordova-android'));
	});
	});
	});
	});