Jenkins integration in Selenium Python - Framework Patterns

Framework Mode - Jenkins integration

Folder Structure

selenium-python-project/
├── tests/
│   ├── test_login.py
│   └── test_checkout.py
├── pages/
│   ├── login_page.py
│   └── checkout_page.py
├── utils/
│   ├── driver_factory.py
│   └── helpers.py
├── config/
│   ├── config.yaml
│   └── credentials.yaml
├── reports/
│   └── latest_report.html
├── requirements.txt
├── pytest.ini
└── Jenkinsfile
  

Test Framework Layers

• Driver Layer: utils/driver_factory.py manages browser setup and teardown.
• Page Objects: pages/ contains page classes representing UI elements and actions.
• Test Cases: tests/ holds test scripts using pytest and page objects.
• Utilities: utils/helpers.py includes reusable functions like waits and assertions.
• Configuration: config/ stores environment settings and credentials in YAML files.
• Reports: reports/ saves test execution reports for review.
• CI/CD Integration: Jenkinsfile defines Jenkins pipeline steps to run tests automatically.

Configuration Patterns

Use YAML files in config/ to separate environment variables, browser choices, and credentials.

Example config.yaml content:

environment: staging
browser: chrome
base_url: https://staging.example.com
  

Example credentials.yaml content:

username: testuser
password: securepass123
  

Load these configs in tests or driver factory to customize test runs.

Jenkinsfile uses parameters to select environment and browser dynamically:

pipeline {
    agent any
    parameters {
        choice(name: 'ENV', choices: ['staging', 'production'], description: 'Select environment')
        choice(name: 'BROWSER', choices: ['chrome', 'firefox'], description: 'Select browser')
    }
    stages {
        stage('Run Tests') {
            steps {
                sh 'pytest --env=${ENV} --browser=${BROWSER} --html=reports/latest_report.html'
            }
        }
    }
    post {
        always {
            publishHTML(target: [
                reportDir: 'reports',
                reportFiles: 'latest_report.html',
                reportName: 'Test Report'
            ])
        }
    }
}
  

Test Reporting and CI/CD Integration

• Use pytest-html plugin to generate readable HTML reports saved in reports/.
• Jenkins pipeline (Jenkinsfile) runs tests on each commit or schedule.
• Reports are published in Jenkins UI using publishHTML plugin for easy access.
• Failures cause Jenkins build to fail, alerting the team immediately.
• Parameters in Jenkins allow flexible test runs without changing code.

Best Practices

1. Separate Config from Code: Keep environment and credentials outside code for security and flexibility.
2. Use Parameterized Jenkins Pipelines: Allow choosing environment and browser at runtime.
3. Generate and Archive Reports: Always produce HTML reports and archive them in Jenkins for traceability.
4. Fail Fast: Configure Jenkins to fail builds on test failures to catch issues early.
5. Use Virtual Environments: Manage Python dependencies with virtualenv or similar to avoid conflicts.

Self Check

Where in this folder structure would you add a new page object for the "User Profile" page?

Key Result

Organize Selenium Python tests with clear layers, config files, and Jenkins pipeline for automated runs and reporting.

Practice

1. What is the main purpose of integrating Selenium Python tests with Jenkins?

easy

A. To write Selenium test scripts faster

B. To automate running tests and get quick feedback

C. To manually run tests on different browsers

D. To replace Selenium with Jenkins for testing

Solution

1. Step 1: Understand Jenkins role

   Jenkins automates tasks like running tests without manual effort.

2. Step 2: Connect Selenium tests with Jenkins

   Integrating Selenium tests with Jenkins allows automatic test execution and quick feedback on code changes.

3. Final Answer:

   To automate running tests and get quick feedback -> Option B

4. Quick Check:

   Automation + feedback = A [OK]

Hint: Jenkins automates tasks, so pick automation-related answer [OK]

Common Mistakes:

