Skip to content

Commit

Permalink
Cleaning up the readme for tests
Browse files Browse the repository at this point in the history
  • Loading branch information
LikeTheSalad committed Oct 5, 2023
1 parent 9c5c10c commit 6967837
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions byte-buddy-gradle-plugin/android-plugin-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,17 @@ How to run the tests
### Environment setup

* The environment var `ANDROID_HOME` must be set and pointing to the Android SDK dir.
* Java 11 is required, more info [here](https://developer.android.com/studio/releases/gradle-plugin#jdk-11).
* A Gradle wrapper version of 7.2+ is required in order to be compatible with the Android
Gradle plugin used in this project, more info on it
[here](https://developer.android.com/studio/releases/gradle-plugin#updating-gradle).
* There must be an Android device connected through [ADB](https://developer.android.com/studio/command-line/adb), either
* Java 11 is required, more
info [here](https://developer.android.com/studio/releases/gradle-plugin#jdk-11).
* There must be an Android device connected
through [ADB](https://developer.android.com/studio/command-line/adb), either
a running Emulator or a real device plugged in with
[USB debugging](https://developer.android.com/studio/command-line/adb#Enabling) enabled.
* Set environment var `ANDROID_TEST` to `"true"`.

This module is disabled by default to avoid issues with the Android Gradle Plugin and Intellij IDEA
version incompatibility, which causes the project analysis to fail when opened with said IDE, though it doesn't
cause any issues when running it from the command line. That's why the environment var `ANDROID_TEST` is needed
in order to switch this module on by setting it to `"true"`.

### Steps

* Build Byte Buddy alongside the Byte Buddy Gradle plugin.
* Run the following command from the Byte Buddy Gradle plugin
* Located in the root dir of this test project, run the following command:
dir: `./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.class=net.bytebuddy.android.test.ByteBuddyInstrumentedTest`
* Optionally, you can also open up this test project with Android Studio, open up the test class and
run it through the IDE.

0 comments on commit 6967837

Please sign in to comment.