mirror of
https://github.com/SCST-project/scst.git
synced 2026-10-22 06:02:33 +00:00
docs: Remove case descriptions from test guides
Remove the issue #367 walkthrough from the KUnit guide and the smoke and SCSI case lists from the Ginkgo guide. Keep scenario expectations with the tests instead of duplicating them in runner documentation. Retain label selection, environment requirements and artifact guidance. Describe optional kernel-log collection without tying it to an issue.
This commit is contained in:
@@ -153,30 +153,6 @@ preloaded KUnit is left unchanged. External dependencies such as `dlm` are
|
||||
loaded with `modprobe` and left loaded. A clean failure before SCST loads also
|
||||
releases runner-owned KUnit; incomplete execution can retain modules.
|
||||
|
||||
## Issue #367: task management and ACG reassignment
|
||||
|
||||
`KUNIT_LABEL=TM` selects `scst-TM-acg`. It checks five `black_hole` modes
|
||||
for session teardown commands, all mode transitions through the sysfs store,
|
||||
rejected and repeated writes, and unchanged-group handling. Reassignment
|
||||
checks require the old mode during the NULL-ACG window and the new mode after
|
||||
the transition; later writes to the old group must not affect the session.
|
||||
`tm_during_reassign_test` also invokes the TM reader from an allocation stub
|
||||
while the real reassignment is in progress, for all five modes. It checks
|
||||
command state, drop policy and event delivery during and after the transition.
|
||||
The reassignment regressions run without a SKIP: with the original ACG reader,
|
||||
they can crash the test VM. Use a disposable VM and retain its console log outside
|
||||
the guest. The fixture controls one interleaving; it does not prove the
|
||||
absence of other races.
|
||||
|
||||
```sh
|
||||
make kunit-build KDIR=/path/to/kernel-build
|
||||
sudo make kunit-run KUNIT_LABEL=TM KUNIT_ARGS='--verbose'
|
||||
```
|
||||
|
||||
Retain the complete printed run directory, especially `report.txt`,
|
||||
`result.json`, `messages.log`, `kernel.log`, `commands.log` and
|
||||
`ktap/scst-TM-acg.ktap`.
|
||||
|
||||
## Add a suite
|
||||
|
||||
Keep suites and fixtures under their owning component's `kunit/` directory;
|
||||
|
||||
@@ -51,9 +51,7 @@ with `basic` (management), `scsi` or `io`; add `fileio` or `blockio` to narrow
|
||||
the backend. For example, `local && io && fileio` needs no physical disk.
|
||||
`GINKGO_FOCUS` additionally filters spec names by regexp.
|
||||
|
||||
GitHub pull requests use `basic || smoke` on both transports. `smoke` covers
|
||||
SCSI identity, capacity and LUN discovery, rejected writes and reads, an UNMAP
|
||||
transfer-boundary case, asynchronous FUA/cache commands and both fio backends.
|
||||
GitHub pull requests use `basic || smoke` on both transports.
|
||||
Pushes to `master` run all specs, including stress and the full parameter tables.
|
||||
|
||||
```sh
|
||||
@@ -115,8 +113,7 @@ Install Python 3, util-linux and sg3_utils on the command host: the target for
|
||||
`local`, the initiator for `iscsi`. I/O also needs fio and kernel `io_uring`
|
||||
support there, plus `lsblk` and `wipefs` on the target for blockio preflight.
|
||||
|
||||
SCSI cases check identity, capacity, LUN visibility and rejection status/sense
|
||||
on temporary fileio exports. Fio verifies CRC32C data using three concurrent
|
||||
Fio verifies CRC32C data using three concurrent
|
||||
4K, 64K and 128K jobs in disjoint regions; see the shared
|
||||
[profile](internal/dataio/verify.fio). It checks completed I/O, not performance.
|
||||
Readback checks do not verify data persistence across a crash or power loss.
|
||||
@@ -159,5 +156,5 @@ affected hosts before retrying; never remove a lock file to bypass a held lock.
|
||||
The printed artifact directory under `report_dir` contains effective config,
|
||||
command logs, JSON/JUnit reports and scenario inputs. I/O adds rendered jobs
|
||||
and fio results; iSCSI adds SSH, initiator and daemon logs, which may contain
|
||||
test CHAP credentials. Only the `issue-367` specs collect kernel warnings;
|
||||
retain kernel logs separately when investigating other failures.
|
||||
test CHAP credentials. Kernel-log collection depends on the selected specs;
|
||||
retain kernel logs separately when investigating failures.
|
||||
|
||||
Reference in New Issue
Block a user