Skip to content

fix(ctrace): rename ctrace-ref to ref - #2637

Merged
thorstendb-ARM merged 2 commits into
mainfrom
fix/ctrace-ref-key
Oct 1, 2026
Merged

thorstendb-ARM merged 2 commits into
mainfrom
fix/ctrace-ref-key

Conversation

@thorstendb-ARM

Copy link
Copy Markdown
Contributor

Update ctrace to read ctrace-refs[].ref from *.ctrace-run.yml, matching the renamed field in Open-CMSIS-Pack/cmsis-toolbox#712. Files containing only the old ctrace-ref key now report a missing required ref field.

Fixes

Changes

  • Rename the YAML field, internal reference member and parameters, and diagnostic context to ref.
  • Update unit/integration fixtures and their integrity hashes; cover the new key and rejection of the old spelling.
  • Clarify in a separate documentation commit that ctrace: Support default file name scheme changes in spec (for TB channel) #2573 is complete while public channel selection and format/framing remain follow-up work.

Validation

  • macOS arm64 Debug build: ctrace, CtraceUnitTests, and CtraceIntegTests passed.
  • 434 unit tests and 51 integration tests passed.
  • All seven selected CTest entries passed, including fixture integrity and CLI smoke checks.
  • git diff --check passed.
  • Linux-only Babeltrace consumer validation is left to CI.

Checklist

  • 🤖 This change is covered by unit tests.
  • 🤹 Manual testing is not required for this rename; automated reader, decoder, and CLI tests passed.
  • 🛡️ Security impacts have been considered; existing required-field validation is retained.
  • 📖 Documentation updates are complete where required.
  • 🧠 Third-party dependency and TPIP updates are not required.

@codecov

codecov Bot commented Sep 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.69%. Comparing base (ce6763d) to head (862b48e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2637   +/-   ##
=======================================
  Coverage   78.69%   78.69%           
=======================================
  Files         199      199           
  Lines       32802    32802           
  Branches    19163    19165    +2     
=======================================
  Hits        25814    25814           
  Misses       4661     4661           
  Partials     2327     2327           
Flag Coverage Δ
ctrace-cov 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
tools/ctrace/src/control/TraceDirectoryJob.cpp 100.00% <100.00%> (ø)
tools/ctrace/src/tracerun/CtraceRunMeta.cpp 100.00% <100.00%> (ø)
tools/ctrace/src/tracerun/TraceRunConfig.h 100.00% <100.00%> (ø)
...ls/ctrace/src/tracerun/YmlTraceRunConfigReader.cpp 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

Copy link
Copy Markdown

Test Results

    6 files   -    39      6 suites   - 145   10s ⏱️ - 16m 2s
  485 tests  - 1 089    485 ✅  - 1 072   0 💤  - 17  0 ❌ ±0 
1 455 runs   - 2 315  1 438 ✅  - 2 264  17 💤  - 51  0 ❌ ±0 

Results for commit 862b48e. ± Comparison against base commit ce6763d.

This pull request removes 1089 tests.
AuxCmdTests ‑ MkdirCmdTest
AuxCmdTests ‑ RmdirCmdTest
AuxCmdTests ‑ TouchCmdTest
BuildSystemGeneratorTests ‑ GenAuditFile
BuildSystemGeneratorTests ‑ GenAuditFile_WithOut_Existing_Audit_File
BuildSystemGeneratorTests ‑ GenAuditFile_With_Existing_Audit_File
BuildSystemGeneratorTests ‑ GetString
BuildSystemGeneratorTests ‑ StrConv
BuildSystemGeneratorTests ‑ StrNorm
CBuildGCCTests ‑ Asm
…

@thorstendb-ARM
thorstendb-ARM merged commit 82c8946 into main Oct 1, 2026
23 checks passed
@thorstendb-ARM
thorstendb-ARM deleted the fix/ctrace-ref-key branch October 1, 2026 11:12
thorstendb-ARM added a commit that referenced this pull request Oct 1, 2026
Integrate the ctrace-ref to ref rename from #2637 while preserving
the central message catalog and compact/verbose diagnostic behavior.
Resolve fixture integrity hashes for renamed YAML and compact CSV.

Validation: macOS arm64 Release build; all seven ctrace CTest entries pass.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request]: ctrace - Rename ctrace-ref: to ref: and source: to index:

2 participants