dceky 1.0.5-beta.ky-declarations.13 → 1.0.5

package/start/helpers/runCypressVisible.ts

@@ -0,0 +1,45 @@
+/* eslint-disable no-console */
+import { spawn } from 'child_process';
+
+// Import helpers
+import getRootPath from './getRootPath';
+
+/**
+ * Run Cypress in visible/interactive mode with a profile
+ * @author Yuen Ler Chow
+ * @param profileName - The profile name to use
+ * @returns Promise that resolves when Cypress closes
+ */
+const runCypressVisible = (profileName: string): Promise<void> => {
+  return new Promise((resolve, reject) => {
+    const root = getRootPath();
+    const env = {
+      ...process.env,
+      CYPRESS_PROFILE: profileName,
+    };
+
+    console.log(`\n🚀 Launching Cypress in interactive mode with profile: ${profileName}`);
+    console.log(`  CYPRESS_PROFILE=${profileName}\n`);
+
+    const cypressProcess = spawn('npx', ['cypress', 'open'], {
+      cwd: root,
+      env,
+      stdio: 'inherit',
+      shell: true,
+    });
+
+    cypressProcess.on('close', (code) => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(new Error(`Cypress exited with code ${code}`));
+      }
+    });
+
+    cypressProcess.on('error', (error) => {
+      reject(error);
+    });
+  });
+};
+
+export default runCypressVisible;

package/start/index.ts

@@ -17,9 +17,11 @@ import findProfilesByNames from './helpers/findProfilesByNames';
 import validateBrowsers from './helpers/validateBrowsers';
 import extractArgValue from './helpers/extractArgValue';
 import getRootPath from './helpers/getRootPath';
+import executeCypress from './helpers/executeCypress';
 
 // Import constants
 import AVAILABLE_BROWSERS from './constants/AVAILABLE_BROWSERS';
+import DEFAULT_THREADS_PER_COMBO from './constants/DEFAULT_THREADS_PER_COMBO';
 
 // Get the project directory
 const pwd = getRootPath();
@@ -86,6 +88,20 @@ const headlessFlagValue = extractArgValue(args, '--headless');
 const hasHeadlessFlag = headlessFlagValue !== undefined;
 isHeadless = !!(envHeadlessRaw && envHeadlessRaw.toLowerCase() !== 'false') || hasHeadlessFlag;
 
