Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs-site/docs/accessibility.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Accessibility testing in Selenium: assert WCAG compliance with bundled axe-core in one line, inside your existing Selenium tests, no extra tools."
id: accessibility
title: Accessibility Assertions
sidebar_position: 17
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Selenium Boot release notes and version history: new features, fixes, and breaking changes across every release."
id: changelog
title: Changelog
sidebar_position: 99
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/ci/github-actions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Run Selenium tests in GitHub Actions: a copy-paste workflow that installs Chrome, runs the suite headless, and uploads the HTML report on every push."
id: github-actions
title: GitHub Actions
sidebar_position: 1
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/ci/jenkins.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Run Selenium tests on Jenkins: a ready Jenkinsfile pipeline that runs the suite, publishes JUnit results, and archives the Selenium Boot HTML report."
id: jenkins
title: Jenkins
sidebar_position: 2
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/ci/quality-gates.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Fail your CI build on a low pass rate or too many flaky tests. Configure Selenium test quality gates so a green pipeline never hides real failures."
id: quality-gates
title: Quality Gates
sidebar_position: 3
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/clock-mocking.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Mock the browser clock in Selenium tests: freeze or advance JavaScript Date to test countdowns, trials, and time-sensitive UI deterministically."
id: clock-mocking
title: Clock Mocking
sidebar_position: 14
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/cloud-execution.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Run Selenium tests on BrowserStack and Sauce Labs with zero code changes. Switch from local Chrome to cloud browsers by editing one config line."
id: cloud-execution
title: Cloud Execution
sidebar_position: 12
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Complete selenium-boot.yml configuration reference: browser, parallel threads, timeouts, retry, and CI quality gates, every option in one place."
id: configuration
title: Configuration Reference
sidebar_position: 3
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/cucumber.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "BDD Selenium testing with Cucumber 7: driver lifecycle, screenshots on failure, and a step timeline in the HTML report, wired up out of the box."
id: cucumber
title: BDD / Cucumber
sidebar_position: 11
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/email-verification.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Verify emails in Selenium tests: assert confirmation links, password resets, and OTPs via Mailhog, Mailtrap, Graph API, or IMAP with the mailbox() API."
id: email-verification
title: Email Verification
sidebar_position: 11
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/extensibility/custom-drivers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Add a custom WebDriver to Selenium Boot: plug in Edge, Safari, Appium, or a cloud driver via NamedDriverProvider without touching the framework."
id: custom-drivers
title: Custom Drivers
sidebar_position: 3
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/extensibility/hooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Run code at suite and test lifecycle points in Selenium with ExecutionHook: inject setup, teardown, and failure handling without subclassing."
id: hooks
title: Execution Hooks
sidebar_position: 2
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/extensibility/plugins.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Extend Selenium Boot with plugins: SeleniumBootPlugin adds behaviour alongside the framework, auto-discovered via Java SPI and ServiceLoader."
id: plugins
title: Plugins
sidebar_position: 1
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/extensibility/report-adapters.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Turn Selenium test results into any format with ReportAdapter: Slack messages, Allure, email summaries, or custom dashboards from the metrics JSON."
id: report-adapters
title: Report Adapters
sidebar_position: 4
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/external-test-data.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Data-driven Selenium tests: load @TestData rows from CSV files, Excel workbooks, and live database queries with no extra boilerplate."
id: external-test-data
title: External Test Data Sources
sidebar_position: 13
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Get your first Selenium test running in under 5 minutes: add one dependency, extend BaseTest, and run, with no WebDriver setup or boilerplate."
id: getting-started
title: Getting Started
sidebar_position: 2
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/gradle.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Use Selenium Boot with Gradle: the recommended build.gradle setup for running TestNG or JUnit 5 Selenium tests with the Maven Central JAR."
id: gradle
title: Gradle Build Support
sidebar_position: 3
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/api-auth.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "API authentication for Selenium API tests: Bearer token, Basic auth, and OAuth2 client credentials supported out of the box."
sidebar_position: 14
---

Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/api-testing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "API testing in Selenium Boot: write pure API tests or hybrid UI plus API tests in the same suite, config, and HTML report."
sidebar_position: 13
---

Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/base-page.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "BasePage in Selenium Boot: wait-backed click, type, getText, dropdown, iframe, and upload helpers so you never write raw Selenium in page objects."
id: base-page
title: BasePage
sidebar_position: 2
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/base-test.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "BaseTest is the one superclass every Selenium Boot test extends, the only setup required. Driver lifecycle, waits, and reporting come for free."
id: base-test
title: BaseTest
sidebar_position: 1
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/browser-lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Control the Selenium browser lifecycle: choose per-test or per-suite WebDriver sessions to balance execution speed against test isolation."
id: browser-lifecycle
title: Browser Lifecycle
sidebar_position: 7
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/console-errors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Catch JavaScript errors in Selenium tests: ConsoleErrorCollector captures browser console errors so silent JS failures fail the test."
id: console-errors
title: Console Error Collector
sidebar_position: 11
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/download-manager.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Test file downloads in Selenium: DownloadManager polls the download directory, waits for the file to appear, and handles partial downloads."
id: download-manager
title: DownloadManager
sidebar_position: 10
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/parallel.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Parallel Selenium test execution: set the thread count in selenium-boot.yml and get thread-safe, isolated WebDriver instances automatically."
id: parallel
title: Parallel Execution
sidebar_position: 5
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/precondition.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Log in once for all Selenium tests: @PreCondition runs setup once per thread and caches the session (cookies and localStorage) for every test."
id: precondition
title: "@PreCondition"
sidebar_position: 12
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/retry.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Automatic retry for flaky Selenium tests: Selenium Boot re-runs failures with no IRetryAnalyzer wiring, enabled in a single config line."
id: retry
title: Retry
sidebar_position: 4
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/scenario-context.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Share state between Selenium test steps safely: built-in scenario and suite context stores replace static fields and thread-unsafe globals."
sidebar_position: 15
---

Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/screenshots.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Automatic screenshots on Selenium test failure, embedded as Base64 in the HTML report, with no external image files or storage to manage."
id: screenshots
title: Screenshots
sidebar_position: 8
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/self-healing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Self-healing Selenium locators: when a selector breaks, the framework falls back through id, name, text, and data-testid and flags every heal."
id: self-healing
title: Self-Healing Locators
sidebar_position: 10
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/semantic-locators.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Accessibility-first Selenium locators: Playwright-style getByRole, getByText, and getByLabel target the accessibility tree and survive CSS refactors."
id: semantic-locators
title: Accessibility-First Locators
sidebar_position: 10
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/smart-locator.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "SmartLocator tries multiple Selenium locator strategies in order and returns the first visible match: resilient locators for brittle selectors."
id: smart-locator
title: SmartLocator
sidebar_position: 9
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/step-logging.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Log named test steps in Selenium: StepLogger renders a timeline with screenshots inside each test's detail panel in the HTML report."
id: step-logging
title: Step Logging
sidebar_position: 6
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/guides/wait-engine.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Explicit waits in Selenium without Thread.sleep(): WaitEngine gives fluent, auto-configured waits driven by your selenium-boot.yml timeout."
id: wait-engine
title: WaitEngine
sidebar_position: 3
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Selenium Boot is the Spring Boot of Selenium: zero setup, Playwright-inspired locators and auto-waiting, and enterprise features, without hiding Selenium."
id: intro
title: Introduction
sidebar_position: 1
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/junit5.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Run Selenium Boot with JUnit 5: opt in via @ExtendWith(SeleniumBootExtension) or BaseJUnit5Test for the same lifecycle, waits, and reporting as TestNG."
id: junit5
title: JUnit 5 Support
sidebar_position: 10
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/performance.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Assert Core Web Vitals in Selenium tests: check LCP, CLS, and other Google performance metrics inline, with no proxy or external service."
id: performance
title: Performance Assertions
sidebar_position: 16
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/quarantine.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Quarantine flaky Selenium tests: mark known-broken tests so the framework skips them automatically, without deleting or commenting out code."
id: quarantine
title: Test Quarantine
sidebar_position: 15
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/reporting/html-report.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Selenium Boot HTML report: a self-contained dashboard with pass-rate gauge, retries, screenshots, flakiness radar, and dark mode, no server needed."
id: html-report
title: HTML Report
sidebar_position: 1
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/reporting/junit-xml.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Selenium Boot emits JUnit-compatible XML that Jenkins, GitHub Actions, and GitLab CI parse natively for standard test result reporting."
id: junit-xml
title: JUnit XML
sidebar_position: 2
Expand Down
1 change: 1 addition & 0 deletions docs-site/docs/test-management.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Push Selenium test results to TestRail and Xray automatically: one annotation, no extra reporting code in your test methods."
id: test-management
title: TestRail & Xray Integration
sidebar_position: 16
Expand Down
Loading