Merge pull request #428 from thaliproject/issue_411

Add support for installing jxcore-cordova plugin using JXC

Author: vjrantal

plugin.xml

@@ -8,8 +8,8 @@
     <license>MIT</license>
     <keywords>cordova,jxcore,node.js,thali</keywords>
     <engines>
-        <engine name="cordova-android" version="~4.1.0" />
-        <engine name="cordova-ios" version="~3.9.0" />
+        <engine name="cordova-android" version=">=4.1.0" />
+        <engine name="cordova-ios" version=">=3.9.0" />
         <engine name="android-sdk" version=">=19" />
     </engines>
 
@@ -30,8 +30,7 @@
         <source-file src="src/android/java/io/jxcore/node/OutgoingSocketThread.java" target-dir="src/io/jxcore/node/" />
         <source-file src="src/android/java/io/jxcore/node/SocketThreadBase.java" target-dir="src/io/jxcore/node/" />
         <source-file src="src/android/java/io/jxcore/node/StreamCopyingThread.java" target-dir="src/io/jxcore/node/" />
-        <hook type="after_prepare" src="scripts/androidAfterPrepare.js"/>
-        <!--<hook type="after_platform_add" src="scripts/androidAfterPlatformAdd.js"/>-->
+        <hook type="before_compile" src="scripts/androidBeforeCompile.js" />
     </platform>
 
     <!-- iOS -->

scripts/androidAfterPrepare.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var fs = require('fs-extra-promise');
+var path = require('path');
+
+/**
+ * We've tried various strategies in plugin.xml to set the minimum sdk
+ * in the Android manifest to an acceptable value such as uses-sdk in
+ * the platform/config section and also the android-minSdkVersion and they do
+ * work in that they add an appropriate uses-sdk to AndroidManifest.xml
+ * but unfortunately it still leaves the default uses-sdk element set to
+ * a min of 10 in there! I'm sure there is some fix but I'm tired of fighting
+ * with it so we just force the change. One last thing to try is to create a
+ * build-extras.gradle next to our plugin.xml and try to either stick in
+ * an android declare block with a defaultConfig and a minSdkVersion or use
+ * the special ext property that Cordova declares. But honestly, I'll figure it
+ * out later.
+ */
+var updateAndroidSDKVersion = function (appRoot) {
+  var androidManifestLocation = path.join(appRoot, 'platforms/android/AndroidManifest.xml');
+  var originalContent = fs.readFileSync(androidManifestLocation).toString();
+  // Different version of Cordova use different mins, yes we need to replace this with xpath
+  var newContent = originalContent
+    .replace('android:minSdkVersion="10"', 'android:minSdkVersion="19"')
+    .replace('android:minSdkVersion="14"', 'android:minSdkVersion="19"');
+  fs.writeFileSync(androidManifestLocation, newContent);
+};
+
+var replaceJXCoreExtension = function (appRoot) {
+  var sourceFile = path.join(appRoot, 'plugins/org.thaliproject.p2p/src/android/java/io/jxcore/node/JXcoreExtension.java');
+  var targetFile = path.join(appRoot, 'platforms/android/src/io/jxcore/node/JXcoreExtension.java');
+  try {
+    var sourceContent = fs.readFileSync(sourceFile);
+    fs.writeFileSync(targetFile, sourceContent);
+  } catch (e) {
+    console.log(e);
+    console.log('Failed to update the JXcoreExtension.java file!');
+    console.log('Please make sure plugins org.thaliproject.p2p and io.jxcore.node are installed.')
+    // Exit the process on this error, because it is a hard requirement for this
+    // plugin to get the right JXcoreExtension.java or otherwise there will be
+    // a build error when the app is tried to be built.
+    process.exit(-1);
+  }
+};
+
+var removeInstallFromPlatform = function (appRoot) {
+  var installDir = path.join(appRoot, 'platforms/android/assets/www/jxcore/node_modules/thali/install');
+  fs.removeSync(installDir);
+};
+
+module.exports = function (context) {
+  var appRoot = context.opts.projectRoot;
+  updateAndroidSDKVersion(appRoot);
+  replaceJXCoreExtension(appRoot);
+  removeInstallFromPlatform(appRoot);
+};

