haven-cypress-integration 2.0.2 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "haven-cypress-integration",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Seamless Cypress integration with HAVEN test case management",
   "main": "index.js",
   "bin": {

package/support.js

@@ -10,6 +10,13 @@
 
 const addContext = require('mochawesome/addContext');
 
+// Sanitize filename to match Cypress's screenshot naming behavior
+// Cypress replaces filesystem-unsafe characters with double spaces
+function sanitizeFilename(name) {
+  // Characters Cypress replaces: / \ ? % * : | " < >
+  return name.replace(/[/\\?%*:|"<>]/g, '  ');
+}
+
 // Attach failed test screenshots to mochawesome report
 // This enables screenshots to appear inline in the mochawesome HTML report
 Cypress.on('test:after:run', (test, runnable) => {
@@ -26,8 +33,15 @@ Cypress.on('test:after:run', (test, runnable) => {
     }
     
     // Cypress screenshot naming: {specName}/{all describes joined by ' -- '} -- {testTitle} (failed).png
+    // Must sanitize same way Cypress does for filesystem-safe filenames
     const fullTitle = [...titleParts, test.title].join(' -- ');
-    const screenshotPath = `screenshots/${specName}/${fullTitle} (failed).png`;
+    const sanitizedTitle = sanitizeFilename(fullTitle);
+    const screenshotPath = `screenshots/${specName}/${sanitizedTitle} (failed).png`;
+    
+    // Debug: Log the generated path
+    console.log('[Haven] Screenshot path generated:', screenshotPath);
+    console.log('[Haven] Title parts:', titleParts);
+    console.log('[Haven] Test title:', test.title);
     
     // Add screenshot to mochawesome context (will appear in HTML report)
     addContext({ test }, screenshotPath);

package/templates/run-filtered.sh

@@ -23,6 +23,42 @@ done
 echo "automationIds: ${AUTOMATION_IDS}"
 echo "customTags: ${CUSTOM_TAGS}"
 
+# =============================================================================
+# HAVEN ENV VAR BRIDGE
+# =============================================================================
+# Collect all custom env vars from Haven and build Cypress --env args.
+# This bridges Haven's env vars to Cypress's expected format.
+#
+# System/internal vars are excluded; everything else is passed to Cypress.
+# =============================================================================
+
+# Pattern for system/internal vars to EXCLUDE from Cypress --env
+EXCLUDE_VARS="^(PATH|HOME|USER|SHELL|PWD|OLDPWD|TERM|LANG|LC_.*|AWS_.*|HOSTNAME|SHLVL|_|NODE_.*|NPM_.*|HAVEN_GREP_PATTERN|ADO_REPO|ADO_PAT|ADO_BRANCH|RUN_ID|PLAN_ID|PRODUCT_NAME|BUCKET_NAME|TRIGGERED_BY|INSTANCE_TYPE|E2E_COMMAND|TEST_ENVIRONMENT|CUSTOM_TAGS|AUTOMATION_IDS|HAVEN_BROWSERS|LS_COLORS|SSH_.*|XDG_.*|DISPLAY|COLORTERM|LESSOPEN|LESSCLOSE|MAIL|LOGNAME|EDITOR|VISUAL|PAGER|MANPATH|INFOPATH|HISTSIZE|HISTFILESIZE|HISTCONTROL|PS1|PS2|PROMPT_COMMAND|IFS)$"
+
+echo "=== Building Cypress env vars from Haven ==="
+CUSTOM_ENV_ARGS=""
+
+while IFS='=' read -r key value; do
+  # Skip empty keys or excluded system vars
+  if [ -z "$key" ] || echo "$key" | grep -qE "$EXCLUDE_VARS"; then
+    continue
+  fi
+  
+  # Add to Cypress env args
+  if [ -n "$CUSTOM_ENV_ARGS" ]; then
+    CUSTOM_ENV_ARGS="${CUSTOM_ENV_ARGS},${key}=${value}"
+  else
+    CUSTOM_ENV_ARGS="${key}=${value}"
+  fi
+  
+  # Also export with CYPRESS_ prefix as fallback for test code access
+  export "CYPRESS_${key}=${value}"
+  
+  echo "  -> ${key}=*** (bridged to Cypress)"
+done < <(env | grep -v "^_=" | sort)
+
+echo "Custom env vars collected: $(echo "$CUSTOM_ENV_ARGS" | tr ',' '\n' | wc -l | tr -d ' ') variables"
+
 TIMESTAMP=$(date +%m%d%Y_%H%M%S)
 PRODUCT_NAME=${PRODUCT_NAME:-unknown_product}
 PLAN_ID=${PLAN_ID:-unknown_plan}
@@ -126,46 +162,91 @@ if [ -z "$GREP_TAGS" ] && [ -z "$GREP_INVERT_TAGS" ]; then
   fi
 fi
 
-# Build Cypress grep arguments
-CYPRESS_GREP_ARGS=""
+# Export grep patterns for downstream use
 if [ -n "$GREP_TAGS" ]; then
   export HAVEN_GREP_INCLUDE="${GREP_TAGS}"
-  CYPRESS_GREP_ARGS="--env grepTags='${GREP_TAGS}'"
-  echo "Include pattern (HAVEN_GREP_INCLUDE): ${GREP_TAGS}"
+  echo "Include pattern: ${GREP_TAGS}"
 fi
 
 if [ -n "$GREP_INVERT_TAGS" ]; then
   export HAVEN_GREP_EXCLUDE="${GREP_INVERT_TAGS}"
-  # Cypress grep uses grepInvert for exclusion
-  if [ -n "$CYPRESS_GREP_ARGS" ]; then
-    CYPRESS_GREP_ARGS="${CYPRESS_GREP_ARGS},grepInvert='${GREP_INVERT_TAGS}'"
-  else
-    CYPRESS_GREP_ARGS="--env grepInvert='${GREP_INVERT_TAGS}'"
-  fi
-  echo "Exclude pattern (HAVEN_GREP_EXCLUDE): ${GREP_INVERT_TAGS}"
+  echo "Exclude pattern: ${GREP_INVERT_TAGS}"
 fi
 
 if [ -z "$GREP_TAGS" ] && [ -z "$GREP_INVERT_TAGS" ]; then
-  echo "No tags provided. Running all tests..."
+  echo "No tag filters provided. Running all tests..."
 fi
 
 # Run Cypress
 echo "Running Cypress tests..."
 set +e
 
+# Build final --env string combining custom vars and grep patterns
+FINAL_ENV_ARGS=""
+
+# Add custom env vars from Haven
+if [ -n "$CUSTOM_ENV_ARGS" ]; then
+  FINAL_ENV_ARGS="${CUSTOM_ENV_ARGS}"
+fi
+
+# Add grep patterns (include)
+if [ -n "$GREP_TAGS" ]; then
+  if [ -n "$FINAL_ENV_ARGS" ]; then
+    FINAL_ENV_ARGS="${FINAL_ENV_ARGS},grepTags=${GREP_TAGS}"
+  else
+    FINAL_ENV_ARGS="grepTags=${GREP_TAGS}"
+  fi
+fi
+
+# Add grep patterns (exclude) - Cypress uses negative pattern with - prefix
+if [ -n "$GREP_INVERT_TAGS" ]; then
+  # Append exclude tags with - prefix to grepTags
+  EXCLUDE_WITH_PREFIX=$(echo "$GREP_INVERT_TAGS" | sed 's/ / -/g' | sed 's/^/-/')
+  if [ -n "$FINAL_ENV_ARGS" ]; then
+    # If grepTags already exists, append exclude patterns
+    if echo "$FINAL_ENV_ARGS" | grep -q "grepTags="; then
+      FINAL_ENV_ARGS=$(echo "$FINAL_ENV_ARGS" | sed "s/grepTags=\([^,]*\)/grepTags=\1 ${EXCLUDE_WITH_PREFIX}/")
+    else
+      FINAL_ENV_ARGS="${FINAL_ENV_ARGS},grepTags=${EXCLUDE_WITH_PREFIX}"
+    fi
+  else
+    FINAL_ENV_ARGS="grepTags=${EXCLUDE_WITH_PREFIX}"
+  fi
+fi
+
+# Add standard grep options
+if [ -n "$FINAL_ENV_ARGS" ]; then
+  FINAL_ENV_ARGS="${FINAL_ENV_ARGS},grepFilterSpecs=true,grepUntagged=false,grepEnabled=true"
+else
+  FINAL_ENV_ARGS="grepFilterSpecs=true,grepUntagged=false,grepEnabled=true"
+fi
+
+# Add TEST_ENVIRONMENT
+FINAL_ENV_ARGS="${FINAL_ENV_ARGS},TEST_ENVIRONMENT=${TEST_ENVIRONMENT}"
+
+echo "Final Cypress --env args: ${FINAL_ENV_ARGS}"
+
 if [ -n "$E2E_COMMAND" ]; then
   echo "Using custom E2E command: $E2E_COMMAND"
-  eval "$E2E_COMMAND" 2>&1 | tee ${RESULTS_DIR}/logs.txt
+  
+  # If E2E_COMMAND contains "cypress run", inject --env args
+  if echo "$E2E_COMMAND" | grep -q "cypress run"; then
+    MODIFIED_COMMAND=$(echo "$E2E_COMMAND" | sed "s/cypress run/cypress run --env '${FINAL_ENV_ARGS}'/")
+    echo "Modified command with env args: $MODIFIED_COMMAND"
+    eval "$MODIFIED_COMMAND" 2>&1 | tee ${RESULTS_DIR}/logs.txt
+  else
+    # For npm scripts like "npm run test:cy", env vars are already exported with CYPRESS_ prefix
+    echo "Note: Custom command doesn't contain 'cypress run'. CYPRESS_* env vars exported as fallback."
+    eval "$E2E_COMMAND" 2>&1 | tee ${RESULTS_DIR}/logs.txt
+  fi
 else
   echo "Using default: npx cypress run"
-  echo "Final grep args: $CYPRESS_GREP_ARGS"
   eval "npx cypress run \
     --headless \
     --browser chrome \
     --reporter mochawesome \
     --reporter-options 'reportDir=${MOCHAWESOME_DIR},overwrite=false,html=false,json=true,timestamp=mmddyyyy_HHMMss' \
-    --env grepFilterSpecs=true,grepUntagged=false,grepEnabled=true,TEST_ENVIRONMENT=${TEST_ENVIRONMENT} \
-    $CYPRESS_GREP_ARGS" 2>&1 | tee ${RESULTS_DIR}/logs.txt
+    --env '${FINAL_ENV_ARGS}'" 2>&1 | tee ${RESULTS_DIR}/logs.txt
 fi
 
 EXIT_CODE=${PIPESTATUS[0]}