• Thinking Jenkins replaces Selenium
• Assuming Jenkins only helps write tests
• Confusing manual and automated test runs

2. Which Jenkins Pipeline step correctly runs a Selenium Python test script named test_login.py?

easy

A. run 'test_login.py'

B. execute python test_login.py

C. sh 'python3 test_login.py'

D. bash python3 test_login.py

Solution

1. Step 1: Identify correct Jenkins syntax

   Jenkins Pipeline uses sh step to run shell commands.

2. Step 2: Check command correctness

   python3 test_login.py is the correct shell command to run the Python script.

3. Final Answer:

   sh 'python3 test_login.py' -> Option C

4. Quick Check:

   Jenkins shell step = sh 'command' [OK]

Hint: Jenkins shell commands use sh 'command' syntax [OK]

Common Mistakes:

• Using invalid Jenkins step names like run or execute
• Missing quotes around shell command
• Confusing bash keyword with Jenkins syntax

3. Given this Jenkins Pipeline snippet, what will be the output if test_login.py fails?

pipeline {
  agent any
  stages {
    stage('Run Tests') {
      steps {
        sh 'python3 test_login.py'
      }
    }
  }
}

medium

A. Jenkins marks the build as failed and stops the pipeline

B. Jenkins ignores the failure and continues the pipeline

C. Jenkins retries the test automatically

D. Jenkins marks the build as successful regardless

Solution

1. Step 1: Understand Jenkins shell step behavior

   If the shell command exits with a non-zero code (test fails), Jenkins marks the build as failed.

2. Step 2: Pipeline stops on failure by default

   Without special handling, Jenkins stops the pipeline on failure and marks build failed.

3. Final Answer:

   Jenkins marks the build as failed and stops the pipeline -> Option A

4. Quick Check:

   Shell failure = build fail + stop [OK]

Hint: Shell command failure stops Jenkins pipeline by default [OK]

Common Mistakes:

• Assuming Jenkins retries tests automatically
• Thinking Jenkins ignores failures without config
• Believing build passes despite test failure

4. You added this Jenkins Pipeline step to run Selenium tests:

sh 'python3 -m selenium test_suite.py'

But the build fails with "No module named selenium" error. What is the likely fix?

medium

A. Use sh 'selenium test_suite.py' instead

B. Change command to python3 selenium test_suite.py

C. Remove -m from the command

D. Add a step to install selenium with pip install selenium before running tests

Solution

1. Step 1: Understand error cause

   "No module named selenium" means Python can't find the selenium package installed.

2. Step 2: Fix by installing selenium

   Adding pip install selenium before running tests ensures the package is available.

3. Final Answer:

   Add a step to install selenium with pip install selenium before running tests -> Option D

4. Quick Check:

   Missing package error = install package first [OK]

Hint: Install missing Python packages before running tests [OK]

Common Mistakes:

• Changing command syntax without installing package
• Removing -m which is unrelated here
• Trying to run selenium as a command

5. You want Jenkins to run Selenium Python tests on multiple browsers (Chrome and Firefox) and report results separately. Which approach is best?

hard

A. Create separate Jenkins stages for each browser running tests with different WebDriver setups

B. Run tests once and assume they work on all browsers

C. Use a single stage and switch browsers randomly during tests

D. Run tests locally and upload results manually to Jenkins

Solution

1. Step 1: Understand multi-browser testing needs

   Each browser requires its own WebDriver setup and test run to isolate results.

2. Step 2: Use separate Jenkins stages for clarity

   Separate stages for Chrome and Firefox allow clear reporting and parallel or sequential runs.

3. Final Answer:

   Create separate Jenkins stages for each browser running tests with different WebDriver setups -> Option A

4. Quick Check:

   Separate stages = clear multi-browser testing [OK]

Hint: Separate stages for each browser give clear test results [OK]

Common Mistakes:

• Running tests once for all browsers without setup
• Switching browsers randomly causing flaky tests
• Manual result uploads instead of automation