Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/publish-npm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ jobs:
- name: Publish
run: yarn npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
YARN_NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.RHDH_NPM_TOKEN }}
YARN_NPM_AUTH_TOKEN: ${{ secrets.RHDH_NPM_TOKEN }}
22 changes: 11 additions & 11 deletions docs/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation Guide for Claude

This file contains essential information for maintaining and extending the VitePress documentation for `rhdh-e2e-test-utils`.
This file contains essential information for maintaining and extending the VitePress documentation for `@red-hat-developer-hub/e2e-test-utils`.

## Documentation Structure

Expand Down Expand Up @@ -43,7 +43,7 @@ docs/
- Use the fixture pattern (recommended) over direct instantiation
- Standard test structure:
```typescript
import { test, expect } from "rhdh-e2e-test-utils/test";
import { test, expect } from "@red-hat-developer-hub/e2e-test-utils/test";

test.describe("Feature", () => {
test.beforeAll(async ({ rhdh }) => { /* deploy */ });
Expand Down Expand Up @@ -202,12 +202,12 @@ Base URL is configured as `/rhdh-e2e-test-utils/` in `config.ts`.

| Export | Import Path | Description |
|--------|-------------|-------------|
| Test fixtures | `rhdh-e2e-test-utils/test` | Main test API |
| Playwright config | `rhdh-e2e-test-utils/playwright-config` | Base config |
| RHDH deployment | `rhdh-e2e-test-utils/rhdh` | RHDHDeployment |
| Keycloak | `rhdh-e2e-test-utils/keycloak` | KeycloakHelper |
| Helpers | `rhdh-e2e-test-utils/helpers` | UIhelper, LoginHelper, etc. |
| Page objects | `rhdh-e2e-test-utils/pages` | CatalogPage, HomePage, etc. |
| Utilities | `rhdh-e2e-test-utils/utils` | KubernetesClientHelper, etc. |
| ESLint | `rhdh-e2e-test-utils/eslint` | ESLint config |
| TypeScript | `rhdh-e2e-test-utils/tsconfig` | TSConfig base |
| Test fixtures | `@red-hat-developer-hub/e2e-test-utils/test` | Main test API |
| Playwright config | `@red-hat-developer-hub/e2e-test-utils/playwright-config` | Base config |
| RHDH deployment | `@red-hat-developer-hub/e2e-test-utils/rhdh` | RHDHDeployment |
| Keycloak | `@red-hat-developer-hub/e2e-test-utils/keycloak` | KeycloakHelper |
| Helpers | `@red-hat-developer-hub/e2e-test-utils/helpers` | UIhelper, LoginHelper, etc. |
| Page objects | `@red-hat-developer-hub/e2e-test-utils/pages` | CatalogPage, HomePage, etc. |
| Utilities | `@red-hat-developer-hub/e2e-test-utils/utils` | KubernetesClientHelper, etc. |
| ESLint | `@red-hat-developer-hub/e2e-test-utils/eslint` | ESLint config |
| TypeScript | `@red-hat-developer-hub/e2e-test-utils/tsconfig` | TSConfig base |
6 changes: 3 additions & 3 deletions docs/api/deployment/deployment-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import type {
AuthProvider,
DeploymentOptions,
DeploymentConfig,
} from "rhdh-e2e-test-utils/rhdh";
} from "@red-hat-developer-hub/e2e-test-utils/rhdh";
```

## DeploymentMethod
Expand Down Expand Up @@ -100,8 +100,8 @@ Combined type for full deployment configuration.
## Example Usage

```typescript
import { RHDHDeployment } from "rhdh-e2e-test-utils/rhdh";
import type { DeploymentOptions } from "rhdh-e2e-test-utils/rhdh";
import { RHDHDeployment } from "@red-hat-developer-hub/e2e-test-utils/rhdh";
import type { DeploymentOptions } from "@red-hat-developer-hub/e2e-test-utils/rhdh";

const options: DeploymentOptions = {
version: "1.5",
Expand Down
4 changes: 2 additions & 2 deletions docs/api/deployment/keycloak-helper.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Class for deploying and managing Keycloak in OpenShift.
## Import

```typescript
import { KeycloakHelper } from "rhdh-e2e-test-utils/keycloak";
import { KeycloakHelper } from "@red-hat-developer-hub/e2e-test-utils/keycloak";
```

## Constructor
Expand Down Expand Up @@ -193,7 +193,7 @@ Wait for Keycloak StatefulSet to be ready.
## Example

```typescript
import { KeycloakHelper } from "rhdh-e2e-test-utils/keycloak";
import { KeycloakHelper } from "@red-hat-developer-hub/e2e-test-utils/keycloak";

