Skip to content

Adding scenario type to name#51

Merged
paigerube14 merged 1 commit intomainfrom
scenario_name
Feb 10, 2026
Merged

Adding scenario type to name#51
paigerube14 merged 1 commit intomainfrom
scenario_name

Conversation

@paigerube14
Copy link
Contributor

@paigerube14 paigerube14 commented Feb 10, 2026

User description

#50


PR Type

Enhancement


Description

  • Add scenario type identifiers to dashboard titles and descriptions

  • Update all five scenario templates with consistent naming format

  • Include scenario type in parentheses for better identification

  • Improve dashboard clarity and organization


Diagram Walkthrough

flowchart LR
  A["Scenario Templates"] -->|Add Type ID| B["app-scenarios"]
  A -->|Add Type ID| C["container-scenarios"]
  A -->|Add Type ID| D["kubevirt-disruption"]
  A -->|Add Type ID| E["node-scenarios"]
  A -->|Add Type ID| F["pod-scenarios"]
  B -->|Format: name<br/>type_id| G["Enhanced Dashboards"]
  C -->|Format: name<br/>type_id| G
  D -->|Format: name<br/>type_id| G
  E -->|Format: name<br/>type_id| G
  F -->|Format: name<br/>type_id| G
Loading

File Walkthrough

Relevant files
Enhancement
app-scenarios.jsonnet
Add application_outages_scenario type identifier                 

templates/General/app-scenarios.jsonnet

  • Updated description to include scenario type identifier
    application_outages_scenario
  • Updated title from 'Manual App Outage Chaos Engineering' to
    'Application Outage Chaos Engineering (application_outages_scenario)'
  • Standardized naming format with type identifier in parentheses
+2/-2     
container-scenarios.jsonnet
Add container_scenarios type identifier                                   

templates/General/container-scenarios.jsonnet

  • Updated description to include scenario type identifier
    container_scenarios
  • Updated title to include scenario type identifier in parentheses
  • Removed 'Manual Test' prefix for cleaner naming
+2/-2     
kubevirt-disruption.jsonnet
Add kubevirt_vm_outage type identifier                                     

templates/General/kubevirt-disruption.jsonnet

  • Updated description to include scenario type identifier
    kubevirt_vm_outage
  • Updated title to include scenario type identifier in parentheses
  • Removed 'Manual Test' prefix for consistency
+2/-2     
node-scenarios.jsonnet
Add node_scenarios type identifier                                             

templates/General/node-scenarios.jsonnet

  • Updated description to include scenario type identifier node_scenarios
  • Updated title from 'Manual Node Chaos Engineering' to 'Node Scenarios
    - Chaos Engineering (node_scenarios)'
  • Standardized naming format with type identifier
+2/-2     
pod-scenarios.jsonnet
Add pod_disruption_scenarios type identifier                         

templates/General/pod-scenarios.jsonnet

  • Updated description to include scenario type identifier
    pod_disruption_scenarios
  • Updated title to include scenario type identifier in parentheses
  • Removed 'Manual Test' prefix for consistency
+2/-2     

Signed-off-by: Paige Patton <prubenda@redhat.com>
@qodo-code-review
Copy link

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟢
🎫 #50
🟢 Add the scenario type identifier/version in parentheses to the title of graphs/dashboards
per scenario.
Make the scenario type visible in the graph/dashboard title to improve communication with
other tooling.
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Extract scenario type into variable

To reduce duplication, extract the scenario type string into a local variable
and use it in both the description and title fields.

templates/General/app-scenarios.jsonnet [7-58]

-// repeated literal in both description and title
-description: 'Application Outage Scenarios - Chaos Engineering (application_outages_scenario)',
-title: 'Application Outage Chaos Engineering (application_outages_scenario)',
+local scenarioType = 'application_outages_scenario';
+description: 'Application Outage Scenarios - Chaos Engineering (' + scenarioType + ')',
+title: 'Application Outage Chaos Engineering (' + scenarioType + ')',

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 7

__

Why: This is a good refactoring suggestion that improves code maintainability by extracting a repeated string literal into a local variable, following the Don't Repeat Yourself (DRY) principle.

Medium
Align scenario identifier with filename/title

Change the scenario identifier from kubevirt_vm_outage to
kubevirt_disruption_scenarios to align with the filename and title for better
consistency.

templates/General/kubevirt-disruption.jsonnet [7-58]

-description: 'Kubevirt Disruption - Chaos Engineering (kubevirt_vm_outage)',
+description: 'Kubevirt Disruption - Chaos Engineering (kubevirt_disruption_scenarios)',
 ...
-title: 'Kubevirt Disruption - Chaos Engineering (kubevirt_vm_outage)',
+title: 'Kubevirt Disruption - Chaos Engineering (kubevirt_disruption_scenarios)',

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 6

__

Why: This suggestion correctly points out that the identifier kubevirt_vm_outage is inconsistent with the filename and title, and proposes a more consistent name that aligns with conventions in other files.

Low
Standardize scenario identifier to plural form

For consistency with other files, change the scenario identifier from the
singular application_outages_scenario to the plural
application_outages_scenarios.

templates/General/app-scenarios.jsonnet [7-58]

-description: 'Application Outage Scenarios - Chaos Engineering (application_outages_scenario)',
+description: 'Application Outage Scenarios - Chaos Engineering (application_outages_scenarios)',
 ...
-title: 'Application Outage Chaos Engineering (application_outages_scenario)',
+title: 'Application Outage Chaos Engineering (application_outages_scenarios)',

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 5

__

Why: The suggestion correctly identifies an inconsistency in naming conventions across files and proposes a change to align them, which improves maintainability.

Low
Correct description grammar

Correct the grammatical error in the description field from "Containers
Scenarios" to "Container Scenarios".

templates/General/container-scenarios.jsonnet [7]

-description: 'Containers Scenarios - Chaos Engineering (container_scenarios)',
+description: 'Container Scenarios - Chaos Engineering (container_scenarios)',
  • Apply / Chat
Suggestion importance[1-10]: 3

__

Why: The suggestion correctly identifies and fixes a minor grammatical error in the description string, which improves the quality of the user-facing text.

Low
  • More

@paigerube14 paigerube14 merged commit 3e07056 into main Feb 10, 2026
3 checks passed
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.

1 participant