Skip to content

test(amdsmi): Update API summary script - #10998

Merged
marifamd merged 1 commit into
developfrom
users/josnarlo/update_api_summary
Sep 2, 2026
Merged

marifamd merged 1 commit into
developfrom
users/josnarlo/update_api_summary

Conversation

@amd-josnarlo

Copy link
Copy Markdown
Contributor

Motivation

The API coverage report folded functional tests into the integration bucket, so the C and Python functional suites were invisible in the summary — and the table's Func column was in fact reporting integration counts under a functional heading. This adds first-class functional categories for both languages, so the report mirrors how the tests are actually organized (unit/, functional/, integration/).

Technical Details

Coverage report (tests/api_summary.py):

  • Expand the test taxonomy from four categories to six by adding c_func_test and py_func_test
  • Rename c_integration/py_integration to c_intg_test/py_intg_test for a consistent {lang}_{level}_test scheme across all six categories
  • Add --c_func_test / --py_func_test, and align every default log filename with its category (_c_unit_test.log, _c_func_test.log, _c_intg_test.log, _py_unit_test.log, _py_func_test.log, _py_intg_test.log)
  • Add a Func column to the summary table and relabel the previous Func column to Intg, which is what it was already counting
  • Widen the CSV from six columns to eight, one per category
  • Remove the unused header string
  • Replace the check-then-act output-directory creation with mkdir(parents=True, exist_ok=True)

Docs (tests/README.md):

  • Document all six log files, including the three amdsmitst invocations (*Unit*.*, *Functional*.*, *Integration*.*) that produce the C logs
  • Refresh the option list, CSV example and summary-table example to match current output
  • Correct the --output example to --output_dir and fix the documented --output_dir default

Issue Tracking

JIRA ID : AILITOOLS-311

Test Plan

Run C++ and Python unit, integration and functional tests and capture output
Run api_summary.py script against testing output

Test Result

API summary report generated properly

@amd-josnarlo
amd-josnarlo requested a review from a team August 31, 2026 21:19
@therock-pr-bot

Copy link
Copy Markdown

✅ All Policy Checks Passed

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ⚠️ Warning Error: Source/code files changed without an accompanying unit test.
Expected: add at least one test file named like test_<name>.py / test_<name>.cpp (or <name>_test.*).
Current: code file(s) changed: projects/amdsmi/tests/api_summary.py; no test file found
🚫 Draft PR 🔜 To Be Enabled —
🚩 Feature Flag 🔜 To Be Enabled —
📊 Code Coverage 🔜 To Be Enabled —

🎉 All policy checks passed!

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

Signed-off-by: josnarlo <joseph.narlo@amd.com>
@amd-josnarlo
amd-josnarlo force-pushed the users/josnarlo/update_api_summary branch from 6a6cf6d to 96520dd Compare September 1, 2026 14:04
@marifamd marifamd changed the title test(amdsmi) [AILITOOLS-311] Update API summary script test(amdsmi): Update API summary script Sep 2, 2026
@marifamd
marifamd merged commit a0a6cbe into develop Sep 2, 2026
55 of 58 checks passed
@marifamd
marifamd deleted the users/josnarlo/update_api_summary branch September 2, 2026 17:32
@systems-assistant

Copy link
Copy Markdown
Contributor

TheRock Submodule Bump Activity

Newest first

marifamd added a commit that referenced this pull request Sep 24, 2026
## Motivation

`amdsmi-license-headers` is `pass_filenames: false`, so it rescans the
whole tree. Once a violation lands on `develop`, every later PR goes 
red instead of the merge that caused it. #10010 merged on a
stale-green formatting run and reddened #10973 and #10998 until #8561
fixed the headers. Third time against this hook (#10402, #10845,
#8561), each fixed reactively.

## Technical Details

`.github/workflows/lstt-formatting.yml`:

- `push` trigger on `develop`, same path filter as `pull_request`, so a
whole-tree hook runs on the merge commit.
- `--from-ref` is event-aware via `FROM_REF`: `github.event.before` on
push, base branch on PR. PR behavior unchanged.
- `cancel-in-progress` limited to `pull_request`, so consecutive merges
each keep their verdict.

Detection at merge, not prevention. Prevention is "Require branches to
be up to date before merging". `develop`'s ruleset has
`required_status_checks` with 
`strict_required_status_checks_policy: false`, so a PR can merge on a
check that last ran against an older base — which is how the stale-green merge
happened.


Signed-off-by: Maisam Arif <Maisam.Arif@amd.com>
anujshuk-amd pushed a commit that referenced this pull request Sep 25, 2026
## Motivation

`amdsmi-license-headers` is `pass_filenames: false`, so it rescans the
whole tree. Once a violation lands on `develop`, every later PR goes 
red instead of the merge that caused it. #10010 merged on a
stale-green formatting run and reddened #10973 and #10998 until #8561
fixed the headers. Third time against this hook (#10402, #10845,
#8561), each fixed reactively.

## Technical Details

`.github/workflows/lstt-formatting.yml`:

- `push` trigger on `develop`, same path filter as `pull_request`, so a
whole-tree hook runs on the merge commit.
- `--from-ref` is event-aware via `FROM_REF`: `github.event.before` on
push, base branch on PR. PR behavior unchanged.
- `cancel-in-progress` limited to `pull_request`, so consecutive merges
each keep their verdict.

Detection at merge, not prevention. Prevention is "Require branches to
be up to date before merging". `develop`'s ruleset has
`required_status_checks` with 
`strict_required_status_checks_policy: false`, so a PR can merge on a
check that last ran against an older base — which is how the stale-green merge
happened.


Signed-off-by: Maisam Arif <Maisam.Arif@amd.com>
dgaliffiAMD pushed a commit that referenced this pull request Sep 25, 2026
## Motivation

`amdsmi-license-headers` is `pass_filenames: false`, so it rescans the
whole tree. Once a violation lands on `develop`, every later PR goes 
red instead of the merge that caused it. #10010 merged on a
stale-green formatting run and reddened #10973 and #10998 until #8561
fixed the headers. Third time against this hook (#10402, #10845,
#8561), each fixed reactively.

## Technical Details

`.github/workflows/lstt-formatting.yml`:

- `push` trigger on `develop`, same path filter as `pull_request`, so a
whole-tree hook runs on the merge commit.
- `--from-ref` is event-aware via `FROM_REF`: `github.event.before` on
push, base branch on PR. PR behavior unchanged.
- `cancel-in-progress` limited to `pull_request`, so consecutive merges
each keep their verdict.

Detection at merge, not prevention. Prevention is "Require branches to
be up to date before merging". `develop`'s ruleset has
`required_status_checks` with 
`strict_required_status_checks_policy: false`, so a PR can merge on a
check that last ran against an older base — which is how the stale-green merge
happened.


Signed-off-by: Maisam Arif <Maisam.Arif@amd.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants