GitHub Actions configuration in Selenium Java - Build an Automation Script

Automate Selenium Java test execution using GitHub Actions

Preconditions (3)

Step 1: Create a GitHub Actions workflow file named 'selenium-test.yml' in the '.github/workflows' directory

Step 2: Configure the workflow to trigger on push to the 'main' branch

Step 3: Set up the workflow to run on the latest Ubuntu runner

Step 4: Add steps to checkout the repository code

Step 5: Add steps to set up JDK 17

Step 6: Add steps to run 'mvn clean test' to execute Selenium tests

Step 7: Verify that the workflow completes successfully and test results are reported

✅ Expected Result: GitHub Actions workflow runs automatically on push to main branch, executes Selenium Java tests using Maven, and reports test results with a successful status if tests pass

Automation Requirements - GitHub Actions YAML

Assertions Needed:

Workflow triggers on push to main branch

JDK 17 is set up correctly

Maven clean test command runs successfully

Test results are reported and workflow completes with success

Best Practices:

Use official actions for checkout and setup-java

Use explicit JDK version

Keep workflow file organized with clear job and step names

Use caching for Maven dependencies (optional but recommended)

Automated Solution

Selenium Java

name: Selenium Java Tests

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v3

    - name: Set up JDK 17
      uses: actions/setup-java@v3
      with:
        distribution: 'temurin'
        java-version: '17'

    - name: Cache Maven packages
      uses: actions/cache@v3
      with:
        path: ~/.m2/repository
        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
        restore-keys: |
          ${{ runner.os }}-maven-

    - name: Run Maven tests
      run: mvn clean test

This GitHub Actions workflow is named 'Selenium Java Tests'. It triggers on any push to the 'main' branch.

The job named 'build' runs on the latest Ubuntu runner.

First, it checks out the repository code using the official actions/checkout@v3 action.

Then, it sets up JDK 17 using actions/setup-java@v3 with the Temurin distribution, ensuring the correct Java version for the Selenium tests.

Next, it caches Maven dependencies located in ~/.m2/repository to speed up future builds, using the hash of the pom.xml file as the cache key.

Finally, it runs the Maven command mvn clean test to compile and execute the Selenium tests.

If the tests pass, the workflow completes successfully and the test results are visible in the GitHub Actions interface.

Common Mistakes - 4 Pitfalls

{'mistake': 'Not specifying the JDK version explicitly', 'why_bad': 'The workflow may run with an unexpected Java version causing test failures or incompatibility', 'correct_approach': "Use the 'actions/setup-java' action with 'java-version' set explicitly to '17'"}

{'mistake': 'Not checking out the repository code before running tests', 'why_bad': 'The workflow will fail because the code to test is missing', 'correct_approach': "Include the 'actions/checkout' step before running any build or test commands"}

{'mistake': 'Running tests without cleaning the Maven project', 'why_bad': 'Old compiled files may cause inconsistent test results', 'correct_approach': "Run 'mvn clean test' to ensure a fresh build and test execution"}

{'mistake': 'Hardcoding runner OS without considering availability', 'why_bad': 'Using an unsupported or unavailable runner can cause workflow failures', 'correct_approach': "Use 'ubuntu-latest' which is a stable and widely supported runner"}

Bonus Challenge

Now add data-driven testing with 3 different login credentials in your Selenium Java tests and ensure the GitHub Actions workflow runs all test cases

Show Hint

Practice

1. What is the main purpose of a GitHub Actions workflow file in a Selenium Java project?

easy

A. To store test results permanently on GitHub

B. To write Java code for Selenium tests

C. To automate running Selenium Java tests on code changes

D. To manually trigger tests from the command line

Solution

1. Step 1: Understand the role of GitHub Actions workflow

   The workflow file defines automated steps that run on events like code changes.

2. Step 2: Connect workflow to Selenium Java tests

   It automates running Selenium Java tests whenever code is pushed or a pull request is made.

3. Final Answer:

   To automate running Selenium Java tests on code changes -> Option C

4. Quick Check:

   Workflow automates tests = D [OK]

