platform.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.
*/

var helpers = require('./helpers'),
    path = require('path'),
    fs = require('fs'),
    shell = require('shelljs'),
    superspawn = require('cordova-common').superspawn,
    config = require('../src/cordova/config'),
    Q = require('q'),
    events = require('cordova-common').events,
    cordova = require('../src/cordova/cordova'),
    plugman = require('../src/plugman/plugman'),
    rewire = require('rewire'),
    platform = rewire('../src/cordova/platform.js');

var projectRoot = 'C:\\Projects\\cordova-projects\\move-tracker';
var pluginsDir = path.join(__dirname, 'fixtures', 'plugins');

describe('platform end-to-end', function () {

    var tmpDir = helpers.tmpDir('platform_test');
    var project = path.join(tmpDir, 'project');

    var results;

    beforeEach(function() {
        shell.rm('-rf', tmpDir);

        // cp then mv because we need to copy everything, but that means it'll copy the whole directory.
        // Using /* doesn't work because of hidden files.
        shell.cp('-R', path.join(__dirname, 'fixtures', 'base'), tmpDir);
        shell.mv(path.join(tmpDir, 'base'), project);
        process.chdir(project);

        // Now we load the config.json in the newly created project and edit the target platform's lib entry
        // to point at the fixture version. This is necessary so that cordova.prepare can find cordova.js there.
        var c = config.read(project);
        c.lib[helpers.testPlatform].url = path.join(__dirname, 'fixtures', 'platforms', helpers.testPlatform + '-lib');
        config.write(project, c);

        // The config.json in the fixture project points at fake "local" paths.
        // Since it's not a URL, the lazy-loader will just return the junk path.
        spyOn(superspawn, 'spawn').andCallFake(function(cmd, args) {
            if (cmd.match(/create\b/)) {
                // This is a call to the bin/create script, so do the copy ourselves.
                shell.cp('-R', path.join(__dirname, 'fixtures', 'platforms', 'android'), path.join(project, 'platforms'));
            } else if(cmd.match(/version\b/)) {
                return Q('3.3.0');
            } else if(cmd.match(/update\b/)) {
                fs.writeFileSync(path.join(project, 'platforms', helpers.testPlatform, 'updated'), 'I was updated!', 'utf-8');
            }
            return Q();
        });

        events.on('results', function(res) { results = res; });
    });

    afterEach(function() {
        process.chdir(path.join(__dirname, '..'));  // Needed to rm the dir on Windows.
        shell.rm('-rf', tmpDir);
    });

    // Factoring out some repeated checks.
    function emptyPlatformList() {
        return cordova.raw.platform('list').then(function() {
            var installed = results.match(/Installed platforms:\n  (.*)/);
            expect(installed).toBeDefined();
            expect(installed[1].indexOf(helpers.testPlatform)).toBe(-1);
        });
    }
    function fullPlatformList() {
        return cordova.raw.platform('list').then(function() {
            var installed = results.match(/Installed platforms:\n  (.*)/);
            expect(installed).toBeDefined();
            expect(installed[1].indexOf(helpers.testPlatform)).toBeGreaterThan(-1);
        });
    }

    // The flows we want to test are add, rm, list, and upgrade.
    // They should run the appropriate hooks.
    // They should fail when not inside a Cordova project.
    // These tests deliberately have no beforeEach and afterEach that are cleaning things up.
    it('should successfully run', function(done) {

        // Check there are no platforms yet.
        emptyPlatformList().then(function() {
            // Add the testing platform.
            return cordova.raw.platform('add', [helpers.testPlatform]);
        }).then(function() {
            // Check the platform add was successful.
            expect(path.join(project, 'platforms', helpers.testPlatform)).toExist();
            expect(path.join(project, 'platforms', helpers.testPlatform, 'cordova')).toExist();
        }).then(fullPlatformList) // Check for it in platform ls.
        .then(function() {
            // Try to update the platform.
            return cordova.raw.platform('update', [helpers.testPlatform]);
        }).then(function() {
            // Our fake update script in the exec mock above creates this dummy file.
            expect(path.join(project, 'platforms', helpers.testPlatform, 'updated')).toExist();
        }).then(fullPlatformList) // Platform should still be in platform ls.
        .then(function() {
            // And now remove it.
            return cordova.raw.platform('rm', [helpers.testPlatform]);
        }).then(function() {
            // It should be gone.
            expect(path.join(project, 'platforms', helpers.testPlatform)).not.toExist();
        }).then(emptyPlatformList) // platform ls should be empty too.
        .fail(function(err) {
            expect(err).toBeUndefined();
        }).fin(done);
    });

    it('should install plugins correctly while adding platform', function(done) {

        cordova.raw.plugin('add', path.join(pluginsDir, 'test'))
        .then(function() {
            return cordova.raw.platform('add', [helpers.testPlatform]);
        })
        .then(function() {
            // Check the platform add was successful.
            expect(path.join(project, 'platforms', helpers.testPlatform)).toExist();
            // Check that plugin files exists in www dir
            expect(path.join(project, 'platforms', helpers.testPlatform, 'assets/www/test.js')).toExist();
        })
        .fail(function(err) {
            expect(err).toBeUndefined();
        })
        .fin(done);
    });

    it('should call prepare after plugins were installed into platform', function(done) {
        var order = '';
        var fail = jasmine.createSpy(fail);
        spyOn(plugman.raw, 'install').andCallFake(function() { order += 'I'; });
        spyOn(cordova.raw, 'prepare').andCallFake(function() { order += 'P'; });

        cordova.raw.plugin('add', path.join(pluginsDir, 'test'))
        .then(function() {
            return cordova.raw.platform('add', [helpers.testPlatform]);
        })
        .fail(fail)
        .fin(function() {
            expect(order).toBe('IP'); // Install first, then prepare
            expect(fail).not.toHaveBeenCalled();
            done();
        });
    });
});

