Skip to content

Conversation

@kumarrahul04
Copy link
Contributor

CASMCMS-9609:Add cmsdev new options and CRUD tests

@kumarrahul04 kumarrahul04 requested review from dlaine-hpe and mharding-hpe and removed request for dlaine-hpe December 5, 2025 15:21
@kumarrahul04
Copy link
Contributor Author

Keeping it in draft mode until the cms team reviews this.

@kumarrahul04 kumarrahul04 self-assigned this Jan 6, 2026
@kumarrahul04 kumarrahul04 marked this pull request as ready for review January 6, 2026 15:13
@@ -0,0 +1,573 @@
# `cmsdev` Test Suite Documentation

The `cmsdev` test suite is a comprehensive validation tool in CSM (Cray System Management). It verifies the health, functionality, and API operations of critical system services including BOS, CFS, Conman, IMS, iPXE/TFTP, and VCS.
Copy link
Contributor

Choose a reason for hiding this comment

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

BOS, CFS, IMS, and VCS should have their full names in parentheses, and link to their entry in glossary.md (in the root of the repo)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

When run on a Kubernetes master NCN, the TFTP file transfer subtest is omitted. However, that TFTP subtest is
run on a worker NCN as part of the Goss NCN health checks.

(`ncn-mw#`) The following command runs the entire `cmsdev` test suite (with the possible exception of the TFTP file
Copy link
Contributor

Choose a reason for hiding this comment

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

This is no longer true with the addition of the CLI and tenancy flags. The example should either use those flags, or note those exceptions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated to add the exceptions


**Tests performed**:

1. **iPXE pod verification** (per architecture):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. **iPXE pod verification** (per architecture):
* iPXE pod verification


1. **iPXE pod verification** (per architecture):
* Verifies iPXE build pods for supported architectures:
* `x86_64` (`amd64`)
Copy link
Contributor

Choose a reason for hiding this comment

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

What does it mean to have that in parentheses here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is added for clarity as x86_64 is also referred as amd64

Comment on lines 343 to 344

2. **TFTP pod verification**:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
2. **TFTP pod verification**:
* TFTP pod verification

Comment on lines 339 to 340
* `x86_64` (`amd64`)
* aarch64 (arm64)
Copy link
Contributor

Choose a reason for hiding this comment

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

What does the parenthetical text indicate?

1. **iPXE pod verification** (per architecture):
* Verifies iPXE build pods for supported architectures:
* `x86_64` (`amd64`)
* aarch64 (arm64)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* aarch64 (arm64)
* `aarch64` (`arm64`)

@mharding-hpe
Copy link
Contributor

I have more comments coming -- github just seemed unhappy with me adding more before I submitted them, for some reason. I'll comment when I'm all done

Comment on lines 339 to 340
* `x86_64` (`amd64`)
* aarch64 (arm64)
Copy link
Contributor

Choose a reason for hiding this comment

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

What does the parenthetical text indicate?

Comment on lines 347 to 348

3. **Persistent Volume Claims (PVC) verification**:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
3. **Persistent Volume Claims (PVC) verification**:
* Persistent Volume Claims (PVC) verification

Comment on lines 350 to 351

4. **iPXE binary `configmap` validation**:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
4. **iPXE binary `configmap` validation**:
* iPXE binary ConfigMap validation

Comment on lines 352 to 353
* Retrieves iPXE binary names from Kubernetes `configmap`
* Validates `configmap` structure and content
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Retrieves iPXE binary names from Kubernetes `configmap`
* Validates `configmap` structure and content
* Retrieves iPXE binary names from Kubernetes ConfigMap
* Validates ConfigMap structure and content

Comment on lines 354 to 355

5. **TFTP file transfer test** (worker NCNs only):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
5. **TFTP file transfer test** (worker NCNs only):
* TFTP file transfer test (only run on worker NCNs)

Comment on lines 357 to 358
* `cray-tftp` (NMN network)
* `cray-tftp-hmn` (HMN network)
Copy link
Contributor

Choose a reason for hiding this comment

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

The two networks should be links to their corresponding entries in glossary.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added the links.

message that resembles the following:
**Symptom**: The VCS subtest fails with a command error.
**Error message**:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Error message**:
The error message resembles the following:

```

If the test is run in verbose mode, or the `cmsdev` log file is examined, a line similar to the following is found:
**Detailed error** (visible in verbose mode or log file):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Detailed error** (visible in verbose mode or log file):
If the test is run in verbose mode, or the `cmsdev` log file is examined, a line similar to the following is found:

* Run test in verbose mode: `/usr/local/bin/cmsdev test -v vcs`
* Or examine the log file: `/opt/cray/tests/install/logs/cmsdev/YYMMDD_HHMMSS_microseconds_PID/cmsdev.log`

See the [`cmsdev` Test Suite Documentation](../cmsdev_tests.md#logging) for more information on logging.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
See the [`cmsdev` Test Suite Documentation](../cmsdev_tests.md#logging) for more information on logging.
See [Logging](../cmsdev_tests.md#logging) for more information on logging.


See the [`cmsdev` Test Suite Documentation](../cmsdev_tests.md#logging) for more information on logging.

## Additional Resources
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Additional Resources
## Additional resources


## SMS test execution
> **See also**: [`cmsdev` Test Suite Documentation](../cmsdev_tests.md) - Comprehensive documentation including all available tests, command-line options, and usage examples.
Copy link
Contributor

Choose a reason for hiding this comment

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

There should be a table of contents for the page here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added

@mharding-hpe
Copy link
Contributor

Ok, I'm done with this review pass

@Cray-HPE Cray-HPE deleted a comment from mharding-hpe Jan 6, 2026
@Cray-HPE Cray-HPE deleted a comment from mharding-hpe Jan 6, 2026
@Cray-HPE Cray-HPE deleted a comment from mharding-hpe Jan 6, 2026
Co-authored-by: Mitch Harding <mitchell.harding@hpe.com>
Signed-off-by: kumarrahul04 <146384313+kumarrahul04@users.noreply.github.com>
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.

3 participants