AZ::Test::GemTestEnvironment Class Reference

A test environment which is intended to facilitate writing unit tests which require components from a gem. More...

#include <GemTestEnvironment.h>

Inherits UnitTest::TraceBusHook.

Classes
class	GemTestEntity
struct	Parameters

Public Member Functions
void	AddDynamicModulePaths (AZStd::span< AZStd::string_view const > dynamicModulePaths)
void	AddDynamicModulePaths (AZStd::initializer_list< AZStd::string_view const > dynamicModulePaths)
void	AddComponentDescriptors (AZStd::span< AZ::ComponentDescriptor *const > componentDescriptors)
void	AddComponentDescriptors (AZStd::initializer_list< AZ::ComponentDescriptor *const > componentDescriptors)
void	AddRequiredComponents (AZStd::span< AZ::TypeId const > requiredComponents)
void	AddRequiredComponents (AZStd::initializer_list< AZ::TypeId const > requiredComponents)
void	AddActiveGems (AZStd::span< AZStd::string_view const > gemNames)
virtual void	AddGemsAndComponents ()
	Allows derived environments to set up which gems, components etc the environment should load.
virtual void	PreCreateApplication ()
	Allows derived environments to perform additional steps prior to creating the application.
virtual void	PostCreateApplication ()
	Allows derived environments to perform additional steps after creating the application.
virtual void	PostSystemEntityActivate ()
	Allows derived environments to perform additional steps after activating the system entity.
virtual void	PreDestroyApplication ()
	Allows derived environments to override to perform additional steps prior to destroying the application.
virtual void	PostDestroyApplication ()
	Allows derived environments to override to perform additional steps after destroying the application.
virtual AZ::ComponentApplication *	CreateApplicationInstance ()
	Allows derived environments to create a desired instance of the application (for example ToolsApplication).

Protected Member Functions
void	SetupEnvironment () override
void	TeardownEnvironment () override

Detailed Description

A test environment which is intended to facilitate writing unit tests which require components from a gem.

Member Function Documentation

AddActiveGems()

void AZ::Test::GemTestEnvironment::AddActiveGems

(

AZStd::span< AZStd::string_view const >

gemNames

)

Adds Gem Names which should be active in the test environment Any gem names added to this environment will be looked up through the O3DE manifest registration system to locate their gem root path. The gem root path is the directory containing the gem.json file. Each gem name is mapped as a key in the registered Settings Registry and FileIO global instances to the gem root path location on disk

Parameters

gemNames

Set of Gem Names to treat as active via adding keys each gem name underneath the AZ::SettingsRegistryMergeUtils::ActiveGemsRootKey key and adding a FileIO alias of @gemroot:<gem-name>@

AddComponentDescriptors()

void AZ::Test::GemTestEnvironment::AddComponentDescriptors

(

AZStd::span< AZ::ComponentDescriptor *const >

componentDescriptors

)

Adds to the collection of component descriptors which should be registered during the environment setup. Generally this will be the same as the descriptors which are registered in the gem's Module function, or a subset of those if only certain components are required during testing.

Parameters

componentDescriptors

Component descriptors to be added to the existing collection.

AddDynamicModulePaths()

void AZ::Test::GemTestEnvironment::AddDynamicModulePaths

(

AZStd::span< AZStd::string_view const >

dynamicModulePaths

)

Adds paths for the dynamic modules which should be loaded. These modules will be loaded prior to the setup of the gem which is the focus of the GemTestEnvironment, so any other gems etc. which that gem depends on should be added here. The gem to be tested should not be added here because it cannot be loaded using the usual module loading process, as that would result in attempting to create the gem's environment a second time.

Parameters

dynamicModulePaths

Dynamic module paths to be added to the existing collection.

AddRequiredComponents()

void AZ::Test::GemTestEnvironment::AddRequiredComponents

(

AZStd::span< AZ::TypeId const >

requiredComponents

)

Adds to the sorted list of components which should be activated during the environment setup. Any required components, for example the gem's system component, should be added here. Dependency sorting is not performed, so it is up to the caller to ensure that all dependencies are met and the components are provided in a valid activation order.

Parameters

requiredComponents

Components to be appended to the existing collection of required components.

---

The documentation for this class was generated from the following file:

• Code/Framework/AzTest/AzTest/GemTestEnvironment.h