Allure reporting integration in Selenium Java - Framework Patterns

Framework Mode - Allure reporting integration

Folder Structure

src/
├── main/
│   └── java/
│       └── com/example/app/
│           └── pages/          # Page Object classes
├── test/
│   └── java/
│       └── com/example/tests/  # Test classes
├── resources/
│   └── testdata/               # Test data files (CSV, JSON)
├── allure-results/             # Allure raw results (generated after tests)
└── pom.xml                     # Maven project file with dependencies

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown with explicit waits.
• Page Objects: Encapsulate UI elements and actions for each page.
• Tests: TestNG test classes that use page objects and include Allure annotations.
• Utilities: Helper classes for logging, screenshots, and test data handling.
• Configuration: Handles environment variables, browser settings, and credentials.

Configuration Patterns

• Environment Profiles: Use Maven profiles or system properties to switch between dev, test, and prod environments.
• Browser Selection: Pass browser type as a system property (e.g., -Dbrowser=chrome) to run tests on different browsers.
• Credentials Management: Store sensitive data in environment variables or encrypted files, not in source code.
• Allure Configuration: Configure Allure plugin in pom.xml and set output directory for results.

Test Reporting and CI/CD Integration

• Allure generates detailed HTML reports with test steps, screenshots, and logs.
• Integrate Allure report generation in Maven lifecycle using mvn test and mvn allure:serve.
• Configure CI pipelines (Jenkins, GitHub Actions) to run tests, collect allure-results, and publish reports.
• Use Allure badges in project README to show test status.

Best Practices for Allure Reporting Integration

1. Use Allure annotations like @Step, @Attachment, and @Severity to enrich reports.
2. Capture screenshots on test failure and attach them to Allure reports.
3. Keep test steps small and descriptive for clear reporting.
4. Clean allure-results folder before each test run to avoid stale data.
5. Integrate Allure report generation as part of CI/CD to ensure visibility of test results.

Self Check

Where in this folder structure would you add a new utility class to capture screenshots for Allure attachments?

Key Result

Integrate Allure reporting by organizing test layers, configuring environment and browser settings, enriching tests with annotations, and automating report generation in CI/CD.