Hint: Workflows automate tasks on code events like push or PR [OK]

Common Mistakes:

• Confusing workflow with writing test code
• Thinking tests run only manually
• Assuming workflow stores test results

2. Which of the following is the correct syntax to specify the Java version in a GitHub Actions workflow step?

easy

A. java-version: 17

B. uses: actions/setup-java@v3
with:
java-version: '17'

C. run: setup-java --version 17

D. setup-java version=17

Solution

1. Step 1: Identify correct action usage syntax

   The official way to set Java version is using 'uses' with 'actions/setup-java@v3' and 'with' parameters.

2. Step 2: Check the correct parameter name and format

   The parameter is 'java-version' with the version as a string, e.g., '17'.

3. Final Answer:

   uses: actions/setup-java@v3 with: java-version: '17' -> Option B

4. Quick Check:

   Correct action syntax = C [OK]

Hint: Use 'uses' with 'actions/setup-java@v3' and 'java-version' key [OK]

Common Mistakes:

• Using 'run' instead of 'uses' for setup-java
• Missing 'with' keyword
• Incorrect parameter name or format

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

on:
  push:
    branches:
      - main
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-java@v3
        with:
          java-version: '11'
      - run: mvn test

medium

A. The workflow runs tests using Java 11 on push to main branch

B. The workflow runs tests using Java 17 on any branch push

C. The workflow does not run because 'on' is missing

D. The workflow runs but skips tests

Solution

1. Step 1: Analyze the trigger event

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

2. Step 2: Check Java version and test command

   Java 11 is set up, and 'mvn test' runs the tests.

3. Final Answer:

   The workflow runs tests using Java 11 on push to main branch -> Option A

4. Quick Check:

   Push to main triggers tests with Java 11 = B [OK]

Hint: Check 'on' event and Java version in 'setup-java' step [OK]

Common Mistakes:

• Assuming tests run on all branches
• Confusing Java 11 with Java 17
• Ignoring the trigger event

4. Identify the error in this GitHub Actions workflow snippet for running Selenium Java tests:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-java@v3
        with:
          java-version: 11
      - run: mvn clean test

medium

A. java-version should be a string, e.g., '11'

B. Missing 'on' trigger event

C. The 'run' command should be 'mvn test clean'

D. actions/checkout@v3 is deprecated

Solution

1. Step 1: Check the 'java-version' format

   The 'java-version' parameter must be a string, so it should be '11' with quotes.

2. Step 2: Verify other parts

   Though 'on' is missing, the question focuses on the snippet error; 'mvn clean test' is correct; 'actions/checkout@v3' is current.

3. Final Answer:

   java-version should be a string, e.g., '11' -> Option A

4. Quick Check:

   Java version needs quotes = A [OK]

Hint: Always quote Java version in setup-java 'with' block [OK]

Common Mistakes:

• Using number instead of string for java-version
• Confusing order of mvn commands
• Assuming checkout action is outdated

5. You want to run Selenium Java tests on both push and pull request events, but only for the 'develop' and 'release' branches. Which is the correct 'on' configuration in your GitHub Actions workflow?

hard

A. on:
push:
branches: [develop]
pull_request:
branches: [release]

B. on:
push:
branches: [main]
pull_request:
branches: [main]

C. on:
push:
branches-ignore: [develop, release]
pull_request:
branches-ignore: [develop, release]

D. on:
push:
branches: [develop, release]
pull_request:
branches: [develop, release]

Solution

1. Step 1: Understand event triggers for push and pull_request

   You want both push and pull_request events to trigger on 'develop' and 'release' branches.

2. Step 2: Check correct syntax for multiple branches

   Use 'branches' with a list of branch names under both push and pull_request keys.

3. Final Answer:

   on: push: branches: [develop, release] pull_request: branches: [develop, release] -> Option D

4. Quick Check:

   Push and PR on develop, release branches = A [OK]

Hint: List branches under both push and pull_request keys [OK]

Common Mistakes:

• Using branches-ignore instead of branches
• Triggering on wrong branches like main
• Separating branches for push and pull_request incorrectly