Class UZagalaSpecScenario#
Defined in File ZagalaSpecScenario.h
Inheritance Relationships#
Base Types#
public UObjectpublic IZagalaSpecTestabilityIndicator(Class IZagalaSpecTestabilityIndicator)public IZagalaSpecDescriptor(Class IZagalaSpecDescriptor)public IZagalaSpecScenarioInterface(Class IZagalaSpecScenarioInterface)public IZagalaSpecEditController(Class IZagalaSpecEditController)public IZagalaSpecScenarioPropertyNames(Class IZagalaSpecScenarioPropertyNames)
Class Documentation#
-
class UZagalaSpecScenario : public UObject, public IZagalaSpecTestabilityIndicator, public IZagalaSpecDescriptor, public IZagalaSpecScenarioInterface, public IZagalaSpecEditController, public IZagalaSpecScenarioPropertyNames#
A feature scenario outlines the expected behavior of a software feature from a user’s perspective, ensuring it meets specific acceptance criteria.
Scenarios are simple and concise examples (easy to understand, precise, verifiables; a specification (instead of a script) of the business domain, not the software.)
IZagalaSpecScenarioInterface interface
-
virtual const TArray<TObjectPtr<UObject>> &GetExpectationsReference() const override#
Read-only access to the expectations array for exporters and tooling.
-
virtual const TArray<TObjectPtr<UObject>> &GetContextExtensionsReference() const override#
Read-only access to the context extensions array for exporters and tooling.
IZagalaSpecScenarioPropertyNames interface
-
virtual FName GetIdentifierPropertyName() const override#
Name of the property that stores the scenario’s gameplay tag (FGameplayTag).
- Returns:
The identifier property name.
-
virtual FName GetDescriptionPropertyName() const override#
Name of the property that stores the scenario’s description (FString).
- Returns:
The description property name.
-
virtual FName GetIncludeInTestsPropertyName() const override#
Name of the property that stores whether the scenario is included in tests (bool).
- Returns:
The include-in-tests property name.
-
virtual FName GetContextExtensionsPropertyName() const override#
Name of the property that stores the context extensions (array of objects).
- Returns:
The context extensions property name.
-
virtual FName GetExpectationsPropertyName() const override#
Name of the property that stores the expectations (array of objects).
- Returns:
The expectations property name.
-
virtual FName GetFilterTagsPropertyName() const override#
Name of the property that stores the scenario filter tags (FGameplayTagContainer).
- Returns:
The filter tags property name.
IZagalaSpecEditController interface
-
virtual bool DoesAllowEditing_Implementation() override#
Returns whether this object currently allows editing.
- Returns:
True if editing is currently allowed, false otherwise.
-
virtual void AllowEditing_Implementation() override#
Tries setting EditController variable to true.
-
virtual void DisallowEditing_Implementation() override#
Tries setting EditController variable to false.
Public Functions
-
UZagalaSpecScenario(const FObjectInitializer &ObjectInitializer = FObjectInitializer::Get())#
-
virtual void PostEditChangeProperty(FPropertyChangedEvent &PropertyChangedEvent) override#
-
virtual EDataValidationResult IsDataValid(class FDataValidationContext &Context) const override#
Fails when the tag is invalid, there are no expectations, or any expectation or context extension is invalid.
Protected Functions
-
virtual bool IsIncludedInTests_Implementation() const override#
Returns true if this scenario should be registered in the test runner.
-
virtual FGameplayTagContainer GetFilterTags_Implementation() const override#
Returns the scenario filter tags (ZagalaSpec.ScenarioFilter.
*) that control whether this scenario is listed when tests are gathered. The tags are copied into the ZagalaSpec feature settings when the owning feature is saved. They are not imported or exported.
- Returns:
The filter tags of this scenario. Empty by default.
-
virtual FGameplayTag GetTag_Implementation() const override#
Returns the associated gameplay tag for this object.
- Returns:
The gameplay tag of this object.
-
virtual FString GetDescription_Implementation() const override#
Returns a textual description of this object.
- Returns:
The description of this object.
Protected Attributes
-
FString Description#
Narrative description of the scenario.
-
bool bIncludeInTests = true#
When false, this scenario is not registered in the test runner.
-
TArray<TObjectPtr<UObject>> ContextExtensions#
Context extensions are used to set up the scenario execution context before expectations run and to control whether additional iterations are needed.
They are executed in sequence, and the scenario execution context waits for all extensions to signal ready before running expectations. Extensions can also implement IZagalaSpecIterationController to indicate whether another iteration pass is needed after expectations complete.
-
TArray<TObjectPtr<UObject>> Expectations#
Array of expectations that belong to this scenario.
Executed sequentially via ExpectationChain. If any expectation fails, the execution context fails and the scenario stops.
-
FGameplayTagContainer FilterTags#
Scenario filter tags (ZagalaSpec.ScenarioFilter.
*) that decide whether this scenario is listed when tests are gathered. They are stored in the ZagalaSpec feature settings when the feature is saved and are not imported or exported.
-
virtual const TArray<TObjectPtr<UObject>> &GetExpectationsReference() const override#