Running Playwright Tests in Jenkins

Searching "Playwright vs Jenkins"? You don't have to choose. Playwright is the test framework: it drives the browser and reports what passed. Jenkins is the CI server that decides when those tests run, whether that's every push, every pull request or a nightly job. Teams on Jenkins usually run Playwright inside it, and that is what this guide sets up: a Jenkinsfile that runs the suite in Microsoft's Playwright Docker image and publishes the HTML and JUnit reports. If you do want the two side by side on features and pricing, see the Playwright vs Jenkins comparison.

Prerequisites#

Before diving into the Jenkins integration, ensure you have:

• Jenkins (version 2.332 or higher)
• Node.js (version 16+ recommended)
• npm or yarn package manager
• Playwright installed (latest version)
• Basic understanding of CI/CD concepts
• Git repository with existing Playwright tests
• Administrative access to Jenkins server

Setting Up Jenkins for Playwright#

Configuring Jenkins Plugins#

To integrate Playwright effectively, you'll need to install several Jenkins plugins:

# Install required Jenkins plugins
jenkins-plugin-manager --plugins \
  git \
  nodejs \
  workflow-aggregator \
  credentials \
  ssh-credentials

# Install required Jenkins plugins
jenkins-plugin-manager --plugins \
  git \
  nodejs \
  workflow-aggregator \
  credentials \
  ssh-credentials

Creating a Jenkinsfile for Playwright Tests#

Here's a comprehensive Jenkinsfile configuration:

// Jenkinsfile for Playwright Test Execution
pipeline {
  agent {
    docker {
      image 'mcr.microsoft.com/playwright:latest'
      args '-u root'
    }
  }

  environment {
    NODE_ENV = 'test'
    PLAYWRIGHT_BROWSERS = 'chromium,firefox'
  }

  stages {
    stage('Checkout') {
      steps {
        git branch: 'main',
            url: 'https://github.com/your-org/playwright-tests.git'
      }
    }

    stage('Install Dependencies') {
      steps {
        sh 'npm ci'
      }
    }

    stage('Run Playwright Tests') {
      steps {
        script {
          try {
            sh 'npx playwright test --reporter=html,junit'
          } catch (err) {
            currentBuild.result = 'UNSTABLE'
          }
        }
      }
      post {
        always {
          junit 'test-results/**/*.xml'
          publishHTML([
            reportName: 'Playwright Test Report',
            reportDir: 'playwright-report',
            reportFiles: 'index.html',
            allowMissing: false
          ])
        }
      }
    }
  }
}

// Jenkinsfile for Playwright Test Execution
pipeline {
  agent {
    docker {
      image 'mcr.microsoft.com/playwright:latest'
      args '-u root'
    }
  }

  environment {
    NODE_ENV = 'test'
    PLAYWRIGHT_BROWSERS = 'chromium,firefox'
  }

  stages {
    stage('Checkout') {
      steps {
        git branch: 'main',
            url: 'https://github.com/your-org/playwright-tests.git'
      }
    }

    stage('Install Dependencies') {
      steps {
        sh 'npm ci'
      }
    }

    stage('Run Playwright Tests') {
      steps {
        script {
          try {
            sh 'npx playwright test --reporter=html,junit'
          } catch (err) {
            currentBuild.result = 'UNSTABLE'
          }
        }
      }
      post {
        always {
          junit 'test-results/**/*.xml'
          publishHTML([
            reportName: 'Playwright Test Report',
            reportDir: 'playwright-report',
            reportFiles: 'index.html',
            allowMissing: false
          ])
        }
      }
    }
  }
}

Advanced Configuration Options#

Parallel Test Execution#

Optimize your test suite by enabling parallel execution:

// playwright.config.ts
export default defineConfig({
  workers: process.env.CI ? 2 : undefined,
  reporter: [
    ["html", { open: "never" }],
    ["junit", { outputFile: "test-results/junit.xml" }],
  ],
});

// playwright.config.ts
export default defineConfig({
  workers: process.env.CI ? 2 : undefined,
  reporter: [
    ["html", { open: "never" }],
    ["junit", { outputFile: "test-results/junit.xml" }],
  ],
});

Browser-Specific Test Targeting#

// Selective browser testing
const browserOptions = {
  chromium: { headless: true },
  firefox: { headless: true },
  webkit: { headless: true },
};

// Selective browser testing
const browserOptions = {
  chromium: { headless: true },
  firefox: { headless: true },
  webkit: { headless: true },
};

Troubleshooting Jenkins Playwright Integration#

Best Practices#

• Use dedicated Jenkins agents for browser testing
• Implement comprehensive error reporting
• Configure test timeouts strategically
• Leverage Docker for consistent test environments
• Use environment-specific configuration management
• Implement comprehensive logging
• Secure credentials using Jenkins Credentials Manager

Next Steps#

• Explore advanced Playwright testing strategies
• Integrate performance monitoring tools
• Learn about browser-specific test configurations
• Investigate containerized test environments
• Master Jenkins pipeline optimization techniques