codecept-with-puppeteer.md

id	title	hide_title	sidebar_label	description	keywords	url	site_name	slug
puppeteer-codecept	Run Puppeteer Tests Using CodeceptJS	true	Integrate With CodeceptJS	Learn how to integrate and run your Puppeteer tests using CodeceptJS across 40+ browser versions on the LambdaTest platform.	puppeteer testing with codeceptjs puppeteer codecept puppeteer mocha automation testing with puppeteer how to use puppeteer for testing test puppeteer puppeteer testing tutorial puppeteer testing lambdatest	https://www.lambdatest.com/support/docs/puppeteer-testing-with-codecept/	LambdaTest	puppeteer-testing-with-codecept/

<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify({ "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{ "@type": "ListItem", "position": 1, "name": "LambdaTest", "item": "https://www.lambdatest.com" },{ "@type": "ListItem", "position": 2, "name": "Support", "item": "https://www.lambdatest.com/support/docs/" },{ "@type": "ListItem", "position": 3, "name": "Puppeteer Testing With CodeceptJS", "item": "https://www.lambdatest.com/support/docs/puppeteer-testing-with-codecept/" }] }) }} ></script>

Puppeteer Testing With CodeceptJS

---

Learn how to run your Puppeteer tests with CodeceptJS across 40+ real browsers and operating systems on the LambdaTest platform.

Prerequisites

---

1. You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

:::tip Sample repo Download or clone the code sample for the Puppeteer Codecept from the LambdaTest GitHub repository to run the tests.

<img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub :::

git clone https://github.com/LambdaTest/puppeteer-sample.git
cd puppeteer-sample
cd puppeteer-codecept

2. Install the npm dependencies.

npm install

3. If you are running Codecept for the first time, run the below command:

npm install codeceptjs puppeteer --save

4. To run Puppeteer tests with CodeceptJS, set your LambdaTest username and access key in the environment variables. Click the Access Key button at the top-right of the Automation Dashboard to access it.

<img loading="lazy" src={require('../assets/images/auth_lt.png').default} alt="Image" width="1444" height="703" className="doc_img"/>

Windows

set LT_USERNAME="YOUR_LAMBDATEST_USERNAME"
set LT_ACCESS_KEY="YOUR_LAMBDATEST_ACCESS_KEY"

macOS/Linux

export LT_USERNAME="YOUR_LAMBDATEST_USERNAME"
export LT_ACCESS_KEY="YOUR_LAMBDATEST_ACCESS_KEY"

Running Tests Using CodeceptJS

---

Test Scenario: The below test script searches LambdaTest on DuckDuckGo and verifies the website title.

1. Navigate to the codecept.conf.js file in the puppeteer-codecept directory.

const { setHeadlessWhen } = require('@codeceptjs/configure');

// turn on headless mode when running with HEADLESS=true environment variable
// export HEADLESS=true && npx codeceptjs run
setHeadlessWhen(process.env.HEADLESS);

const caps_chrome = {
	browserName    : 'Chrome',
	browserVersion : 'latest',
	'LT:Options'   : {
		platform   : 'Windows 10',
		build      : 'Sample Puppeteer-Codecept',
		name       : 'Puppeteer-Codecept test on Chrome',
		resolution : '1366x768',
		user       : process.env.LT_USERNAME,
		accessKey  : process.env.LT_USER_KEY,
		network    : true
	}
};

const caps_edge = {
	browserName    : 'MicrosoftEdge',
	browserVersion : 'latest',
	'LT:Options'   : {
		platform   : 'Windows 10',
		build      : 'Sample Puppeteer-Codecept',
		name       : 'Puppeteer-Codecept test on Edge',
		resolution : '1366x768',
		user       : process.env.LT_USERNAME,
		accessKey  : process.env.LT_USER_KEY,
		network    : true
	}
};

exports.config = {
  tests: './specs/*.spec.js',
  output: './output',
  helpers: {
    Puppeteer: {
      chrome: {
        browserWSEndpoint : `wss://cdp.lambdatest.com/puppeteer?capabilities=${encodeURIComponent(JSON.stringify(caps_chrome))}`,
        "ignoreHTTPSErrors": true
      }
    }
  },
  include: {
    I: './steps_file.js'
  },
  bootstrap: null,
  mocha: {},
  name: 'codeceptjs-example',
  plugins: {
    pauseOnFail: {},
    retryFailedStep: {
      enabled: true
    },
    tryTo: {
      enabled: true
    },
    screenshotOnFail: {
      enabled: true
    }
  }
}

2. Now pass the below command to run your test.

npx codeceptjs run

3. Visit the LambdaTest Web Automation Dashboard to see your test results.