mirror of
https://github.com/apache/cordova-android.git
synced 2025-01-19 23:42:53 +08:00
373 lines
20 KiB
JavaScript
373 lines
20 KiB
JavaScript
/**
|
|
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 rewire = require('rewire');
|
|
var common = rewire('../../../bin/templates/cordova/lib/pluginHandlers');
|
|
var android = common.__get__('handlers');
|
|
var path = require('path');
|
|
var fs = require('fs');
|
|
var shell = require('shelljs');
|
|
var os = require('os');
|
|
var temp = path.join(os.tmpdir(), 'plugman');
|
|
var plugins_dir = path.join(temp, 'cordova/plugins');
|
|
var dummyplugin = path.join(__dirname, '../../fixtures/org.test.plugins.dummyplugin');
|
|
var faultyplugin = path.join(__dirname, '../../fixtures/org.test.plugins.faultyplugin');
|
|
var android_studio_project = path.join(__dirname, '../../fixtures/android_studio_project/*');
|
|
|
|
var PluginInfo = require('cordova-common').PluginInfo;
|
|
var AndroidProject = require('../../../bin/templates/cordova/lib/AndroidProject');
|
|
|
|
var dummyPluginInfo = new PluginInfo(dummyplugin);
|
|
var valid_source = dummyPluginInfo.getSourceFiles('android');
|
|
var valid_resources = dummyPluginInfo.getResourceFiles('android');
|
|
var valid_libs = dummyPluginInfo.getLibFiles('android');
|
|
|
|
var faultyPluginInfo = new PluginInfo(faultyplugin);
|
|
var invalid_source = faultyPluginInfo.getSourceFiles('android');
|
|
|
|
describe('android project handler', function () {
|
|
describe('installation', function () {
|
|
var copyFileOrig = common.__get__('copyFile');
|
|
var copyFileSpy = jasmine.createSpy('copyFile');
|
|
var dummyProject;
|
|
|
|
beforeEach(function () {
|
|
shell.mkdir('-p', temp);
|
|
dummyProject = AndroidProject.getProjectFile(temp);
|
|
copyFileSpy.calls.reset();
|
|
common.__set__('copyFile', copyFileSpy);
|
|
});
|
|
|
|
afterEach(function () {
|
|
shell.rm('-rf', temp);
|
|
common.__set__('copyFile', copyFileOrig);
|
|
});
|
|
|
|
describe('of <lib-file> elements', function () {
|
|
it('Test#001 : should copy files for Android Studio projects', function () {
|
|
android['lib-file'].install(valid_libs[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
expect(copyFileSpy).toHaveBeenCalledWith(dummyplugin, 'src/android/TestLib.jar', temp, path.join('app', 'libs', 'TestLib.jar'), false);
|
|
});
|
|
});
|
|
|
|
describe('of <resource-file> elements', function () {
|
|
it('Test#002 : should copy files to the correct location on an Android Studio project', function () {
|
|
android['resource-file'].install(valid_resources[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
expect(copyFileSpy).toHaveBeenCalledWith(dummyplugin, 'android-resource.xml', temp, path.join('app', 'src', 'main', 'res', 'xml', 'dummy.xml'), false);
|
|
});
|
|
});
|
|
|
|
describe('of <source-file> elements', function () {
|
|
beforeEach(function () {
|
|
shell.cp('-rf', android_studio_project, temp);
|
|
});
|
|
|
|
it('Test#003 : should copy stuff from one location to another by calling common.copyFile', function () {
|
|
android['source-file'].install(valid_source[0], dummyPluginInfo, dummyProject);
|
|
expect(copyFileSpy)
|
|
.toHaveBeenCalledWith(dummyplugin, 'src/android/DummyPlugin.java', temp, path.join('src/com/phonegap/plugins/dummyplugin/DummyPlugin.java'), false);
|
|
});
|
|
|
|
it('Test#004 : should install source files to the right location for Android Studio projects', function () {
|
|
android['source-file'].install(valid_source[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
expect(copyFileSpy)
|
|
.toHaveBeenCalledWith(dummyplugin, 'src/android/DummyPlugin.java', temp, path.join('app/src/main/java/com/phonegap/plugins/dummyplugin/DummyPlugin.java'), false);
|
|
});
|
|
|
|
it('Test#005 : should throw if source file cannot be found', function () {
|
|
common.__set__('copyFile', copyFileOrig);
|
|
expect(function () {
|
|
android['source-file'].install(invalid_source[0], faultyPluginInfo, dummyProject);
|
|
}).toThrow(new Error('"' + path.resolve(faultyplugin, 'src/android/NotHere.java') + '" not found!'));
|
|
});
|
|
|
|
it('Test#006 : should throw if target file already exists', function () {
|
|
// write out a file
|
|
var target = path.resolve(temp, 'src/com/phonegap/plugins/dummyplugin');
|
|
shell.mkdir('-p', target);
|
|
target = path.join(target, 'DummyPlugin.java');
|
|
fs.writeFileSync(target, 'some bs', 'utf-8');
|
|
|
|
expect(function () {
|
|
android['source-file'].install(valid_source[0], dummyPluginInfo, dummyProject);
|
|
}).toThrow(new Error('"' + target + '" already exists!'));
|
|
});
|
|
});
|
|
|
|
describe('of <framework> elements', function () {
|
|
|
|
var someString = jasmine.any(String);
|
|
|
|
var copyNewFileOrig = common.__get__('copyNewFile');
|
|
var copyNewFileSpy = jasmine.createSpy('copyNewFile');
|
|
|
|
beforeEach(function () {
|
|
shell.cp('-rf', android_studio_project, temp);
|
|
|
|
spyOn(dummyProject, 'addSystemLibrary');
|
|
spyOn(dummyProject, 'addSubProject');
|
|
spyOn(dummyProject, 'addGradleReference');
|
|
common.__set__('copyNewFile', copyNewFileSpy);
|
|
});
|
|
|
|
afterEach(function () {
|
|
common.__set__('copyNewFile', copyNewFileOrig);
|
|
});
|
|
|
|
it('Test#007 : should throw if framework doesn\'t have "src" attribute', function () {
|
|
expect(function () { android.framework.install({}, dummyPluginInfo, dummyProject); }).toThrow();
|
|
});
|
|
|
|
it('Test#008 : should install framework without "parent" attribute into project root', function () {
|
|
var framework = {src: 'plugin-lib'};
|
|
android.framework.install(framework, dummyPluginInfo, dummyProject);
|
|
expect(dummyProject.addSystemLibrary).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
});
|
|
|
|
it('Test#009 : should install framework with "parent" attribute into parent framework dir', function () {
|
|
var childFramework = {src: 'plugin-lib2', parent: 'plugin-lib'};
|
|
android.framework.install(childFramework, dummyPluginInfo, dummyProject);
|
|
expect(dummyProject.addSystemLibrary).toHaveBeenCalledWith(path.resolve(dummyProject.projectDir, childFramework.parent), someString);
|
|
});
|
|
|
|
it('Test#010 : should not copy anything if "custom" attribute is not set', function () {
|
|
var framework = {src: 'plugin-lib'};
|
|
var cpSpy = spyOn(shell, 'cp');
|
|
android.framework.install(framework, dummyPluginInfo, dummyProject);
|
|
expect(dummyProject.addSystemLibrary).toHaveBeenCalledWith(someString, framework.src);
|
|
expect(cpSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('Test#011 : should copy framework sources if "custom" attribute is set', function () {
|
|
var framework = {src: 'plugin-lib', custom: true};
|
|
android.framework.install(framework, dummyPluginInfo, dummyProject);
|
|
expect(dummyProject.addSubProject).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
expect(copyNewFileSpy).toHaveBeenCalledWith(dummyPluginInfo.dir, framework.src, dummyProject.projectDir, someString, false);
|
|
});
|
|
|
|
it('Test#012 : should install gradleReference using project.addGradleReference', function () {
|
|
var framework = {src: 'plugin-lib', custom: true, type: 'gradleReference'};
|
|
android.framework.install(framework, dummyPluginInfo, dummyProject);
|
|
expect(copyNewFileSpy).toHaveBeenCalledWith(dummyPluginInfo.dir, framework.src, dummyProject.projectDir, someString, false);
|
|
expect(dummyProject.addGradleReference).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
});
|
|
});
|
|
|
|
describe('of <js-module> elements', function () {
|
|
var jsModule = {src: 'www/dummyplugin.js'};
|
|
var wwwDest, platformWwwDest;
|
|
|
|
beforeEach(function () {
|
|
spyOn(fs, 'writeFileSync');
|
|
wwwDest = path.resolve(dummyProject.www, 'plugins', dummyPluginInfo.id, jsModule.src);
|
|
platformWwwDest = path.resolve(dummyProject.platformWww, 'plugins', dummyPluginInfo.id, jsModule.src);
|
|
});
|
|
|
|
it('Test#013 : should put module to both www and platform_www when options.usePlatformWww flag is specified', function () {
|
|
android['js-module'].install(jsModule, dummyPluginInfo, dummyProject, {usePlatformWww: true});
|
|
expect(fs.writeFileSync).toHaveBeenCalledWith(wwwDest, jasmine.any(String), 'utf-8');
|
|
expect(fs.writeFileSync).toHaveBeenCalledWith(platformWwwDest, jasmine.any(String), 'utf-8');
|
|
});
|
|
|
|
it('Test#014 : should put module to www only when options.usePlatformWww flag is not specified', function () {
|
|
android['js-module'].install(jsModule, dummyPluginInfo, dummyProject);
|
|
expect(fs.writeFileSync).toHaveBeenCalledWith(wwwDest, jasmine.any(String), 'utf-8');
|
|
expect(fs.writeFileSync).not.toHaveBeenCalledWith(platformWwwDest, jasmine.any(String), 'utf-8');
|
|
});
|
|
});
|
|
|
|
describe('of <asset> elements', function () {
|
|
var asset = {src: 'www/dummyPlugin.js', target: 'foo/dummy.js'};
|
|
var wwwDest; /* eslint no-unused-vars: "off" */
|
|
var platformWwwDest; /* eslint no-unused-vars: "off" */
|
|
|
|
beforeEach(function () {
|
|
wwwDest = path.resolve(dummyProject.www, asset.target);
|
|
platformWwwDest = path.resolve(dummyProject.platformWww, asset.target);
|
|
});
|
|
|
|
it('Test#015 : should put asset to both www and platform_www when options.usePlatformWww flag is specified', function () {
|
|
android.asset.install(asset, dummyPluginInfo, dummyProject, {usePlatformWww: true});
|
|
expect(copyFileSpy).toHaveBeenCalledWith(dummyPluginInfo.dir, asset.src, dummyProject.www, asset.target);
|
|
expect(copyFileSpy).toHaveBeenCalledWith(dummyPluginInfo.dir, asset.src, dummyProject.platformWww, asset.target);
|
|
});
|
|
|
|
it('Test#016 : should put asset to www only when options.usePlatformWww flag is not specified', function () {
|
|
android.asset.install(asset, dummyPluginInfo, dummyProject);
|
|
expect(copyFileSpy).toHaveBeenCalledWith(dummyPluginInfo.dir, asset.src, dummyProject.www, asset.target);
|
|
expect(copyFileSpy).not.toHaveBeenCalledWith(dummyPluginInfo.dir, asset.src, dummyProject.platformWww, asset.target);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('uninstallation', function () {
|
|
|
|
var removeFileOrig = common.__get__('removeFile');
|
|
var deleteJavaOrig = common.__get__('deleteJava');
|
|
|
|
var removeFileSpy = jasmine.createSpy('removeFile');
|
|
var deleteJavaSpy = jasmine.createSpy('deleteJava');
|
|
var dummyProject;
|
|
|
|
beforeEach(function () {
|
|
shell.mkdir('-p', temp);
|
|
shell.mkdir('-p', plugins_dir);
|
|
shell.cp('-rf', android_studio_project, temp);
|
|
AndroidProject.purgeCache();
|
|
dummyProject = AndroidProject.getProjectFile(temp);
|
|
common.__set__('removeFile', removeFileSpy);
|
|
common.__set__('deleteJava', deleteJavaSpy);
|
|
});
|
|
|
|
afterEach(function () {
|
|
shell.rm('-rf', temp);
|
|
common.__set__('removeFile', removeFileOrig);
|
|
common.__set__('deleteJava', deleteJavaOrig);
|
|
});
|
|
|
|
describe('of <lib-file> elements', function () {
|
|
it('Test#017 : should remove jar files for Android Studio projects', function () {
|
|
android['lib-file'].install(valid_libs[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
android['lib-file'].uninstall(valid_libs[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
expect(removeFileSpy).toHaveBeenCalledWith(temp, path.join('app/libs/TestLib.jar'));
|
|
});
|
|
});
|
|
|
|
describe('of <resource-file> elements', function () {
|
|
it('Test#018 : should remove files for Android Studio projects', function () {
|
|
android['resource-file'].install(valid_resources[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
android['resource-file'].uninstall(valid_resources[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
expect(removeFileSpy).toHaveBeenCalledWith(temp, path.join('app/src/main/res/xml/dummy.xml'));
|
|
});
|
|
});
|
|
|
|
describe('of <source-file> elements', function () {
|
|
it('Test#019 : should remove stuff by calling common.deleteJava for Android Studio projects', function () {
|
|
android['source-file'].install(valid_source[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
android['source-file'].uninstall(valid_source[0], dummyPluginInfo, dummyProject, {android_studio: true});
|
|
expect(deleteJavaSpy).toHaveBeenCalledWith(temp, path.join('app/src/main/java/com/phonegap/plugins/dummyplugin/DummyPlugin.java'));
|
|
});
|
|
});
|
|
|
|
describe('of <framework> elements', function () {
|
|
|
|
var someString = jasmine.any(String);
|
|
|
|
beforeEach(function () {
|
|
shell.mkdir(path.join(dummyProject.projectDir, dummyPluginInfo.id));
|
|
|
|
spyOn(dummyProject, 'removeSystemLibrary');
|
|
spyOn(dummyProject, 'removeSubProject');
|
|
spyOn(dummyProject, 'removeGradleReference');
|
|
});
|
|
|
|
it('Test#020 : should throw if framework doesn\'t have "src" attribute', function () {
|
|
expect(function () { android.framework.uninstall({}, dummyPluginInfo, dummyProject); }).toThrow();
|
|
});
|
|
|
|
it('Test#021 : should uninstall framework without "parent" attribute into project root', function () {
|
|
var framework = {src: 'plugin-lib'};
|
|
android.framework.uninstall(framework, dummyPluginInfo, dummyProject);
|
|
expect(dummyProject.removeSystemLibrary).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
});
|
|
|
|
it('Test#022 : should uninstall framework with "parent" attribute into parent framework dir', function () {
|
|
var childFramework = {src: 'plugin-lib2', parent: 'plugin-lib'};
|
|
android.framework.uninstall(childFramework, dummyPluginInfo, dummyProject);
|
|
expect(dummyProject.removeSystemLibrary).toHaveBeenCalledWith(path.resolve(dummyProject.projectDir, childFramework.parent), someString);
|
|
});
|
|
|
|
it('Test#023 : should remove framework sources if "custom" attribute is set', function () {
|
|
var framework = {src: 'plugin-lib', custom: true};
|
|
android.framework.uninstall(framework, dummyPluginInfo, dummyProject);
|
|
expect(dummyProject.removeSubProject).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
expect(removeFileSpy).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
});
|
|
|
|
it('Test#24 : should install gradleReference using project.removeGradleReference', function () {
|
|
var framework = {src: 'plugin-lib', custom: true, type: 'gradleReference'};
|
|
android.framework.uninstall(framework, dummyPluginInfo, dummyProject);
|
|
expect(removeFileSpy).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
expect(dummyProject.removeGradleReference).toHaveBeenCalledWith(dummyProject.projectDir, someString);
|
|
});
|
|
});
|
|
|
|
describe('of <js-module> elements', function () {
|
|
var jsModule = {src: 'www/dummyPlugin.js'};
|
|
var wwwDest;
|
|
var platformWwwDest;
|
|
|
|
beforeEach(function () {
|
|
wwwDest = path.resolve(dummyProject.www, 'plugins', dummyPluginInfo.id, jsModule.src);
|
|
platformWwwDest = path.resolve(dummyProject.platformWww, 'plugins', dummyPluginInfo.id, jsModule.src);
|
|
|
|
spyOn(shell, 'rm');
|
|
|
|
var existsSyncOrig = fs.existsSync;
|
|
spyOn(fs, 'existsSync').and.callFake(function (file) {
|
|
if ([wwwDest, platformWwwDest].indexOf(file) >= 0) return true;
|
|
return existsSyncOrig.call(fs, file);
|
|
});
|
|
});
|
|
|
|
it('Test#025 : should put module to both www and platform_www when options.usePlatformWww flag is specified', function () {
|
|
android['js-module'].uninstall(jsModule, dummyPluginInfo, dummyProject, {usePlatformWww: true});
|
|
expect(shell.rm).toHaveBeenCalledWith('-Rf', wwwDest);
|
|
expect(shell.rm).toHaveBeenCalledWith('-Rf', platformWwwDest);
|
|
});
|
|
|
|
it('Test#026 : should put module to www only when options.usePlatformWww flag is not specified', function () {
|
|
android['js-module'].uninstall(jsModule, dummyPluginInfo, dummyProject);
|
|
expect(shell.rm).toHaveBeenCalledWith('-Rf', wwwDest);
|
|
expect(shell.rm).not.toHaveBeenCalledWith('-Rf', platformWwwDest);
|
|
});
|
|
});
|
|
|
|
describe('of <asset> elements', function () {
|
|
var asset = {src: 'www/dummyPlugin.js', target: 'foo/dummy.js'};
|
|
var wwwDest, platformWwwDest;
|
|
|
|
beforeEach(function () {
|
|
wwwDest = path.resolve(dummyProject.www, asset.target);
|
|
platformWwwDest = path.resolve(dummyProject.platformWww, asset.target);
|
|
|
|
spyOn(shell, 'rm');
|
|
|
|
var existsSyncOrig = fs.existsSync;
|
|
spyOn(fs, 'existsSync').and.callFake(function (file) {
|
|
if ([wwwDest, platformWwwDest].indexOf(file) >= 0) return true;
|
|
return existsSyncOrig.call(fs, file);
|
|
});
|
|
});
|
|
|
|
it('Test#027 : should put module to both www and platform_www when options.usePlatformWww flag is specified', function () {
|
|
android.asset.uninstall(asset, dummyPluginInfo, dummyProject, {usePlatformWww: true});
|
|
expect(shell.rm).toHaveBeenCalledWith(jasmine.any(String), wwwDest);
|
|
expect(shell.rm).toHaveBeenCalledWith(jasmine.any(String), platformWwwDest);
|
|
});
|
|
|
|
it('Test#028 : should put module to www only when options.usePlatformWww flag is not specified', function () {
|
|
android.asset.uninstall(asset, dummyPluginInfo, dummyProject);
|
|
expect(shell.rm).toHaveBeenCalledWith(jasmine.any(String), wwwDest);
|
|
expect(shell.rm).not.toHaveBeenCalledWith(jasmine.any(String), platformWwwDest);
|
|
});
|
|
});
|
|
});
|
|
});
|