Pipedrive Cypress Automation Framework

This project contains automated tests for the Pipedrive application using Cypress.

Prerequisites

• Node.js (v18 or higher)
• npm (comes with Node.js)
• A Pipedrive account with valid credentials
• Git
• Docker (for Docker-based testing)

Detailed Project Structure

├── cypress/
│   ├── e2e/                    # Test files
│   │   └── Pipedrive/
│   │       └── Web/           # Web application tests
│   │           ├── pages/     # Page Object Models
│   │           │   ├── ContactPage.js
│   │           │   └── LoginPage.js
│   │           └── tests/     # Test Specifications
│   │               ├── 01_login_test.cy.js
│   │               └── 02_contact_test.cy.js
│   ├── fixtures/              # Test data
│   ├── reports/              # Test reports
│   │   └── mochawesome/     # Mochawesome reports
│   ├── screenshots/         # Test failure screenshots
│   └── videos/             # Test execution recordings
├── .github/
│   └── workflows/          # GitHub Actions workflows
│       └── github-workflow.yml  # GitHub Actions workflow for Docker-based testing
├── node_modules/          # Project dependencies
├── cypress.config.js      # Cypress configuration
├── cypress.env.json       # Cypress environment variables
├── Dockerfile            # Docker configuration
├── docker-compose.yml    # Docker Compose configuration
├── .dockerignore         # Docker ignore file
├── Jenkinsfile          # Jenkins pipeline configuration
├── reporter-config.json # Mochawesome reporter configuration
├── run-cypress-docker.sh # Docker helper script
├── run-tests.sh        # Local test execution helper
├── test-workflow.sh    # CI/CD test workflow helper
├── package.json          # Project metadata and scripts
├── package-lock.json     # Dependency lock file
└── README.md            # Project documentation

Detailed Setup Instructions

1. Clone the Repository:

git clone <repository-url>
cd Cypress-Automation

2. Install Dependencies:

# Install all dependencies
npm ci

# Verify Cypress installation
npx cypress verify

3. Environment Setup: Create a cypress.env.json file in the root directory:

{
    "email": "your-pipedrive-email",
    "password": "your-pipedrive-password",
    "BASE_URL": "https://app.pipedrive.com"
}

4. Verify Installation:

# Open Cypress Test Runner
npx cypress open

# Run a test in headless mode
npx cypress run

Docker Setup

Prerequisites

• Docker Desktop installed and running

Running Tests with Docker

1. Using npm Scripts:

# Run all tests in Chrome
npm run docker:test:chrome

# Run specific test file
npm run docker:test:login

# Run tests in all browsers
npm run docker:test:all

2. Using Docker Directly:

# Run tests using the official Cypress Docker image
docker run --rm \
  -v "${PWD}:/e2e" \
  -w /e2e \
  -e CYPRESS_BASE_URL=$CYPRESS_BASE_URL \
  -e CYPRESS_EMAIL=$CYPRESS_EMAIL \
  -e CYPRESS_PASSWORD=$CYPRESS_PASSWORD \
  cypress/included:12.17.4 \
  --browser chrome \
  --reporter mochawesome \
  --reporter-options reportDir=cypress/reports/mochawesome,overwrite=false,html=false,json=true

3. Viewing Test Results: Test results, screenshots, and videos will be available in your local project directory as they are mounted as volumes.

CI/CD Integration

GitHub Actions

The project uses GitHub Actions for CI/CD with Docker support. The workflow includes:

• Node.js setup with caching
• Dependency installation
• Test execution in Docker
• Report generation
• Artifact upload

Workflow Details

The GitHub workflow (.github/workflows/github-workflow.yml) performs the following steps:

1. Checkout Code:

   • Clones the repository
   • Sets up the working directory

2. Node.js Setup:

   • Installs Node.js v18
   • Configures npm caching for faster builds
   • Installs project dependencies

3. Directory Setup:

   • Creates necessary directories for reports
   • Sets up permissions for test artifacts
   • Prepares the environment for test execution

4. Test Execution:

   • Runs Cypress tests in Docker container
   • Uses the official Cypress Docker image
   • Configures Mochawesome reporter
   • Handles test failures gracefully

5. Report Generation:

   • Merges test reports from multiple runs
   • Generates HTML reports using Mochawesome
   • Creates a dummy report if no tests are executed
   • Verifies report generation success

