agent

AppFunctions Testing Agent

AppFunctions Testing Agent is a testing and debugging tool for Android AppFunctions. It allows developers to troubleshoot integration issues, manually invoke functions with deterministic input, and test functions using an LLM-based agent.

Prerequisites

• ADB: Ensure you have adb installed and in your PATH.
• Device/Emulator: A connected Android device or emulator with developer options enabled.

Building and Running

To build, install, and launch the app with elevated privileges (required for some AppFunctions APIs), use the run_privileged.sh script.

Usage

./run_privileged.sh [OPTIONS]

Options

• -b, --build: Force a rebuild of the app before installing.
• -r, --release: Use the release build type instead of debug.
• -f, --flavor FLAVOR: Specify the build flavor (standard or retail). Defaults to standard.
• -k, --api-key KEY: The Gemini API key (required for retail builds if not set elsewhere).
• -h, --help: Show the help message.

Examples

Standard Debug Build

./run_privileged.sh --build

Retail Debug Build with API Key

./run_privileged.sh --build --flavor retail --api-key YOUR_API_KEY

Testing

Always run relevant tests to verify your changes before committing.

Unit Tests

Run unit tests for all variants:

./gradlew test

Or for a specific variant:

./gradlew testStandardDebugUnitTest
./gradlew testRetailDebugUnitTest -PGEMINI_API_KEY=YOUR_API_KEY

Instrumented Tests

Run instrumented tests on a connected device:

./gradlew connectedAndroidTest

Note: Some instrumented tests require a Gemini API key. Pass it using -Pandroid.testInstrumentationRunnerArguments.gemini_api_key=YOUR_API_KEY.

Screenshot Tests

Verify UI changes with screenshot tests:

./gradlew updateDebugScreenshotTest

Releasing (Bundling)

To create a distributable test suite bundle, use the bundle.sh script. This script creates a zip file containing the APK, instructions, and a launch script.

Usage

./bundle.sh [OPTIONS]

Options

• -o, --output-dir DIR: Directory to save the bundle (default: current directory).
• -r, --release: Build the release version instead of debug.
• -f, --flavor FLAVOR: Specify the build flavor (standard or retail). Defaults to standard.
• -k, --api-key KEY: The Gemini API key (required for retail builds).

Examples

Bundle Standard Debug Version

./bundle.sh

Bundle Retail Debug Version

./bundle.sh --flavor retail --api-key YOUR_API_KEY