Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 4.13 KB

README.md

File metadata and controls

100 lines (75 loc) · 4.13 KB
Raw

CulebraTester2-public

CulebraTester: Snaky Android Testing

Welcome to CulebraTester2.

Android testing can be complicated, time-consuming, and tedious. What if it didn’t have to be?

CulebraTester2 provides an API that facilitates the creation of tests and test automation tools and UI's. Not sure what we mean?

Continue reading and see how you can run this early preview.

⚠️ Warning
This is an alpha version of CulebraTester2 expect changes

How to run CulebraTester2 ?

  1. Have your device or emulator connected to adb
  2. Install APKs
    1. Download prebuilt app and instrumentation APKs from Github Actions
    2. or build from source and install
      1. Copy local.properties.SAMPLE to local.properties and adapt the values to your environment
      2. ./culebratester2 install (or run ./gradlew installDebug installDebugAndroidTest)
  3. Start server bash <(curl -sL https://git.io/JT5nc) start-server
    1. alternatively if you checked out the source you can run ./culebratester2 start-server instead
  4. Open http://localhost:9987/ with a browser or curl
  5. You should see CulebraTester2: Go to http://localhost:<port>/help for usage details.
  6. If the previous request worked, you can try something more ambitious like http://localhost:9987/v2/uiDevice/screenshot
  7. Take a look at CulebraTester2 API or its spec openapi.yaml for more info
  8. When you are done testing, navigating to http://localhost:9987/quit will terminate the server

Want to learn more?

Detailed information can be found in the CulebraTester2 wiki wiki

AndroidViewClient

CulebraTester2 is the new backend for AndroidViewClient/culebra.

It can be used similarly to other backends with the following command options

-h, --use-uiautomator-helper     use UiAutomatorHelper Android app

for example

$ dump -ah emulator-5554 | jq
⚠️ CulebraTester2 server should have been started and port redirected.
{
  "id": "hierarchy",
  "text": "Window Hierarchy",
  "timestamp": "2020-10-12T02:18:45.639Z",
  "children": [
    {
      "id": 0,
      "parent": -1,
      "text": "",
      "package": "com.android.systemui",
      "checkable": false,
      "clickable": false,
      "index": 0,
      "content_description": "",
      "focusable": false,
    ...

or set useuiautomatorhelper=True when you create a ViewClient object.

culebra

CulebraTester2 is a new implementation in Kotlin of culebra.

A Python client implementation can be found at CulebraTester2-client.

This previous version API specification can be found at here.

Example

The script simple-calculator-test shows a rudimentary usage of this API by

  • starting Calculator activity
  • finding one of the digit buttons (can be specified or a random one is selected)
  • clicking on that button

UI

We mentioned CulebraTester2 provides an API that facilitates the creation of test automation tools and UIs.

Here we are, this is in the making.

CulebraTester2-ui preview

Communication

Found issues? Use https://github.com/dtmilano/CulebraTester2-public/issues

Have questions? Use https://stackoverflow.com/questions/tagged/androidviewclient.