Maven Surefire plugin in JUnit - Framework Patterns

Framework Mode - Maven Surefire plugin

Folder Structure of a Maven JUnit Test Project

my-maven-project/
├── src/
│   ├── main/
│   │   └── java/               # Application source code
│   └── test/
│       └── java/               # Test source code
│           └── com/example/
│               └── tests/      # JUnit test classes
├── pom.xml                    # Maven project configuration
└── target/                    # Compiled output and reports
  

Test Framework Layers

• Test Classes: JUnit test classes under src/test/java that contain test methods.
• Page Objects / Helpers: Java classes to model UI pages or reusable test utilities.
• Test Runner: Maven Surefire plugin runs tests during the build lifecycle.
• Configuration: pom.xml defines dependencies, plugins, and test settings.
• Reports: Surefire generates test reports in target/surefire-reports.

Configuration Patterns with Maven Surefire Plugin

The pom.xml file configures the Surefire plugin to run JUnit tests. Key points:

• Plugin Declaration: Add maven-surefire-plugin in the <plugins> section.
• Test Includes/Excludes: Specify which test classes to run using patterns like **/*Test.java.
• System Properties: Pass environment variables or credentials via <systemPropertyVariables>.
• Parallel Execution: Configure parallel test runs for faster execution.
• JVM Arguments: Set memory or debug options if needed.

Example snippet in pom.xml:

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>3.0.0</version>
      <configuration>
        <includes>
          <include>**/*Test.java</include>
        </includes>
        <systemPropertyVariables>
          <env>test</env>
        </systemPropertyVariables>
        <parallel>methods</parallel>
        <threadCount>4</threadCount>
      </configuration>
    </plugin>
  </plugins>
</build>
  

Test Reporting and CI/CD Integration

• Surefire Reports: After tests run, reports are saved in target/surefire-reports as plain text and XML files.
• CI/CD Tools: Jenkins, GitHub Actions, GitLab CI can run mvn test to execute tests and collect reports.
• Report Plugins: Use plugins like maven-surefire-report-plugin to generate HTML reports.
• Fail Build on Test Failure: Surefire fails the build if any test fails, preventing broken code from deploying.

Best Practices for Maven Surefire Plugin Framework

1. Use Clear Test Naming: Name test classes with *Test.java suffix to match Surefire defaults.
2. Isolate Tests: Ensure tests do not depend on each other to allow parallel execution.
3. Configure Environments: Use system properties to switch between test environments without code changes.
4. Keep Tests Fast: Avoid long-running tests in unit test phase; use integration test phase if needed.
5. Use Reports for Feedback: Regularly check Surefire reports to catch failures early.

Self Check Question

Where in this Maven project structure would you add a new JUnit test class for the Login feature?

Key Result

Maven Surefire plugin runs JUnit tests during build, manages test execution, and generates reports.

Practice

1. What is the main purpose of the Maven Surefire plugin in a JUnit testing project?

easy

A. To deploy the application to a server

B. To compile Java source code

C. To run tests automatically during the build process

D. To package the application into a JAR file

Solution

1. Step 1: Understand the role of Maven Surefire plugin

   The Maven Surefire plugin is designed to run tests automatically during the build process, ensuring code correctness early.

2. Step 2: Differentiate from other Maven plugins

   Other plugins like compiler or deploy handle compiling or deployment, not running tests.

3. Final Answer:

   To run tests automatically during the build process -> Option C

4. Quick Check:

   Maven Surefire runs tests during build [OK]

Hint: Surefire runs tests during build, not compile or deploy [OK]

Common Mistakes:

• Confusing Surefire with compiler plugin
• Thinking Surefire packages the app
• Assuming Surefire deploys the app

2. Which XML tag correctly configures the Maven Surefire plugin in the pom.xml file?

easy

A. org.apache.maven.pluginsmaven-jar-plugin

B. org.apache.maven.pluginsmaven-compiler-plugin

C. org.junit.jupiterjunit-jupiter-engine

D. org.apache.maven.pluginsmaven-surefire-plugin

Solution

1. Step 1: Identify the correct plugin artifactId for Surefire

   The Maven Surefire plugin uses maven-surefire-plugin as its artifactId.

2. Step 2: Confirm groupId and artifactId match Surefire plugin

   The groupId is org.apache.maven.plugins, which is standard for Maven plugins.

3. Final Answer:

   <plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId></plugin> -> Option D

4. Quick Check:

   Surefire plugin artifactId = maven-surefire-plugin [OK]

Hint: Surefire plugin artifactId always contains 'surefire' [OK]

Common Mistakes:

• Using maven-compiler-plugin instead of surefire
• Confusing JUnit engine with Surefire plugin
• Using maven-jar-plugin for testing

3. Given this pom.xml snippet, what will happen when you run mvn test?

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <version>3.0.0-M7</version>
  <configuration>
    <includes>
      <include>**/*Test.java</include>
    </includes>
  </configuration>
</plugin>

medium

A. Only Java files ending with 'Test.java' will be run as tests

B. All Java files will be compiled but no tests will run

C. Tests will run only if file names start with 'Test'

D. No tests will run because version is invalid

Solution

1. Step 1: Understand the includes configuration

   The <includes> tag specifies which test files to run. Here, it includes files matching **/*Test.java.

2. Step 2: Interpret the pattern meaning

   The pattern means any Java file ending with 'Test.java' in any folder will be run as a test.

3. Final Answer:

   Only Java files ending with 'Test.java' will be run as tests -> Option A

4. Quick Check:

   Includes pattern '**/*Test.java' runs matching test files [OK]

Hint: Includes '**/*Test.java' runs files ending with 'Test.java' [OK]

Common Mistakes:

• Assuming all Java files run as tests
• Thinking files starting with 'Test' run
• Believing version 3.0.0-M7 is invalid

4. You added the Maven Surefire plugin to your pom.xml but tests are not running. Which of these is the most likely cause?

medium

A. The pom.xml file is not saved

B. The artifactId is misspelled as maven-surefire-plugn

C. The version tag is missing

D. JUnit tests are written in a different folder than src/test/java

Solution

1. Step 1: Check plugin artifactId spelling

   If the artifactId is misspelled, Maven cannot find the plugin, so tests won't run.

2. Step 2: Consider other causes

   Missing version usually defaults to latest, unsaved pom.xml is unlikely, and test folder location matters but less common cause.

3. Final Answer:

   The artifactId is misspelled as maven-surefire-plugn -> Option B

4. Quick Check:

   Misspelled artifactId stops Surefire plugin loading [OK]

Hint: Check artifactId spelling first if tests don't run [OK]

Common Mistakes:

• Ignoring typo in artifactId
• Assuming missing version always breaks build
• Not verifying test source folder

5. You want to run only tests tagged with @Fast annotation using Maven Surefire plugin. Which configuration snippet in pom.xml achieves this?

hard

A. Fast

B. Fast

C. **/*Fast.java

D. Fast*

Solution

1. Step 1: Understand Surefire's group filtering

   Surefire uses <groups> to include tests with specific JUnit categories or tags.

2. Step 2: Match the correct tag for including groups

   Using <groups>Fast</groups> runs only tests tagged with @Fast.

3. Final Answer:

   <configuration><groups>Fast</groups></configuration> -> Option A

4. Quick Check:

   Use <groups> to run tagged tests [OK]

Hint: Use <groups> tag to run tests with specific annotations [OK]

Common Mistakes:

• Using excludedGroups instead of groups
• Filtering by filename instead of annotation
• Using <test> tag incorrectly