Cypress

1. Launch a terminal in your IDE.
2. In the workspace folder, create a new folder, for example CypressSEDemo (as shown in the images included in this article). This is the folder we refer to as tests root folder.
3. Change to the new folder you created.

4. Run the following command to create the package.json file:

   Copy

   npm init

5. In the generated package.json file, specify the name of the package, version, and Cypress version, as follows:

   Copy

   {
     "name": "<NAME>",
     "version": "<VERSION>",
     "dependencies": {
       "cypress": "^<CYPRESS_VERSION>",
       "perfecto-cypress-sdk": "^0.0.52",
       "perfecto-cypress-reporter": "^0.0.12"
     }
   }

   Where:

   • <NAME> and <VERSION> can be anything you like.

   • <CYPRESS_VERSION> can be any version, but consider using one of the cached versions to get better performance (see also Support info).

6. To install Cypress, run the following command from the command line:

   Copy

   npm install cypress --save-dev 

   --save-dev saves it as a dependency in the package.json file.

7. To launch Cypress, run the following command: 

   Copy

   npx cypress open

   This launches the Cypress UI and also creates a cypress folder inside the CypressSEDemo folder you created in step 1, including the cypress.json file.

8. In the Cypress UI:
   1. Click any *.spec.js file and launch it in the selected browser.
   2. Close the Cypress UI.

1. Install the Perfecto-Cypress SDK by running the following command (make sure your location is inside the tests root folder, which includes the cypress folder):

   Copy

   npm install perfecto-cypress-sdk --save-dev

2. To add Perfecto Cypress Reporter capabilities, run the following command:

   Copy

   npm install perfecto-cypress-reporter --save-dev 

Running Cypress tests in Perfecto requires the following configuration files:

• perfecto-config.json: See Perfectoconfig options.
• cypress.json: See the Cypress documentation.
• package.json: All dependencies that your project needs to execute the Cypress run command.

To initialize the SDK:

1. Run the init command to generate perfecto-config.json (see also Perfecto-config.json details) (make sure your location is inside the tests root folder, which includes the cypress folder)::

   Copy

   npx perfecto-cypress init --tests.path=./ --skip

   where --skip omits the interactive questions that otherwise occur (about the cloud name, security token, and so on).

