Issue 4324 - Add Gradle build config

README.md

 Adblock Plus Library for Android
 ========================
 
 An Android library project that runs a proxy to block ads.
 
 Updating the dependencies
 -------------------------
 
 Adblock Plus Library for Android has dependencies that aren't in this repository.
 To update those, call:
@@ skipping 34 matching lines @@
 
 ### Building
 
 Set environment variable ANDROID_HOME to your Android SDK directory or pass it in command-line (below).
 In the 'libadblockplus-android' directory run:
 
         mvn clean install [-Dandroid.sdk.path=/some/where/sdk]
 
 This will generate *.aar library artifact in the 'target' directory. 
 
+Building with Gradle/Android Studio
+-----------------------------------
+
+### Requirements
+
+* [The Android SDK](http://developer.android.com/sdk)
+* Android SDK Build tools 22.0.1

[Felix Dahlke, 2016/11/18 07:17:42]

Any reason we refer to a specific build tools version here, but not above when
it comes to building with Maven and Ant? Maybe we should move the SDK/NDK
requirement to a shared requirements section, so we don't have to duplicate it?

[anton, 2016/11/21 08:15:39]

It's a good question and honestly i don't remember what was the reason exactly
(i think it was that 24.0.1 requires java 8 as android.jar is compiled with java
8). But it does not makes sense as after that a new version of gradle plugin was
released (moved from experimental ndk support to main branch) and now it
requires just the latest version (24.0.1), see
https://codereview.adblockplus.org/29361445/patch/29362070/29362134

[Felix Dahlke, 2016/11/21 08:55:33]

So how I understand that, it works just fine with the latest version? Why
specify the SDK build tools version here then?

+* [The Android NDK](https://developer.android.com/tools/sdk/ndk)
+
+Edit 'buildToolsVersion' in 'build.gradle' files if necessary.

[Felix Dahlke, 2016/11/18 07:17:42]

"files" - is there more than one? Also, does build.gradle have to be created? If
so, how should it look?

[anton, 2016/11/21 08:15:39]

Yes, there are multiple `build.gradle` files - in each directory/Gradle module`.

[Felix Dahlke, 2016/11/21 08:55:33]

Acknowledged.

+
+### Building from command-line
+
+In the project root directory create the file _local.properties_ and set
+_sdk.dir_ and _ndk.dir_ to where you installed it, e.g.:
+
+    sdk.dir = /some/where/sdk
+    ndk.dir = /some/where/ndk
+
+In the project root directory run:
+
+    ./gradlew assembleDebug
+
+This will generate *.aar library artifact in 'libadblockplus-android/build/outputs/aar/' directory.

[Felix Dahlke, 2016/11/18 07:17:43]

Unrelated, but I think it'd also be helpful to point out above in the Ant
section where the .aar is created if one builds via Ant. But that should go into
a separate commit, Noissue is fine.

[Felix Dahlke, 2016/11/18 07:17:43]

Wording nit: "artifact in THE [...] directory."

[anton, 2016/11/21 08:15:39]

Acknowledged.

[anton, 2016/11/21 08:15:39]

Acknowledged.

[anton, 2016/11/21 12:29:51]

When compiling with Ant no aar is created. It just uses good-old copy to copy
compiled classes and resources to the application. For this the app should refer
to the library in project.properties

+
 ## Library tests
 
 ### Requirements
 
 Make sure _Library_ requirements are present.
 
-### Building
+### Building with Ant
 
 Set ANDROID_HOME environment variable to your Android SDK directory.
 
 In the 'libadblockplus-android-tests' run:
 
     ant instrument
 
-### Testing
+### Testing with Ant
 
 1. Connect an Android device or start the Android Emulator.
 2. In the 'libadblockplus-android-tests' directory run:
 
     ant instrument install test
 
 to build instrumentation tests app and perform testing or run:
 
     ant test
 
 to run installed instrumentation tests app.
 
 To run specific **test** run:
 
     ant testOnly -DtestClass=full.test.class.name
 
 For example:
 
     ant testOnly -DtestClass=org.adblockplus.libadblockplus.tests.NotificationTest
 
 To run specific **test method** run:
 
     ant testOnly -DtestClass=full.test.class.name#testMethod
 
 For example:
 
-    ant testOnly -DtestClass=org.adblockplus.libadblockplus.tests.NotificationTest#testAddNotification
+    ant testOnly -DtestClass=org.adblockplus.libadblockplus.tests.NotificationTest#testAddNotification
+
+### Building with Gradle/Android Studio
+
+Make sure you've created _local.properties_ file to build the library (see above).

[Felix Dahlke, 2016/11/18 07:17:42]

Wording nit: "you've created THE [...] file".

+In the project root directory run:
+
+    ./gradlew assembleDebugAndroidTest
+
+This will generate *.apk in 'libadblockplus-android-tests/build/outputs/apk/' directory.

[Felix Dahlke, 2016/11/18 07:17:42]

Wording nit: "in THE [...] directory"

+
+### Testing with Gradle/Android Studio
+
+You can select test class/method and click 'Run ..Test'. The library and test app will be
+compiled, installed to emuator/device and launched automatically.