describe('add function', function () {
    var opts;
    var hooksRunnerMock;

    beforeEach(function(){
        opts = {};
        hooksRunnerMock = {
            fire: function () {
                return Q();
            }
        };
    });

    it('throws if the target list is empty', function (done) {
        var targets = [];
        platform.add(hooksRunnerMock, projectRoot, targets, opts).fail(function (error) {
            expect(error.message).toBe('No platform specified. Please specify a platform to add. See `cordova platform list`.');
            done();
        });
    });

    it('throws if the target list is undefined or null', function (done) {

        // case 1 : target list undefined
        var targets; // = undefined;
        platform.add(hooksRunnerMock, projectRoot, targets, opts).fail(function (error) {
            expect(error.message).toBe('No platform specified. Please specify a platform to add. See `cordova platform list`.');
        });

        // case 2 : target list null
        targets = null;
        platform.add(hooksRunnerMock, projectRoot, targets, opts).fail(function (error) {
            expect(error.message).toBe('No platform specified. Please specify a platform to add. See `cordova platform list`.');
            done();
        });
    });
});

describe('platform add plugin rm end-to-end', function () {

    var tmpDir = helpers.tmpDir('plugin_rm_test');
    var project = path.join(tmpDir, 'hello');
    var pluginsDir = path.join(project, 'plugins');

    beforeEach(function() {
        process.chdir(tmpDir);
    });

    afterEach(function() {
        process.chdir(path.join(__dirname, '..'));  // Needed to rm the dir on Windows.
        shell.rm('-rf', tmpDir);
    });

    it('should remove dependency when removing parent plugin', function(done) {

        cordova.raw.create('hello')
        .then(function() {
            process.chdir(project);
            return cordova.raw.platform('add', 'ios@latest');
        })
        .then(function() {
            return cordova.raw.plugin('add', 'cordova-plugin-media');
        })
        .then(function() {
            expect(path.join(pluginsDir, 'cordova-plugin-media')).toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-file')).toExist();
            return cordova.raw.platform('add', 'android@latest');
        })
        .then(function() {
            expect(path.join(pluginsDir, 'cordova-plugin-media')).toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-file')).toExist();
            return cordova.raw.plugin('rm', 'cordova-plugin-media');
        })
        .then(function() {
            expect(path.join(pluginsDir, 'cordova-plugin-media')).not.toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-file')).not.toExist();
        })
        .fail(function(err) {
            console.error(err);
            expect(err).toBeUndefined();
        })
        .fin(done);
    }, 20000);
});

