| /** |
| 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. |
| */ |
| |
| var fs = require('fs'); |
| var path = require('path'); |
| |
| var shell = require('shelljs'); |
| var requireFresh = require('import-fresh'); |
| |
| var create = require('..'); |
| var events = require('cordova-common').events; |
| var CordovaError = require('cordova-common').CordovaError; |
| var ConfigParser = require('cordova-common').ConfigParser; |
| const {tmpDir, createWith, createWithMockFetch, expectRejection} = require('./helpers'); |
| |
| const appName = 'TestBase'; |
| const appId = 'org.testing'; |
| const appVersion = '1.0.0'; |
| const project = path.join(tmpDir, appName); |
| |
| // Setup and teardown test dirs |
| beforeEach(function () { |
| shell.rm('-rf', project); |
| shell.mkdir('-p', tmpDir); |
| }); |
| afterEach(function () { |
| process.chdir(path.join(__dirname, '..')); // Needed to rm the dir on Windows. |
| shell.rm('-rf', tmpDir); |
| }); |
| |
| describe('cordova create checks for valid-identifier', function () { |
| const error = new CordovaError('is not a valid identifier'); |
| |
| it('should reject reserved words from start of id', function () { |
| return expectRejection(create(project, 'int.bob', appName, {}, events), error); |
| }); |
| |
| it('should reject reserved words from end of id', function () { |
| return expectRejection(create(project, 'bob.class', appName, {}, events), error); |
| }); |
| }); |
| |
| describe('create end-to-end', function () { |
| |
| function checkCommonArtifacts () { |
| // Check that top level dirs exist |
| var dirs = ['hooks', 'platforms', 'plugins', 'www']; |
| dirs.forEach(function (d) { |
| expect(path.join(project, d)).toExist(); |
| }); |
| |
| // Check that README.md exists inside of hooks |
| expect(path.join(project, 'hooks', 'README.md')).toExist(); |
| |
| // Check that index.html exists inside of www |
| expect(path.join(project, 'www', 'index.html')).toExist(); |
| |
| // Check that www files don't get copied to the top level |
| expect(path.join(project, 'index.html')).not.toExist(); |
| |
| // index.js and template subdir folder should not exist in top level |
| // (inner files should be copied to the project top level folder) |
| expect(path.join(project, 'index.js')).not.toExist(); |
| expect(path.join(project, 'template')).not.toExist(); |
| |
| // Check that config.xml does not exist inside of www |
| expect(path.join(project, 'www', 'config.xml')).not.toExist(); |
| |
| // Check that config.xml was updated correctly |
| var configXml = new ConfigParser(path.join(project, 'config.xml')); |
| expect(configXml.packageName()).toEqual(appId); |
| expect(configXml.name()).toEqual(appName); |
| expect(configXml.version()).toEqual(appVersion); |
| } |
| |
| // Check that we got package.json and it was updated correctly |
| function checkPackageJson () { |
| const pkg = requireFresh(path.join(project, 'package.json')); |
| expect(pkg.name).toEqual(appId); |
| expect(pkg.displayName).toEqual(appName); |
| expect(pkg.version).toEqual(appVersion); |
| } |
| |
| // Check that we got no package.json |
| function checkNoPackageJson () { |
| expect(path.join(project, 'package.json')).not.toExist(); |
| } |
| |
| // Check that we did use the default template |
| function checkDefaultTemplate () { |
| const pkg = requireFresh(path.join(project, 'package.json')); |
| expect(pkg.author).toEqual('Apache Cordova Team'); |
| |
| const configXml = new ConfigParser(path.join(project, 'config.xml')); |
| expect(configXml.author()).toEqual('Apache Cordova Team'); |
| } |
| |
| // Check that we did not use the default template |
| function checkNotDefaultTemplate () { |
| const configXml = new ConfigParser(path.join(project, 'config.xml')); |
| expect(configXml.author()).not.toEqual('Apache Cordova Team'); |
| } |
| |
| function checkProjectCreatedWithFixtureTemplate () { |
| checkCommonArtifacts(); |
| checkNoPackageJson(); |
| checkNotDefaultTemplate(); |
| } |
| |
| function checkProjectCreatedWithDefaultTemplate () { |
| checkCommonArtifacts(); |
| checkPackageJson(); |
| checkDefaultTemplate(); |
| } |
| |
| it('should successfully run without template and use default hello-world app', function () { |
| // Create a real project with no template |
| // use default cordova-app-hello-world app |
| return create(project, appId, appName, {}, events) |
| .then(checkProjectCreatedWithDefaultTemplate); |
| }); |
| |
| it('should successfully run with Git URL', function () { |
| // Create a real project with git URL as template |
| var config = { |
| lib: { |
| www: { |
| url: 'https://github.com/apache/cordova-app-hello-world', |
| template: true |
| } |
| } |
| }; |
| return createWithMockFetch(project, appId, appName, config, events) |
| .then(fetchSpy => { |
| expect(fetchSpy).toHaveBeenCalledTimes(1); |
| expect(fetchSpy.calls.argsFor(0)[0]).toBe(config.lib.www.url); |
| }) |
| .then(checkProjectCreatedWithDefaultTemplate); |
| }); |
| |
| it('should successfully run with NPM package', function () { |
| // Create a real project with npm module as template |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: 'phonegap-template-vue-f7-tabs@1' |
| } |
| } |
| }; |
| return createWithMockFetch(project, appId, appName, config, events) |
| .then(fetchSpy => { |
| expect(fetchSpy).toHaveBeenCalledTimes(1); |
| expect(fetchSpy.calls.argsFor(0)[0]).toBe(config.lib.www.url); |
| }) |
| .then(checkProjectCreatedWithDefaultTemplate); |
| }); |
| |
| it('should successfully run with NPM package and explicitly fetch latest if no version is given', function () { |
| // Create a real project with npm module as template |
| // TODO fetch should be responsible for the cache busting part of this test |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: 'phonegap-template-vue-f7-tabs' |
| } |
| } |
| }; |
| return createWithMockFetch(project, appId, appName, config, events) |
| .then(fetchSpy => { |
| expect(fetchSpy).toHaveBeenCalledTimes(1); |
| expect(fetchSpy.calls.argsFor(0)[0]).toBe(config.lib.www.url + '@latest'); |
| }) |
| .then(checkProjectCreatedWithDefaultTemplate); |
| }); |
| |
| it('should successfully run with template not having a package.json at toplevel', function () { |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'nopackage_json') |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkProjectCreatedWithFixtureTemplate); |
| }); |
| |
| it('should successfully run with template having package.json and no sub directory', function () { |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'withpackage_json') |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkProjectCreatedWithFixtureTemplate); |
| }); |
| |
| it('should successfully run with template having package.json, and subdirectory, and no package.json in subdirectory', function () { |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'withsubdirectory') |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkProjectCreatedWithFixtureTemplate); |
| }); |
| |
| it('should successfully run with template having package.json, and subdirectory, and package.json in subdirectory', function () { |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'withsubdirectory_package_json') |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkCommonArtifacts) |
| .then(checkPackageJson) |
| .then(checkNotDefaultTemplate); |
| }); |
| |
| it('should successfully run config.xml in the www folder and move it outside', function () { |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'config_in_www') |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkProjectCreatedWithFixtureTemplate); |
| }); |
| |
| it('should successfully run with www folder as the template', function () { |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'config_in_www', 'www') |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkProjectCreatedWithFixtureTemplate); |
| }); |
| |
| it('should successfully run with existing, empty destination', function () { |
| shell.mkdir('-p', project); |
| return create(project, appId, appName, {}, events) |
| .then(checkProjectCreatedWithDefaultTemplate); |
| }); |
| |
| describe('when --link-to is provided', function () { |
| function allowSymlinkErrorOnWindows (err) { |
| const onWindows = process.platform.slice(0, 3) === 'win'; |
| const isSymlinkError = err && String(err.message).startsWith('Symlinks on Windows'); |
| if (onWindows && isSymlinkError) { |
| pending(err.message); |
| } else { |
| throw err; |
| } |
| } |
| |
| it('when passed www folder should not move www/config.xml, only copy and update', function () { |
| function checkSymWWW () { |
| // Check if top level dirs exist. |
| var dirs = ['hooks', 'platforms', 'plugins', 'www']; |
| dirs.forEach(function (d) { |
| expect(path.join(project, d)).toExist(); |
| }); |
| expect(path.join(project, 'hooks', 'README.md')).toExist(); |
| |
| // Check if www files exist. |
| expect(path.join(project, 'www', 'index.html')).toExist(); |
| |
| // Check www/config exists |
| expect(path.join(project, 'www', 'config.xml')).toExist(); |
| // Check www/config.xml was not updated. |
| var configXml = new ConfigParser(path.join(project, 'www', 'config.xml')); |
| expect(configXml.packageName()).toEqual('io.cordova.hellocordova'); |
| expect(configXml.version()).toEqual('0.0.1'); |
| expect(configXml.description()).toEqual('this is the correct config.xml'); |
| |
| // Check that config.xml was copied to project/config.xml |
| expect(path.join(project, 'config.xml')).toExist(); |
| configXml = new ConfigParser(path.join(project, 'config.xml')); |
| expect(configXml.description()).toEqual('this is the correct config.xml'); |
| // Check project/config.xml was updated. |
| expect(configXml.packageName()).toEqual(appId); |
| expect(configXml.version()).toEqual('1.0.0'); |
| |
| // Check that we got no package.json |
| expect(path.join(project, 'package.json')).not.toExist(); |
| |
| // Check that www is really a symlink, |
| // and project/config.xml , hooks and merges are not |
| expect(fs.lstatSync(path.join(project, 'www')).isSymbolicLink()).toBe(true); |
| expect(fs.lstatSync(path.join(project, 'hooks')).isSymbolicLink()).not.toBe(true); |
| expect(fs.lstatSync(path.join(project, 'config.xml')).isSymbolicLink()).not.toBe(true); |
| } |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'config_in_www', 'www'), |
| link: true |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkSymWWW) |
| .catch(allowSymlinkErrorOnWindows); |
| }); |
| |
| it('with subdirectory should not update symlinked project/config.xml', function () { |
| function checkSymSubDir () { |
| // Check if top level dirs exist. |
| var dirs = ['hooks', 'platforms', 'plugins', 'www']; |
| dirs.forEach(function (d) { |
| expect(path.join(project, d)).toExist(); |
| }); |
| expect(path.join(project, 'hooks', 'README.md')).toExist(); |
| |
| // index.js and template subdir folder should not exist (inner files should be copied to the project folder) |
| expect(path.join(project, 'index.js')).not.toExist(); |
| expect(path.join(project, 'template')).not.toExist(); |
| |
| // Check if www files exist. |
| expect(path.join(project, 'www', 'index.html')).toExist(); |
| |
| // Check that www, and config.xml is really a symlink |
| expect(fs.lstatSync(path.join(project, 'www')).isSymbolicLink()).toBe(true); |
| expect(fs.lstatSync(path.join(project, 'config.xml')).isSymbolicLink()).toBe(true); |
| |
| // Check that config.xml was not updated. (symlinked config does not get updated!) |
| var configXml = new ConfigParser(path.join(project, 'config.xml')); |
| expect(configXml.packageName()).toEqual('io.cordova.hellocordova'); |
| expect(configXml.version()).toEqual('0.0.1'); |
| |
| // Check that we got the right config.xml |
| expect(configXml.description()).toEqual('this is the correct config.xml'); |
| |
| // Check that we got package.json (the correct one) and it was changed |
| var pkjson = requireFresh(path.join(project, 'package.json')); |
| // Pkjson.name should equal config's id. |
| expect(pkjson.name).toEqual(appId.toLowerCase()); |
| expect(pkjson.valid).toEqual('true'); |
| } |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'withsubdirectory_package_json'), |
| link: true |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkSymSubDir) |
| .catch(allowSymlinkErrorOnWindows); |
| }); |
| |
| it('with no config should create one and update it', function () { |
| function checkSymNoConfig () { |
| // Check if top level dirs exist. |
| var dirs = ['hooks', 'platforms', 'plugins', 'www']; |
| dirs.forEach(function (d) { |
| expect(path.join(project, d)).toExist(); |
| }); |
| expect(path.join(project, 'hooks', 'hooks.file')).toExist(); |
| expect(path.join(project, 'merges', 'merges.file')).toExist(); |
| |
| // Check if www files exist. |
| expect(path.join(project, 'www', 'index.html')).toExist(); |
| |
| // Check that config.xml was updated. |
| var configXml = new ConfigParser(path.join(project, 'config.xml')); |
| expect(configXml.packageName()).toEqual(appId); |
| |
| // Check that www, hooks, merges are really a symlink; config is not |
| expect(fs.lstatSync(path.join(project, 'www')).isSymbolicLink()).toBe(true); |
| expect(fs.lstatSync(path.join(project, 'hooks')).isSymbolicLink()).toBe(true); |
| expect(fs.lstatSync(path.join(project, 'merges')).isSymbolicLink()).toBe(true); |
| expect(fs.lstatSync(path.join(project, 'config.xml')).isSymbolicLink()).not.toBe(true); |
| } |
| |
| var config = { |
| lib: { |
| www: { |
| template: true, |
| url: path.join(__dirname, 'templates', 'noconfig'), |
| link: true |
| } |
| } |
| }; |
| return create(project, appId, appName, config, events) |
| .then(checkSymNoConfig) |
| .catch(allowSymlinkErrorOnWindows); |
| }); |
| |
| }); |
| }); |
| |
| describe('when shit happens', function () { |
| it('should fail when dir is missing', function () { |
| return expectRejection( |
| create(null, appId, appName, {}, events), |
| new CordovaError('Directory not specified') |
| ); |
| }); |
| |
| it('should fail when dir already exists', function () { |
| return expectRejection( |
| create(__dirname, appId, appName, {}, events), |
| new CordovaError('Path already exists and is not empty') |
| ); |
| }); |
| |
| it('should fail when destination is inside template', function () { |
| const config = { |
| lib: { |
| www: { |
| url: path.join(tmpDir, 'template') |
| } |
| } |
| }; |
| const destination = path.join(config.lib.www.url, 'destination'); |
| return expectRejection( |
| create(destination, appId, appName, config, events), |
| new CordovaError('inside the template') |
| ); |
| }); |
| |
| it('should fail when fetch fails', function () { |
| const config = { |
| lib: { |
| www: { |
| template: true, |
| url: 'http://localhost:123456789/cordova-create' |
| } |
| } |
| }; |
| const fetchError = new Error('Fetch fail'); |
| const failingFetch = jasmine.createSpy('failingFetch') |
| .and.callFake(() => Promise.reject(fetchError)); |
| return expectRejection( |
| createWith({fetch: failingFetch})(project, appId, appName, config), |
| fetchError |
| ); |
| |
| }); |
| |
| it('should fail when template does not exist', function () { |
| const config = { |
| lib: { |
| www: { |
| url: path.join(__dirname, 'doesnotexist') |
| } |
| } |
| }; |
| return expectRejection( |
| create(project, appId, appName, config, events), |
| new CordovaError('Could not find directory') |
| ); |
| }); |
| }); |
