spec/cordova-cli/prepare.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 cordova = require('../../cordova'),
    et = require('elementtree'),
    shell = require('shelljs'),
    plugman = require('plugman'),
    path = require('path'),
    fs = require('fs'),
    config_parser = require('../../src/config_parser'),
    android_parser = require('../../src/metadata/android_parser'),
    hooker = require('../../src/hooker'),
    fixtures = path.join(__dirname, '..', 'fixtures'),
    test_plugin = path.join(fixtures, 'plugins', 'android'),
    hooks = path.join(fixtures, 'hooks'),
    tempDir = path.join(__dirname, '..', '..', 'temp'),
    cordova_project = path.join(fixtures, 'projects', 'cordova');

var cwd = process.cwd();

describe('prepare command', function() {
    beforeEach(function() {
        shell.rm('-rf', tempDir);
        cordova.create(tempDir);
    });

    it('should not run inside a Cordova-based project with no added platforms', function() {
        this.after(function() {
            process.chdir(cwd);
        });

        process.chdir(tempDir);
        expect(function() {
            cordova.prepare();
        }).toThrow();
    });
    
    it('should run inside a Cordova-based project with at least one added platform', function() {
        // move platform project fixtures over to fake cordova into thinking platforms were added
        // TODO: possibly add this to helper?
        this.after(function() {
            process.chdir(cwd);
        });

        spyOn(shell, 'exec');
        expect(function() {
            shell.cp('-Rf', path.join(cordova_project, 'platforms', 'android'), path.join(tempDir, 'platforms'));
            process.chdir(tempDir);
            var a_parser_spy = spyOn(android_parser.prototype, 'update_project');
            cordova.prepare();
            expect(a_parser_spy).toHaveBeenCalled();
        }).not.toThrow();
    });
    it('should not run outside of a Cordova-based project', function() {
        this.after(function() {
            process.chdir(cwd);
        });

        shell.mkdir('-p', tempDir);
        process.chdir(tempDir);

        expect(function() {
            cordova.prepare();
        }).toThrow();
    });

    describe('plugman integration', function() {
        beforeEach(function() {
            shell.cp('-Rf', path.join(cordova_project, 'platforms', 'android'), path.join(tempDir, 'platforms'));
            process.chdir(tempDir);
        });
        afterEach(function() {
            process.chdir(cwd);
        });

        it('should invoke plugman.prepare after update_project', function() {
            var a_parser_spy = spyOn(android_parser.prototype, 'update_project');
            var prep_spy = spyOn(plugman, 'prepare');
            cordova.prepare();
            a_parser_spy.mostRecentCall.args[1](); // fake out android_parser
            var android_path = path.join(tempDir, 'platforms', 'android');
            var plugins_dir = path.join(tempDir, 'plugins');
            expect(prep_spy).toHaveBeenCalledWith(android_path, 'android', plugins_dir);
        });
        it('should invoke add_plugin_changes for any added plugins to verify configuration changes for plugins are in place', function() {
            var platform_path  = path.join(tempDir, 'platforms', 'android');
            var plugins_dir = path.join(tempDir, 'plugins');
            plugman.install('android', platform_path, test_plugin, plugins_dir, {});
            var a_parser_spy = spyOn(android_parser.prototype, 'update_project');
            var prep_spy = spyOn(plugman, 'prepare');
            var plugin_changes_spy = spyOn(plugman.config_changes, 'add_plugin_changes');
            cordova.prepare();
            a_parser_spy.mostRecentCall.args[1](); // fake out android_parser
            expect(plugin_changes_spy).toHaveBeenCalledWith('android', platform_path, plugins_dir, 'ca.filmaj.AndroidPlugin', {PACKAGE_NAME:"org.apache.cordova.cordovaExample"}, true, false); 
        });
    });

    describe('hooks', function() {
        var s;
        beforeEach(function() {
            s = spyOn(hooker.prototype, 'fire').andReturn(true);
        });

        describe('when platforms are added', function() {
            beforeEach(function() {
                shell.cp('-rf', path.join(cordova_project, 'platforms', 'android'), path.join(tempDir, 'platforms'));
                process.chdir(tempDir);
            });
            afterEach(function() {
                shell.rm('-rf', path.join(tempDir, 'platforms', 'android'));
                process.chdir(cwd);
            });

            it('should fire before hooks through the hooker module', function() {
                cordova.prepare();
                expect(s).toHaveBeenCalledWith('before_prepare', jasmine.any(Function));
            });
            it('should fire after hooks through the hooker module', function() {
                spyOn(shell, 'exec');
                cordova.prepare('android', function() {
                     expect(hooker.prototype.fire).toHaveBeenCalledWith('after_prepare');
                });
            });
        });

        describe('with no platforms added', function() {
            beforeEach(function() {
                shell.rm('-rf', tempDir);
                cordova.create(tempDir);
                process.chdir(tempDir);
            });
            afterEach(function() {
                process.chdir(cwd);
            });
            it('should not fire the hooker', function() {
                expect(function() {
                    cordova.prepare();
                }).toThrow();
                expect(s).not.toHaveBeenCalledWith('before_prepare');
                expect(s).not.toHaveBeenCalledWith('after_prepare');
            });
        });
    });
});