describe('platform add and remove --fetch', function () {

    var tmpDir = helpers.tmpDir('plat_add_remove_fetch_test');
    var project = path.join(tmpDir, 'helloFetch');
    var platformsDir = path.join(project, 'platforms');
    var nodeModulesDir = path.join(project, 'node_modules');

    beforeEach(function() {
        process.chdir(tmpDir);
    });

    afterEach(function() {
        process.chdir(path.join(__dirname, '..'));  // Needed to rm the dir on Windows.
        shell.rm('-rf', tmpDir);
    });

    it('should add and remove platform from node_modules directory', function(done) {

        cordova.raw.create('helloFetch')
        .then(function() {
            process.chdir(project);
            return cordova.raw.platform('add', 'ios', {'fetch':true});
        })
        .then(function() {
            expect(path.join(nodeModulesDir, 'cordova-ios')).toExist();
            expect(path.join(platformsDir, 'ios')).toExist();
            return cordova.raw.platform('add', 'android', {'fetch':true});
        })
        .then(function() {
            expect(path.join(nodeModulesDir, 'cordova-android')).toExist();
            expect(path.join(platformsDir, 'android')).toExist();
            //Tests finish before this command finishes resolving
            //return cordova.raw.platform('rm', 'ios', {'fetch':true});
        })
        .then(function() {
            //expect(path.join(nodeModulesDir, 'cordova-ios')).not.toExist();
            //expect(path.join(platformsDir, 'ios')).not.toExist();
            //Tests finish before this command finishes resolving
            //return cordova.raw.platform('rm', 'android', {'fetch':true});
        })
        .then(function() {
            //expect(path.join(nodeModulesDir, 'cordova-android')).not.toExist();
            //expect(path.join(platformsDir, 'android')).not.toExist();
        })
        .fail(function(err) {
            console.error(err);
            expect(err).toBeUndefined();
        })
        .fin(done);
    }, 40000);
});

describe('plugin add and rm end-to-end --fetch', function () {

    var tmpDir = helpers.tmpDir('plugin_rm_fetch_test');
    var project = path.join(tmpDir, 'hello3');
    var pluginsDir = path.join(project, 'plugins');

    beforeEach(function() {
        process.chdir(tmpDir);
    });

    afterEach(function() {
        process.chdir(path.join(__dirname, '..'));  // Needed to rm the dir on Windows.
        shell.rm('-rf', tmpDir);
    });

    it('should remove dependency when removing parent plugin', function(done) {

        cordova.raw.create('hello3')
        .then(function() {
            process.chdir(project);
            return cordova.raw.platform('add', 'ios', {'fetch': true});
        })
        .then(function() {
            return cordova.raw.plugin('add', 'cordova-plugin-media', {'fetch': true});
        })
        .then(function() {
            expect(path.join(pluginsDir, 'cordova-plugin-media')).toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-file')).toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-compat')).toExist();
            expect(path.join(project, 'node_modules', 'cordova-plugin-media')).toExist();
            expect(path.join(project, 'node_modules', 'cordova-plugin-file')).toExist();
            expect(path.join(project, 'node_modules', 'cordova-plugin-compat')).toExist();
            return cordova.raw.platform('add', 'android', {'fetch':true});
        })
        .then(function() {
            expect(path.join(pluginsDir, 'cordova-plugin-media')).toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-file')).toExist();
            return cordova.raw.plugin('rm', 'cordova-plugin-media', {'fetch':true});
        })
        .then(function() {
            expect(path.join(pluginsDir, 'cordova-plugin-media')).not.toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-file')).not.toExist();
            expect(path.join(pluginsDir, 'cordova-plugin-compat')).not.toExist();
            //These don't work yet due to the tests finishing before the promise resolves.
            //expect(path.join(project, 'node_modules', 'cordova-plugin-media')).not.toExist();
            //expect(path.join(project, 'node_modules', 'cordova-plugin-file')).not.toExist();
            //expect(path.join(project, 'node_modules', 'cordova-plugin-compat')).not.toExist();
        })
        .fail(function(err) {
            console.error(err);
            expect(err).toBeUndefined();
        })
        .fin(done);
    }, 60000);
});

