tests/spec/unit/templates/cordova/lib/PackageJsonParser.spec.js

/*
    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 path = require('path');
const fs = require('fs-extra');
const rewire = require('rewire');

const PackageJsonParser = rewire('../../../../../../bin/templates/cordova/lib/PackageJsonParser');
const ConfigParser = require('cordova-common').ConfigParser;

const FIXTURES = path.join(__dirname, '..', '..', '..', '..', 'fixtures');

// Create a real config object before mocking out everything.
const cfg = new ConfigParser(path.join(FIXTURES, 'test-config-1.xml'));
const cfgEmpty = new ConfigParser(path.join(FIXTURES, 'test-config-empty.xml'));

const defaultMockProjectPackageJson = {
    name: 'io.cordova.electronTest',
    displayName: 'electronTest',
    version: '1.0.0',
    description: 'A Sample Apache Cordova Electron Application.',
    author: 'Apache Cordova Team',
    license: 'Apache-2.0',
    dependencies: { 'cordova-electron': '^1.0.2' },
    devDependencies: {},
    cordova: {
        plugins: {},
        platforms: ['electron']
    }
};

const locations = {
    buildRes: path.join('mock', 'build-res'),
    www: path.join('mock', 'www'),
    configXml: path.join('mock', 'config.xml')
};

describe('PackageJsonParser class', () => {
    let packageJsonParser;
    let emitSpy;

    beforeEach(() => {
        packageJsonParser = PackageJsonParser.__get__('PackageJsonParser');

        emitSpy = jasmine.createSpy('emit');
        packageJsonParser.__set__('events', { emit: emitSpy });
    });

    it('should should be defined.', () => {
        expect(packageJsonParser).toBeDefined();
    });

    it('should set initial value correctly.', () => {
        packageJsonParser = new PackageJsonParser(locations.www, '/root/project');

        // mock package JSON Object
        const packageJsonObj = { main: 'cdv-electron-main.js' };

        expect(packageJsonParser.path).toEqual(path.join('mock', 'www', 'package.json'));
        expect(packageJsonParser.www).toEqual(locations.www);
        expect(packageJsonParser.package).toEqual(packageJsonObj);
    });

    it('should return when config xml is not defined.', () => {
        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(undefined);

        // mock package JSON Object
        const packageJsonObj = { main: 'cdv-electron-main.js' };

        expect(packageJsonParser.package).toEqual(packageJsonObj);
    });

    it('should set package json object values to default, when config xml is empty.', () => {
        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfgEmpty, defaultMockProjectPackageJson);

        // mock package JSON Object
        const packageJsonObj = {
            package:
                {
                    main: 'cdv-electron-main.js',
                    name: 'io.cordova.hellocordova',
                    displayName: 'HelloCordova',
                    version: '1.0.0',
                    description: 'A sample Apache Cordova application that responds to the deviceready event.',
                    dependencies: { 'cordova-electron': '^1.0.2' },
                    homepage: 'https://cordova.io',
                    license: 'Apache-2.0',
                    author: 'Apache Cordova Team'
                }
        };

        expect(packageJsonParser.package).toEqual(packageJsonObj.package);
    });

    it('should read and set package json object values from config xml.', () => {
        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfg, defaultMockProjectPackageJson);

        // mock package JSON Object
        const packageJsonObj = {
            package:
                {
                    main: 'cdv-electron-main.js',
                    name: 'whatever',
                    displayName: 'HelloWorld',
                    version: '1.1.1',
                    description: 'A sample Apache Cordova application.',
                    dependencies: { 'cordova-electron': '^1.0.2' },
                    homepage: 'http://cordova.io',
                    license: 'Apache 2.0 License',
                    author: { name: 'Cordova Team', email: 'dev@cordova.com' }
                }
        };

        expect(packageJsonParser.package).toEqual(packageJsonObj.package);
    });

    it('should warn when "cordova-*" prefixed dependency is defined in package.json dependencies.', () => {
        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfg, defaultMockProjectPackageJson);

        expect(emitSpy).toHaveBeenCalled();

        let actual = emitSpy.calls.argsFor(0)[1];
        let expectedPartial = '[Cordova Electron] The built package size may be larger than necessary.';
        expect(actual).toContain(expectedPartial);

        actual = emitSpy.calls.argsFor(1)[1];
        expectedPartial = '[Cordova Electron] The following Cordova package(s) were detected as "dependencies" in the projects "package.json" file.';
        expect(actual).toContain(expectedPartial);
        expect(actual).toContain('cordova-electron');
    });

    it('should not warn when "cordova-*" prefixed dependency is not defined in package.json dependencies.', () => {
        const mockProjectPackageJson = Object.assign({}, defaultMockProjectPackageJson);
        mockProjectPackageJson.devDependencies = Object.assign({}, defaultMockProjectPackageJson.dependencies);
        mockProjectPackageJson.dependencies = { foobar: '1.0.0' }; // setting a non "cordova-" dependency

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfg, mockProjectPackageJson);

        expect(emitSpy).not.toHaveBeenCalled();
    });

    it('should skip configuring the Electron app\'s dependencies when the Cordova project\'s package.json dependencies are not set.', () => {
        const mockProjectPackageJson = Object.assign({}, defaultMockProjectPackageJson);
        mockProjectPackageJson.dependencies = {};

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfg, mockProjectPackageJson);

        expect(emitSpy).not.toHaveBeenCalled();
    });

    it('should skip preparing npm packages that already contain absolute paths.', () => {
        const mockProjectPackageJson = Object.assign({}, defaultMockProjectPackageJson);
        mockProjectPackageJson.dependencies = { foobar: 'file:/tmp/foobar.tar.gz' };

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfg, mockProjectPackageJson);

        expect(emitSpy).not.toHaveBeenCalled();
    });

    it('should convert npm packages that contain relative path to be absolute paths.', () => {
        const mockProjectPackageJson = Object.assign({}, defaultMockProjectPackageJson);
        mockProjectPackageJson.dependencies = { foobar: 'file:../tmp/foobar.tar.gz' };

        spyOn(fs, 'pathExistsSync').and.returnValue(true);

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project', '/root/project')
            .configure(cfg, mockProjectPackageJson);

        expect(emitSpy).not.toHaveBeenCalled();
    });

    it('should warn that an npm packages will be dropped when the absolute path could not be found.', () => {
        const mockProjectPackageJson = Object.assign({}, defaultMockProjectPackageJson);
        mockProjectPackageJson.dependencies = { foobar: 'file:../tmp/foobar.tar.gz' };

        spyOn(fs, 'pathExistsSync').and.returnValue(false);

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project', '/root/project')
            .configure(cfg, mockProjectPackageJson);

        const actual = emitSpy.calls.argsFor(0)[1];
        const expectedPartial = '[Cordova Electron] The following local npm dependencies could not be located and will not be deployed to the Electron app:';
        expect(actual).toContain(expectedPartial);
        expect(actual).toContain('foobar');
    });

    it('should not set package dependencies when project dependencies is missing.', () => {
        const mockProjectPackageJson = Object.assign({}, defaultMockProjectPackageJson);
        mockProjectPackageJson.devDependencies = Object.assign({}, defaultMockProjectPackageJson.dependencies);
        delete mockProjectPackageJson.dependencies;

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfg, mockProjectPackageJson);

        expect(emitSpy).not.toHaveBeenCalled();
        expect(packageJsonParser.package.dependencies).not.toBeDefined();
    });

    it('should write provided data when config xml is empty.', () => {
        const writeFileSyncSpy = jasmine.createSpy('writeFileSync');
        packageJsonParser.__set__('fs', { writeFileSync: writeFileSyncSpy });

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfgEmpty, defaultMockProjectPackageJson)
            .write();

        expect(writeFileSyncSpy).toHaveBeenCalled();

        // mock package JSON Object
        let packageJsonObj = {
            package:
                {
                    main: 'cdv-electron-main.js',
                    name: 'io.cordova.hellocordova',
                    displayName: 'HelloCordova',
                    version: '1.0.0',
                    description: 'A sample Apache Cordova application that responds to the deviceready event.',
                    dependencies: { 'cordova-electron': '^1.0.2' },
                    homepage: 'https://cordova.io',
                    license: 'Apache-2.0',
                    author: 'Apache Cordova Team'
                }
        };

        const packagePath = writeFileSyncSpy.calls.argsFor(0)[0];
        expect(packagePath).toEqual(path.join('mock', 'www', 'package.json'));

        // get package json file content and remove white spaces
        let packageFile = writeFileSyncSpy.calls.argsFor(0)[1];

        // convert to remove white space
        packageFile = packageFile.replace(/\s+/g, '');
        packageJsonObj = JSON.stringify(packageJsonObj.package).replace(/\s/g, '');
        expect(packageFile).toEqual(packageJsonObj);

        const packageFormat = writeFileSyncSpy.calls.argsFor(0)[2];
        expect(packageFormat).toEqual('utf8');
    });

    it('should write package json object values from config xml.', () => {
        const writeFileSyncSpy = jasmine.createSpy('writeFileSync');
        packageJsonParser.__set__('fs', { writeFileSync: writeFileSyncSpy });

        packageJsonParser = new PackageJsonParser(locations.www, '/root/project')
            .configure(cfg, defaultMockProjectPackageJson)
            .write();

        expect(writeFileSyncSpy).toHaveBeenCalled();

        // mock package JSON Object
        let packageJsonObj = {
            package:
                {
                    main: 'cdv-electron-main.js',
                    name: 'whatever',
                    displayName: 'HelloWorld',
                    version: '1.1.1',
                    description: 'A sample Apache Cordova application.',
                    dependencies: { 'cordova-electron': '^1.0.2' },
                    homepage: 'http://cordova.io',
                    license: 'Apache 2.0 License',
                    author: { name: 'Cordova Team', email: 'dev@cordova.com' }
                }
        };

        const packagePath = writeFileSyncSpy.calls.argsFor(0)[0];
        expect(packagePath).toEqual(path.join('mock', 'www', 'package.json'));

        // get package json file content and remove white spaces
        let packageFile = writeFileSyncSpy.calls.argsFor(0)[1];

        // convert to remove white space
        packageFile = packageFile.replace(/\s+/g, '');
        packageJsonObj = JSON.stringify(packageJsonObj.package).replace(/\s/g, '');
        expect(packageFile).toEqual(packageJsonObj);

        const packageFormat = writeFileSyncSpy.calls.argsFor(0)[2];
        expect(packageFormat).toEqual('utf8');
    });
});