base-config.ts

/* eslint-disable no-console */
import { defineConfig } from 'cypress';
import websocketTasks from './support/utils/webSocket-utils';
import path from 'path';
import fs from 'fs';
const { removeDirectory } = require('cypress-delete-downloads-folder');
const { beforeRunHook, afterRunHook } = require('cypress-mochawesome-reporter/lib');

// Required for env vars to be available in cypress
require('dotenv').config();

/**
 * Filter test spec paths based on env var configuration
 */
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;
};

/**
 * VARIABLES
 */
const hasCoverage = (process.env.TEST_INSTRUMENT === 'true') || false; // Add coverage if instrumented
let testDirs = ['priority', 'components', 'setup', 'pages', 'navigation', 'global-ui', 'features', 'extensions'];
const skipSetup = process.env.TEST_SKIP?.includes('setup');
const baseUrl = (process.env.TEST_BASE_URL || 'https://localhost:8005').replace(/\/$/, '');
const DEFAULT_USERNAME = 'admin';
const username = process.env.TEST_USERNAME || DEFAULT_USERNAME;
const apiUrl = process.env.API || (baseUrl.endsWith('/dashboard') ? baseUrl.split('/').slice(0, -1).join('/') : baseUrl);

if (process.env.TEST_A11Y) {
  testDirs = ['accessibility'];
}

/**
 * LOGS:
 * Summary of the environment variables that we have detected (or are going ot use)
 * We won't show any passwords
 */
console.log('E2E Test Configuration');
console.log('');
console.log(`    Username: ${ username }`);

if (!process.env.CATTLE_BOOTSTRAP_PASSWORD && !process.env.TEST_PASSWORD) {
  console.log(' ❌ You must provide either CATTLE_BOOTSTRAP_PASSWORD or TEST_PASSWORD');
}
if (process.env.CATTLE_BOOTSTRAP_PASSWORD && process.env.TEST_PASSWORD) {
  console.log(' ❗ If both CATTLE_BOOTSTRAP_PASSWORD and TEST_PASSWORD are provided, the first will be used');
}
if (!skipSetup && !process.env.CATTLE_BOOTSTRAP_PASSWORD) {
  console.log(' ❌ You must provide CATTLE_BOOTSTRAP_PASSWORD when running setup tests');
}
if (skipSetup && !process.env.TEST_PASSWORD) {
  console.log(' ❌ You must provide TEST_PASSWORD when running the tests without the setup tests');
}

console.log(`    Setup tests will ${ skipSetup ? 'NOT' : '' } be run`);
console.log(`    Dashboard URL: ${ baseUrl }`);
console.log(`    Rancher API URL: ${ apiUrl }`);

// Check API - sometimes in dev, you might have API set to a different system to the base url - this won't work
// as the login cookie will be for the base url and any API requests will fail as not authenticated
if (apiUrl && !baseUrl.startsWith(apiUrl)) {
  console.log('\n ❗ API variable is different to TEST_BASE_URL - tests may fail due to authentication issues');
}

console.log('');

/**
 * Base Cypress configuration for Rancher Dashboard E2E tests
 */
