From e32bcd88aaf760e5b0191a48c9a704b5b54ddfcc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julio=20C=C3=A9sar?= Date: Wed, 18 Apr 2018 13:16:54 +0200 Subject: [PATCH] CB-14038 (android): fix false positive detecting project type --- bin/templates/cordova/lib/AndroidStudio.js | 33 +------ .../android_project/AndroidManifest.xml | 69 --------------- .../android_project/assets/www/.gitkeep | 0 .../android_project/res/xml/config.xml | 54 ------------ spec/fixtures/android_project/src/.gitkeep | 0 spec/unit/AndroidProject.spec.js | 31 ------- spec/unit/AndroidStudio.spec.js | 5 -- spec/unit/pluginHandlers/handlers.spec.js | 87 ++++++++----------- 8 files changed, 35 insertions(+), 244 deletions(-) delete mode 100644 spec/fixtures/android_project/AndroidManifest.xml delete mode 100644 spec/fixtures/android_project/assets/www/.gitkeep delete mode 100644 spec/fixtures/android_project/res/xml/config.xml delete mode 100644 spec/fixtures/android_project/src/.gitkeep delete mode 100644 spec/unit/AndroidProject.spec.js diff --git a/bin/templates/cordova/lib/AndroidStudio.js b/bin/templates/cordova/lib/AndroidStudio.js index fbcb926f..68d4d8f6 100644 --- a/bin/templates/cordova/lib/AndroidStudio.js +++ b/bin/templates/cordova/lib/AndroidStudio.js @@ -6,37 +6,6 @@ /* jshint esnext: false */ -var path = require('path'); -var fs = require('fs'); -var CordovaError = require('cordova-common').CordovaError; - module.exports.isAndroidStudioProject = function isAndroidStudioProject (root) { - var eclipseFiles = ['AndroidManifest.xml', 'libs', 'res']; - var androidStudioFiles = ['app', 'app/src/main']; - - // assume it is an AS project and not an Eclipse project - var isEclipse = false; - var isAS = true; - - if (!fs.existsSync(root)) { - throw new CordovaError('AndroidStudio.js:inAndroidStudioProject root does not exist: ' + root); - } - - // if any of the following exists, then we are not an ASProj - eclipseFiles.forEach(function (file) { - if (fs.existsSync(path.join(root, file))) { - isEclipse = true; - } - }); - - // if it is NOT an eclipse project, check that all required files exist - if (!isEclipse) { - androidStudioFiles.forEach(function (file) { - if (!fs.existsSync(path.join(root, file))) { - console.log('missing file :: ' + file); - isAS = false; - } - }); - } - return (!isEclipse && isAS); + return true; }; diff --git a/spec/fixtures/android_project/AndroidManifest.xml b/spec/fixtures/android_project/AndroidManifest.xml deleted file mode 100644 index 17489caf..00000000 --- a/spec/fixtures/android_project/AndroidManifest.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/spec/fixtures/android_project/assets/www/.gitkeep b/spec/fixtures/android_project/assets/www/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/spec/fixtures/android_project/res/xml/config.xml b/spec/fixtures/android_project/res/xml/config.xml deleted file mode 100644 index 4f087a9d..00000000 --- a/spec/fixtures/android_project/res/xml/config.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/spec/fixtures/android_project/src/.gitkeep b/spec/fixtures/android_project/src/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/spec/unit/AndroidProject.spec.js b/spec/unit/AndroidProject.spec.js deleted file mode 100644 index 755c6f35..00000000 --- a/spec/unit/AndroidProject.spec.js +++ /dev/null @@ -1,31 +0,0 @@ -/** - 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 path = require('path'); -var AndroidProject = require('../../bin/templates/cordova/lib/AndroidProject'); -var android_project = path.join(__dirname, '../fixtures/android_project'); - -describe('AndroidProject class', function () { - describe('getPackageName method', function () { - it('Test#001 : should return an android project\'s proper package name', function () { - expect(AndroidProject.getProjectFile(android_project).getPackageName()) - .toEqual('com.alunny.childapp'); - }); - }); -}); diff --git a/spec/unit/AndroidStudio.spec.js b/spec/unit/AndroidStudio.spec.js index 4db74d6a..11d46752 100644 --- a/spec/unit/AndroidStudio.spec.js +++ b/spec/unit/AndroidStudio.spec.js @@ -8,9 +8,4 @@ describe('AndroidStudio module', function () { var isAndStud = AndroidStudio.isAndroidStudioProject(root); expect(isAndStud).toBe(true); }); - it('should return false non Android Studio project', function () { - var root = path.join(__dirname, '../fixtures/android_project/'); - var isAndStud = AndroidStudio.isAndroidStudioProject(root); - expect(isAndStud).toBe(false); - }); }); diff --git a/spec/unit/pluginHandlers/handlers.spec.js b/spec/unit/pluginHandlers/handlers.spec.js index dae57a91..edc8f43b 100644 --- a/spec/unit/pluginHandlers/handlers.spec.js +++ b/spec/unit/pluginHandlers/handlers.spec.js @@ -28,7 +28,7 @@ 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_project = path.join(__dirname, '../../fixtures/android_project/*'); +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'); @@ -60,48 +60,44 @@ describe('android project handler', function () { }); describe('of elements', function () { - it('Test#001 : should copy files', function () { - android['lib-file'].install(valid_libs[0], dummyPluginInfo, dummyProject); - expect(copyFileSpy).toHaveBeenCalledWith(dummyplugin, 'src/android/TestLib.jar', temp, path.join('libs', 'TestLib.jar'), false); - }); - it('Test#002 : should copy files for Android Studio projects', 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 elements', function () { - it('Test#003 : should copy files to the correct location on a non-Android Studio project', function () { - android['resource-file'].install(valid_resources[0], dummyPluginInfo, dummyProject); - expect(copyFileSpy).toHaveBeenCalledWith(dummyplugin, 'android-resource.xml', temp, path.join('res', 'xml', 'dummy.xml'), false); + 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 elements', function () { beforeEach(function () { - shell.cp('-rf', android_project, temp); + shell.cp('-rf', android_studio_project, temp); }); - it('Test#004 : should copy stuff from one location to another by calling common.copyFile', function () { + 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#005 : should install source files to the right location for Android Studio projects', function () { + 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#006 : should throw if source file cannot be found', function () { + 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#007 : should throw if target file already exists', function () { + 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); @@ -122,7 +118,7 @@ describe('android project handler', function () { var copyNewFileSpy = jasmine.createSpy('copyNewFile'); beforeEach(function () { - shell.cp('-rf', android_project, temp); + shell.cp('-rf', android_studio_project, temp); spyOn(dummyProject, 'addSystemLibrary'); spyOn(dummyProject, 'addSubProject'); @@ -134,23 +130,23 @@ describe('android project handler', function () { common.__set__('copyNewFile', copyNewFileOrig); }); - it('Test#008 : should throw if framework doesn\'t have "src" attribute', function () { + it('Test#007 : should throw if framework doesn\'t have "src" attribute', function () { expect(function () { android.framework.install({}, dummyPluginInfo, dummyProject); }).toThrow(); }); - it('Test#009 : should install framework without "parent" attribute into project root', function () { + 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#010 : should install framework with "parent" attribute into parent framework dir', function () { + 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#011 : should not copy anything if "custom" attribute is not set', function () { + 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); @@ -158,14 +154,14 @@ describe('android project handler', function () { expect(cpSpy).not.toHaveBeenCalled(); }); - it('Test#012 : should copy framework sources if "custom" attribute is set', function () { + 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#013 : should install gradleReference using project.addGradleReference', function () { + 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); @@ -183,13 +179,13 @@ describe('android project handler', function () { platformWwwDest = path.resolve(dummyProject.platformWww, 'plugins', dummyPluginInfo.id, jsModule.src); }); - it('Test#014 : should put module to both www and platform_www when options.usePlatformWww flag is specified', function () { + 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#015 : should put module to www only when options.usePlatformWww flag is not specified', function () { + 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'); @@ -206,13 +202,13 @@ describe('android project handler', function () { platformWwwDest = path.resolve(dummyProject.platformWww, asset.target); }); - it('Test#016 : should put asset to both www and platform_www when options.usePlatformWww flag is specified', function () { + 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#017 : should put asset to www only when options.usePlatformWww flag is not specified', function () { + 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); @@ -232,7 +228,7 @@ describe('android project handler', function () { beforeEach(function () { shell.mkdir('-p', temp); shell.mkdir('-p', plugins_dir); - shell.cp('-rf', android_project, temp); + shell.cp('-rf', android_studio_project, temp); AndroidProject.purgeCache(); dummyProject = AndroidProject.getProjectFile(temp); common.__set__('removeFile', removeFileSpy); @@ -246,12 +242,7 @@ describe('android project handler', function () { }); describe('of elements', function () { - it('Test#018 : should remove jar files', function () { - android['lib-file'].install(valid_libs[0], dummyPluginInfo, dummyProject); - android['lib-file'].uninstall(valid_libs[0], dummyPluginInfo, dummyProject); - expect(removeFileSpy).toHaveBeenCalledWith(temp, path.join('libs/TestLib.jar')); - }); - it('Test#019 : should remove jar files for Android Studio projects', 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')); @@ -259,12 +250,7 @@ describe('android project handler', function () { }); describe('of elements', function () { - it('Test#020 : should remove files', function () { - android['resource-file'].install(valid_resources[0], dummyPluginInfo, dummyProject); - android['resource-file'].uninstall(valid_resources[0], dummyPluginInfo, dummyProject); - expect(removeFileSpy).toHaveBeenCalledWith(temp, path.join('res/xml/dummy.xml')); - }); - it('Test#021 : should remove files for Android Studio projects', 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')); @@ -272,12 +258,7 @@ describe('android project handler', function () { }); describe('of elements', function () { - it('Test#022 : should remove stuff by calling common.deleteJava', function () { - android['source-file'].install(valid_source[0], dummyPluginInfo, dummyProject); - android['source-file'].uninstall(valid_source[0], dummyPluginInfo, dummyProject); - expect(deleteJavaSpy).toHaveBeenCalledWith(temp, path.join('src/com/phonegap/plugins/dummyplugin/DummyPlugin.java')); - }); - it('Test#023 : should remove stuff by calling common.deleteJava for Android Studio projects', 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')); @@ -296,30 +277,30 @@ describe('android project handler', function () { spyOn(dummyProject, 'removeGradleReference'); }); - it('Test#024 : should throw if framework doesn\'t have "src" attribute', function () { + it('Test#020 : should throw if framework doesn\'t have "src" attribute', function () { expect(function () { android.framework.uninstall({}, dummyPluginInfo, dummyProject); }).toThrow(); }); - it('Test#025 : should uninstall framework without "parent" attribute into project root', function () { + 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#026 : should uninstall framework with "parent" attribute into parent framework dir', function () { + 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#027 : should remove framework sources if "custom" attribute is set', function () { + 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#28 : should install gradleReference using project.removeGradleReference', function () { + 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); @@ -345,13 +326,13 @@ describe('android project handler', function () { }); }); - it('Test#029 : should put module to both www and platform_www when options.usePlatformWww flag is specified', function () { + 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#030 : should put module to www only when options.usePlatformWww flag is not specified', function () { + 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); @@ -375,13 +356,13 @@ describe('android project handler', function () { }); }); - it('Test#031 : should put module to both www and platform_www when options.usePlatformWww flag is specified', function () { + 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#032 : should put module to www only when options.usePlatformWww flag is not specified', function () { + 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);