Manage Test Cases
Test cases are the main objects users work with in Veckl. Each one is a Markdown file with structured YAML frontmatter.
Browse and Filter
Section titled “Browse and Filter”The Test Cases page lists every test case Veckl can read from the configured repository.
Use filters to narrow the list by:
- Control family.
- Component.
- Status.
- Lifecycle.
- Search text.
Open a test case to review its metadata, steps, current results, and Git history link.
Create a Test Case
Section titled “Create a Test Case”Select New Test Case and fill in the required fields:
- Primary control.
- Component.
- Assessor, unless saving as a draft.
Optional fields help make the test repeatable:
- Fully satisfied controls.
- Partially satisfied controls.
- Prerequisites.
- Testing steps.
- Evidence references.
- Code snippets for commands or checks.
When you save, Veckl generates an ID from the component, control, and sequence counter. For example, a component RHEL9 and control AC-2 produces an ID shaped like RHEL9-AC-02-001.
Drafts and Active Tests
Section titled “Drafts and Active Tests”Use drafts when a test case is still being written. Drafts can be edited but cannot be executed.
Publish the test case when it is ready for execution.
Edit a Test Case
Section titled “Edit a Test Case”Open the test case and select Edit.
Edit the fields that need to change, then save. Veckl commits the updated Markdown file to the repository.
Execute a Test Case
Section titled “Execute a Test Case”The execution wizard walks through each testing step.
For each step:
- Read the instruction.
- Run the required check outside Veckl.
- Mark the step as pass, fail, or not tested.
- Continue to the review step.
On review, Veckl shows the pass, fail, and not-tested counts. Saving execution results updates the test case frontmatter and creates a Git commit.
Review History
Section titled “Review History”Use the History link on a test case to open the file history in GitHub. Historical versions in Veckl are read-only so users can inspect previous content without accidentally editing old state.
Archive and Restore
Section titled “Archive and Restore”Archive a test case when it should stay in the repository for audit purposes but no longer appears as active work.
Restore an archived test case if it needs to return to the active workflow.