mirror of
https://codeberg.org/reverse-skill-lab/apk-reverse
synced 2026-11-17 10:04:30 +08:00
Reconstruction pass: make the gates tell the truth, make the package self-contained, keep the one-hop symptom index
An external audit of this repository landed on four structural findings, and this pass is the
response to them. Everything below was re-measured on this tree before being acted on; two of the
audit's claims needed a correction of my own, and both corrections are noted in place.
**The gates were optimistic, and one of them did not read content at all.**
doctor.py the capability table was hard-coded (`repack + sign = bool(java) and python`), so a
machine with a JDK and no zipalign/apksigner was told it could re-sign; the script
inventory was a hand-written list of 28 against 51 files on disk, omitting the nine
most important scripts. It now scans the directory (`registered/checked = 52 / 52`,
unjudgeable entries counted as `unknown`, never skipped) and resolves capability as a
real requires-closure, reporting BLOCKED with the missing piece and an installable
next step. Measured: the old doctor reports `[OK] repack + sign` on a JDK-only PATH
where keytool, jarsigner, zipalign, apksigner and all eight smali jars are absent.
The report is allowed to look bad; that is the point.
check_commands.py (new)
anchor checks prove a section exists, never that a command runs. This parses each
script's argparse table with `ast` and checks every documented invocation against it.
146 commands / 41 interfaces, 0 drift. It caught `sig_probe.py --live --pkg`, which
does not exist -- the reference had been wrong since it was written.
check_routing.py (new)
the symptom index now has one home (`SKILL.md`, because symptom -> file must stay one
hop) and the inventory has another (`references/routing.md`). This gate proves the
mirror agrees, that every reference file is named, and that every script is named.
**so_constpatch.py was corrupting APKs it rebuilt.** The writer copied filename and timestamp onto a
fresh ZipInfo and recompressed the whole archive: 435-entry real package, `extra` lost on 205 entries,
`external_attr` rewritten on all 435, 132 untouched entries recompressed, and `resources.arsc` pushed
to an unaligned offset. Android's own `zipalign -c -v 4` fails the old output and passes the new one;
a 26-case fixture suite pins it, and `extractNativeLibs="false"` is now refused by default with a
pointer at `repack.py`. Fixing it exposed the same defect in `repack.py`, where `^lib/[^/]+\.so$`
cannot match `lib/arm64-v8a/*.so` -- so its alignment handling had never once fired on a real APK.
**The package was not self-contained.** 59 references pointed at the repository root, which `npx
skills add` does not install. They now converge on `references/evidence-summary.md` (capability,
conclusion, strength, evidence that ships) plus `evidence/` with the machine-readable companions: 8
references remain and each is explicitly labelled "repository root, not shipped". A drill in which
the new files were copied to an isolated directory and asked three questions answered all three.
**SKILL.md: 572 lines / 15,733 tokens -> 398 lines / ~10,900 tokens**, without losing the two things
that had to stay. The symptom index remains inline; the reference and script indexes moved to the
on-demand routing file. The freed budget went into making the rules *stronger*, not shorter: the
constraints section is now a table of thirteen non-negotiable constraints each paired with the check
that catches a violation, and the tooling obligations are instructions whose violation is a defect
(hedging language in SKILL.md: 1 line, down from a paragraph of hedged advice). Long references gained
a navigation head so a reader can decide from the top whether to load one.
**New: an executable test layer.** `tests/` (unit, CLI contract, no-device integration) plus
`pytest.ini`, `tests/run_tests.py`, a minimal CI job, and `evals/evals.json` written but never run --
stated as such in the file. 608 passed / 158 skipped / 25 xfailed. The 25 xfails are a work order, not
a pass: thirteen scripts report a missing input by exiting 1 instead of 2, seven let a traceback
escape, four treat `--help` as an error, and `preflight --json` lacks a `status` field. A regression
row for `dex_patch_bytes.py` reproduces a previous artifact byte-for-byte
(`67ae1e58e7a44777e5ac8f9f823ab21e…`) and additionally pins the four bytes that may move.
**Two real defects the new tests found in the tooling itself.** `check_repo.py` decoded subprocess
output with the locale encoding, so on a GBK console a script printing an em dash in its usage line
was reported as crashed; it now decodes UTF-8 explicitly. And a CLI contract test drove a *real
attached device* through `coldstart.py` -- logcat, screenshots, five orphan `adb logcat` processes --
which is fixed twice over: child processes run in a private temporary cwd, and the fifteen
device-bound scripts are never executed beyond `--help`/argument parsing.
**Quoting on the device side is now one implementation.** `devsh.su` escaped only double quotes, so
`;`, `$( )` and backticks in a caller-supplied value still reached the device shell while
`coldstart.Device.shell` quoted correctly. Both use `scripts/device_shell.py` now: POSIX single-quote
escaping, argv arrays by default, and identifier validation that refuses a malformed package, path or
component with exit 2 instead of a traceback. The integration test that used to pin the *defect* (it
asserted `su -c "…"` with `\"` escapes) now asserts the property, across five metacharacter payloads.
Gates: check_repo 0 problems (including the content-reading identity scan over git ls-files),
check_refs 0 dangling / 0 warning, check_routing coherent (53 symptom / 45 reference / 54 script rows),
check_budget 0 failure / 0 warning with the always-loaded body now measured in tokens rather than in
"narrative lines with the index excluded", check_commands 146 checked / 0 drift, pytest 608 passed.
Not done, and stated rather than implied: CI has never run on a runner; the evals have never been
executed; the 25 xfails are open; no device-side install/launch was performed in this pass.
This commit is contained in:
@@ -0,0 +1,174 @@
|
||||
"""Shared fixtures for the apk-reverse regression suite.
|
||||
|
||||
The rules this directory follows (they are the point of the directory, not a
|
||||
style preference):
|
||||
|
||||
* Nothing here may need a device, adb, frida, or the network. Routes that do
|
||||
are recorded as experiments in ``tests/benchmark.md``; their coverage gap is
|
||||
stated in ``docs/tool-verification/EXTENSION-test-harness.md`` rather than
|
||||
simulated into a green tick.
|
||||
* A missing fixture is ``pytest.skip`` with the reason on stdout, never a red
|
||||
test. ``tools/_work/bench/**`` is git-ignored, so CI legitimately does not
|
||||
have it and the regression hash test must degrade to a skip there.
|
||||
* This suite observes behaviour. It never edits anything under
|
||||
``skills/apk-reverse/scripts/`` -- a defect found here is written into the
|
||||
report as a work item, not patched in place.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import importlib.util
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
REPO_ROOT = Path(__file__).resolve().parents[1]
|
||||
SCRIPTS_DIR = REPO_ROOT / "skills" / "apk-reverse" / "scripts"
|
||||
FIXTURES_DIR = Path(__file__).resolve().parent / "fixtures"
|
||||
BENCH_L1L3 = REPO_ROOT / "tools" / "_work" / "bench" / "l1l3"
|
||||
|
||||
# Some scripts import their siblings by bare name (`from dexutil import ...`);
|
||||
# loading them as modules requires that directory on sys.path. The suite's own
|
||||
# directory is added too, so `from conftest import load_script` works regardless
|
||||
# of how pytest resolves the rootdir.
|
||||
for _p in (SCRIPTS_DIR, Path(__file__).resolve().parent):
|
||||
if str(_p) not in sys.path:
|
||||
sys.path.insert(0, str(_p))
|
||||
|
||||
PYTHON = sys.executable
|
||||
|
||||
# Children run with this as their working directory, never the scripts directory.
|
||||
# Measured reason: `coldstart.py` writes its capture under `--out` (default
|
||||
# `coldstart/`), so a contract test that ran it with the scripts directory as cwd
|
||||
# left a `skills/apk-reverse/scripts/coldstart/logcat.txt` behind. This suite must
|
||||
# not write anywhere near the shipped tree, and a script that defaults an output
|
||||
# path relative to cwd is exactly the case that catches a harness out.
|
||||
ISOLATED_CWD = tempfile.mkdtemp(prefix="apkrev-suite-cwd-")
|
||||
|
||||
# The regression marker established before this harness existed. It is a hash,
|
||||
# not a golden-file rewrite: scripts/dex_patch_bytes.py applied to the
|
||||
# l1l3 fixture must still reproduce the file that the recorded benchmark row
|
||||
# produced.
|
||||
L1L3_PATCHED_SHA256 = "67ae1e58e7a44777e5ac8f9f823ab21e"
|
||||
|
||||
_loaded: dict[str, object] = {}
|
||||
|
||||
|
||||
class ScriptResult:
|
||||
"""Result of running one script as a subprocess."""
|
||||
|
||||
def __init__(self, argv, returncode, stdout, stderr, timed_out=False):
|
||||
self.argv = argv
|
||||
self.returncode = returncode
|
||||
self.stdout = stdout
|
||||
self.stderr = stderr
|
||||
self.timed_out = timed_out
|
||||
|
||||
@property
|
||||
def output(self) -> str:
|
||||
return self.stdout + self.stderr
|
||||
|
||||
@property
|
||||
def has_traceback(self) -> bool:
|
||||
return "Traceback (most recent call last)" in self.output
|
||||
|
||||
def __repr__(self) -> str: # keeps assertion failures readable
|
||||
return "ScriptResult(argv=%r, rc=%r, timed_out=%r)" % (
|
||||
self.argv, self.returncode, self.timed_out)
|
||||
|
||||
|
||||
def script_path(name: str) -> Path:
|
||||
return SCRIPTS_DIR / name
|
||||
|
||||
|
||||
def all_scripts() -> list[str]:
|
||||
"""Every shipped script, sorted. Used to parameterise the CLI contract tests."""
|
||||
return sorted(p.name for p in SCRIPTS_DIR.glob("*.py"))
|
||||
|
||||
|
||||
def run_script(name, args=(), timeout=60, cwd=None, stdin=None, env=None):
|
||||
"""Run one shipped script in a subprocess and capture everything.
|
||||
|
||||
The child runs with ``PYTHONIOENCODING=utf-8`` so that a non-UTF-8 console
|
||||
(a Windows CP936 shell, a CI runner with C locale) does not turn a UTF-8
|
||||
print into a UnicodeEncodeError and change the exit code under test, and with
|
||||
an isolated working directory so that a script defaulting an output path
|
||||
relative to cwd cannot write into the shipped tree.
|
||||
"""
|
||||
argv = [PYTHON, str(script_path(name))] + [str(a) for a in args]
|
||||
child_env = dict(os.environ)
|
||||
child_env["PYTHONIOENCODING"] = "utf-8"
|
||||
child_env["PYTHONDONTWRITEBYTECODE"] = "1"
|
||||
if env:
|
||||
child_env.update(env)
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
argv, capture_output=True, text=True, encoding="utf-8", errors="replace",
|
||||
timeout=timeout, cwd=str(cwd or ISOLATED_CWD), input=stdin, env=child_env,
|
||||
)
|
||||
except subprocess.TimeoutExpired as exc:
|
||||
return ScriptResult(argv, None, _text(exc.stdout), _text(exc.stderr),
|
||||
timed_out=True)
|
||||
return ScriptResult(argv, proc.returncode, proc.stdout or "", proc.stderr or "")
|
||||
|
||||
|
||||
def _text(blob):
|
||||
if blob is None:
|
||||
return ""
|
||||
if isinstance(blob, bytes):
|
||||
return blob.decode("utf-8", "replace")
|
||||
return blob
|
||||
|
||||
|
||||
def load_script(name):
|
||||
"""Import a shipped script as a module, so pure functions can be unit-tested.
|
||||
|
||||
The module is registered under a namespaced name (``apkrev_<stem>``) because
|
||||
several scripts have siblings with the same basename in other trees.
|
||||
"""
|
||||
if name in _loaded:
|
||||
return _loaded[name]
|
||||
path = script_path(name)
|
||||
mod_name = "apkrev_" + path.stem
|
||||
spec = importlib.util.spec_from_file_location(mod_name, str(path))
|
||||
if spec is None or spec.loader is None:
|
||||
raise ImportError("cannot load %s" % path)
|
||||
module = importlib.util.module_from_spec(spec)
|
||||
sys.modules[mod_name] = module
|
||||
spec.loader.exec_module(module)
|
||||
_loaded[name] = module
|
||||
return module
|
||||
|
||||
|
||||
def require_path(path: Path, why: str):
|
||||
"""Skip with a printed reason when a git-ignored fixture is absent."""
|
||||
if not Path(path).exists():
|
||||
pytest.skip("fixture absent: %s (%s)" % (path, why))
|
||||
return Path(path)
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def repo_root():
|
||||
return REPO_ROOT
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def scripts_dir():
|
||||
return SCRIPTS_DIR
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def fixtures_dir():
|
||||
return FIXTURES_DIR
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def bench_l1l3():
|
||||
return require_path(
|
||||
BENCH_L1L3,
|
||||
"tools/_work/bench is git-ignored; re-download the l1l3 sample to run the "
|
||||
"dex_patch_bytes regression hash test",
|
||||
)
|
||||
Reference in New Issue
Block a user