describe('cocoapod plugin add and rm end-to-end', function () {

    var tmpDir = helpers.tmpDir('cocoapod_plugin_test');
    var project = path.join(tmpDir, 'hello4');

    var samplePlugin = path.join(__dirname, 'fixtures', 'plugins', 'sample-cordova-plugin-cocoapod-dependent');
    var overlappingDependencyPlugin = path.join(__dirname, 'fixtures', 'plugins', 'sample-cocoapod-plugin-overlapping-dependency');
    var AFNetworking = 'AFNetworking',
        CWStatusBarNotification = 'CWStatusBarNotification';
    var podfile, podsJSON, workspace;

    beforeEach(function() {
        process.chdir(tmpDir);
    });

    afterEach(function() {
        process.chdir(path.join(__dirname, '..'));  // Needed to rm the dir on Windows.
        shell.rm('-rf', tmpDir);
    });

    it('installs and uninstalls plugin depending on new pod and existing pod', function(done) {

        cordova.raw.create('hello4')
        .then(function() {
            process.chdir(project);
            return cordova.raw.platform('add', 'https://git-wip-us.apache.org/repos/asf/cordova-ios.git');
        })
        .then(function() {
            return cordova.raw.plugin('add', samplePlugin);
        })
        .then(function() {
            podfile = path.resolve('./platforms/ios/Podfile');
            podsJSON = path.resolve('./platforms/ios/pods.json');
            workspace = path.resolve('./platforms/ios/HelloCordova.xcworkspace');

            //podfile should have been created
            fs.exists(podfile, function(podfileExists){
                expect(podfileExists);
            });

            //pods.json should have been created
            fs.exists(podsJSON, function(podsJSONExists){
                expect(podsJSONExists);
            });

            //workspace should have been created
            fs.exists(workspace, function(workspaceCreated){
                expect(workspaceCreated);
            });

            var podfileContent = fs.readFileSync(podfile, {'encoding' : 'utf8'});
            expect(podfileContent.indexOf(AFNetworking) !== -1 );

            var podsJSONContent = require(podsJSON);
            expect(podsJSONContent[AFNetworking] !== null);

            return cordova.raw.plugin('add', overlappingDependencyPlugin);
        })
        .then(function() {
            var podfileContent = fs.readFileSync(podfile, {'encoding' : 'utf8'}); 
            var numberOfTimesAFNetworkingIsInPodfile = podfileContent.match(/AFNetworking/g || []).length;

            expect(podfileContent.indexOf(CWStatusBarNotification) !== -1);
            expect(numberOfTimesAFNetworkingIsInPodfile).toEqual(1); 

            delete require.cache[require.resolve(podsJSON)];
            var podsJSONContent = require(podsJSON);
            var countPropertyOfAFNetworkingInPodsJSON = podsJSONContent[AFNetworking].count;
            var specPropertyOfAFNetworkingInPodsJSON = podsJSONContent[AFNetworking].spec;

            expect(countPropertyOfAFNetworkingInPodsJSON).toEqual(2);
            //spec property should not be changed because of overlapping dependency
            expect(specPropertyOfAFNetworkingInPodsJSON).toEqual('~> 3.0');

            return cordova.raw.plugin('rm','sample-cocoapod-plugin-overlapping-dependency');
        })
        .then(function() {
            //expect only AFNetworking
            var podfileContent = fs.readFileSync(podfile, {'encoding' : 'utf8'}); 

            expect(podfileContent.indexOf(CWStatusBarNotification) === -1);
            expect(podfileContent.indexOf(AFNetworking) !== -1);
  
            delete require.cache[require.resolve(podsJSON)];
            var podsJSONContent = require(podsJSON);

            expect(podsJSONContent[AFNetworking]);
            expect(podsJSONContent[CWStatusBarNotification] === undefined);

            return cordova.raw.plugin('rm', 'sample-cordova-plugin-cocoapod-dependent');
        })
        .then(function() {
            //expect no pods 
            delete require.cache[require.resolve(podfile)];
            var podfileContent = fs.readFileSync(podfile, {'encoding' : 'utf8'}); 

            expect(podfileContent.indexOf(CWStatusBarNotification) === -1);
            expect(podfileContent.indexOf(AFNetworking) === -1);

            delete require.cache[require.resolve(podsJSON)];
            var podsJSONContent = require(podsJSON);

            expect(podsJSONContent[AFNetworking] === undefined);
            expect(podsJSONContent[CWStatusBarNotification] === undefined);
        })
        .fail(function(err) {
            console.error(err);
            expect(err).toBeUndefined();
        })
        .fin(done);
    }, 60000); 
});