Skip to content
This repository was archived by the owner on Dec 7, 2019. It is now read-only.

Commit 55e0713

Browse files
artem-zinnatullinartem-zinnatullin
committed
Initial public release.
0 parents  commit 55e0713

29 files changed

+2422
-0
lines changed

‎.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.gradle
2+
/local.properties
3+
/.idea/
4+
*.iml
5+
.DS_Store
6+
build/
7+
artifacts/
8+
/captures
9+
gradle/local.properties
10+
/docs
11+
12+
# Share code style.
13+
!.idea/codeStyleSettings.xml

‎LICENSE.txt

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2017 Juno Inc.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
## Composer — Reactive Android Instrumentation Test Runner.
2+
3+
Composer is a modern reactive replacement for [square/spoon][spoon] with following feature set:
4+
5+
* Parallel test execution on multiple emulators/devices with [test sharding](https://developer.android.com/topic/libraries/testing-support-library/index.html#ajur-sharding) support.
6+
* Logcat output capturing per test and for whole test run as well.
7+
* Screenshots and files pulling for each test reactively (with support for [square/spoon][spoon] folder structure).
8+
* JUnit4 report generation.
9+
10+
### Why we've decided to replace [square/spoon][spoon]
11+
12+
**Problem 1:** Our UI tests are stable, but we saw a lot of UI tests build failures. About ~50% of our CI builds were failing. All such failures of UI tests came from Spoon not being able to run tests on one or more emulators (device is red in the report and error message is `…work/emulator-5554/result.json (No such file or directory)`, basically it timed out on installing the apk on a device, increasing adb timeout did not help, all emulators responded to adb commands and mouse/keyboard interactions, we suppose problem is in in ddmlib used by Spoon.
13+
**Solution:** Composer does not use ddmlib and talks to emulators/devices by invoking `adb` binary.
14+
15+
**Problem 2:** Pretty often when test run finished, Spoon freezed on moving screenshots from one of the emulators/devices. Again, we blame ddmlib used in Spoon for that.
16+
**Solution:** Composer invokes `adb` binary to pull files from emulators/devices, we haven't seen problems with that in more than 700 builds on CI.
17+
18+
**Problem 3:** Spoon pulled screenshots/files *after* finish of the whole test run on a device which slows down builds: `test_run_time + pull_files_time`.
19+
**Solution:** Composer pulls screenshots/files *reactively* after each test which basically leads to: `~test_run_time`.
20+
21+
**Problem 4:** If test sharding is enabled (which we do all the time), Spoon HTML report is very hard to look at, especially if you want to find some particular test(s) and it's not failed. You have to either hover mouse over each test to find out its name or go into html/xml source and find on which emulator/device test was sharded in order to click on correct device and then find test by CMD+F on the page.
22+
**Solution:** ~~Composer does not generate HTML report~~ HTML report that we have in mind will be easier to look at and inspect.
23+
24+
**Problem 5:** Html report can be very slow to load if you have lots of screenshots (which we do) since it displays all the screenshots of tests that were run on a particular device on a single page — it can take up to minutes to finish while you effectively unable to scroll page since scroll is jumping up and down each time new screenshot loaded.
25+
**Solution:** ~~Composer does not generate HTML report~~ HTML report that we have in mind will not display screenshots until you explicitly ask it for that meaning fast page load times.
26+
27+
>With Composer we were able to make UI tests required part of CI for Pull Requests.
28+
>It's fast, reliable and uses RxJava which means that it's relatively easy to add more features combining complex async transformations.
29+
30+
### HTML Report
31+
32+
Composer already have all the info to generate it, but HTML, CSS and JS are not technologies we love and good at in our Android team, so some help from the community will be great!
33+
34+
For now you can inspect test run results by looking at build log, screenshots/files, captured logcat output (it's not hard, but HTML report would be very nice).
35+
36+
## Usage
37+
38+
Composer shipped as jar, to run it you need JVM 1.8+: java -jar composer-latest-version.jar options.
39+
40+
#### Supported options:
41+
42+
* `--help, -help, help, -h`
43+
* Print help and exit.
44+
* Required: no.
45+
* `--apk`
46+
* Path to application apk that needs to be tested.
47+
* Required: **yes**.
48+
* `--test-apk`
49+
* Path to apk with tests.
50+
* Required: **yes**.
51+
* `--test-package`
52+
* Android package name of the test apk.
53+
* Required: **yes** (Could be parsed from `--test-apk`, PR welcome).
54+
* `--test-runner`
55+
* Full qualified name of test runner class you're using.
56+
* Required: **yes** (Could be parsed from `--test-apk`, PR welcome).
57+
* `--shard`
58+
* Either `true` or `false` to enable/disable test sharding which runs tests in parallel on available devices/emulators. True by default.
59+
* Required: no.
60+
* `--output-directory`
61+
* Either relative or absolute path to directory for output: reports, files from devices and so on. `composer-output` by default.
62+
* Required: no.
63+
* `--instrumentation-arguments`
64+
* Key-value pairs to pass to Instrumentation Runner. Usage example: `--instrumentation-arguments myKey1 myValue1 myKey2 myValue2`.
65+
* Required: no.
66+
67+
##### Example
68+
69+
```console
70+
java -jar composer-latest-version.jar \
71+
--apk app/build/outputs/apk/example-debug.apk \
72+
--test-apk app/build/outputs/apk/example-debug-androidTest.apk \
73+
--test-package com.example.test \
74+
--test-runner com.example.test.ExampleTestRunner \
75+
--output-directory artifacts/composer-output \
76+
--instrumentation-arguments key1 value1 key2 value2
77+
```
78+
79+
## License
80+
81+
```
82+
Copyright 2017 Juno, Inc.
83+
84+
Licensed under the Apache License, Version 2.0 (the "License");
85+
you may not use this file except in compliance with the License.
86+
You may obtain a copy of the License at
87+
88+
http://www.apache.org/licenses/LICENSE-2.0
89+
90+
Unless required by applicable law or agreed to in writing, software
91+
distributed under the License is distributed on an "AS IS" BASIS,
92+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
93+
See the License for the specific language governing permissions and
94+
limitations under the License.
95+
```
96+
97+
[spoon]: https://github.com/square/spoon

‎build.gradle

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
apply from: 'dependencies.gradle'
2+
3+
buildscript {
4+
// Gradle will not find vars defined in an external file when referring to them
5+
// in the buildscript block, unless you link it from the buildscript block, too.
6+
apply from: 'dependencies.gradle'
7+
8+
repositories {
9+
jcenter()
10+
}
11+
12+
dependencies {
13+
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin"
14+
classpath 'com.github.ben-manes:gradle-versions-plugin:0.13.0'
15+
classpath "org.junit.platform:junit-platform-gradle-plugin:$versions.junitPlatform"
16+
}
17+
}
18+
19+
allprojects {
20+
repositories {
21+
jcenter()
22+
}
23+
24+
apply plugin: 'com.github.ben-manes.versions'
25+
}

‎cmd-common/build.gradle

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
apply plugin: 'kotlin'
2+
apply plugin: 'org.junit.platform.gradle.plugin'
3+
4+
dependencies {
5+
compile libraries.kotlinStd
6+
compile libraries.kotlinRuntime
7+
compile libraries.kotlinReflect
8+
compile libraries.rxJava
9+
}
10+
11+
dependencies {
12+
testCompile libraries.spek
13+
testCompile libraries.spekSubjectExtension
14+
testCompile libraries.spekJunitPlatformEngine
15+
testCompile libraries.assertJ
16+
}
17+
18+
junitPlatform {
19+
platformVersion = versions.junitPlatform
20+
21+
filters {
22+
engines {
23+
include 'spek'
24+
}
25+
}
26+
}

0 commit comments

Comments
 (0)