scripts/androidBeforeCompile.js

@@ -1,6 +1,7 @@
 var LogCallback;
 var myName;
 var os = require('os');
+var tmp = require('tmp');
 
 /**
  * Turn Bluetooth and WiFi either on or off
@@ -91,3 +92,19 @@ if (typeof jxcore !== 'undefined' && jxcore.utils.OSInfo().isMobile) {
     console.log(message);
   }
 }
+
+/**
+ * Returns the file path to the temporary directory that can be used by tests
+ * to store data that does not have to be persisted between app restarts.
+ * The temporary directory is removed when the process exits.
+ */
+var tmpObject = null;
+exports.tmpDirectory = function () {
+  if (tmpObject === null) {
+    tmp.setGracefulCleanup();
+    tmpObject = tmp.dirSync({
+      unsafeCleanup: true
+    });
+  }
+  return tmpObject.name;
+};

test/www/jxcore/lib/testUtils.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var install = require('../../../../thali/install/install.js');
+var tape = require('../lib/thali-tape');
+var testUtils = require('../lib/testUtils.js');
+var exec = require('child_process').exec;
+var path = require('path');
+
+var test = tape({
+  setup: function(t) {
+    t.end();
+  },
+  teardown: function(t) {
+    t.end();
+  }
+});
+
+test('two required plugins should get installed', function (t) {
+  var tmpDirectory = testUtils.tmpDirectory();
+  var testAppName = 'TestApp';
+  var testAppDirectory = path.join(tmpDirectory, testAppName);
+  var cordovaCreateCommand = 'cordova create ' + testAppName;
+  exec(cordovaCreateCommand, { cwd: tmpDirectory }, function (err, stdout, stderr) {
+    if (err) {
+      t.fail('Cordova command should not fail!');
+      t.end();
+      return;
+    }
+    install(function () {
+      var cordovaPluginsCommand = 'cordova plugins list';
+      exec(cordovaPluginsCommand, { cwd: testAppDirectory }, function (err, stdout, stderr) {
+        t.ok(stdout.indexOf('io.jxcore.node' >= 0), 'jxcore cordova plugin is installed');
+        t.ok(stdout.indexOf('org.thaliproject.p2p' >= 0), 'thali cordova plugin is installed');
+        t.end();
+      });
+    }, testAppDirectory);
+  });
+});

test/www/jxcore/meta_tests/testInstall.js

@@ -0,0 +1,32 @@
+'use strict';
+
+var path = require('path');
+var fs = require('fs');
+
+var testUtils = require('../lib/testUtils.js');
+var tape = require('../lib/thali-tape');
+
+var test = tape({
+  setup: function(t) {
+    t.end();
+  },
+  teardown: function(t) {
+    t.end();
+  }
+});
+
+test('test utils should return same temporary folder when called multiple times', function (t) {
+  var firstDirectory = testUtils.tmpDirectory();
+  var secondDirectory = testUtils.tmpDirectory();
+  t.equal(firstDirectory, secondDirectory);
+  t.end();
+});
+
+test('should be able to write to the temporary folder', function (t) {
+  var temporaryDirectory = testUtils.tmpDirectory();
+  console.log(temporaryDirectory);
+  fs.mkdir(path.join(temporaryDirectory, 'somePath'), function (err) {
+    t.equal(err, null, 'no error returned when creating a subfolder');
+    t.end();
+  });
+});

test/www/jxcore/meta_tests/testTestUtils.js

@@ -35,10 +35,10 @@
     "request-promise": "0.4.3",
     "socket.io-client": "^1.3.6",
     "supertest-as-promised": "^2.0.2",
-    "thali" : "^2.0.1",
     "tape": "^4.0.0",
     "tape-catch": "^1.0.4",
-    "thali": "^1.0.22",
+    "thali" : "^2.0.1",
+    "tmp": "0.0.28",
     "urlsafe-base64": "^1.0.0",
     "uuid": "^2.0.0",
     "wrapping-tape": "^0.0.3"