Maven build lifecycle in Selenium Java - Framework Patterns

Framework Mode - Maven build lifecycle

Folder Structure of a Maven Selenium Java Project

my-selenium-project/
├── pom.xml
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── App.java
│   └── test/
│       └── java/
│           └── com/example/tests/
│               ├── pages/
│               │   └── LoginPage.java
│               ├── tests/
│               │   └── LoginTest.java
│               └── utils/
│                   └── WebDriverFactory.java
└── target/
    └── (compiled classes, reports, jars)
  

Test Framework Layers in Maven Selenium Java

• Driver Layer: Manages WebDriver setup and teardown (e.g., WebDriverFactory.java).
• Page Objects: Classes representing web pages with locators and actions (e.g., LoginPage.java).
• Test Layer: Test classes containing test methods using TestNG or JUnit (e.g., LoginTest.java).
• Utilities: Helper classes for common functions like waits, logging, or data handling.
• Configuration: pom.xml for build lifecycle, dependencies, plugins, and profiles.

Configuration Patterns in Maven Build Lifecycle

The pom.xml file controls the build lifecycle phases:

• clean: Removes previous build files (target folder).
• compile: Compiles source code.
• test-compile: Compiles test code.
• test: Runs tests using TestNG or JUnit.
• package: Packages compiled code into a JAR or WAR.
• verify: Runs checks on results (e.g., integration tests).
• install: Installs package into local repository.
• deploy: Copies package to remote repository.

Use profiles in pom.xml to manage different environments (dev, test, prod) and browsers.

Example snippet for profiles:

<profiles>
  <profile>
    <id>chrome</id>
    <properties>
      <browser>chrome</browser>
    </properties>
  </profile>
  <profile>
    <id>firefox</id>
    <properties>
      <browser>firefox</browser>
    </properties>
  </profile>
</profiles>

Test Reporting and CI/CD Integration

• Use Maven Surefire Plugin to run tests and generate reports in target/surefire-reports.
• Integrate with Jenkins or GitHub Actions to run Maven commands automatically on code push.
• Reports can be viewed in Jenkins UI or exported as HTML/XML for analysis.
• Use plugins like maven-failsafe-plugin for integration tests and advanced reporting.

Best Practices for Maven Build Lifecycle in Selenium Java

• Keep pom.xml clean and modular by using profiles and properties.
• Separate test code from production code under src/test/java and src/main/java.
• Use explicit Maven phases to control build steps and avoid running unnecessary tasks.
• Use dependency management to keep Selenium and TestNG/JUnit versions consistent.
• Automate test runs in CI/CD pipelines using Maven commands like mvn clean test.

Self Check Question

Where in this Maven project structure would you add a new page object class for the "Dashboard" page?

Key Result

Maven organizes Selenium Java tests with a clear lifecycle controlling build, test, and packaging phases using pom.xml.

Practice

1. Which Maven build lifecycle phase is responsible for compiling the source code of a Java project?

easy

A. clean

B. test

C. package

D. compile

Solution

1. Step 1: Understand Maven lifecycle phases

   Maven has phases like clean, compile, test, and package, each with a specific role.

2. Step 2: Identify the phase for compiling source code

   The compile phase compiles the Java source code into bytecode.

3. Final Answer:

   compile -> Option D

4. Quick Check:

   Compile phase compiles code = compile [OK]

Hint: Compile phase always compiles source code [OK]

Common Mistakes:

• Confusing 'test' phase with compiling code
• Thinking 'package' compiles code
• Assuming 'clean' compiles code

2. Which Maven command cleans the project by deleting the target directory?

easy

A. mvn clean

B. mvn compile

C. mvn package

D. mvn test

Solution

1. Step 1: Recall Maven commands and their purposes

   mvn clean deletes the target directory, removing previous build files.

2. Step 2: Match command to cleaning action

   Only mvn clean removes old build artifacts before a fresh build.

3. Final Answer:

   mvn clean -> Option A

4. Quick Check:

   Clean command deletes target folder = mvn clean [OK]

Hint: Clean command always removes old build files [OK]

Common Mistakes:

• Using mvn package to clean project
• Confusing mvn test with cleaning
• Thinking mvn compile cleans files

3. What will happen if you run mvn test on a Maven project that has not been compiled yet?

medium

A. Tests will fail because code is not compiled

B. Maven will compile the code first, then run tests

C. Maven will skip compilation and run tests directly

D. Maven will only clean the project without running tests

Solution

1. Step 1: Understand Maven lifecycle phase dependencies

   Running mvn test triggers all previous phases including compile automatically.

2. Step 2: Predict behavior when code is not compiled

   Maven compiles code before running tests to ensure tests run on compiled classes.

3. Final Answer:

   Maven will compile the code first, then run tests -> Option B

4. Quick Check:

   Test phase runs compile first = compile then test [OK]

Hint: Test phase always runs compile first [OK]

Common Mistakes:

• Assuming tests run without compiling
• Thinking Maven skips compile phase
• Confusing clean with test phase

4. You run mvn package but get an error saying tests failed. What is the best way to fix this without skipping tests?

medium

A. Run mvn package -DskipTests to skip tests

B. Run mvn compile only to compile code

C. Run mvn clean package to clean and rebuild

D. Delete the target folder manually and rerun mvn package

Solution

1. Step 1: Understand the error cause

   Tests failed during package phase, so build stopped.

2. Step 2: Choose a fix that cleans and rebuilds including tests

   Running mvn clean package removes old files and rebuilds fresh, running tests again.

3. Final Answer:

   Run mvn clean package to clean and rebuild -> Option C

4. Quick Check:

   Clean then package reruns tests = mvn clean package [OK]

Hint: Clean before package to fix test errors without skipping [OK]

Common Mistakes:

• Skipping tests instead of fixing them
• Only compiling without packaging
• Manually deleting target folder is error-prone

5. You want to create a Maven build that cleans, compiles, runs tests, and packages your project in one command. Which command should you use?

hard

A. mvn clean package

B. mvn clean compile test package

C. mvn compile test package

D. mvn test package

Solution

1. Step 1: Understand Maven lifecycle chaining

   Running a later phase runs all previous phases automatically.

2. Step 2: Identify the shortest command that runs all phases

   mvn clean package runs clean, compile, test, and package in order.

3. Final Answer:

   mvn clean package -> Option A

4. Quick Check:

   Package phase runs all before it = mvn clean package [OK]

Hint: Run clean then package to do all steps in one [OK]

Common Mistakes:

• Listing all phases explicitly is unnecessary
• Skipping clean phase
• Running test package without clean