Skip to content

OU-1472: rename tags to be the same as backend features #1128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PeterYurkovich wants to merge 1 commit into from
Open

OU-1472: rename tags to be the same as backend features #1128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 58 additions & 30 deletions .claude/commands/cypress/cypress-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: cypress-run
name: cypress-run
description: Display Cypress test commands - choose execution mode (headless recommended)
parameters:
- name: execution-mode
Expand All @@ -10,7 +10,8 @@ parameters:

# Cypress Test Commands

**Prerequisites**:
**Prerequisites**:

1. Run `/cypress-setup` first to configure your environment.
2. Ensure the "Cypress Tests" terminal window is open (created by `/cypress-setup`)

Expand All @@ -31,25 +32,28 @@ parameters:
All npm commands should be executed in the "Cypress Tests" terminal using the helper scripts:

**macOS:**

```bash
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "npm run <command>"
```

**Linux:**

```bash
./.claude/commands/cypress/scripts/open-cypress-terminal-linux.sh --run "npm run <command>"
```

**Instructions**: Based on the `execution-mode` parameter provided by the user:

- If `execution-mode` is "interactive": Display ONLY the "Interactive Mode" section below
- If `execution-mode` is "headless": display ONLY the "Headless Mode" section with interactive options to be chosen
- If `execution-mode` is "headed": display ONLY the "Headed Mode" section with interactive options to be chosen

**IMPORTANT**: Always execute the selected command using the appropriate script:

- macOS: `./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "<command>"`
- Linux: `./.claude/commands/cypress/scripts/open-cypress-terminal-linux.sh --run "<command>"`


---

# Interactive Mode
Expand All @@ -59,6 +63,7 @@ All npm commands should be executed in the "Cypress Tests" terminal using the he
## What is Interactive Mode?

Interactive mode opens the Cypress Test Runner UI where you can:

- Browse and select tests visually
- Watch tests run in real-time with time-travel debugging
- Inspect DOM snapshots at each step
Expand All @@ -71,16 +76,19 @@ Interactive mode opens the Cypress Test Runner UI where you can:
**Open Cypress Interactive UI (run in Cypress Tests terminal):**

macOS:

```bash
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "npm run cypress:open"
```

Linux:

```bash
./.claude/commands/cypress/scripts/open-cypress-terminal-linux.sh --run "npm run cypress:open"
```

This opens a visual interface where you can:

1. Choose a browser (Chrome, Firefox, Edge, Electron)
2. Browse your test files
3. Click any test to run it
Expand Down Expand Up @@ -113,10 +121,12 @@ All commands below run tests in headless mode (no visible browser).
**IMPORTANT**: Before showing test commands, you MUST dynamically read:

### 1. Available NPM Scripts

Read `web/package.json` and extract all scripts matching `test-cypress-*` and `cypress:*` patterns.
Present them as available test suite commands.

### 2. Available Test Spec Files
### 2. Available Test Spec Files

Scan `web/cypress/e2e/` directory recursively and list all `.cy.ts` files.
Present them as available spec file targets for `--spec` option.

Expand All @@ -125,21 +135,25 @@ Present them as available spec file targets for `--spec` option.
## Quick Reference - Base Commands

**Run with npm script (if defined in package.json):**

```bash
npm run <script-name>
```

**Run all tests headless:**

```bash
npm run cypress:run
```

**Run specific spec file:**

```bash
npm run cypress:run -- --spec "cypress/e2e/<path-to-file>.cy.ts"
```

**Run with custom tags:**

```bash
npm run cypress:run -- --env grepTags="<YOUR_TAGS_HERE>"
```
Expand All @@ -149,10 +163,12 @@ npm run cypress:run -- --env grepTags="<YOUR_TAGS_HERE>"
## NPM Scripts from package.json

**Instructions**: Read `web/package.json` and list ALL scripts that start with:

- `test-cypress-*` (predefined test suites)
- `cypress:*` (base cypress commands)

For each script found, display:

```bash
npm run <script-name>
```
Expand All @@ -166,6 +182,7 @@ Add a brief description based on the grepTags or other flags in the script defin
**Instructions**: Scan `web/cypress/e2e/` recursively and organize by folder:

For each `.cy.ts` file found, show the command:

```bash
npm run cypress:run -- --spec "cypress/e2e/<relative-path>"
```
Expand All @@ -177,29 +194,32 @@ Group files by their parent folder (monitoring, coo, perses, virtualization, inc
## Custom Tag Combinations - Headless

**Base command for custom tags:**

```bash
npm run cypress:run -- --env grepTags="YOUR_TAGS_HERE"
```

**Tag Operators:**
- `+` = AND (e.g., `@alerts+@smoke` = alerts AND smoke)
- `--` = NOT (e.g., `@monitoring --@flaky` = monitoring but NOT flaky)
- `,` = OR (e.g., `@alerts,@metrics` = alerts OR metrics)

- `+` = AND (e.g., `@alerting+@metrics` = alerts AND metrics)
- `--` = NOT (e.g., `@alerting --@flaky` = alerting but NOT flaky)
- `,` = OR (e.g., `@alerting,@metrics` = alerts OR metrics)

**Common tag patterns:**

| Goal | Command |
|------|---------|
| Smoke tests only | `npm run cypress:run -- --env grepTags="@smoke"` |
| Exclude flaky | `npm run cypress:run -- --env grepTags="<tag> --@flaky"` |
| Exclude demo | `npm run cypress:run -- --env grepTags="<tag> --@demo"` |
| Fast smoke | `npm run cypress:run -- --env grepTags="@smoke --@slow --@flaky"` |
| Goal | Command |
| ---------------- | ----------------------------------------------------------------- |
| Smoke tests only | `npm run cypress:run -- --env grepTags="@smoke"` |
| Exclude flaky | `npm run cypress:run -- --env grepTags="<tag> --@flaky"` |
| Exclude demo | `npm run cypress:run -- --env grepTags="<tag> --@demo"` |
| Fast smoke | `npm run cypress:run -- --env grepTags="@smoke --@slow --@flaky"` |

---

## Running Multiple Spec Files

**Comma-separate spec paths:**

```bash
npm run cypress:run -- --spec "cypress/e2e/<file1>.cy.ts,cypress/e2e/<file2>.cy.ts"
```
Expand All @@ -209,18 +229,21 @@ npm run cypress:run -- --spec "cypress/e2e/<file1>.cy.ts,cypress/e2e/<file2>.cy.
## Advanced Headless Options

**Run with specific browser:**

```bash
npm run cypress:run -- --browser firefox
npm run cypress:run -- --browser edge
npm run cypress:run -- --browser chrome
```

**Disable video recording:**

```bash
npm run cypress:run -- --config video=false
```

**Disable screenshots:**

```bash
npm run cypress:run -- --config screenshotOnRunFailure=false
```
Expand All @@ -234,11 +257,13 @@ All commands below open a visible browser window.
## Quick Start - Headed

**Interactive Mode (Cypress UI, pick tests manually):**

```bash
npm run cypress:open
```

**Base headed mode command:**

```bash
npm run cypress:run -- --headed
```
Expand All @@ -249,23 +274,27 @@ npm run cypress:run -- --headed

**IMPORTANT**: Before showing test commands, you MUST dynamically read:

### 1. Available Test Spec Files
### 1. Available Test Spec Files

Scan `web/cypress/e2e/` directory recursively and list all `.cy.ts` files.
Present them as available spec file targets with `--headed` flag.

### 2. Available Tags

Extract grepTags patterns from `web/package.json` scripts to show common tag combinations.

---

## Running Test Suites - Headed

To run any tag-based suite in headed mode, add `--headed` flag:

```bash
npm run cypress:run -- --headed --env grepTags="<TAG_COMBINATION>"
```

**Examples based on common tags:**

```bash
# Monitoring tests (headed)
npm run cypress:run -- --headed --env grepTags="@monitoring --@flaky"
Expand All @@ -282,11 +311,13 @@ npm run cypress:run -- --headed --env grepTags="@coo --@flaky"
## Running Specific Files - Headed

**Template:**

```bash
npm run cypress:run -- --headed --spec "cypress/e2e/<path-to-file>.cy.ts"
```

**Instructions**: Scan `web/cypress/e2e/` and for each `.cy.ts` file, the headed command is:

```bash
npm run cypress:run -- --headed --spec "cypress/e2e/<relative-path>"
```
Expand All @@ -296,13 +327,15 @@ npm run cypress:run -- --headed --spec "cypress/e2e/<relative-path>"
## Advanced Headed Options

**Headed with specific browser:**

```bash
npm run cypress:run -- --headed --browser chrome
npm run cypress:run -- --headed --browser firefox
npm run cypress:run -- --headed --browser edge
```

**Headed without video:**

```bash
npm run cypress:run -- --headed --config video=false
```
Expand All @@ -314,27 +347,19 @@ npm run cypress:run -- --headed --config video=false
Use these tags with `--env grepTags`:

**Feature Tags:**
- `@monitoring` - Core monitoring plugin tests
- `@monitoring-dev` - Developer user tests
- `@alerts` - Alert-related tests

- `@acm-alerting` - Alert-related tests in ACM perspective
- `@alerting` - Alert-related tests
- `@legacy-dashboards` - Legacy dashboard tests
- `@metrics` - Metrics explorer tests
- `@dashboards` - Legacy dashboard tests
- `@perses` - Perses dashboard tests
- `@coo` - Observability Operator tests
- `@acm` - Advanced Cluster Management tests
- `@virtualization` - OpenShift Virtualization tests
- `@targets` - Targets tests
- `@perses-dashboards` - Perses dashboard tests
- `@cluster-health-analyzer` - Incidents feature tests

**Modifier Tags:**
- `@smoke` - Quick smoke tests

- `@slow` - Longer running tests
- `@flaky` - Known flaky tests
- `@demo` - Demo/showcase tests

**Tag Operators:**
- `+` = AND (e.g., `@alerts+@smoke` = alerts AND smoke)
- `--` = NOT (e.g., `@monitoring --@flaky` = monitoring but NOT flaky)
- `,` = OR (e.g., `@alerts,@metrics` = alerts OR metrics)

---

Expand All @@ -349,16 +374,19 @@ Use these tags with `--env grepTags`:
All cypress commands should be executed in the "Cypress Tests" terminal using:

**macOS:**

```bash
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "<your-command>"
```

**Linux:**

```bash
./.claude/commands/cypress/scripts/open-cypress-terminal-linux.sh --run "<your-command>"
```

**Examples:**

```bash
# Run smoke tests (macOS)
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "npm run test-cypress-smoke"
Expand All @@ -367,7 +395,7 @@ All cypress commands should be executed in the "Cypress Tests" terminal using:
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "npm run cypress:run -- --spec 'cypress/e2e/monitoring/00.bvt_admin.cy.ts'"

# Run with custom tags (macOS)
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "npm run cypress:run -- --env grepTags='@monitoring --@flaky'"
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "npm run cypress:run -- --env grepTags='@alerting @legacy-dashboards @metrics @targets --@flaky'"

# Open interactive mode (macOS)
./.claude/commands/cypress/scripts/open-cypress-terminal-macos.sh --run "npm run cypress:open"
Expand Down
Loading