+// Check for THREADS_PER_COMBO (env var or CLI arg)
+const envThreadsRaw = process.env.THREADS_PER_COMBO;
+const argThreadsRaw = extractArgValue(args, '--threadsPerCombo');
+const threadsRaw = envThreadsRaw || argThreadsRaw;
+let threadsPerCombo: number | undefined;
+if (threadsRaw) {
+  const parsed = Number.parseInt(threadsRaw, 10);
+  if (!Number.isNaN(parsed) && parsed > 0) {
+    threadsPerCombo = parsed;
+  } else {
+    console.warn(`⚠️ Invalid THREADS_PER_COMBO value: "${threadsRaw}". Using default (${DEFAULT_THREADS_PER_COMBO}).`);
+  }
+}
+
 // If headless wasn't specified, ask the user to choose
 if (!envHeadlessRaw && !hasHeadlessFlag) {
   const choices = showChooser({
@@ -157,8 +173,10 @@ if (
   selectedProfiles = choices.map((choice) => { return profiles[choice.index]; });
 }
 
-// Execute commands for each combination of profile and browser (not yet implemented)
-console.log('Starting Cypress with the following configuration:');
-console.log(`Profiles: ${selectedProfiles.map((p) => { return p.profileName; }).join(', ')}`);
-console.log(`Browsers: ${selectedBrowsers.join(', ')}`);
-console.log(`Headless: ${isHeadless}`);
+// Execute Cypress with selected configuration
+executeCypress({
+  selectedProfiles,
+  selectedBrowsers,
+  isHeadless,
+  threadsPerCombo,
+});

package/start/types/MochawesomeReporterConfig.ts

@@ -0,0 +1,23 @@
+/**
+ * Mochawesome reporter configuration
+ * @author Yuen Ler Chow
+ */
+type MochawesomeReporterConfig = {
+  // The reporter(s) to enable (e.g., "mochawesome")
+  reporterEnabled: string;
+  // Options for the mochawesome reporter
+  mochawesomeReporterOptions: {
+    // Directory where report files will be saved
+    reportDir: string;
+    // Filename pattern for report files (supports [name] placeholder)
+    reportFilename: string;
+    // Whether to overwrite existing report files
+    overwrite: boolean;
+    // Whether to generate HTML reports
+    html: boolean;
+    // Whether to generate JSON reports
+    json: boolean;
+  };
+};
+
+export default MochawesomeReporterConfig;

package/start/types/Profile.ts

@@ -0,0 +1,12 @@
+/**
+ * Profile configuration
+ * @author Yuen Ler Chow
+ */
+type Profile = {
+  // The filename of the profile (e.g., "prod.Profile.ts")
+  file: string;
+  // The name of the profile extracted from the filename (e.g., "prod")
+  profileName: string;
+};
+
+export default Profile;

package/start/types/ReportInfo.ts

@@ -0,0 +1,22 @@
+/**
+ * Information about a generated report
+ * @author Yuen Ler Chow
+ */
+type ReportInfo = {
+  // The name of the profile (e.g., "prod", "stage")
+  profileName: string;
+  // The browser used (e.g., "chrome", "edge")
+  browser: string;
+  // Path to the generated HTML report file
+  reportPath: string;
+  // True if the test run was successful
+  success: boolean;
+  // Human-readable timestamp of when the report was generated
+  timestamp: string;
+  // Total number of tests in the report
+  totalTests?: number;
+  // Number of tests that passed
+  passedTests?: number;
+};
+
+export default ReportInfo;

package/start/types/RunResult.ts

@@ -0,0 +1,18 @@
+/**
+ * Result from a Cypress headless run
+ * @author Yuen Ler Chow
+ */
+type RunResult = {
+  // The name of the profile used for this run (e.g., "prod", "stage")
+  profileName: string;
+  // The browser used for this run (e.g., "chrome", "edge")
+  browser: string;
+  // Whether the test run completed successfully (all tests passed and report generated)
+  success: boolean;
+  // The output directory for this specific profile+browser combination
+  outputDir: string;
+  // Path to the generated HTML report file, undefined if report generation failed
+  reportPath?: string;
+};
+
+export default RunResult;

package/start/types/ScreenshotInfo.ts

@@ -0,0 +1,13 @@
+/**
+ * Information about a screenshot captured during a Cypress test run,
+ * used for linking screenshots in the report homepage
+ * @author Yuen Ler Chow
+ */
+type ScreenshotInfo = {
+  // Relative URL path to the screenshot file from the report homepage
+  href: string;
+  // Display name for the screenshot (typically the relative file path)
+  name: string;
+};
+
+export default ScreenshotInfo;

package/start/types/TemplateReportInfo.ts

@@ -0,0 +1,16 @@
+import ReportInfo from './ReportInfo';
+import ScreenshotInfo from './ScreenshotInfo';
+
+/**
+ * Extended version of ReportInfo with additional computed fields
+ * needed for rendering the EJS report homepage template
+ * @author Yuen Ler Chow
+ */
+type TemplateReportInfo = ReportInfo & {
+  // Relative URL path to the HTML report file, or null if report doesn't exist
+  relativeReportPath: string | null;
+  // List of screenshots captured during this test run
+  screenshots: ScreenshotInfo[];
+};
+
+export default TemplateReportInfo;

package/src/commands/visitCanvasGETEndpoint.ts

@@ -1,61 +0,0 @@
-/// <reference types="cypress" />
-
-/*----------------------------------------*/
-/* ---------------- Type ---------------- */
-/*----------------------------------------*/
-
-declare global {
-  namespace Cypress {
-    interface Chainable {
-      /**
-       * Makes a GET request to Canvas API endpoint
-       * @author Yuen Ler Chow
-       * @param opts object containing all arguments
-       * @param opts.path The API path (e.g., '/courses', '/users/self')
-       * @param opts.accessToken The Canvas access token
-       * @return Cypress chainable containing the Canvas API response body
-       */
-      visitCanvasGETEndpoint(
-        opts: {
-          path: string,
-          accessToken: string,
-        }
-      ): Chainable<any>;
-    }
-  }
-}
-
-/*----------------------------------------*/
-/* --------------- Command -------------- */
-/*----------------------------------------*/
-
-const visitCanvasGETEndpoint = () => {
-  Cypress.Commands.add(
-    'visitCanvasGETEndpoint',
-    (
-      opts: {
-        path: string,
-        accessToken: string,
-      },
-    ) => {
-      cy.log('Visiting Canvas GET endpoint');
-      const { path, accessToken } = opts;
-
-      cy.log(`Canvas API: ${path}`);
-      return cy.request({
-        method: 'GET',
-        url: `https://canvas.harvard.edu/api/v1${path}`,
-        qs: {
-          per_page: 200,
-          access_token: accessToken,
-        },
-      }).its('body');
-    },
-  );
-};
-
-/*----------------------------------------*/
-/* --------------- Export --------------- */
-/*----------------------------------------*/
-
-export default visitCanvasGETEndpoint;