test-butler - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #rust #deep-learning #docker #nodejs #windows #awesome #cli #vue #mcp #ios

test-butler

(★ 1,044)

Reliable Android Testing, at your service

파일 탐색기

최종 버전 다운로드 (.zip)

- - deploy-snapshot.yml
  - gradle-wrapper-validation.yml
  - merge-check.yml
  - publish-maven-central.yml
- build.gradle
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- publishing.gradle
- build.gradle
- - platform.keystore
- build.gradle
- build.gradle
- - platform.keystore
- build.gradle
- build.gradle
- build.gradle
.gitignore
build.gradle
CHANGELOG.md
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
LICENSE
NOTICE
README.md
RELEASING.md
settings.gradle

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/linkedin/test-butler

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd test-butler

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Test Butler
[![Build Status](https://img.shields.io/github/workflow/status/linkedin/test-butler/Merge%20checks)](https://img.shields.io/github/workflow/status/linkedin/test-butler/Merge%20checks)
[![Maven Central][mavenbadge-svg]][mavencentral]

Reliable Android testing, at your service.

## Motivation

Test Butler was inspired by the Google presentation "[Going Green: Cleaning up the Toxic Mobile Environment](https://www.youtube.com/watch?v=aHcmsK9jfGU)".
For more background, read the Test Butler announcement [blog post](https://engineering.linkedin.com/blog/2016/08/introducing-and-open-sourcing-test-butler--reliable-android-test).

## What does it do?

* Stabilizes the Android emulator, to help prevent test failures caused by emulator issues.
  * **Disables animations** so Espresso tests can run properly.
  * **Disables crash & ANR dialogs** so a system app misbehaving won't trigger a popup that causes your UI tests to fail.
  * **Locks the keyguard, WiFi radio, and CPU** to ensure they don't go to sleep unexpectedly while tests are running.
  * **Disables system spell checker** to avoid redline highlights and text auto correction.
* Handles changing global emulator settings and holds relevant permissions so your app doesn't have to.
  * **Enable/disable WiFi:** Test Butler allows tests to simulate a situation where WiFi is not connected or changes availability at some point.
  * **Change device orientation:** Tests can manually set the orientation of the device during test execution.
  * **Set location services mode:** Test Butler lets your code simulate different location services modes, like battery saver or high accuracy.
  * **Set application locale:** Tests can set a custom `Locale` object for their application to simulate running the app in another language.
  * **Grant runtime permissions:** Tests can grant Marshmallow's runtime permissions to their application directly from test code.
  * **Use hardware IME:** Tests can tell the system to prefer the hardware IME.
  * **Control immersive mode confirmation:** Tests can enable or disable immersive mode confirmation.

## How does it work?

Test Butler is a two-part project. It includes an Android library that your test code can depend on, as well as a companion Android app apk that must be installed on your Android emulator before using Test Butler.  You can build the Test Butler APK yourself from source, or download the binary from [Maven Central][mavencentral]

The Test Butler library is a thin wrapper around an [AIDL interface](https://developer.android.com/guide/components/aidl.html) to give your tests a safe way to talk to the Test Butler app's service running in the background on the emulator.

The Test Butler app is signed using the system keystore for the Android emulator, so it is automatically granted `signature`-level permissions when installed. This means granting permissions via adb is not necessary. It also means that this app **can only be installed on emulators that use the stock Android keystore!**

Being a system app makes Test Butler much easier to use than existing Android solutions for changing emulator settings. To disable animations, you just need a single line of code in your app; no extra permissions in your debug manifest, no granting permissions via adb, no Gradle plugin to integrate.

Test Butler can even use permissions that can't be granted via adb, like the [`SET_ACTIVITY_WATCHER`](https://github.com/android/platform_frameworks_base/blob/master/core/res/AndroidManifest.xml#L1902) permission, which lets Test Butler disable crash & ANR dialogs during tests.

## Any "gotchas" to look out for?

Only a few:

Test Butler helper app requires an emulator image with stock Android else it won't install, therefore it **will not work with non-stock emulator images such as ones with Google APIs or Google Play!**

Test Butler adds a custom [`IActivityController`](https://github.com/android/platform_frameworks_base/blob/master/core/java/android/app/IActivityController.aidl) to the system to be able to suppress crash & ANR dialogs. This technique is also used internally by the [`Monkey`](https://github.com/android/platform_development/blob/master/cmds/monkey/src/com/android/commands/monkey/Monkey.java#L255) tool. Unfortunately, the implementation of the [`isUserAMonkey()`](https://developer.android.com/reference/android/app/ActivityManager.html#isUserAMonkey()) method takes advantage of the fact that the `Monkey` class is the only thing inside Android that sets an `IActivityController` and [returns true whenever one is set](https://github.com/android/platform_frameworks_base/blob/master/services/core/java/com/android/server/am/ActivityManagerService.java#L10718).

This means that `isUserAMonkey()` **will return true** while Test Butler is running! If your app uses this method to invoke different behavior during actual monkey testing, you may encounter issues while running tests with Test Butler. An easy fix is to create a helper method in your app to call instead of `isUserAMonkey()`, which returns `false` while instrumentation tests are running and calls through to the real `isUserAMonkey()` when the app is not being instrumented.

## Download

Download the latest .apk and .aar via Maven:
```xml
    <dependency>
      <groupId>com.linkedin.testbutler</groupId>
      <artifactId>test-butler-library</artifactId>
      <version>2.2.1</version>
      <type>pom</type>
    </dependency>
    <dependency>
      <groupId>com.linkedin.testbutler</groupId>
      <artifactId>test-butler-app</artifactId>
      <version>2.2.1</version>
      <type>pom</type>
    </dependency>
```

or Gradle:
```
    androidTestImplementation 'com.linkedin.testbutler:test-butler-library:2.2.1'
    androidTestUtil 'com.linkedin.testbutler:test-butler-app:2.2.1'
```

You can also download the apk file manually from [Maven Central][mavencentral] if you prefer.

## Getting Started

Install the Test Butler apk on your emulator prior to running tests, then add the following to your test runner class:

```java

public class ExampleTestRunner extends AndroidJUnitRunner {
  @Override
  public void onStart() {
      TestButler.setup(getTargetContext());
      super.onStart();
  }

@Override
  public void finish(int resultCode, Bundle results) {
      TestButler.teardown(getTargetContext());
      super.finish(resultCode, results);
  }
}
```

To change settings on the device from your tests, just use the methods in the `TestButler` class. For example:

```java
@Before
public void setup() {
  TestButler.setLocationMode(Settings.Secure.LOCATION_MODE_OFF);
}

@Test
public void verifyBehaviorWithNoLocation() {
  // ...
}

@After
public void teardown() {
  TestButler.setLocationMode(Settings.Secure.LOCATION_MODE_HIGH_ACCURACY);
}
```

NB: See [gotchyas](#any-gotchas-to-look-out-for) above to see why `@BeforeClass` & `@AfterClass` aren't used here.

## Snapshots

You can use snapshot builds to test the latest unreleased changes. A new snapshot is published
after every merge to the main branch by the [Deploy Snapshot Github Action workflow](.github/workflows/deploy-snapshot.yml).

Just add the Sonatype snapshot repository to your Gradle scripts:
```gradle
repositories {
    maven {
        url "https://oss.sonatype.org/content/repositories/snapshots/"
    }
}
```

You can find the latest snapshot version to use in the [gradle.properties](gradle.properties) file.

[mavenbadge-svg]: https://maven-badges.herokuapp.com/maven-central/com.linkedin.testbutler/test-butler-app/badge.svg
[mavencentral]: https://search.maven.org/artifact/com.linkedin.testbutler/test-butler-app