1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# Building the Ice for Android Test Suite
This directory contains an Android Studio project for the Ice test suite. For
ease of development and testing, this project also builds a subset of the Ice
JAR files. This is not necessary for your own projects as it considerably
complicates the project configuration.
Building [Ice for Java](../BuildInstructions.md) is the only way to build
all of the Ice JAR files from source. The JAR files produced by the Ice for Java
build fully support Android. If you prefer, our [binary distributions][1]
include pre-compiled JAR files.
## Build Requirements
### Android Development Tools
Building any Ice application for Android requires Android Studio and the Android
SDK build tools. We tested with the following components:
- Android Studio 2.3
- Android SDK 21
- Android Build Tools 21
Ice requires at minimum API level 21:
- Android 5 (API21)
If you want to target a later version of the Android API level for the test
suite, edit `gradle.properties` and change the following variables:
ice_compileSdkVersion
ice_minSdkVersion
ice_targetSdkVersion
### Slice to Java Compiler
To build this project you'll need the Slice to Java compiler, which generates
Java code from Slice definitions. The compiler is written in C++. If you have
a suitable C++ development environment, you can build [Ice for C++](../../cpp)
yourself. Otherwise, you can obtain the compiler by installing a
[binary distribution][1].
The project's Gradle-based build system will automatically search for the
compiler in this repository and in the default installation directories used
by the binary distributions for our supported platforms.
### Bzip2 Compression
Ice for Android supports protocol compression using the bzip2 classes included
with [Apache Commons Compress][2].
The Maven package id for the bzip2 JAR file is as follows:
groupId=org.apache.tools, version=1.0, artifactId=bzip2
You must add the bzip2 classes to your project to enable protocol compression.
> *These classes are a pure Java implementation of the bzip2 algorithm and
therefore add significant latency to Ice requests.*
## Building the Project
Follow these steps to import the Ice for Android project into Android Studio:
1. Start Android Studio
2. Select Open Project
3. Navigate to the android-compat subdirectory
4. If presented with an "Import Project from Gradle" dialog, select
"Use default gradle wrapper" and press OK
The Android Studio project contains a `testController` application for the Ice
test suite. To run the application, select it in the configuration pull down and
run it.
## Running the Test Suite
To run the test suite you need to add the `tools` and `platform-tools`
directories from the Android SDK to your PATH.
On macOS you can use the following command:
export PATH=~/Library/Android/sdk/tools:~/Library/Android/sdk/platform-tools:$PATH
On Windows you can use the following command:
set PATH=%LOCALAPPDATA%\Android\sdk\tools;%LOCALAPPDATA%\Android\sdk\platform-tools;%PATH%
The Instant Run feature from Android Studio causes some problems with the test
suite application. You need to disable it in order to run the test controller
application, check the following page for instructions on how to disable it:
https://developer.android.com/studio/run/index.html#disable-ir
Start the `testController` application from Android Studio and once it has
started, run the testsuite by using the `allTests.py` script:
cd android-compat
python allTests.py
This will try to run the testsuite on the connected device. If multiple devices
are connected, you can use the `--device` argument to select a device:
python allTests.py --device=ZX1C2234XF
You can see the list of connected devices with the `adb` command:
adb devices -l
If you are running the application on an emulator, you need to pass the
`--androidemulator` command line option:
python allTests.py --androidemulator --device=emulator-5554
You can also start the emulator from the `allTests.py` script:
python allTests.py --androidemulator --avd=Nexus_6P_API_25 --controller-app
Where `--avd` is set to the Android emulator image you want to use. You can list
the available image names in your host by using `emulator -list-avds`. Images
can be created using Android Studio.
[1]: https://zeroc.com/distributions/ice
[2]: https://commons.apache.org/proper/commons-compress/
|
