Skip to content

Add SBMR side-band manual testing guide#47

Open
amrathesh wants to merge 1 commit intoARM-software:mainfrom
amrathesh:openbmc-manual-tests
Open

Add SBMR side-band manual testing guide#47
amrathesh wants to merge 1 commit intoARM-software:mainfrom
amrathesh:openbmc-manual-tests

Conversation

@amrathesh
Copy link
Member

  • add sanity checks for PLDM and MCTP for OpenBMC based servers.

- add sanity checks for PLDM and MCTP for OpenBMC based
  servers.

Signed-off-by: Amrathesh <amrathesh@arm.com>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a plan to link Rule_ID in arm_sbmr_testcase_checklist.rst to this document

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's the idea, @Guru9902 is working on a task to add self decalaration tags for rules which are not currently covered by ACS. he would link the rules applicable to corresponding sections in this doc.

@anncheng-arm
Copy link

Hi @amrathesh , @gtossk2

I’d like to propose a revised format for the manual test case documentation. I felt this version was a bit hard to follow and not very structured, so I’ve reworked it with the following: https://github.com/anncheng-arm/sbmr-acs/blob/openbmc-manual-tests/docs/sideband_manual_testing.md

Structure and readability: Each test case is presented as a clear block (objective, rule IDs, prerequisites, steps table), so it’s easier to read and navigate.

Linking from the checklist: In checklist.rst, we can simply link each rule ID (e.g. M3_SB_1, M3_SB_2) to the corresponding test case (e.g. PLDM_Test_Case_001). That way, the checklist stays compact while still pointing to the full test description.

Coverage at a glance: When reading the manual test doc, users can see in one place which rule IDs each test case covers, which should make both writing and reviewing simpler.

Would you be open to adopting this style? Thanks for your feedback.

@amrathesh
Copy link
Member Author

Hi @amrathesh , @gtossk2

I’d like to propose a revised format for the manual test case documentation. I felt this version was a bit hard to follow and not very structured, so I’ve reworked it with the following: https://github.com/anncheng-arm/sbmr-acs/blob/openbmc-manual-tests/docs/sideband_manual_testing.md

Structure and readability: Each test case is presented as a clear block (objective, rule IDs, prerequisites, steps table), so it’s easier to read and navigate.

Linking from the checklist: In checklist.rst, we can simply link each rule ID (e.g. M3_SB_1, M3_SB_2) to the corresponding test case (e.g. PLDM_Test_Case_001). That way, the checklist stays compact while still pointing to the full test description.

Coverage at a glance: When reading the manual test doc, users can see in one place which rule IDs each test case covers, which should make both writing and reviewing simpler.

Would you be open to adopting this style? Thanks for your feedback.

Hi @anncheng-arm ,

Thank you for reviewing, proposed style looks more structured than current. will work on the changes.

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.

2 participants