6. Artifact Management:

   • Uploads test reports as artifacts
   • Archives screenshots on test failures
   • Saves test execution videos
   • Sets retention period for artifacts

Workflow Triggers

The workflow runs automatically on:

• Push to main/master branches
• Pull requests to main/master branches
• Manual workflow dispatch
• Scheduled runs (if configured)

Required Secrets

Add these secrets to your GitHub repository:

• CYPRESS_BASE_URL: Pipedrive application URL
• CYPRESS_EMAIL: Pipedrive login email
• CYPRESS_PASSWORD: Pipedrive login password

Workflow Artifacts

The workflow generates and uploads the following artifacts:

• Mochawesome HTML reports
• Test failure screenshots
• Test execution videos
• Debug logs and error reports

Jenkins Pipeline

The project includes Jenkins pipeline configuration (Jenkinsfile) with the following features:

• Docker-based test execution
• Automated test execution
• Report generation
• Artifact archiving
• Failure notifications

Jenkins Setup

1. Prerequisites:

   • Jenkins server with Docker plugin installed
   • Docker installed on Jenkins agent
   • Node.js installed on Jenkins agent

2. Configuration:

   • Create a new Pipeline job
   • Point to the repository containing this project
   • Set the pipeline script to use the Jenkinsfile
   • Configure environment variables:
     • CYPRESS_EMAIL: Pipedrive login email
     • CYPRESS_PASSWORD: Pipedrive login password
     • CYPRESS_BASE_URL: Pipedrive application URL

3. Pipeline Stages:

   • Checkout: Get the code from the repository
   • Build Docker Image: Build the Docker image for testing
   • Create Reports Directory: Set up directories for reports
   • Run Cypress Tests: Execute tests in Docker
   • Generate Reports: Create test reports
   • Post Actions: Archive artifacts and handle success/failure

Test Execution Scripts

The project includes several helper scripts:

• run-cypress-docker.sh: Docker-based test execution
• run-tests.sh: Local test execution helper
• test-workflow.sh: CI/CD workflow helper

Running Tests

Local Development

# Run all tests in Chrome
npm run test:chrome

# Run specific test file
npx cypress run --spec "cypress/e2e/Pipedrive/Web/tests/01_login_test.cy.js"

# Open Cypress Test Runner
npx cypress open

CI/CD Pipeline

Tests run automatically on:

• Push to main/master/test branches
• Pull requests to main/master/test branches
• Manual workflow dispatch
• Jenkins pipeline execution

Test Reports

Report Generation

# Generate reports
npm run generate:report

# Merge multiple reports
npm run merge:reports

# Generate all reports
npm run generate:all-reports

Report Location

• HTML reports: cypress/reports/mochawesome/
• Screenshots: cypress/screenshots/
• Videos: cypress/videos/

Best Practices

1. Test Organization:

   • Tests are organized by feature
   • Page Object Model pattern for better maintenance
   • Each test file focuses on a specific feature

2. Data Management:

   • Use fixtures for test data
   • Environment variables for sensitive data
   • Separate test data from test logic

3. Reporting:

   • Mochawesome reports for detailed test results
   • Screenshots on test failures
   • Video recordings for debugging

4. CI/CD Integration:

   • Automated test execution
   • Report generation and archiving
   • Failure notifications

Troubleshooting

1. Docker Issues:

   • Ensure Docker is running
   • Check volume mounting permissions
   • Verify environment variables

2. Test Failures:

   • Check test reports
   • Review screenshots
   • Verify selectors
   • Check application state

3. CI/CD Issues:

   • Verify GitHub secrets
   • Check workflow logs
   • Ensure proper permissions
   • Check Jenkins configuration

Debug Tools

• Cypress Debug Logs: DEBUG=cypress:*
• Network Logs: Chrome DevTools
• Test Reports: Mochawesome
• Screenshots: cypress/screenshots

Maintenance

Regular Tasks

1. Update dependencies:

npm update

2. Clean reports:

npm run clean:reports

3. Verify tests:

npx cypress verify

Version Control

• Follow Git flow branching model
• Use meaningful commit messages
• Keep feature branches updated
• Regular merges to main branch

Support

For issues or questions:

1. Check troubleshooting guide
2. Review test reports
3. Check CI/CD logs
4. Create GitHub issue

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests locally
5. Submit a pull request

License

This project is licensed under the ISC License.