GitHub Actions integration in Selenium Python - Framework Patterns

Framework Mode - GitHub Actions 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/
│   └── test_report.html
├── .github/
│   └── workflows/
│       └── selenium-tests.yml
├── requirements.txt
└── README.md
  

Test Framework Layers

• Driver Layer: utils/driver_factory.py creates and manages Selenium WebDriver instances.
• Page Objects: pages/ contains classes representing web pages with methods for interactions.
• Tests: tests/ holds test scripts using pytest that call page objects.
• Utilities: utils/ has helper functions and driver setup code.
• Configuration: config/ stores environment settings and credentials in YAML files.
• CI/CD Integration: .github/workflows/selenium-tests.yml defines GitHub Actions workflow to run tests automatically.

Configuration Patterns

Use YAML files in config/ to store environment variables like URLs, browsers, and credentials.

Example config.yaml:

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

Example credentials.yaml (keep private, do not commit secrets):

username: "testuser"
password: "securepassword"

GitHub Actions workflow uses secrets stored in GitHub repository settings for sensitive data.

Workflow example snippet to run tests on multiple Python versions and browsers:

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.10, 3.11]
        browser: [chrome, firefox]
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
      - name: Run Selenium tests
        env:
          BROWSER: ${{ matrix.browser }}
          BASE_URL: ${{ secrets.BASE_URL }}
          USERNAME: ${{ secrets.USERNAME }}
          PASSWORD: ${{ secrets.PASSWORD }}
        run: |
          pytest tests/ --html=reports/test_report.html
  

Test Reporting and CI/CD Integration

• Use pytest-html plugin to generate HTML test reports saved in reports/.
• GitHub Actions uploads test reports as artifacts for review after runs.
• Configure GitHub Actions to run tests on pull requests and merges to main branch.
• Fail the workflow if any test fails, providing clear pass/fail feedback in GitHub UI.
• Optionally integrate notifications (email, Slack) on test results using GitHub Actions steps.

Best Practices

1. Keep secrets out of code: Use GitHub Secrets for credentials, never commit passwords.
2. Use matrix strategy: Test multiple Python versions and browsers automatically.
3. Isolate tests: Each test should be independent and clean up after itself.
4. Use explicit waits: Avoid flaky tests by waiting for elements properly in page objects.
5. Generate readable reports: Use HTML reports for easy understanding of test results.

Self Check

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

Key Result

Organize Selenium Python tests with clear layers and automate runs using GitHub Actions workflows.

Practice

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

easy

A. To manually trigger tests only when needed

B. To write Selenium tests faster using GitHub's editor

C. To deploy the application to production automatically

D. To automatically run tests on code changes and catch bugs early

Solution

1. Step 1: Understand GitHub Actions role

   GitHub Actions automates workflows like running tests when code changes.

2. Step 2: Identify Selenium test integration benefit

   Running Selenium tests automatically helps find bugs early without manual effort.

3. Final Answer:

   To automatically run tests on code changes and catch bugs early -> Option D

4. Quick Check:

   Automation for early bug detection = B [OK]

Hint: GitHub Actions runs tests automatically on code changes [OK]

Common Mistakes:

• Thinking tests run only manually
• Confusing testing with deployment
• Assuming GitHub edits test code automatically

2. Which YAML file location is correct for defining GitHub Actions workflows that run Selenium Python tests?

easy

A. .github/workflows/selenium_tests.yml

B. selenium_tests.yml

C. .github/actions/selenium_tests.yml

D. workflows/selenium_tests.yml

Solution

1. Step 1: Recall GitHub Actions workflow folder

   Workflows must be inside the .github/workflows directory.

2. Step 2: Match correct file path

   Only .github/workflows/selenium_tests.yml places the YAML file correctly inside .github/workflows.

3. Final Answer:

   .github/workflows/selenium_tests.yml -> Option A

4. Quick Check:

   Workflow YAML location = A [OK]

Hint: Workflows go inside .github/workflows folder [OK]

Common Mistakes:

• Placing workflow files outside .github/workflows
• Using .github/actions folder incorrectly
• Missing the .github prefix

3. Given this GitHub Actions YAML snippet, what will happen when code is pushed to the main branch?

name: Selenium Tests
on:
  push:
    branches: [main]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.12'
      - name: Install dependencies
        run: pip install selenium
      - name: Run tests
        run: python test_suite.py

medium

A. Tests will run on every push to any branch

B. Selenium tests will run automatically on every push to main branch

C. Tests will run only if manually triggered

D. The workflow will fail due to missing Python setup

Solution

1. Step 1: Analyze trigger event

   The workflow triggers on push events to the main branch only.

2. Step 2: Check job steps

   Steps include checkout, Python setup, installing selenium, and running tests, so tests run automatically.

3. Final Answer:

   Selenium tests will run automatically on every push to main branch -> Option B

4. Quick Check:

   Push to main triggers tests = C [OK]

Hint: Check 'on' section for event triggers in YAML [OK]

Common Mistakes:

• Assuming tests run on all branches
• Thinking manual trigger is needed
• Missing Python setup step

4. You wrote this GitHub Actions workflow to run Selenium tests but it fails with "command not found: python":

name: Selenium Tests
on: [push]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run tests
        run: python test_suite.py

What is the likely fix?

medium

A. Add a step to set up Python using actions/setup-python

B. Change 'python' to 'python3' in the run command

C. Remove the checkout step

D. Add 'pip install selenium' before running tests

Solution

1. Step 1: Identify missing Python setup

   The error "command not found: python" means Python is not installed or set up in the runner.

2. Step 2: Add Python setup step

   Using actions/setup-python installs and configures Python before running tests.

3. Final Answer:

   Add a step to set up Python using actions/setup-python -> Option A

4. Quick Check:

   Python setup missing causes error = D [OK]

Hint: Always set up Python before running Python commands [OK]

Common Mistakes:

• Assuming python3 is available without setup
• Skipping Python setup step
• Removing checkout step unnecessarily

5. You want to run Selenium Python tests on multiple Python versions (3.10, 3.11, 3.12) using GitHub Actions. Which YAML snippet correctly sets up this matrix testing?

hard

A. jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: 3.10, 3.11, 3.12
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: pip install selenium
- name: Run tests
run: python test_suite.py

B. jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: [3.10, 3.11, 3.12]
- name: Install dependencies
run: pip install selenium
- name: Run tests
run: python test_suite.py

C. jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.10, 3.11, 3.12]
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: pip install selenium
- name: Run tests
run: python test_suite.py

D. jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.10 3.11 3.12]
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: pip install selenium
- name: Run tests
run: python test_suite.py

Solution

1. Step 1: Understand matrix syntax

   The matrix must be a YAML list with square brackets and commas: [3.10, 3.11, 3.12].

2. Step 2: Use matrix variable correctly

   The Python version in setup-python must use ${{ matrix.python-version }} to pick each version.

3. Final Answer:

   The YAML snippet with strategy.matrix.python-version: [3.10, 3.11, 3.12] -> Option C

4. Quick Check:

   Matrix list and variable syntax = A [OK]

Hint: Use matrix with brackets and commas, reference with ${{ matrix.var }} [OK]

Common Mistakes:

• Using commas missing or wrong brackets in matrix
• Passing list directly to python-version input
• Not referencing matrix variable in setup-python