Hosam-Eldin.mostafa/ecu-tests
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ecu-tests/docs/15_report_properties_cheatsheet.md
Hosam-Eldin Mostafa 582764d410 Mark legacy BabyLIN adapter as deprecated across code and docs 
The MUM (Melexis Universal Master) adapter is the current default; the
BabyLIN SDK adapter is retained only for backward compatibility with
existing rigs.

Code:
- Emit DeprecationWarning when BabyLinInterface is instantiated and
  when tests/conftest.py routes interface.type=='babylin' to it.
- Update module/class docstrings in ecu_framework/{__init__,config,
  lin/__init__,lin/babylin}.py to label BabyLIN-specific fields and
  paths as deprecated.

Config / scripts / pytest:
- pytest.ini: relabel the babylin marker as deprecated.
- config/{babylin.example,examples,test_config}.yaml: add deprecation
  banners and field comments.
- scripts/99-babylin.rules and scripts/pi_install.sh: annotate the
  udev-rule install block as legacy-only.

Documentation:
- TESTING_FRAMEWORK_GUIDE.md, docs/08_babylin_internals.md, and
  vendor/README.md: prepend explicit "DEPRECATED" banners.
- docs/{README,01,02,04,05,07,09,10,12,13,14,15,18,DEVELOPER_COMMIT_
  GUIDE}.md: relabel "legacy" to "deprecated" where babylin is
  mentioned, present MUM as the primary path, and steer new work
  toward the MUM examples.

No tests, configs, or modules were deleted; existing BabyLIN setups
keep working but now produce a clear DeprecationWarning at runtime.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-07 17:32:24 +02:00

1.7 KiB
Raw Blame History

Report properties cheatsheet (record_property / rp)

Use these standardized keys when calling record_property("key", value) or the rp("key", value) helper. This keeps reports consistent and easy to scan across suites.

General

  • test_phase: setup | call | teardown (if you want to distinguish)
  • environment: local | ci | lab
  • config_source: defaults | file | env | env+overrides (already used in unit tests)

LIN (common)

  • lin_type: mock | mum | babylin (babylin is deprecated)
  • tx_id: hex string or int (e.g., "0x12")
  • tx_data: list of ints (bytes)
  • rx_present: bool
  • rx_id: hex string or int
  • rx_data: list of ints
  • timeout_s: float seconds

BabyLIN specifics (DEPRECATED)

  • sdf_path: string
  • schedule_nr: int
  • receive_result: frame | timeout
  • wrapper: mock_bl | _MockBytesOnly | real (for future)

Mock-specific

  • expected_data: list of ints

Power supply (PSU)

  • psu_idn: string from *IDN?
  • output_status_before: bool
  • output_status_after: bool
  • set_voltage: float (V)
  • set_current: float (A)
  • measured_voltage: float (V)
  • measured_current: float (A)
  • psu_port: e.g., COM4 or /dev/ttyUSB0 (if helpful)

Flashing

  • hex_path: string
  • sent_count: int (frames sent by stub/mock)
  • flash_result: ok | fail (for future real flashing)

Configuration highlights

  • interface_type: mock | mum | babylin (babylin is deprecated)
  • interface_channel: int
  • flash_enabled: bool

Tips

  • Prefer simple, lowercase snake_case keys
  • Use lists for byte arrays so they render clearly in JSON and HTML
  • Log both expected and actual when asserting patterns (e.g., deterministic responses)
  • Keep units in the key name when helpful (voltage/current include V/A in the name)