How honeynet/droidbot works
Project Type and Purpose
• DroidBot is a full-stack, command-line driven testing framework for Android apps.
• It orchestrates devices/emulators via ADB, generates input events (random/scripted/ML-driven), monitors app state, and builds a UI Transition Graph (UTG).
File Structure
• Top-level entry points:
• start.py / droidbot/start.py – CLI launcher
• droidbot/app.py, droidbot/droidbot.py – core engine
• Adapters (droidbot/adapter): modular interfaces to external tools/protocols (ADB, minicap, logcat, JDWP, Accessibility, CV).
• Core modules:
• env_manager.py – sets up device environment (install APK, start services)
• input_manager.py / input_event.py – events dispatch
• input_policy*.py, rl/ – decision logic (random, scripted, RL)
• monitor.py / device_state.py – state capture (view hierarchy, screenshots, logs)
• utg.py – UTG construction
• Resources: built-in scripts, native libraries, APKs, styling for reports.
• Script samples: json templates for custom input sequences.
README Insights
• Dependencies: Python, Java/Android SDK, (optional) OpenCV
• Modes: random vs. GUI-model vs. CV mode vs. humanoid
• Outputs: logs, view hierarchy XML, screenshots, UTG graph
Main Components & Interactions
A. CLI Layer
• Component: droidbot CLI
• Responsibility: parse arguments, invoke core engine
B. Core Engine
• Modules: AppRunner (app.py), Environment Manager
• Flow:
1. env_manager installs APK on device/emulator
2. env_manager activates required services (accessibility, IME)
C. Adapter Layer
• Adapters: ADB, DroidBot IME, Minicap (screen capture), Logcat, JDWP, CV, Telnet, ProcessMonitor, etc.
• Role: send input events (input_manager → adapter), capture device state (monitor ← adapter)
D. Input Decision Layer
• Random Policy / Scripted Policy / RL Policy
• RL submodules: env (state↔observation), action, reward, config
E. Monitoring & State
• device_state: holds current UI tree, screenshot, logs
• monitor: continuously polls adapters for updates
F. UTG Builder & Reporter
• utg.py: builds nodes (UI states) and edges (events)
• resources/stylesheets + HTML templates: generate report
G. External Dependencies
• Android SDK (adb)
• Java VM (for APK instrumentation)
• (Optional) OpenCV for CV adapter
Architectural Patterns & Principles
• Modular adapter pattern: each device interaction protocol in its own class
• Pluggable input policies: easily swap random, script, RL
• Separation of concerns: environment setup, input generation, monitoring, reporting
Detail
• Modules and submodules (e.g., rl/env.py under “RL Policy”)
• Key resource directories (e.g., built-in scripts under resources/scripts)
• External integrations (Humanoid, optional OpenCV)