Getting UWorld inside automation test

Development Programming & Scripting C++
, , , ,
1

I’m using IMPLEMENT_COMPLEX_AUTOMATION_TEST(..., ..., EAutomationTestFlags::EditorContext | EAutomationTestFlags::EngineFilter) to create an automation test. In this test I want to enumerate all maps in the game, and each CameraActor within those maps. My goal is to take a bunch of screen captures.

My problem is that both GEngine->GetWorld() and GEngine->GetWorldContextFromPIEInstance(0)->World() return null. My guess is that maybe this kind of test doesn’t make sense for an Editor test, and maybe I need to write/run a Game test. Can anybody confirm, and if so point me to a sample Game test.

Thanks.

2

I highly encourage anyone stumbling upon this to look at some of the tests as they are implemented in UE4 project (search for UWorld keyword in Tests files).

The following solution works for me and I scraped it together from observing UE4 Tests implementations.

inline UWorld* GetWorldForTestSafe()
{
	if (GEditor && GEditor->GetWorldContexts().Num() && GEditor->GetWorldContexts()[0].World())
	{
		UE_LOG(LogGameGeneric, Verbose, TEXT("Getting world from editor"))
		return GEditor->GetWorldContexts()[0].World();
	}
	if (GEngine && GEngine->GetWorldContexts().Num() && GEngine->GetWorldContexts()[0].World())
	{
		UE_LOG(LogGameGeneric, Verbose, TEXT("Getting world from engine"))
		return GEngine->GetWorldContexts()[0].World();
	}
	if (GEditor)
	{
		UE_LOG(LogGameGeneric, Verbose, TEXT("Creating new world for editor"))
		return FAutomationEditorCommonUtils::CreateNewMap();
	}
	UE_LOG(LogGameGeneric, Verbose, TEXT("GEditor was not present, could not create World (map)"))
	return nullptr;
}

But this might not be the best approach as the World Contexts might not be present at all for different types of tests.
It would be better to check against the test type which is being run.

I have tested this only few times and it seems to work, so I hope it at least helps somebody to find the correct direction if stumbeled upon this.

3 Likes