const baseConfig = defineConfig({
  defaultCommandTimeout: process.env.TEST_TIMEOUT ? +process.env.TEST_TIMEOUT : 10000,
  trashAssetsBeforeRuns: true,
  chromeWebSecurity:     false,
  retries:               {
    runMode:  2,
    openMode: 0
  },
  env: {
    grepFilterSpecs:  true,
    grepOmitFiltered: true,
    baseUrl,
    coverage:         hasCoverage,
    codeCoverage:     {
      exclude: [
        'cypress/**/*.*',
        '**/__tests__/**/*.*',
        '**/__mocks__/**/*.*',
        '**/shell/scripts/**/*.*',
        'docusaurus/**/*.*',
        'stories/**/*.*',
        'drone/**/*.*',
      ],
      include: [
        'shell/**/*.{vue,ts,js}',
        'pkg/rancher-components/src/components/**/*.{vue,ts,js}',
      ]
    },
    api:                      apiUrl,
    username,
    password:                 process.env.CATTLE_BOOTSTRAP_PASSWORD || process.env.TEST_PASSWORD,
    bootstrapPassword:        process.env.CATTLE_BOOTSTRAP_PASSWORD,
    grepTags:                 process.env.GREP_TAGS,
    VAI_ENABLED:              process.env.VAI_ENABLED,
    // the below env vars are only available to tests that run in Jenkins
    awsAccessKey:             process.env.AWS_ACCESS_KEY_ID,
    awsSecretKey:             process.env.AWS_SECRET_ACCESS_KEY,
    azureSubscriptionId:      process.env.AZURE_AKS_SUBSCRIPTION_ID,
    azureClientId:            process.env.AZURE_CLIENT_ID,
    azureClientSecret:        process.env.AZURE_CLIENT_SECRET,
    customNodeIp:             process.env.CUSTOM_NODE_IP,
    customNodeKey:            process.env.CUSTOM_NODE_KEY,
    customNodeUser:           process.env.CUSTOM_NODE_USER || 'ec2-user',
    accessibility:            !!process.env.TEST_A11Y, // Are we running accessibility tests?
    a11yFolder:               path.join('.', 'cypress', 'accessibility'),
    gkeServiceAccount:        process.env.GKE_SERVICE_ACCOUNT,
    // Set to 'true' to allow skipping when a chart is filtered from the UI catalog.
    allowFilteredCatalogSkip: process.env.CYPRESS_ALLOW_FILTERED_CATALOG_SKIP,
  },
  reporter:        'cypress-mochawesome-reporter',
  reporterOptions: {
    saveJson:        true,
    saveAllAttempts: true,
    reportDir:       'cypress/reports'
  },
  e2e: {
    fixturesFolder: 'cypress/e2e/blueprints',
    setupNodeEvents(on, config) {
      // For more info: https://docs.cypress.io/guides/tooling/code-coverage
      require('@cypress/code-coverage/task')(on, config);
      require('@cypress/grep/src/plugin')(config);
      // For more info: https://www.npmjs.com/package/cypress-delete-downloads-folder

      on('task', { removeDirectory });
      websocketTasks(on, config);

      require('cypress-terminal-report/src/installLogsPrinter')(on, {
        outputRoot:           `${ config.projectRoot }/browser-logs/`,
        outputTarget:         { 'out.html': 'html' },
        logToFilesOnAfterRun: true,
        printLogsToConsole:   'never',
        // printLogsToFile:      'always', // default prints on failures
      });

      // Load Accessibility plugin if configured
      // as per https://github.com/rancher/dashboard/pull/15865 load order matters
      // this need to go after "cypress-terminal-report" always
      if (process.env.TEST_A11Y) {
        require('./support/plugins/accessibility').default(on, config);
      } else {
        // Add in the cypress-mochawesome-reporter reporter hooks
        on('before:run', async(details) => {
          await beforeRunHook(details);
        });

        // Done this way to catch errors when there are no tests run
        on('after:run', async() => {
          // We need to wait for the cypress-terminal-report plugin to finish writing the browser logs
          // There's a race condition where the mochawesome afterRunHook can finish and exit the process
          // before the terminal report is written.
          const logFile = path.join(config.projectRoot, 'browser-logs', 'out.html');
          const timeout = 5000; // 5 seconds
          const interval = 100; // 100 ms
          let waited = 0;
          const fileExists = () => {
            try {
              return fs.existsSync(logFile);
            } catch (e) {
              return false;
            }
          };

          const wait = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));

          while (waited < timeout && !fileExists()) {
            await wait(interval);
            waited += interval;
          }

          if (!fileExists()) {
            console.warn(`\n\n⚠️  Browser log file not found at ${ logFile } after ${ timeout }ms. Proceeding without it.\n\n`);
          }

          try {
            await afterRunHook();
          } catch (error) {
            console.error(error); // eslint-disable-line no-console
          }
        });
      }

      return config;
    },
    experimentalSessionAndOrigin: true,
    specPattern:                  getSpecPattern(testDirs, process.env),
    baseUrl
  },
  videoCompression:       15,
  videoUploadOnPasses:    false,
  screenshotOnRunFailure: process.env.TEST_NO_SCREENSHOTS !== 'true',
  video:                  process.env.TEST_NO_VIDEOS !== 'true'
});

// Default export is the base config
export default baseConfig;