Issue 4031 - Implement tests for libadblockplus-android

README.md

Index: README.md
diff --git a/README.md b/README.md
index d142952a682f92f0e34be81cfb1c8374a5161a5a..e396386bbc19f5e6e7d0243b8fcb50ad0bfb05cd 100644
--- a/README.md
+++ b/README.md
@@ -11,14 +11,16 @@ To update those, call:
 
     ./ensure_dependencies.py
 
+## Library
+
 Building with Ant
 ------------------
 
 ### Requirements
 
-- [The Android SDK](http://developer.android.com/sdk)
-- [The Android NDK](https://developer.android.com/tools/sdk/ndk)
-- [Ant](http://ant.apache.org)
+* [The Android SDK](http://developer.android.com/sdk)
+* [The Android NDK](https://developer.android.com/tools/sdk/ndk)
+* [Ant](http://ant.apache.org)
 
 ### Building
 
@@ -39,7 +41,7 @@ Building with Maven
 
 All 'Building with Ant' requirements and additional requirements:
 
-- [Maven](https://maven.apache.org)
+* [Maven](https://maven.apache.org)
 
 ### Building
 
@@ -49,3 +51,30 @@ 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. 
+
+## Library tests
+
+### Requirements
+
+Make sure _Library_ requirements are present.
+
+### Building
+
+Set ANDROID_HOME environment variable to your Android SDK directory.
+
+In the 'libadblockplus-android-tests' run:

[Felix Dahlke, 2016/09/12 13:52:12]

Nit: "In the 'libadblockplus-android-tests' directory"?

[anton, 2016/09/13 05:49:08]

Yes, it's "Library tests" README section and it's about the tests. We're having
"libadblockplus-android" directory with jni-glue files and
"libadblockplus-android-tests" with the tests. We need to run in
"libadblockplus-android-tests" to build both tests and dependencies (jni glue)
so it's not mistyping

[Felix Dahlke, 2016/09/13 08:30:13]

Just to clarify, what I meant here is that the sentence sounds weird this way:
"In the $directory_name run", so I suggested to write "In the $directory_name
directory run". You also say "In the 'libadblockplus-android-tests' directory
run" below, so this sentence here seemed like it's just missing a "directory".

[anton, 2016/09/13 10:44:37]

Acknowledged.

+
+    ant instrument
+
+### Testing
+
+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

[Felix Dahlke, 2016/09/12 13:52:12]

Nit: Missing period? :D

[anton, 2016/09/13 05:49:08]

did not catch that. it can be called "instrumentation tests app". it's an
application that has instrumented code and actually the whole app is tests

[Felix Dahlke, 2016/09/13 08:30:13]

I know, I'm just saying that there appears to be a period (".") missing at the
end of the sentence.