2. In the perfecto-config.json file, define the following:
   • The cloud name, for example demo. The SDK automatically adds .perfectomobile.com.
   • The security token, either hard-coded or passed later as a parameter in the command line.
   • The test specs you want to execute in the cloud, for example **/*.specs.js for the specsExt parameter

3. Depending on your Cypress version:

   • Version 10:

     Import perfecto-cypress-reporter into the support file cypress/support/e2e.js by adding the following code.

   • Version 9 and earlier:

     Import perfecto-cypress-reporter into the support file cypress/support/index.js by adding the following code.

   Copy

   import 'perfecto-cypress-reporter' // or require('perfecto-cypress-reporter');

4. Use the following SDK commands as needed: run, pack, upload

   For more information on these commands, run the --help command.

   Copy

   Help

   npx perfecto-cypress --help
   perfecto-cypress <command>Commands:
     perfecto-cypress init    init Perfecto and Cypress configuration files
     perfecto-cypress pack    Zip tests files according to configurations
     perfecto-cypress run     Run Cypress tests on Perfecto cloud
     perfecto-cypress upload  Upload tests zip archive to Perfecto cloud repository
   
   Options:
     --version  Show version number                                       [boolean]
     --help     Show help                                                 [boolean]

Alternative upload option

As an alternative to the SDK, you can upload your project through the Perfecto UI. To do this, perform the following steps:

1. Pack your project, as follows:

   1. Go to your project folder.

   2. Open a command line window.

   3. Run the following command to create a zip file of your project:

      Copy

      npx perfecto-cypress pack

2. Upload your compressed project to the Perfecto repository using the Perfecto UI (see also Manage the repository):

   1. In a browser, navigate to the URL of your Perfecto cloud.

   2. On the landing page, under Assets and Setup, click ACCOUNT SETUP.

   3. In the Repository view, click the upload icon at the bottom right:

      1. Browse to the zip file you want to upload.

      2. In the File upload dialog box, make sure that the name of the zip file is unique, select Private or Public, and click UPLOAD.

3. From your project's root folder (where perfecto-config.json is located), run your project with the tests.artifactKey parameter, as follows:

   Copy

   npx perfecto-cypress run --tests.artifactKey=<PRIVATE/PUBLIC>:<zip file name>

For a quick execution, perform the following steps:

1. Run the command from terminal, as follows:

   Copy

   npx perfecto-cypress run --config=.\CypressSEDemo\perfecto-config.json 

   where CypressSEDemo is the name of the folder you created in step Launch a terminal in your IDE..

2. Launch Perfecto and go to Test Analysis > Live Stream to view the live execution.

   When it is done, you can see the results based on the CI Job or Project, or you can open the report link that should appear in the command line window.

   Tip: The test report also provides an option for downloading the Cypress logs. In the report, at the top right, click the download button  and select Cypress logs.

Following is a complete list of command line parameters, including the known reporting perfecto-cypress-sdk options to be passed.

npx perfecto-cypress run --help
perfecto-cypress run

Run Cypress tests on Perfecto cloud

Credentials options (will override config file)
  --credentials.cloud, --cloud          Cloud name                      [string]
  --credentials.securityToken, --token  Offline token                   [string]

Test options (will override config file)
  --tests.artifactKey, --ta  Repository artifact key                    [string]
  --tests.path, --tp         Root path for test to pack                 [string]
  --tests.ignore, --ti       ignore files list                           [array]
  --tests.specsExt, --ts     specs files extension
                                                 [string] [default: "*.spec.js"]

Reporting options (will override config file)
../Perfecto/test-analysis/download_the_reporting_sdk.htm
  --reporting.jobName, --rjn         reporting job name                 [string]
  --reporting.jobNumber, --rjNum     reporting job number               [number]
  --reporting.branch, --rb           reporting branch                   [string]
  --reporting.projectName, --rpn     reporting project name             [string]
  --reporting.projectVersion, --rpv  reporting project version          [string]
  --reporting.author, --ra           reporting author                   [string]
  --reporting.tags, --rt             reporting tags, example: tag1 tag2  [array]
  --reporting.customFields, --rcf    reporting custom fields, example:
                                     key1,value1 key2,value2             [array]

Options:
  --env, -e     environment variables to attach to `cypress run` command
  --config, -c  Path to config file, see documentation:
                                             [default: "./perfecto-config.json"]

When uploading a Cypress test suite to the Perfecto cloud, utilize the following command options:

npx perfecto-cypress upload --help
perfecto-cypress upload

Upload tests zip archive to Perfecto cloud repository

Credentials options (will override config file)
  --credentials.cloud, --cloud          Cloud name                      [string]
  --credentials.securityToken, --token  Offline token                   [string]

Options:
  --archivePath, -p  Path to tests zip file  [default: "./perfecto-cypress.zip"]
  --temporary, -t    Upload tests archive as temp artifact
                                                       [boolean] [default: true]
  --folderType, -f   Set the location of tests archive in the repository
                    [choices: "PRIVATE", "PUBLIC", "GROUP"] [default: "PRIVATE"]
  --config, -c       Path to config file, see documentation:
                                             [default: "./perfecto-config.json"]

After uploading a .zip file to the cloud, the cloud admin should obtain the repository ID of that .zip file and pass it through the run command to be executed in the cloud. For example, if the repository ID is PRIVATE:perfecto-cypress.zip, the command would be as follows:

npx perfecto-cypress run --config=.\test\perfecto-config.json --ta=PRIVATE:perfecto-cypress.zip