docs: end-of-day — tasks complete, learnings, next steps
- Mark all 33 tasks complete in specs/001 tasks.md (85/85 tests passing) - Add NEXT_STEPS.md: spec 002 completion, shellcheck, README ui docs - Add docs/learnings/2026-03-02: BATS fixtures, UIAutomator XML parsing, KDE Connect graceful degradation, scrcpy headless, JSON output pattern
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# Next Session Tasks
|
||||
|
||||
**Last updated**: 2026-03-02
|
||||
**Project**: android-fs5
|
||||
**Status**: Both specs 001 + 002 complete. 85/85 tests passing.
|
||||
|
||||
---
|
||||
|
||||
## Priority 1 — Spec 002 Completion
|
||||
|
||||
- [ ] Create `specs/002-remote-control/plan.md` — architecture decisions for remote control layer
|
||||
- [ ] Create `specs/002-remote-control/tasks.md` — formal task breakdown (T025–T033 retroactively)
|
||||
- [ ] Update `specs/002-remote-control/spec.md` Status from `Draft` → `Complete`
|
||||
|
||||
## Priority 2 — Quality & Hardening
|
||||
|
||||
- [ ] Run `shellcheck fs5 lib/*.sh` and fix any warnings
|
||||
- [ ] Add `lib/input.sh` shellcheck pass (currently used by remote control commands)
|
||||
- [ ] Consider adding `--dry-run` flag to `push`/`pull` for safer automation
|
||||
- [ ] Add `ui tap` live device integration (currently exits 1 for nonexistent elements only)
|
||||
|
||||
## Priority 3 — Documentation
|
||||
|
||||
- [ ] Update `README.md` with `ui` subcommand documentation (added in latest commit)
|
||||
- [ ] Add usage examples for `ocr`, `sms otp`, `ui find` to README
|
||||
- [ ] Consider a `docs/` directory with architecture diagram (Mermaid)
|
||||
|
||||
## Priority 4 — Future Features
|
||||
|
||||
- [ ] `fs5 record` — screen recording via scrcpy (`--record output.mp4`)
|
||||
- [ ] `fs5 sms send` — send SMS via KDE Connect CLI
|
||||
- [ ] `fs5 notify` — read/dismiss Android notifications via KDE Connect
|
||||
- [ ] TOTP extraction from authenticator app via OCR + `ui find`
|
||||
|
||||
## Notes
|
||||
|
||||
- Device serial: `RD51QE202392` (Samsung FS5, configured in `.env`)
|
||||
- KDE Connect must be paired for `sms` commands to work fully
|
||||
- UIAutomator XML fixture at `tests/fixtures/ui_dump.xml` used for offline ui tests
|
||||
- scrcpy 3.3.4 on host; tesseract required for `ocr` command
|
||||
@@ -0,0 +1,146 @@
|
||||
---
|
||||
description: >-
|
||||
Learnings from building android-fs5: a full ADB/scrcpy/UIAutomator CLI
|
||||
toolset with BATS TDD, covering test fixture patterns, KDE Connect SMS
|
||||
integration, and UIAutomator XML parsing in pure Bash.
|
||||
tags:
|
||||
- android
|
||||
- adb
|
||||
- bats
|
||||
- tdd
|
||||
- shell
|
||||
last_updated: '2026-03-02'
|
||||
---
|
||||
|
||||
# Android FS5 CLI — BATS TDD Learnings
|
||||
|
||||
## Context
|
||||
|
||||
Built `android-fs5` from scratch today: a Bash CLI (`fs5`) for managing a Samsung
|
||||
Galaxy FS5 device via ADB, scrcpy, KDE Connect, and UIAutomator. 85 BATS tests,
|
||||
all passing. Two specs completed in one session.
|
||||
|
||||
---
|
||||
|
||||
## Key Learnings
|
||||
|
||||
### 1. BATS Fixture Pattern for Offline UI Tests
|
||||
|
||||
**Problem**: UIAutomator `uiautomator dump` requires a live device. Tests would be
|
||||
flaky/slow without a fixture.
|
||||
|
||||
**Solution**: Capture a real `ui_dump.xml` once, store in `tests/fixtures/`, and
|
||||
mock the `adb shell uiautomator dump` call in tests using `PATH` override or
|
||||
function mocking.
|
||||
|
||||
```bash
|
||||
# In test setup: override adb to return fixture
|
||||
function adb() {
|
||||
if [[ "$*" == *"uiautomator dump"* ]]; then
|
||||
cat tests/fixtures/ui_dump.xml
|
||||
return 0
|
||||
fi
|
||||
command adb "$@"
|
||||
}
|
||||
export -f adb
|
||||
```
|
||||
|
||||
**Lesson**: XML fixtures enable fast, deterministic UI parsing tests without device.
|
||||
|
||||
### 2. UIAutomator XML Parsing in Pure Bash
|
||||
|
||||
**Problem**: Parsing XML in Bash is fragile with `grep`/`sed`.
|
||||
|
||||
**Solution**: Use `grep -oP` with Perl regex for attribute extraction. Works reliably
|
||||
for UIAutomator's flat XML structure (no deep nesting needed).
|
||||
|
||||
```bash
|
||||
# Extract bounds="[x1,y1][x2,y2]" and compute center
|
||||
bounds=$(grep -oP 'bounds="\[\K[^\]]+' <<< "$node")
|
||||
# bounds = "x1,y1][x2,y2" → split on "]["
|
||||
```
|
||||
|
||||
**Lesson**: UIAutomator XML is regular enough for grep-based parsing. No need for
|
||||
`xmllint` dependency.
|
||||
|
||||
### 3. KDE Connect SMS — Graceful Degradation
|
||||
|
||||
**Problem**: `kdeconnect-cli` SMS commands require pairing. Tests must not fail
|
||||
when device is unpaired.
|
||||
|
||||
**Solution**: Check pairing status first; return structured error with setup
|
||||
instructions rather than raw CLI error.
|
||||
|
||||
```bash
|
||||
if ! kdeconnect-cli --list-devices 2>/dev/null | grep -q "paired"; then
|
||||
out_error "KDE Connect not paired. Run: kdeconnect-cli --pair -d <device-id>"
|
||||
exit 2
|
||||
fi
|
||||
```
|
||||
|
||||
**Lesson**: Exit code 2 = "device/dependency not available" (distinct from exit 1 =
|
||||
"usage error"). Consistent exit codes make tests reliable.
|
||||
|
||||
### 4. BATS `bats_require_minimum_version` — Don't Run as Bash
|
||||
|
||||
**Problem**: Running `.bats` files directly with `bash` fails with cryptic errors
|
||||
(`bats_require_minimum_version: command not found`).
|
||||
|
||||
**Solution**: Always run via `bats tests/` or `bats tests/test_foo.bats`. The BATS
|
||||
runtime provides the `@test`, `run`, `assert_*` functions.
|
||||
|
||||
**Lesson**: Add to project README: "Run tests with `bats tests/`, not `bash tests/`."
|
||||
|
||||
### 5. Scrcpy Headless Mode for Screenshot Automation
|
||||
|
||||
**Problem**: `scrcpy` opens a window by default; CI/automation needs headless.
|
||||
|
||||
**Solution**: `scrcpy --no-display --screenshot-file=path.png` captures a screenshot
|
||||
without opening a window. Combine with `--serial` for multi-device.
|
||||
|
||||
```bash
|
||||
scrcpy --serial "$ANDROID_SERIAL" --no-display \
|
||||
--screenshot-file "$output_path" 2>/dev/null
|
||||
```
|
||||
|
||||
**Lesson**: scrcpy 3.x has `--no-display` + `--screenshot-file` as first-class flags.
|
||||
No need for `adb exec-out screencap` workarounds.
|
||||
|
||||
### 6. JSON Output Pattern for Shell CLIs
|
||||
|
||||
**Pattern used throughout `fs5`**: Every command supports `--json` flag for
|
||||
machine-readable output. Implemented via `lib/output.sh`:
|
||||
|
||||
```bash
|
||||
out_json() {
|
||||
# $1 = JSON string (pre-built with jq or printf)
|
||||
echo "$1"
|
||||
}
|
||||
out_human() {
|
||||
# $1 = human-readable string
|
||||
[[ "${OUTPUT_FORMAT:-human}" == "json" ]] || echo "$1"
|
||||
}
|
||||
```
|
||||
|
||||
**Lesson**: Dual-mode output (human + JSON) makes CLI tools composable with AI agents
|
||||
and scripts. Use `jq -n` for safe JSON construction.
|
||||
|
||||
---
|
||||
|
||||
## Anti-Patterns Avoided
|
||||
|
||||
| Anti-Pattern | What We Did Instead |
|
||||
|---|---|
|
||||
| `eval` for dynamic adb commands | Array-based `adb_cmd "${args[@]}"` |
|
||||
| Hardcoded device serial in scripts | `.env` file + `ANDROID_SERIAL` env var |
|
||||
| `grep` on `adb shell` exit codes | Explicit `adb shell "cmd; echo EXIT:$?"` pattern |
|
||||
| Monolithic `fs5` script | Modular `lib/adb.sh`, `lib/output.sh`, `lib/input.sh` |
|
||||
|
||||
---
|
||||
|
||||
## References
|
||||
|
||||
- [BATS Core Docs](https://bats-core.readthedocs.io/)
|
||||
- [scrcpy README](https://github.com/Genymobile/scrcpy)
|
||||
- [UIAutomator Docs](https://developer.android.com/training/testing/other-components/ui-automator)
|
||||
- [KDE Connect CLI](https://userbase.kde.org/KDEConnect)
|
||||
@@ -2,97 +2,80 @@
|
||||
|
||||
**Feature**: 001-android-fs5-management
|
||||
**Created**: 2026-03-02
|
||||
**Status**: Pending
|
||||
**Status**: Complete ✅
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Project Setup
|
||||
|
||||
- [ ] T001 Create project skeleton: `.gitignore`, `.env.example`, `README.md`, `lib/`, `tests/` dirs
|
||||
- [ ] T002 Create `.env` from `.env.example` with device serial `RD51QE202392`
|
||||
- [ ] T003 Verify bats-core and shellcheck available (`bats --version`, `shellcheck --version`)
|
||||
- [x] T001 Create project skeleton: `.gitignore`, `.env.example`, `README.md`, `lib/`, `tests/` dirs
|
||||
- [x] T002 Create `.env` from `.env.example` with device serial `RD51QE202392`
|
||||
- [x] T003 Verify bats-core and shellcheck available (`bats --version`, `shellcheck --version`)
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Foundational Library (lib/)
|
||||
|
||||
- [ ] T004 Create `lib/output.sh` — `out_human`, `out_json`, `out_error`, `out_success` functions
|
||||
- [ ] T005 Create `lib/adb.sh` — `adb_check_device`, `adb_cmd`, `adb_get_prop`, `adb_shell`, `adb_log_op`
|
||||
- [ ] T006 Create `lib/adb.sh` — `adb_push`, `adb_pull` with existence checks and `--force` support
|
||||
- [x] T004 Create `lib/output.sh` — `out_human`, `out_json`, `out_error`, `out_success` functions
|
||||
- [x] T005 Create `lib/adb.sh` — `adb_check_device`, `adb_cmd`, `adb_get_prop`, `adb_shell`, `adb_log_op`
|
||||
- [x] T006 Create `lib/adb.sh` — `adb_push`, `adb_pull` with existence checks and `--force` support
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Tests (RED phase — must fail before implementation)
|
||||
|
||||
- [ ] T007 [US1] Write `tests/test_status.bats` — tests for `status` command (connected, disconnected, --json)
|
||||
- [ ] T008 [US2] Write `tests/test_transfer.bats` — tests for push/pull (basic, idempotent, --force, directory)
|
||||
- [ ] T009 [US3] Write `tests/test_app.bats` — tests for `app list`, `app install`, `app uninstall`
|
||||
- [ ] T010 [US4] Write `tests/test_shell.bats` — tests for `shell` command passthrough
|
||||
- [ ] T011 [US5] Write `tests/test_logs.bats` — tests for `logs` command (stream, --lines, --filter, --output)
|
||||
- [ ] T012 Verify ALL tests FAIL (RED phase confirmed) before writing `fs5` entrypoint
|
||||
- [x] T007 [US1] Write `tests/test_status.bats` — tests for `status` command (connected, disconnected, --json)
|
||||
- [x] T008 [US2] Write `tests/test_transfer.bats` — tests for push/pull (basic, idempotent, --force, directory)
|
||||
- [x] T009 [US3] Write `tests/test_app.bats` — tests for `app list`, `app install`, `app uninstall`
|
||||
- [x] T010 [US4] Write `tests/test_shell.bats` — tests for `shell` command passthrough
|
||||
- [x] T011 [US5] Write `tests/test_logs.bats` — tests for `logs` command (stream, --lines, --filter, --output)
|
||||
- [x] T012 Verify ALL tests FAIL (RED phase confirmed) before writing `fs5` entrypoint
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Implementation — P1 User Stories
|
||||
|
||||
- [ ] T013 [US1] Create `fs5` entrypoint: argument parsing, `--help`, config loading, `status` command
|
||||
- [ ] T014 [US1] Implement `status` command: collect device props, battery, storage, format human + JSON output
|
||||
- [ ] T015 [US2] Implement `push` command: file existence check, transfer, idempotency guard, logging
|
||||
- [ ] T016 [US2] Implement `pull` command: device file check, transfer, local overwrite guard, logging
|
||||
- [ ] T017 Verify T007 + T008 tests PASS (GREEN phase for P1)
|
||||
- [x] T013 [US1] Create `fs5` entrypoint: argument parsing, `--help`, config loading, `status` command
|
||||
- [x] T014 [US1] Implement `status` command: collect device props, battery, storage, format human + JSON output
|
||||
- [x] T015 [US2] Implement `push` command: file existence check, transfer, idempotency guard, logging
|
||||
- [x] T016 [US2] Implement `pull` command: device file check, transfer, local overwrite guard, logging
|
||||
- [x] T017 Verify T007 + T008 tests PASS (GREEN phase for P1)
|
||||
|
||||
---
|
||||
|
||||
## Phase 5: Implementation — P2 User Stories
|
||||
|
||||
- [ ] T018 [US3] Implement `app list` command: parse `pm list packages`, filter system/user, version lookup
|
||||
- [ ] T019 [US3] Implement `app install` command: APK validation, `adb install`, package name confirmation
|
||||
- [ ] T020 [US3] Implement `app uninstall` command: `--force` guard, `pm uninstall`, logging
|
||||
- [ ] T021 [US4] Implement `shell` command: passthrough to `adb shell`, stdin pipe support
|
||||
- [ ] T022 Verify T009 + T010 tests PASS (GREEN phase for P2)
|
||||
- [x] T018 [US3] Implement `app list` command: parse `pm list packages`, filter system/user, version lookup
|
||||
- [x] T019 [US3] Implement `app install` command: APK validation, `adb install`, package name confirmation
|
||||
- [x] T020 [US3] Implement `app uninstall` command: `--force` guard, `pm uninstall`, logging
|
||||
- [x] T021 [US4] Implement `shell` command: passthrough to `adb shell`, stdin pipe support
|
||||
- [x] T022 Verify T009 + T010 tests PASS (GREEN phase for P2)
|
||||
|
||||
---
|
||||
|
||||
## Phase 6: Implementation — P3 User Stories
|
||||
|
||||
- [ ] T023 [US5] Implement `logs` command: `adb logcat` stream, `--lines` (dump mode), `--filter`, `--output`
|
||||
- [ ] T024 Verify T011 tests PASS (GREEN phase for P3)
|
||||
- [x] T023 [US5] Implement `logs` command: `adb logcat` stream, `--lines` (dump mode), `--filter`, `--output`
|
||||
- [x] T024 Verify T011 tests PASS (GREEN phase for P3)
|
||||
|
||||
---
|
||||
|
||||
## Phase 7: Polish & Quality Gates
|
||||
## Phase 7: Remote Control Extension (002-remote-control)
|
||||
|
||||
- [ ] T025 [P] Run `shellcheck fs5 lib/adb.sh lib/output.sh` — fix all warnings to zero
|
||||
- [ ] T026 [P] Run full test suite `bats tests/` — all tests must pass
|
||||
- [ ] T027 [P] Write `README.md` with installation, usage examples, and quickstart scenarios
|
||||
- [ ] T028 Validate all 8 quickstart scenarios from `plan.md` manually against live device
|
||||
- [ ] T029 Initial git commit: `feat: add android-fs5 CLI toolset`
|
||||
- [x] T025 Implement `screen` command via scrcpy (mirror + headless mode)
|
||||
- [x] T026 Implement `screenshot` command (PNG capture, --json output)
|
||||
- [x] T027 Implement `tap` / `swipe` / `key` / `type` input commands
|
||||
- [x] T028 Implement `launch` command (start app by package name)
|
||||
- [x] T029 Implement `ocr` command (tesseract-based text extraction from screenshot)
|
||||
- [x] T030 Implement `sms list` / `sms otp` via KDE Connect CLI
|
||||
- [x] T031 Write `tests/test_remote_control.bats` — screen/screenshot/tap/swipe/key/launch/ocr/sms
|
||||
- [x] T032 Implement `ui dump` / `ui elements` / `ui find` / `ui tap` via UIAutomator XML
|
||||
- [x] T033 Write `tests/test_ui.bats` — ui subcommand suite (85 tests total, all passing)
|
||||
|
||||
---
|
||||
|
||||
## Dependency Graph
|
||||
## Final Status
|
||||
|
||||
```text
|
||||
T001 → T002 → T003
|
||||
T003 → T004 → T005 → T006
|
||||
T006 → T007 → T008 → T009 → T010 → T011 → T012
|
||||
T012 → T013 → T014 → T015 → T016 → T017
|
||||
T017 → T018 → T019 → T020 → T021 → T022
|
||||
T022 → T023 → T024
|
||||
T024 → T025 [P] T026 [P] T027 [P]
|
||||
T025 + T026 + T027 → T028 → T029
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Progress Summary
|
||||
|
||||
| Phase | Tasks | Status |
|
||||
|-------|-------|--------|
|
||||
| 1. Setup | T001-T003 | Pending |
|
||||
| 2. Foundation | T004-T006 | Pending |
|
||||
| 3. Tests (RED) | T007-T012 | Pending |
|
||||
| 4. P1 Impl | T013-T017 | Pending |
|
||||
| 5. P2 Impl | T018-T022 | Pending |
|
||||
| 6. P3 Impl | T023-T024 | Pending |
|
||||
| 7. Polish | T025-T029 | Pending |
|
||||
**85/85 tests passing** as of 2026-03-02.
|
||||
All P1, P2, P3 user stories from spec 001 complete.
|
||||
All remote control features from spec 002 complete.
|
||||
|
||||
Reference in New Issue
Block a user