Allure reporting integration in Selenium Java

Introduction

Allure reporting helps you see clear and beautiful test results. It makes understanding test outcomes easy and fast.

You want to share test results with your team in a simple way.

You need to track which tests passed or failed over time.

You want screenshots or logs attached to test reports automatically.

You want to organize test results by features or test cases.

You want to generate reports after running Selenium tests.

Syntax

Selenium Java

1. Add Allure dependencies in your Maven pom.xml:

<dependency>
  <groupId>io.qameta.allure</groupId>
  <artifactId>allure-junit5</artifactId>
  <version>2.21.0</version>
  <scope>test</scope>
</dependency>

2. Annotate your test class or methods:

import io.qameta.allure.Description;
import io.qameta.allure.Step;
import org.junit.jupiter.api.Test;

@Description("Test description here")
public class MyTest {

  @Step("Open homepage")
  public void openHome() {
    // test steps
  }

  @Test
  public void testExample() {
    openHome();
    // assertions
  }
}

3. Run tests with Maven and generate report:
mvn clean test
allure serve target/allure-results

Use @Step to mark important actions in your test for better report details.

Allure collects results in target/allure-results folder by default.

Examples

This example shows how to add a step with a dynamic name using parameters.

Selenium Java

import io.qameta.allure.Step;

@Step("Login with username {username}")
public void login(String username) {
  // login code
}

This test has a description that appears in the Allure report.

Selenium Java

import io.qameta.allure.Description;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Assertions;

@Description("Verify homepage title")
@Test
public void testHomeTitle() {
  String title = driver.getTitle();
  Assertions.assertEquals("Home", title);
}

Sample Program

This test opens a browser, goes to example.com, checks the page title, and closes the browser. All steps and description will appear in the Allure report.

Selenium Java

import io.qameta.allure.Description;
import io.qameta.allure.Step;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;

public class AllureSeleniumTest {

  WebDriver driver;

  @Step("Open browser and navigate to example.com")
  public void openBrowser() {
    driver = new ChromeDriver();
    driver.get("https://example.com");
  }

  @Step("Check page title")
  public void checkTitle() {
    String title = driver.getTitle();
    Assertions.assertEquals("Example Domain", title);
  }

  @Description("Test to open example.com and verify title")
  @Test
  public void testExampleDotComTitle() {
    openBrowser();
    checkTitle();
    driver.quit();
  }
}

Important Notes

Make sure to install Allure command line tool to generate and view reports.

Use meaningful step names to make reports easy to understand.

Attach screenshots or logs in steps for better debugging.

Summary

Allure reporting makes test results clear and easy to share.

Use annotations like @Step and @Description to add details.

Run tests and generate reports with Maven and Allure commands.

Practice

1. What is the main purpose of integrating Allure reporting in Selenium Java tests?

easy

A. To generate clear and shareable test reports with detailed steps

B. To speed up the execution of Selenium tests

C. To replace Selenium WebDriver with a new testing tool

D. To write test cases without any code

Solution

1. Step 1: Understand Allure reporting purpose

   Allure reporting is designed to make test results easy to read and share by adding detailed steps and descriptions.

2. Step 2: Compare options with Allure features

   Only To generate clear and shareable test reports with detailed steps correctly describes Allure's role in generating clear, detailed reports. Other options describe unrelated features.

3. Final Answer:

   To generate clear and shareable test reports with detailed steps -> Option A

4. Quick Check:

   Allure reporting = clear, shareable reports [OK]

Hint: Allure = better test reports, not faster tests [OK]

Common Mistakes:

• Confusing Allure with test execution speed tools
• Thinking Allure replaces Selenium WebDriver
• Assuming Allure writes tests automatically

2. Which annotation is used in Selenium Java tests to add a detailed step description in Allure reports?

easy

A. @Step

B. @Test

C. @BeforeMethod

D. @Ignore

Solution

1. Step 1: Identify Allure annotations for steps

   The @Step annotation marks methods as steps in Allure reports, adding detailed descriptions.

2. Step 2: Eliminate unrelated annotations

   @Test runs tests, @BeforeMethod runs setup, @Ignore skips tests. Only @Step adds step details.

3. Final Answer:

   @Step -> Option A

4. Quick Check:

   @Step = detailed step in Allure [OK]

Hint: @Step marks steps for Allure, not test execution [OK]

Common Mistakes:

• Confusing @Step with @Test annotation
• Using @BeforeMethod for step descriptions
• Thinking @Ignore adds report details

3. Given the following code snippet, what will be the Allure report output for the step description?

@Step("Open login page")
public void openLoginPage() {
    driver.get("https://example.com/login");
}

medium

A. The report will not show any step because @Step is ignored

B. The report will show an error because @Step requires a return value

C. The report will show a step named 'Open login page' when this method runs

D. The report will show the URL instead of the step name

Solution

1. Step 1: Understand @Step annotation usage

   The @Step annotation with a string parameter sets the step name shown in Allure reports.

2. Step 2: Analyze the method behavior

   When openLoginPage() runs, Allure logs the step with the name 'Open login page'. No return value is needed.

3. Final Answer:

   The report will show a step named 'Open login page' when this method runs -> Option C

4. Quick Check:

   @Step("Open login page") = step shown as 'Open login page' [OK]

Hint: @Step string sets step name in report [OK]

Common Mistakes:

• Thinking @Step needs a return value
• Assuming steps are ignored without extra config
• Expecting URL to appear instead of step name

4. You added @Step annotations to your Selenium Java test methods, but Allure reports do not show any steps. What is the most likely cause?

medium

A. Allure does not support Selenium tests

B. @Step annotation is only for JUnit, not TestNG

C. You need to add @Test annotation to every step method

D. You forgot to add the Allure listener or adapter in your test setup

Solution

1. Step 1: Check Allure integration requirements

   Allure requires adding listeners or adapters (like Allure TestNG listener) to capture @Step annotations during test execution.

2. Step 2: Identify common misconfigurations

   Without the listener, steps are not recorded. The other options are incorrect because Allure supports Selenium tests, @Step works with TestNG, and @Test is for test methods.

3. Final Answer:

   You forgot to add the Allure listener or adapter in your test setup -> Option D

4. Quick Check:

   Missing listener = no steps in report [OK]

Hint: Add Allure listener to capture @Step annotations [OK]

Common Mistakes:

• Assuming @Step works without listener
• Confusing @Step with @Test annotation
• Believing Allure doesn't support Selenium

5. You want to generate an Allure report after running your Selenium Java tests with Maven. Which sequence of commands correctly runs tests and generates the report?

hard

A. mvn test clean allure:report

B. mvn clean test allure:serve

C. allure generate mvn test

D. mvn allure:report clean test

Solution

1. Step 1: Understand Maven and Allure commands

   To run tests and generate an Allure report, first run tests with mvn clean test, then generate and serve the report with allure:serve.

2. Step 2: Analyze command order

   mvn clean test allure:serve correctly runs clean, then tests, then serves the report. Other options have wrong order or invalid commands.

3. Final Answer:

   mvn clean test allure:serve -> Option B

4. Quick Check:

   Run tests then serve report = mvn clean test allure:serve [OK]

Hint: Run tests first, then serve Allure report with Maven [OK]

Common Mistakes:

• Running allure commands before tests
• Mixing command order incorrectly
• Using invalid Allure commands