Add an explanation about running tests against Android App Bundle module #11601

KazuCocoa · 2018-10-31T02:32:47Z

Proposed changes

We can run test a .apks file which is generated by Android App Bundle feature after appium/appium-base-driver#271
I'd leave a hint to run .apks.

Types of changes

What types of changes does your code introduce to Appium?
Put an x in the boxes that apply

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

I have read the CONTRIBUTING doc
I have signed the CLA
Lint and unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)
Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

mykola-mokhnach · 2018-10-31T09:30:33Z

docs/en/writing-running-appium/android/android-appbundle.md

+Google has released [Android App Bundle](https://developer.android.com/platform/technology/app-bundle/) feature.
+`.aab` file is generated by the feature. We must upload the file to Google Play Store.
+
+We can get distributed apk files from the `.aab` file via [bundletool](https://github.com/google/bundletool). Using the generated files, we can test against release module. After [1](https://github.com/appium/appium-adb/pull/367) and [2](https://github.com/appium/appium-base-driver/pull/271), you can run Appium tests against `.apks` file. The commits are available over Appium 1.9.2.


The support for apks is currently only present in UIA2

, we can test against the release module.
...
Since Appium 1.9.2, you can run Appium tests against an .apks file.

mykola-mokhnach · 2018-10-31T09:34:22Z

docs/en/writing-running-appium/android/android-appbundle.md

@@ -0,0 +1,51 @@
+## How To Test Android App Bundle


I think it makes sense to also add https://developer.android.com/studio/command-line/bundletool link into this article

mykola-mokhnach · 2018-10-31T09:35:01Z

docs/en/writing-running-appium/android/android-appbundle.md

+
+1. Export `bundletool.jar` in your path
+    - Appium search the `bundletool.jar` in your local. Make sure you can find the path with `which 'bundletool.jar'`. If you can't find it, please set the path correctly.
+2. Generate `.apks` from `.aab`


I believe this might be also possible with Android Studio UI

since version 3.2

Generate the .apks file from the .aab file

jlipps

some wording suggestions

jlipps · 2018-10-31T21:07:09Z

docs/en/writing-running-appium/android/android-appbundle.md

@@ -0,0 +1,51 @@
+## How To Test Android App Bundle
+
+Google has released [Android App Bundle](https://developer.android.com/platform/technology/app-bundle/) feature.


Google has released the Android App Bundle feature.

jlipps · 2018-10-31T21:07:34Z

docs/en/writing-running-appium/android/android-appbundle.md

+## How To Test Android App Bundle
+
+Google has released [Android App Bundle](https://developer.android.com/platform/technology/app-bundle/) feature.
+`.aab` file is generated by the feature. We must upload the file to Google Play Store.


An .aab file is generated by the feature, which we are supposed to upload to the Google Play Store

jlipps · 2018-10-31T21:08:36Z

docs/en/writing-running-appium/android/android-appbundle.md

+Google has released [Android App Bundle](https://developer.android.com/platform/technology/app-bundle/) feature.
+`.aab` file is generated by the feature. We must upload the file to Google Play Store.
+
+We can get distributed apk files from the `.aab` file via [bundletool](https://github.com/google/bundletool). Using the generated files, we can test against release module. After [1](https://github.com/appium/appium-adb/pull/367) and [2](https://github.com/appium/appium-base-driver/pull/271), you can run Appium tests against `.apks` file. The commits are available over Appium 1.9.2.


, we can test against the release module.
...
Since Appium 1.9.2, you can run Appium tests against an .apks file.

jlipps · 2018-10-31T21:08:59Z

docs/en/writing-running-appium/android/android-appbundle.md

+## How to run tests
+
+1. Export `bundletool.jar` in your path
+    - Appium search the `bundletool.jar` in your local. Make sure you can find the path with `which 'bundletool.jar'`. If you can't find it, please set the path correctly.


Appium looks for bundletool.jar in your local environment.

jlipps · 2018-10-31T21:09:14Z

docs/en/writing-running-appium/android/android-appbundle.md

+
+1. Export `bundletool.jar` in your path
+    - Appium search the `bundletool.jar` in your local. Make sure you can find the path with `which 'bundletool.jar'`. If you can't find it, please set the path correctly.
+2. Generate `.apks` from `.aab`


Generate the .apks file from the .aab file

jlipps · 2018-10-31T21:10:28Z

docs/en/writing-running-appium/android/android-appbundle.md

+          --ks-pass pass:kazucocoa \              # Password of the keystore
+          --overwrite                             # Everytime, you can override the apks
+        ```
+3. Set the `.apks` in your `app` capability.


Use the path to the .apks file as your app capability

jlipps · 2018-10-31T21:10:34Z

docs/en/writing-running-appium/android/android-appbundle.md

+
+## Tips
+
+### Test with differnet languages


jlipps · 2018-10-31T21:11:04Z

docs/en/writing-running-appium/android/android-appbundle.md

+
+### Test with differnet languages
+
+Set `fullReset: true` if you would like to test against different languages resources in every creating session.


if you would like to test against the app using different languages' resources.

jlipps · 2018-10-31T21:12:28Z

docs/en/writing-running-appium/android/android-appbundle.md

+
+Set `fullReset: true` if you would like to test against different languages resources in every creating session.
+
+Appium installs minimal resources following appbundle feature. For example, if a device environment is English, Appium installs only `en` resource. The installed apk has no Japanese resource.


Appium only installs the minimum set of resources, following the behavior of the appbundle feature. For example, if a device's language is set to English, Appium will only install the en resource. The installed apk will have no Japanese language resources.

jlipps · 2018-10-31T21:12:51Z

docs/en/writing-running-appium/android/android-appbundle.md

+
+Appium installs minimal resources following appbundle feature. For example, if a device environment is English, Appium installs only `en` resource. The installed apk has no Japanese resource.
+
+Appium decides which resource must install in the installation phase. We should specify `fullReset: true` to force re-installation call.


In order to force re-installation with a different set of language resources, specify fullReset: true

KazuCocoa · 2018-11-08T01:09:48Z

@jlipps Could you take a look again?
Would like to include this into the next release (and set a link to this doc in the changelog)

KazuCocoa · 2018-11-08T23:56:53Z

will update later if we have any update for this doc

…ule (#11601) * add tutorial for app bundle * tweak a description * remove redundant lines * apply grateful reviews

KazuCocoa added 3 commits October 31, 2018 11:25

add tutorial for app bundle

9ddc4c3

tweak a description

f9834b8

remove redundant lines

812301f

mykola-mokhnach reviewed Oct 31, 2018

View reviewed changes

jlipps reviewed Oct 31, 2018

View reviewed changes

apply grateful reviews

331e3bc

KazuCocoa mentioned this pull request Nov 8, 2018

1.10 changelog #11651

Merged

KazuCocoa merged commit 48a2958 into appium:master Nov 8, 2018

KazuCocoa deleted the add-explanation-of-appbundle branch November 8, 2018 23:57

imurchie pushed a commit that referenced this pull request Nov 19, 2018

Add an explanation about running tests against Android App Bundle mod…

549bac3

…ule (#11601) * add tutorial for app bundle * tweak a description * remove redundant lines * apply grateful reviews

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an explanation about running tests against Android App Bundle module #11601

Add an explanation about running tests against Android App Bundle module #11601

KazuCocoa commented Oct 31, 2018

mykola-mokhnach Oct 31, 2018

jlipps Oct 31, 2018

mykola-mokhnach Oct 31, 2018

mykola-mokhnach Oct 31, 2018

mykola-mokhnach Oct 31, 2018

jlipps Oct 31, 2018

jlipps left a comment

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

jlipps Oct 31, 2018

KazuCocoa commented Nov 8, 2018

KazuCocoa commented Nov 8, 2018

		@@ -0,0 +1,51 @@
		## How To Test Android App Bundle

		Google has released [Android App Bundle](https://developer.android.com/platform/technology/app-bundle/) feature.


		### Test with differnet languages

		Set `fullReset: true` if you would like to test against different languages resources in every creating session.


		Set `fullReset: true` if you would like to test against different languages resources in every creating session.

		Appium installs minimal resources following appbundle feature. For example, if a device environment is English, Appium installs only `en` resource. The installed apk has no Japanese resource.


		Appium installs minimal resources following appbundle feature. For example, if a device environment is English, Appium installs only `en` resource. The installed apk has no Japanese resource.

		Appium decides which resource must install in the installation phase. We should specify `fullReset: true` to force re-installation call.

Add an explanation about running tests against Android App Bundle module #11601

Add an explanation about running tests against Android App Bundle module #11601

Conversation

KazuCocoa commented Oct 31, 2018

Proposed changes

Types of changes

Checklist

Further comments

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jlipps left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KazuCocoa commented Nov 8, 2018

KazuCocoa commented Nov 8, 2018