const keycloak = new KeycloakHelper({
namespace: "rhdh-keycloak",
Expand Down
6 changes: 3 additions & 3 deletions docs/api/deployment/keycloak-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type {
KeycloakGroupConfig,
KeycloakRealmConfig,
KeycloakConnectionConfig,
} from "rhdh-e2e-test-utils/keycloak";
} from "@red-hat-developer-hub/e2e-test-utils/keycloak";
```

## KeycloakDeploymentOptions
Expand Down Expand Up @@ -139,8 +139,8 @@ await keycloak.connect({
## Example Usage

```typescript
import { KeycloakHelper } from "rhdh-e2e-test-utils/keycloak";
import type { KeycloakUserConfig } from "rhdh-e2e-test-utils/keycloak";
import { KeycloakHelper } from "@red-hat-developer-hub/e2e-test-utils/keycloak";
import type { KeycloakUserConfig } from "@red-hat-developer-hub/e2e-test-utils/keycloak";

const keycloak = new KeycloakHelper();
await keycloak.deploy();
Expand Down
4 changes: 2 additions & 2 deletions docs/api/deployment/rhdh-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Class for managing RHDH deployments in OpenShift.
## Import

```typescript
import { RHDHDeployment } from "rhdh-e2e-test-utils/rhdh";
import { RHDHDeployment } from "@red-hat-developer-hub/e2e-test-utils/rhdh";
```

## Constructor
Expand Down Expand Up @@ -139,7 +139,7 @@ await rhdh.teardown();
## Example

```typescript
import { RHDHDeployment } from "rhdh-e2e-test-utils/rhdh";
import { RHDHDeployment } from "@red-hat-developer-hub/e2e-test-utils/rhdh";

const rhdh = new RHDHDeployment("my-namespace");

Expand Down
6 changes: 3 additions & 3 deletions docs/api/eslint/create-eslint-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ ESLint configuration factory.
## Import

```typescript
import { createEslintConfig } from "rhdh-e2e-test-utils/eslint";
import { createEslintConfig } from "@red-hat-developer-hub/e2e-test-utils/eslint";
```

## `createEslintConfig()`
Expand All @@ -26,7 +26,7 @@ Create ESLint flat config with Playwright and TypeScript rules.

```javascript
// eslint.config.js
import { createEslintConfig } from "rhdh-e2e-test-utils/eslint";
import { createEslintConfig } from "@red-hat-developer-hub/e2e-test-utils/eslint";

export default createEslintConfig(import.meta.dirname);
```
Expand All @@ -42,7 +42,7 @@ export default createEslintConfig(import.meta.dirname);
## Extending

```javascript
import { createEslintConfig } from "rhdh-e2e-test-utils/eslint";
import { createEslintConfig } from "@red-hat-developer-hub/e2e-test-utils/eslint";

const baseConfig = createEslintConfig(import.meta.dirname);

Expand Down
4 changes: 2 additions & 2 deletions docs/api/helpers/api-helper.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Utilities for GitHub and Backstage API interactions.
## Import

```typescript
import { APIHelper } from "rhdh-e2e-test-utils/helpers";
import { APIHelper } from "@red-hat-developer-hub/e2e-test-utils/helpers";
```

## Static Methods (GitHub)
Expand Down Expand Up @@ -127,7 +127,7 @@ async deleteEntityFromCatalog(
## Example

```typescript
import { APIHelper } from "rhdh-e2e-test-utils/helpers";
import { APIHelper } from "@red-hat-developer-hub/e2e-test-utils/helpers";

// GitHub operations
await APIHelper.createGitHubRepo("my-org", "test-repo");
Expand Down
4 changes: 2 additions & 2 deletions docs/api/helpers/login-helper.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Authentication helper for various providers.
## Import

```typescript
import { LoginHelper } from "rhdh-e2e-test-utils/helpers";
import { LoginHelper } from "@red-hat-developer-hub/e2e-test-utils/helpers";
```

## Constructor
Expand Down Expand Up @@ -61,7 +61,7 @@ Sign out of RHDH.
## Example

```typescript
import { test } from "rhdh-e2e-test-utils/test";
import { test } from "@red-hat-developer-hub/e2e-test-utils/test";

test.beforeEach(async ({ loginHelper }) => {
await loginHelper.loginAsKeycloakUser();
Expand Down
2 changes: 1 addition & 1 deletion docs/api/helpers/ui-helper.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ UI interaction helper for Material-UI components.
## Import

```typescript
import { UIhelper } from "rhdh-e2e-test-utils/helpers";
import { UIhelper } from "@red-hat-developer-hub/e2e-test-utils/helpers";
```

## Constructor
Expand Down
2 changes: 1 addition & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Reference

Complete API documentation for all exports from `rhdh-e2e-test-utils`.
Complete API documentation for all exports from `@red-hat-developer-hub/e2e-test-utils`.

## Exports Overview

Expand Down
6 changes: 3 additions & 3 deletions docs/api/pages/catalog-import-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Page object for the catalog import functionality.
## Import

```typescript
import { CatalogImportPage } from "rhdh-e2e-test-utils/pages";
import { CatalogImportPage } from "@red-hat-developer-hub/e2e-test-utils/pages";
```

## Constructor
Expand Down Expand Up @@ -109,8 +109,8 @@ await catalogImportPage.inspectEntityAndVerifyYaml("kind: Component");

```typescript
import { test, expect } from "@playwright/test";
import { CatalogImportPage } from "rhdh-e2e-test-utils/pages";
import { UIhelper } from "rhdh-e2e-test-utils/helpers";
import { CatalogImportPage } from "@red-hat-developer-hub/e2e-test-utils/pages";
import { UIhelper } from "@red-hat-developer-hub/e2e-test-utils/helpers";

test("import a new component", async ({ page }) => {
const uiHelper = new UIhelper(page);
Expand Down
4 changes: 2 additions & 2 deletions docs/api/pages/catalog-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Page object for the RHDH software catalog (`/catalog` page).
## Import

```typescript
import { CatalogPage } from "rhdh-e2e-test-utils/pages";
import { CatalogPage } from "@red-hat-developer-hub/e2e-test-utils/pages";
```

## Constructor
Expand Down Expand Up @@ -109,7 +109,7 @@ await row.click();

```typescript
import { test, expect } from "@playwright/test";
import { CatalogPage } from "rhdh-e2e-test-utils/pages";
import { CatalogPage } from "@red-hat-developer-hub/e2e-test-utils/pages";

test("search and navigate catalog", async ({ page }) => {
const catalogPage = new CatalogPage(page);
Expand Down
6 changes: 3 additions & 3 deletions docs/api/pages/extensions-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Page object for the RHDH extensions/plugins marketplace page.
## Import

```typescript
import { ExtensionsPage } from "rhdh-e2e-test-utils/pages";
import { ExtensionsPage } from "@red-hat-developer-hub/e2e-test-utils/pages";
```

## Constructor
Expand Down Expand Up @@ -181,8 +181,8 @@ Verify a key-value row in a table.

```typescript
import { test, expect } from "@playwright/test";
import { ExtensionsPage } from "rhdh-e2e-test-utils/pages";
import { UIhelper } from "rhdh-e2e-test-utils/helpers";
import { ExtensionsPage } from "@red-hat-developer-hub/e2e-test-utils/pages";
import { UIhelper } from "@red-hat-developer-hub/e2e-test-utils/helpers";

test("browse and filter extensions", async ({ page }) => {
const uiHelper = new UIhelper(page);
Expand Down
4 changes: 2 additions & 2 deletions docs/api/pages/home-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Page object for the RHDH home page.
## Import

```typescript
import { HomePage } from "rhdh-e2e-test-utils/pages";
import { HomePage } from "@red-hat-developer-hub/e2e-test-utils/pages";
```

## Constructor
Expand Down Expand Up @@ -87,7 +87,7 @@ await homePage.verifyVisitedCardContent("Recently Visited");

```typescript
import { test, expect } from "@playwright/test";
import { HomePage } from "rhdh-e2e-test-utils/pages";
import { HomePage } from "@red-hat-developer-hub/e2e-test-utils/pages";

test("verify home page features", async ({ page }) => {
const homePage = new HomePage(page);
Expand Down
4 changes: 2 additions & 2 deletions docs/api/pages/notification-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Page object for the RHDH notifications page.
## Import

```typescript
import { NotificationPage } from "rhdh-e2e-test-utils/pages";
import { NotificationPage } from "@red-hat-developer-hub/e2e-test-utils/pages";
```

## Constructor
Expand Down Expand Up @@ -202,7 +202,7 @@ Sort notifications with newest first (default).

```typescript
import { test, expect } from "@playwright/test";
import { NotificationPage } from "rhdh-e2e-test-utils/pages";
import { NotificationPage } from "@red-hat-developer-hub/e2e-test-utils/pages";

test("manage notifications", async ({ page }) => {
const notificationPage = new NotificationPage(page);
Expand Down
6 changes: 3 additions & 3 deletions docs/api/playwright/base-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Playwright configuration utilities for RHDH testing.
## Import

```typescript
import { defineConfig, baseConfig } from "rhdh-e2e-test-utils/playwright-config";
import { defineConfig, baseConfig } from "@red-hat-developer-hub/e2e-test-utils/playwright-config";
```

## `defineConfig()`
Expand All @@ -29,7 +29,7 @@ Creates a Playwright configuration with RHDH defaults.
### Example

```typescript
import { defineConfig } from "rhdh-e2e-test-utils/playwright-config";
import { defineConfig } from "@red-hat-developer-hub/e2e-test-utils/playwright-config";

export default defineConfig({
projects: [
Expand Down Expand Up @@ -75,7 +75,7 @@ Raw base configuration object. Use for advanced customization.
### Example

```typescript
import { baseConfig } from "rhdh-e2e-test-utils/playwright-config";
import { baseConfig } from "@red-hat-developer-hub/e2e-test-utils/playwright-config";
import { defineConfig as playwrightDefineConfig } from "@playwright/test";

export default playwrightDefineConfig({
Expand Down
6 changes: 3 additions & 3 deletions docs/api/playwright/global-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ When deployed:
## Disabling Global Setup

```typescript
import { baseConfig } from "rhdh-e2e-test-utils/playwright-config";
import { baseConfig } from "@red-hat-developer-hub/e2e-test-utils/playwright-config";
import { defineConfig } from "@playwright/test";

export default defineConfig({
Expand All @@ -56,7 +56,7 @@ Create your own that calls the default:

```typescript
// global-setup.ts
import { globalSetup as defaultSetup } from "rhdh-e2e-test-utils/playwright-config";
import { globalSetup as defaultSetup } from "@red-hat-developer-hub/e2e-test-utils/playwright-config";

export default async function globalSetup() {
// Your custom setup
Expand All @@ -72,7 +72,7 @@ export default async function globalSetup() {

```typescript
// playwright.config.ts
import { defineConfig } from "rhdh-e2e-test-utils/playwright-config";
import { defineConfig } from "@red-hat-developer-hub/e2e-test-utils/playwright-config";

export default defineConfig({
globalSetup: require.resolve("./global-setup"),
Expand Down
6 changes: 3 additions & 3 deletions docs/api/playwright/test-fixtures.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Custom Playwright fixtures for RHDH testing.
## Import

```typescript
import { test, expect } from "rhdh-e2e-test-utils/test";
import { test, expect } from "@red-hat-developer-hub/e2e-test-utils/test";
```

## Fixtures
Expand Down Expand Up @@ -83,15 +83,15 @@ test("using baseURL", async ({ page, baseURL }) => {
## Exported Types

```typescript
import type { Page, BrowserContext, Locator } from "rhdh-e2e-test-utils/test";
import type { Page, BrowserContext, Locator } from "@red-hat-developer-hub/e2e-test-utils/test";
```

Re-exports all Playwright types for convenience.

## Complete Example

```typescript
import { test, expect } from "rhdh-e2e-test-utils/test";
import { test, expect } from "@red-hat-developer-hub/e2e-test-utils/test";

test.describe("My Tests", () => {
test.beforeAll(async ({ rhdh }) => {
Expand Down
4 changes: 2 additions & 2 deletions docs/api/utils/bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Shell command execution via zx.
## Import

```typescript
import { $ } from "rhdh-e2e-test-utils/utils";
import { $ } from "@red-hat-developer-hub/e2e-test-utils/utils";
```

## Usage
Expand Down Expand Up @@ -47,7 +47,7 @@ try {
## Example

```typescript
import { $ } from "rhdh-e2e-test-utils/utils";
import { $ } from "@red-hat-developer-hub/e2e-test-utils/utils";

// Run setup script
await $`bash scripts/setup.sh ${namespace}`;
Expand Down
Loading