Cypress

Before you run the test, make sure to create a ZIP package by following these steps:

1. Specify ZIP Content and Entry Point Script: Ensure that the ZIP file contains, along with tests, the following files in the root directory:

   • macOS:

     run-test.sh

   • Windows:

     run-test.ps1

   Tip

   For a dual setup to work for both macOS and Windows, you can include both scripts in the ZIP.

2. Indicate Cypress Paths for Screenshots, Results, and Videos: BitBar expects Cypress screenshots, results, and videos to be stored at the default Cypress paths, viewed from the root directory:

   • Screenshots: ./cypress/screenshots (learn more about configuring screenshots)

   • Videos: ./cypress/videos (learn more about configuring videos)

   • Results: ./cypress/results

3. Set up TEST-all.xml Generation for Test Result Presentation with junit-report-merger: To display test results effectively in the UI, create a TEST-all.xml file at the root directory of your tests. This file should be a merge of JUnit reports from different specs. Currently, BitBar supports only JUnit reporters for this purpose. Use Cypress's recommended junit-report-merger tool for merging reports. Specify the reporter either in your Cypress configuration or in a command line when running Cypress.

   Example 1. Setting up TEST-all.xml generation with junit-report-merger:

   npm install junit-report-merger --save-dev
   ./node_modules/.bin/jrm ./TEST-all.xml "cypress/results/*.xml"

   
   
   

4. Specify Browsers for Testing: If you wish to run tests on specific browsers, you will need to use the Launch by a path approach. The paths for different browsers are:

   • macOS:

     /opt/nodes/node-chrome-<version>/browser/Chrome.app/Contents/MacOS/Google Chrome

     /opt/nodes/node-firefox-<version>/browser/Firefox.app/Contents/MacOS/firefox

     /opt/nodes/node-safari-<version>/browser/Safari.app/Contents/MacOS/Safari

   • Windows:

     C:\nodes\node-chrome-<version>\browser\chrome.exe

5. Craft a Lean ZIP Package: When creating the ZIP package, ensure efficiency by excluding unnecessary and heavy files such as node_modules. Additionally, prevent the inclusion of existing results by removing them first. A helpful approach is executing rm -rf cypress/screenshots cypress/results cypress/videos before zipping, ensuring a streamlined package ready for efficient testing.

   Example 2. Creating a ZIP package:

   zip -r rwa.zip backend codecov.yml cypress cypress.config.js cypress.d.ts data package.json public run-test.sh sandbox.config.json scripts src tsconfig.json tsconfig.tsnode.json yarn.lock run-test.ps1 .env .yarnrczip -r kitchensink.zip app cypress cypress.config.js package-lock.json package.json scripts serve.json run-test.sh run-test.ps1

   
   
   

To create an automated test using Cypress, follow these steps:

1. From the dashboard, navigate to Create Automated Test > Desktop (Windows, Linux & macOS).

   Note

   The process does not currently offer support for Linux.

2. Select Desktop Browser Cypress Server Side.

3. Choose or upload a zipped package that includes your test files alongside an entry point script, which initiates the test execution process.

4. Choose a device from:

   • Use existing device group

   • Use chosen devices

   • Use currently idle device(s)

5. Create and run the automated test.

To check the result of your test, go to the Projects section on the navigation pane and choose the one that interests you. Click the project, select a Test Run, and Go to results. The Device Session provides information on:

1. Device Session Browser

2. Session Details:

   • Analytics

   • Device

   • Tests and Steps

   • Issues

3. Artifacts:

   • Screenshots

   • Videos

   • Files

4. TEST-all.xml

5. Create and run the automated test.