ADR 0004: A flat tradelocker_bot package next to the legacy entrypoint¶
- Status: Accepted
- Date: 2026-11-11
Context¶
Migrated code needs a home that both the legacy entrypoint
(main_without_ssl.py) and the tests can import. The image copies the whole
repository into /app and runs python main_without_ssl.py from there,
without installing the project as a package.
Decision¶
New code lives in a top-level tradelocker_bot/ package, split into layers:
domain/ now, with application/ and adapters/ as later roadmap steps
create them. A fitness test (tests/test_layer_dependencies.py, which now covers each inner layer) allows the
domain to import only its own package and an explicitly named set of pure
standard-library modules, and forbids the builtins that do I/O or load code
(open, print, input, exit, eval, __import__, globals and
similar), as a guard against accidents rather than a sandbox. The import
check is a true allow-list, so a new third-party package, layer or impure
stdlib module fails CI without anyone having to foresee it.
Consequences¶
-
The image needs no change:
/appis the working directory, sotradelocker_botimports the same way the legacylibs/does.Update (step 5, ADR 0010):
libs/is gone. Its modules moved intotradelocker_bot/adapters/, and the composition roottradelocker_bot/composition_root.pysits next to the layers as the package's outermost module. - CI smoke-runs the entrypoint inside the built image. The tests run from the repository root on the runner's Python, so they cannot detect a package that is missing from, or broken in, the image.
Alternatives considered¶
- import-linter forbidden contract. Rejected for the domain rule: a forbidden contract lists packages to block, so any library not on the list passes. Reconsider import-linter's layers contract once the application and adapter layers exist.
-
src/layout. Rejected for now: it only works once the image installs the project (pip install .). That changes the image build and the frozen container contract in a step that is meant to be structure-only. Revisit when the entrypoint is replaced (roadmap step 5).Update (step 5, ADR 0010): still deferred. Step 5 kept
main_without_ssl.pyas the container command, because the frozen contract names it, so the image still runs the script from/appand gains nothing from an installed package.