From 9440af30017042215e11844a74bf1794c29f65ee Mon Sep 17 00:00:00 2001 From: baubakg Date: Fri, 30 Aug 2024 20:29:33 +0200 Subject: [PATCH] Fixing toc --- README.md | 118 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 72 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 0a4038b..3bc1252 100644 --- a/README.md +++ b/README.md @@ -14,52 +14,78 @@ Examples of events are: * Service shut-downs ## Table of Contents -- [Problem Statement](#problem-statement) - * [Interruptive Events](#interruptive-events) - * [Non-Interruptive Events](#non-interruptive-events) -- [Installation](#installation) - * [Maven](#maven) -- [Phases](#phases) - * [Test Execution Modes](#test-execution-modes) - + [Default Mode](#default-mode) - + [Single Execution Mode](#single-execution-mode) - + [Shuffled Execution Mode](#shuffled-execution-mode) - - [Shuffled - Interruptive](#shuffled---interruptive) - - [Shuffled - Non-Interruptive](#shuffled---non-interruptive) -- [Writing a Phased Test](#writing-a-phased-test) - * [Setting Execution Modes](#setting-execution-modes) - + [Shuffled Mode](#shuffled-mode) - + [Single Run Mode](#single-run-mode) - * [Local Execution](#local-execution) - * [Non-Interruptive Events](#non-interruptive-events-1) - + [Writing a Non-Interruptive Event](#writing-a-non-interruptive-event) - + [Binding an Event to a Scenario](#binding-an-event-to-a-scenario) - + [Attaching an Event using the PhaseEvent Annotation](#attaching-an-event-using-the-phaseevent-annotation) - + [Attaching an Event using the PhasedTest Annotation](#attaching-an-event-using-the-phasedtest-annotation) - + [Attaching an Event to the Test Suite](#attaching-an-event-to-the-test-suite) - * [Before- and After-Phase Actions](#before--and-after-phase-actions) - * [Nested Design Pattern](#nested-design-pattern) -- [Running a Phased Test](#running-a-phased-test) - * [Run Time Properties](#run-time-properties) - * [Executing a CONSUMER phase based on the PRODUCED Data](#executing-a-consumer-phase-based-on-the-produced-data) - * [Execution Order](#execution-order) -- [Integrity between Steps and Scenarios](#integrity-between-steps-and-scenarios) - * [Phase Contexts - Managing the Scenario Step Executions](#phase-contexts---managing-the-scenario-step-executions) - + [On Failure](#on-failure) - + [On Non-Execution of a Phase](#on-non-execution-of-a-phase) - * [Managing Phased Data](#managing-phased-data) - + [Simple Properties file - Default](#simple-properties-file---default) - + [Phased Data Broker](#phased-data-broker) -- [Reporting](#reporting) - * [Report By Phase Group and Scenario](#report-by-phase-group-and-scenario) - + [Configuring Merged Reports](#configuring-merged-reports) - * [Raw Reports](#raw-reports) -- [Misc](#misc) - * [Data Providers](#data-providers) -- [Known Issues and Limitations](#known-issues-and-limitations) - * [Parallel Testing](#parallel-testing) - * [Retry Mechanisms](#retry-mechanisms) -- [Release Notes](#release-notes) + + * [Problem Statement](#problem-statement) + * [Interruptive Events](#interruptive-events) + * [Non-Interruptive Events](#non-interruptive-events) + * [Installation](#installation) + * [Maven](#maven) + * [Demo](#demo) + * [Phases](#phases) + * [Test Execution Modes](#test-execution-modes) + * [Default Mode](#default-mode) + * [Single Execution Mode](#single-execution-mode) + * [Shuffled Execution Mode](#shuffled-execution-mode) + * [Shuffled - Interruptive](#shuffled---interruptive) + * [Shuffled - Non-Interruptive](#shuffled---non-interruptive) + * [Writing a Phased Test](#writing-a-phased-test) + * [Setting Execution Modes](#setting-execution-modes) + * [Shuffled Mode](#shuffled-mode) + * [Single Run Mode](#single-run-mode) + * [Local Execution](#local-execution) + * [Non-Interruptive Events](#non-interruptive-events) + * [Writing a Non-Interruptive Event](#writing-a-non-interruptive-event) + * [Binding an Event to a Scenario](#binding-an-event-to-a-scenario) + * [Attaching an Event using the PhaseEvent Annotation](#attaching-an-event-using-the-phaseevent-annotation) + * [Attaching an Event using the PhasedTest Annotation](#attaching-an-event-using-the-phasedtest-annotation) + * [Attaching an Event to the Test Suite](#attaching-an-event-to-the-test-suite) + * [Targeting an Event to a Specific Step](#targeting-an-event-to-a-specific-step) + * [Before- and After-Phase Actions](#before--and-after-phase-actions) + * [Nested Design Pattern](#nested-design-pattern) + * [Running a Phased Test](#running-a-phased-test) + * [Run Time Properties](#run-time-properties) + * [PHASED.TESTS.PHASE](#phasedtestsphase) + * [PHASED.EVENTS.NONINTERRUPTIVE](#phasedeventsnoninterruptive) + * [PHASED.TESTS.DATABROKER](#phasedtestsdatabroker) + * [PHASED.TESTS.STORAGE.PATH](#phasedtestsstoragepath) + * [PHASED.TESTS.OUTPUT.DIR](#phasedtestsoutputdir) + * [PHASED.TESTS.RETRY.DISABLED](#phasedtestsretrydisabled) + * [PHASED.TESTS.REPORT.BY.PHASE_GROUP](#phasedtestsreportbyphase_group) + * [PHASED.TESTS.CODE.ROOT](#phasedtestscoderoot) + * [PHASED.TESTS.DETECT.ORDER](#phasedtestsdetectorder) + * [PHASED.TESTS.NONPHASED.LEGACY](#phasedtestsnonphasedlegacy) + * [Executing a CONSUMER phase based on the PRODUCED Data](#executing-a-consumer-phase-based-on-the-produced-data) + * [Execution Order](#execution-order) + * [Integrity between Steps and Scenarios](#integrity-between-steps-and-scenarios) + * [Phase Contexts - Managing the Scenario Step Executions](#phase-contexts---managing-the-scenario-step-executions) + * [On Failure](#on-failure) + * [On Non-Execution of a Phase](#on-non-execution-of-a-phase) + * [Managing Phased Data](#managing-phased-data) + * [Simple Properties file - Default](#simple-properties-file---default) + * [Phased Data Broker](#phased-data-broker) + * [Reporting](#reporting) + * [Report By Phase Group and Scenario](#report-by-phase-group-and-scenario) + * [Configuring Merged Reports](#configuring-merged-reports) + * [Raw Reports](#raw-reports) + * [Misc](#misc) + * [Data Providers](#data-providers) + * [Known Issues and Limitations](#known-issues-and-limitations) + * [Parallel Testing](#parallel-testing) + * [Retry Mechanisms](#retry-mechanisms) + * [Release Notes](#release-notes) + * [8.11.2](#8112) + * [8.11.1](#8111) + * [8.0.0](#800) + * [7.0.10](#7010) + * [7.0.9](#709) + * [7.0.8](#708) + * [7.0.7](#707) + * [7.0.5](#705) + * [7.0.4](#704) + * [7.0.3](#703) + * [7.0.0](#700) + * [1.0.0](#100) + ## Problem Statement Phased Testing has been created to address the issues related to Event Based Testing. Event Based Testing is a notion where tests adapt to external events, and allow you to simulate how your product reacts to an external event. We identify two types of events: