spec/plugin.spec.js

var cordova = require('../cordova'),
    path = require('path'),
    shell = require('shelljs'),
    fs = require('fs'),
    hooker = require('../src/hooker'),
    tempDir = path.join(__dirname, '..', 'temp'),
    fixturesDir = path.join(__dirname, 'fixtures'),
    testPlugin = path.join(fixturesDir, 'plugins', 'test'),
    androidPlugin = path.join(fixturesDir, 'plugins', 'android');

var cwd = process.cwd();

describe('plugin command', function() {
    beforeEach(function() {
        // Make a temp directory
        shell.rm('-rf', tempDir);
        shell.mkdir('-p', tempDir);
    });

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

        cordova.create(tempDir);

        process.chdir(tempDir);

        expect(function() {
            cordova.plugin();
        }).not.toThrow();
    });
    it('should not run outside of a Cordova-based project', function() {
        this.after(function() {
            process.chdir(cwd);
        });

        process.chdir(tempDir);

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

    var listing_tests = function(_invocation) {
        return function() {
            beforeEach(function() {
                cordova.create(tempDir);
            });

            afterEach(function() {
                process.chdir(cwd);
            });

            it('should list out no plugins for a fresh project', function() {
                process.chdir(tempDir);

                expect(cordova.plugin(_invocation)).toEqual('No plugins added. Use `cordova plugin add <plugin>`.');
            });
        };
    };
    describe('`ls`', listing_tests('ls'));
    describe('`list`', listing_tests('list'));

    describe('`add`', function() {
        beforeEach(function() {
            cordova.create(tempDir);
            process.chdir(tempDir);
        });

        afterEach(function() {
            process.chdir(cwd);
        });
        describe('failure', function() {
            it('should throw if your app has no platforms added', function() {
                expect(function() {
                    cordova.plugin('add', testPlugin);
                }).toThrow('You need at least one platform added to your app. Use `cordova platform add <platform>`.');
            });
            it('should throw if plugin does not support any app platforms', function() {
                var cb = jasmine.createSpy();
                runs(function() {
                    cordova.platform('add', 'ios', cb);
                });
                waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                runs(function() {
                    expect(function() {
                        cordova.plugin('add', androidPlugin);
                    }).toThrow('Plugin "android" does not support any of your application\'s platforms. Plugin platforms: android; your application\'s platforms: ios');
                });
            });
            it('should throw if plugin is already added to project', function() {
                var cb = jasmine.createSpy();
                var pluginCb = jasmine.createSpy();
                runs(function() {
                    cordova.platform('add', 'ios', cb);
                });
                waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                runs(function() {
                    cordova.plugin('add', testPlugin, pluginCb);
                });
                waitsFor(function() { return pluginCb.wasCalled; }, 'test plugin add');
                runs(function() {
                    expect(function() {
                        cordova.plugin('add', testPlugin, pluginCb);
                    }).toThrow('Plugin "test" already added to project.');
                });
            });
            it('should throw if plugin does not have a plugin.xml', function() {
                var cb = jasmine.createSpy();
                runs(function() {
                    cordova.platform('add', 'ios', cb);
                });
                waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                runs(function() {
                    expect(function() {
                        cordova.plugin('add', fixturesDir);
                    }).toThrow('Plugin "fixtures" does not have a plugin.xml in the root. Plugin must support the Cordova Plugin Specification: https://github.com/alunny/cordova-plugin-spec');
                });
            });
        });
        describe('success', function() {
            it('should add plugin www assets to project www folder', function() {
                var cb = jasmine.createSpy();
                var pluginCb = jasmine.createSpy();
                runs(function() {
                    cordova.platform('add', 'ios', cb);
                });
                waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                runs(function() {
                    cordova.plugin('add', testPlugin, pluginCb);
                });
                waitsFor(function() { return pluginCb.wasCalled; }, 'test plugin add');
                runs(function() {
                    expect(fs.existsSync(path.join(tempDir, 'www', 'test.js'))).toBe(true);
                });
            });
            it('should add the full plugin to the plugins directory', function() {
                var cb = jasmine.createSpy();
                var pluginCb = jasmine.createSpy();
                runs(function() {
                    cordova.platform('add', 'ios', cb);
                });
                waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                runs(function() {
                    cordova.plugin('add', testPlugin, pluginCb);
                });
                waitsFor(function() { return pluginCb.wasCalled; }, 'test plugin add');
                runs(function() {
                    expect(fs.existsSync(path.join(tempDir, 'plugins', 'test'))).toBe(true);
                });
            });
            it('should be able to handle adding multiple plugins', function() {
                cordova.platform('add', 'android');
                var cb = jasmine.createSpy();
                runs(function() {
                    cordova.plugin('add', [testPlugin, androidPlugin], cb);
                });
                waitsFor(function() { return cb.wasCalled; }, 'test+android plugin add');
                runs(function() {
                    expect(fs.existsSync(path.join(tempDir, 'plugins', 'test'))).toBe(true);
                    expect(fs.existsSync(path.join(tempDir, 'plugins', 'android'))).toBe(true);
                });
            });
        });
    });

    var removing_tests = function(_invocation) {
        return function() {
            beforeEach(function() {
                cordova.create(tempDir);
                process.chdir(tempDir);
            });

            afterEach(function() {
                process.chdir(cwd);
            });
            describe('failure', function() {
                it('should throw if your app has no platforms added', function() {
                    expect(function() {
                        cordova.plugin(_invocation, testPlugin);
                    }).toThrow('You need at least one platform added to your app. Use `cordova platform add <platform>`.');
                });
                it('should throw if plugin is not added to project', function() {
                    var cb = jasmine.createSpy();
                    runs(function() {
                        cordova.platform('add', 'ios', cb);
                    });
                    waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                    runs(function() {
                        expect(function() {
                            cordova.plugin(_invocation, 'test', function() {});
                        }).toThrow('Plugin "test" not added to project.');
                    });
                });
            });
            describe('success', function() {
                it('should remove plugin www assets from project www folder', function() {
                    var cb = jasmine.createSpy();
                    var pluginCb = jasmine.createSpy();
                    var removeCb = jasmine.createSpy();
                    runs(function() {
                        cordova.platform('add', 'ios', cb);
                    });
                    waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                    runs(function() {
                        cordova.plugin('add', testPlugin, pluginCb);
                    });
                    waitsFor(function() { return pluginCb.wasCalled; }, 'test plugin add');
                    runs(function() {
                        cordova.plugin(_invocation, 'test', removeCb);
                    });
                    waitsFor(function() { return removeCb.wasCalled; }, 'test plugin remove');
                    runs(function() {
                        expect(fs.existsSync(path.join(tempDir, 'www', 'test.js'))).toBe(false);
                    });
                });
                it('should remove the full plugin from the plugins directory', function() {
                    var cb = jasmine.createSpy();
                    var pluginCb = jasmine.createSpy();
                    var removeCb = jasmine.createSpy();
                    runs(function() {
                        cordova.platform('add', 'ios', cb);
                    });
                    waitsFor(function() { return cb.wasCalled; }, 'ios platform add');
                    runs(function() {
                        cordova.plugin('add', testPlugin, pluginCb);
                    });
                    waitsFor(function() { return pluginCb.wasCalled; }, 'test plugin add');
                    runs(function() {
                        cordova.plugin(_invocation, 'test', removeCb);
                    });
                    waitsFor(function() { return removeCb.wasCalled; }, 'test plugin remove');
                    runs(function() {
                        expect(fs.existsSync(path.join(tempDir, 'plugins', 'test'))).toBe(false);
                    });
                });
                it('should be able to handle removing multiple plugins', function() {
                    cordova.platform('add', 'android');
                    var cb = jasmine.createSpy();
                    var cbtwo = jasmine.createSpy();
                    runs(function() {
                        cordova.plugin('add', [testPlugin, androidPlugin], cb);
                    });
                    waitsFor(function() { return cb.wasCalled; }, 'test+android plugin add');
                    runs(function() {
                        cordova.plugin(_invocation, [testPlugin, androidPlugin], cbtwo);
                    });
                    waitsFor(function() { return cbtwo.wasCalled; }, 'test+android plugin rm');
                    runs(function() {
                        expect(fs.existsSync(path.join(tempDir, 'plugins', 'test'))).toBe(false);
                        expect(fs.existsSync(path.join(tempDir, 'plugins', 'android'))).toBe(false);
                    });
                });
            });
        };
    };
    describe('`rm`', removing_tests('rm'));
    describe('`remove`', removing_tests('remove'));

    describe('hooks', function() {
        var s;
        beforeEach(function() {
            cordova.create(tempDir);
            process.chdir(tempDir);
            s = spyOn(hooker.prototype, 'fire').andReturn(true);
        });
        afterEach(function() {
            process.chdir(cwd);
            shell.rm('-rf', tempDir);
        });

        describe('list (ls) hooks', function() {
            it('should fire before hooks through the hooker module', function() {
                cordova.plugin();
                expect(s).toHaveBeenCalledWith('before_plugin_ls');
            });
            it('should fire after hooks through the hooker module', function() {
                cordova.plugin();
                expect(s).toHaveBeenCalledWith('after_plugin_ls');
            });
        });
        describe('remove (rm) hooks', function() {
            beforeEach(function() {
                cordova.platform('add', 'android');
                spyOn(shell, 'exec').andReturn({code:0}); // fake call to pluginstall
                cordova.plugin('add', androidPlugin);
                s.reset();
            });
            it('should fire before hooks through the hooker module', function() {
                cordova.plugin('rm', 'android');
                expect(s).toHaveBeenCalledWith('before_plugin_rm');
            });
            it('should fire after hooks through the hooker module', function() {
                cordova.plugin('rm', 'android');
                expect(s).toHaveBeenCalledWith('after_plugin_rm');
            });
        });
        describe('add hooks', function() {
            beforeEach(function() {
                cordova.platform('add', 'android');
                spyOn(shell, 'exec').andReturn({code:0}); // fake call to pluginstall
            });
            it('should fire before hooks through the hooker module', function() {
                cordova.plugin('add', androidPlugin);
                expect(s).toHaveBeenCalledWith('before_plugin_add');
            });
            it('should fire after hooks through the hooker module', function() {
                cordova.plugin('add', androidPlugin);
                expect(s).toHaveBeenCalledWith('after_plugin_add');
            });
        });
    });
});