AutomationTestSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    AutomationTestSettings.h: Declares the UAutomationTestSettings class.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Engine/EngineTypes.h"
#include "UObject/SoftObjectPath.h"
#include "AutomationTestSettings.generated.h"
 
 
USTRUCT()
struct FExternalToolDefinition
{
    GENERATED_USTRUCT_BODY()
 
    /* The name of the tool / test. */
    UPROPERTY(config, EditAnywhere, Category=ExternalTools)
    FString ToolName;
 
    /* The executable to run. */
    UPROPERTY(config, EditAnywhere, Category=ExternalTools, meta=(FilePathFilter = "*"))
    FFilePath ExecutablePath;
 
    /* The command line options to pass to the executable. */
    UPROPERTY(config, EditAnywhere, Category=ExternalTools)
    FString CommandLineOptions;
 
    /* The working directory for the new process. */
    UPROPERTY(config, EditAnywhere, Category=ExternalTools, meta=(RelativePath))
    FDirectoryPath WorkingDirectory;
 
    /* If set, look for scripts with this extension. */
    UPROPERTY(config, EditAnywhere, Category=ExternalTools)
    FString ScriptExtension;
 
    /* If the ScriptExtension is set, look here for the script files. */
    UPROPERTY(config, EditAnywhere, Category=ExternalTools, meta=(RelativePath))
    FDirectoryPath ScriptDirectory;
};
 
USTRUCT()
struct FImportFactorySettingValues
{
    GENERATED_USTRUCT_BODY()
 
    /* The name of the FProperty to change */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (ToolTip = "Name of the property to change.  Nested settings can be modified using \"Outer.Property\""))
    FString SettingName;
 
    /* The value to apply to the FProperty */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (ToolTip = "Value to import for the specified property."))
    FString Value;
};
 
 
USTRUCT()
struct FEditorImportExportTestDefinition
{
    GENERATED_USTRUCT_BODY()
 
    /* The file to import */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "*"))
    FFilePath ImportFilePath;
 
    /* The file extension to use when exporting */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (ToolTip = "The file extension to use when exporting this asset.  Used to find a supporting exporter"))
    FString ExportFileExtension;
 
    /* If true, the export step will be skipped */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    bool bSkipExport = false;
 
    /* Settings for the import factory */
    UPROPERTY(config, EditAnywhere, Category=Automation)
    TArray<FImportFactorySettingValues> FactorySettings;
};
 
USTRUCT()
struct FEditorImportWorkflowDefinition
{
    GENERATED_USTRUCT_BODY()
 
    /* The file to import */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "*"))
    FFilePath ImportFilePath;
 
    /* Settings for the import factory */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    TArray<FImportFactorySettingValues> FactorySettings;
};
 
USTRUCT()
struct FBuildPromotionImportWorkflowSettings
{
    GENERATED_USTRUCT_BODY()
 
    /* Import settings for the Diffuse texture */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition Diffuse;
 
    /* Import settings for the Normalmap texture */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition Normal;
 
    /* Import settings for the static mesh */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition StaticMesh;
 
    /* Import settings for the static mesh to re-import */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition ReimportStaticMesh;
 
    /* Import settings for the blend shape */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition BlendShapeMesh;
 
    /* Import settings for the morph mesh */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition MorphMesh;
 
    /* Import settings for the skeletal mesh */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition SkeletalMesh;
 
    /* Import settings for the animation asset.  (Will automatically use the skeleton of the skeletal mesh above) */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition Animation;
 
    /* Import settings for the sound */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition Sound;
 
    /* Import settings for the surround sound (Select any of the channels.  It will auto import the rest)*/
    UPROPERTY(config, EditAnywhere, Category = Automation)
    FEditorImportWorkflowDefinition SurroundSound;
 
    /* Import settings for any other assets you may want to import */
    UPROPERTY(config, EditAnywhere, Category = Automation)
    TArray<FEditorImportWorkflowDefinition> OtherAssetsToImport;
};
 
USTRUCT()
struct FBuildPromotionOpenAssetSettings
{
    GENERATED_USTRUCT_BODY()
 
    /* The blueprint asset to open */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath BlueprintAsset;
 
    /* The material asset to open */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath MaterialAsset;
    
    /* The particle system asset to open */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath ParticleSystemAsset;
    
    /* The skeletal mesh asset to open */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath SkeletalMeshAsset;
    
    /* The static mesh asset to open */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath StaticMeshAsset;
    
    /* The texture asset to open */
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath TextureAsset;
};
 
