Fix TEST_SKIP flag; Update README.md

Signed-off-by: Francesco Torchia <[email protected]>

Author: torchiaf

.github/workflows/test.yaml

@@ -58,7 +58,6 @@ jobs:
           TEST_PASSWORD: ${{ env.CATTLE_BOOTSTRAP_PASSWORD }}
           CATTLE_BOOTSTRAP_PASSWORD: ${{ env.CATTLE_BOOTSTRAP_PASSWORD }}
           TEST_BASE_URL: ${{ env.DEV_UI_URL }}
-          TEST_SKIP: setup
           API: ${{ env.CATTLE_SERVER_URL }}
         run: |
           yarn e2e --browser chrome

README.md

@@ -1,7 +1,16 @@
-> :warning: Warning! This project is in its very early stages of development. Expect frequent changes and potential breaking updates as we iterate on features and architecture.
-
 # rancher-ai-ui
 
+The Rancher AI UI extension adds an AI-powered chat assistant directly into the Rancher Dashboard.
+
+It helps users interact with clusters and workloads using conversational queries and suggested actions — improving discoverability, troubleshooting, and automation.
+
+It also adds direct links in the Rancher UI to the Chat, available on resource lists, resource detail pages and the global navigation — making it quick to start a conversation about any cluster object or action.
+
+Key features
+- Conversational assistant integrated into Rancher UI
+- Actionable suggestions and templates to speed common workflows
+- Support for configurable LLM backends (local or remote)
+
 ## Running for Development
 This is what you probably want to get started.
 ```bash
@@ -35,20 +44,38 @@ yarn serve-pkgs
 ```
 
 ## E2E tests
-Running locally:
+
+#### Launch the mock Agent
 ```bash
-# Build and Run the mock Agent
 cd mock-agent
 yarn install
 yarn start
+```
 
-# Launch dev UI
+#### Launch UI in dev mode
+```bash
 API=https://your-rancher VUE_APP_AGENT_MESSAGES_WS_PATH=ws://localhost:8000/ws/agent yarn dev
+```
 
-# Launch Cypress Dashboard
+#### Launch Cypress
+
+```bash
+# Launch Cypress dashboard - interactive mode
 TEST_SKIP=setup TEST_PASSWORD=${rancher-password} yarn cypress:open
+
+# Run Cypress tests in background
+TEST_SKIP=setup TEST_PASSWORD=${rancher-password} yarn cypress:run
 ```
 
+#### Environment variables
+- `API`, the address of your Rancher instance.
+- `TEST_USERNAME`, default `admin`.
+- `TEST_PASSWORD`, user password or custom during first Rancher run.
+- `CATTLE_BOOTSTRAP_PASSWORD`, initialization password.
+- `TEST_BASE_URL`, Rancher UI dev URL, default `https://localhost:8005`.
+- `TEST_SKIP=setup`, avoid to execute bootstrap setup tests for already initialized Rancher instances, it has to be toggled in case of new instances
+
+
 License
 =======
 Check Rancher AI UI Apache License details [here](LICENSE)

cypress.config.ts

@@ -10,6 +10,7 @@ require('dotenv').config();
 /**
  * VARIABLES
  */
+let testDirs = ['setup', 'pages'];
 const hasCoverage = (process.env.TEST_INSTRUMENT === 'true') || false; // Add coverage if instrumented
 const skipSetup = process.env.TEST_SKIP?.includes('setup');
 const baseUrl = (process.env.TEST_BASE_URL || 'https://localhost:8005').replace(/\/$/, '');
@@ -49,6 +50,28 @@ if (apiUrl && !baseUrl.startsWith(apiUrl)) {
   console.log('\n ❗ API variable is different to TEST_BASE_URL - tests may fail due to authentication issues');
 }
 
+/**
+ * Filter test spec paths based on env var configuration
+ * @returns
+ */
+const getSpecPattern = (dirs: string[], envs: NodeJS.ProcessEnv): string[] => {
+  // Gets paths with only
+  const onlyDirs = dirs.filter((dir) => (envs.TEST_ONLY?.split(',').map((env) => env.trim()).includes(dir)));
+
+  // List the test directories to be included
+  const activeDirs = dirs.filter((dir) => !(envs.TEST_SKIP?.split(',').map((env) => env.trim()).includes(dir)));
+
+  const finalDirs = onlyDirs.length ? onlyDirs : activeDirs;
+  const paths = finalDirs.map((dir) => `cypress/e2e/tests/${ dir }/**/*.spec.ts`);
+
+  if (process.env.NODE_ENV !== 'test') {
+    // eslint-disable-next-line no-console
+    console.log(`Running tests for paths: ${ paths.join(', ') }`);
+  }
+
+  return paths;
+};
+
 export default defineConfig({
   projectId:             process.env.TEST_PROJECT_ID,
   defaultCommandTimeout: process.env.TEST_TIMEOUT ? +process.env.TEST_TIMEOUT : 10000,
@@ -89,7 +112,7 @@ export default defineConfig({
   e2e: {
     fixturesFolder:               'cypress/e2e/blueprints',
     experimentalSessionAndOrigin: true,
-    specPattern:                  'cypress/e2e/tests/**/*.spec.ts',
+    specPattern:                  getSpecPattern(testDirs, process.env),
     baseUrl,
     async setupNodeEvents(on, config) {
       // For more info: https://docs.cypress.io/guides/tooling/code-coverage

cypress/e2e/tests/chat.spec.ts renamed to cypress/e2e/tests/pages/chat.spec.ts

@@ -24,7 +24,7 @@
     "lint-l10n": "./node_modules/.bin/yamllint pkg/rancher-ai-ui/l10n/en-us.yaml",
     "cypress:open": "cypress open --e2e --browser chrome",
     "cypress:run": "cypress run",
-    "e2e": "TEST_SKIP=setup CATTLE_BOOTSTRAP_PASSWORD=$CATTLE_BOOTSTRAP_PASSWORD TEST_PASSWORD=$TEST_PASSWORD TEST_USERNAME=$TEST_USERNAME VAI_ENABLED=$VAI_ENABLED TEST_BASE_URL=$TEST_BASE_URL API=$API yarn cypress:run --spec 'cypress/e2e/tests/rancher-setup.spec.ts,cypress/e2e/tests/**/*.spec.ts'"
+    "e2e": "CATTLE_BOOTSTRAP_PASSWORD=$CATTLE_BOOTSTRAP_PASSWORD TEST_PASSWORD=$TEST_PASSWORD TEST_USERNAME=$TEST_USERNAME VAI_ENABLED=$VAI_ENABLED TEST_BASE_URL=$TEST_BASE_URL API=$API yarn cypress:run"
   },
   "devDependencies": {
     "@types/lodash": "4.17.20",