USTRUCT()
struct FBuildPromotionNewProjectSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Automation)
    FDirectoryPath NewProjectFolderOverride;
 
    UPROPERTY(EditAnywhere, Category = Automation)
    FString NewProjectNameOverride;
};
 
USTRUCT()
struct FMaterialEditorPromotionSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath DefaultMaterialAsset;
 
    UPROPERTY(EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath DefaultDiffuseTexture;
 
    UPROPERTY(EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath DefaultNormalTexture;
 
};
 
 
USTRUCT()
struct FParticleEditorPromotionSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath DefaultParticleAsset;
};
 
USTRUCT()
struct FBlueprintEditorPromotionSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath FirstMeshPath;
 
    UPROPERTY(EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath SecondMeshPath;
 
    UPROPERTY(EditAnywhere, Category = Automation, meta = (FilePathFilter = "uasset"))
    FFilePath DefaultParticleAsset;
};
 
 
USTRUCT()
struct FBuildPromotionTestSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Automation)
    FFilePath DefaultStaticMeshAsset;
 
    UPROPERTY(EditAnywhere, Category = Automation)
    FBuildPromotionImportWorkflowSettings   ImportWorkflow;
 
    UPROPERTY(EditAnywhere, Category = Automation)
    FBuildPromotionOpenAssetSettings    OpenAssets;
 
    UPROPERTY(EditAnywhere, Category = Automation)
    FBuildPromotionNewProjectSettings NewProjectSettings;
 
    UPROPERTY(EditAnywhere, Category = Automation)
    FFilePath   SourceControlMaterial;
};
 
USTRUCT()
struct FEditorMapPerformanceTestDefinition
{
    GENERATED_USTRUCT_BODY()
    
    
    UPROPERTY(config, EditAnywhere, Category = Automation, meta=( AllowedClasses="/Script/Engine.World" ))
    FSoftObjectPath PerformanceTestmap;
 
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (ToolTip = "This is the length of time in seconds that this test will run for before stopping."))
    int32 TestTimer = 0;
};
 
USTRUCT()
struct FLaunchOnTestSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter = "umap"))
    FFilePath LaunchOnTestmap;
 
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (ToolTip = "This is the device to be used for launch on. Example: WindowsClient, Android, IOS, Linux"))
    FString DeviceID;
};
 
 
 
UCLASS(config=Engine, defaultconfig, MinimalAPI)
class UAutomationTestSettings : public UObject
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UPROPERTY(EditAnywhere, config, Category = Loading)
    TArray<FString> EngineTestModules;
 
    UPROPERTY(EditAnywhere, config, Category = Loading)
    TArray<FString> EditorTestModules;
 
    UPROPERTY(config, EditAnywhere, Category = Automation, meta=( AllowedClasses="/Script/Engine.World" ))
    FSoftObjectPath AutomationTestmap;
 
    UPROPERTY(config, EditAnywhere, Category = Automation)
    TArray<FEditorMapPerformanceTestDefinition> EditorPerformanceTestMaps;
 
    UPROPERTY(EditAnywhere, config, Category="Open Asset Tests")
    TArray<FString> AssetsToOpen;
 
    UPROPERTY(EditAnywhere, config, Category = "PIE Test Maps")
    TArray<FString> MapsToPIETest;
 
    UPROPERTY(EditAnywhere, config, Category = "Play all project Maps In PIE")
    bool bUseAllProjectMapsToPlayInPIE;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    FBuildPromotionTestSettings BuildPromotionTest;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    FMaterialEditorPromotionSettings MaterialEditorPromotionTest;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    FParticleEditorPromotionSettings ParticleEditorPromotionTest;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    FBlueprintEditorPromotionSettings BlueprintEditorPromotionTest;
 
    UPROPERTY(EditAnywhere, config, Category = MiscAutomationSetups)
    TArray<FString> TestLevelFolders;
    
    UPROPERTY(EditAnywhere, config, Category=ExternalTools)
    TArray<FExternalToolDefinition> ExternalTools;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    TArray<FEditorImportExportTestDefinition> ImportExportTestDefinitions;
 
    UPROPERTY(config, EditAnywhere, Category = Automation, meta = (FilePathFilter="umap"))
    TArray<FLaunchOnTestSettings> LaunchOnSettings;
 
    UPROPERTY(EditAnywhere, config, Category=Screenshots)
    FIntPoint DefaultScreenshotResolution;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    float PIETestDuration;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    float DefaultInteractiveFramerate;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    float DefaultInteractiveFramerateWaitTime;
 
    UPROPERTY(EditAnywhere, config, Category = Automation)
    float DefaultInteractiveFramerateDuration;
};