// Copyright Epic Games, Inc. All Rights Reserved. #include "SAutomationTestItem.h" #include "Modules/ModuleManager.h" #include "IAutomationReport.h" #include "IAutomationControllerModule.h" #include "SlateOptMacros.h" #include "Framework/Application/SlateApplication.h" #include "Widgets/Images/SImage.h" #include "Widgets/Images/SSpinningImage.h" #include "Widgets/Notifications/SProgressBar.h" #include "Widgets/Text/STextBlock.h" #include "Widgets/Input/SCheckBox.h" #include "AutomationWindowStyle.h" #include "AutomationTestExcludelist.h" #include "SAutomationWindow.h" #if WITH_EDITOR #include "AssetRegistry/AssetData.h" #include "EngineGlobals.h" #include "Editor.h" #include "AssetRegistry/AssetRegistryModule.h" #include "Dialogs/Dialogs.h" #include "SKismetInspector.h" #endif #include "Widgets/Input/SHyperlink.h" #include "SSimpleButton.h" #define LOCTEXT_NAMESPACE "AutomationTestItem" /* SAutomationTestItem interface *****************************************************************************/ void SAutomationTestItem::Construct( const FArguments& InArgs, const TSharedRef& InOwnerTableView ) { TestStatus = InArgs._TestStatus; ColumnWidth = InArgs._ColumnWidth; HighlightText = InArgs._HighlightText; OnCheckedStateChangedDelegate = InArgs._OnCheckedStateChanged; SMultiColumnTableRow< TSharedPtr< FString > >::Construct( SMultiColumnTableRow< TSharedPtr< FString > >::FArguments(), InOwnerTableView ); } BEGIN_SLATE_FUNCTION_BUILD_OPTIMIZATION TSharedRef SAutomationTestItem::GenerateWidgetForColumn( const FName& ColumnName ) { if( ColumnName == AutomationTestWindowConstants::Title) { TSharedRef TestNameWidget = SNullWidget::NullWidget; // Would be nice to warp to text location...more difficult when distributed. if ( !TestStatus->GetOpenCommand().IsEmpty() && WITH_EDITOR ) { #if WITH_EDITOR TestNameWidget = SNew(SHyperlink) .Style(FAutomationWindowStyle::Get(), "Common.GotoNativeCodeHyperlink") .OnNavigate_Lambda([=] { GEngine->Exec(nullptr, *TestStatus->GetOpenCommand()); }) .Text(FText::FromString(TestStatus->GetDisplayNameWithDecoration())); #endif } else if ( !TestStatus->GetAssetPath().IsEmpty() && WITH_EDITOR ) { #if WITH_EDITOR TestNameWidget = SNew(SHyperlink) .Style(FAutomationWindowStyle::Get(), "Common.GotoNativeCodeHyperlink") .OnNavigate_Lambda([=] { FString AssetPath = TestStatus->GetAssetPath(); FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked(TEXT("AssetRegistry")); TArray AllAssets; AssetRegistryModule.Get().GetAssetsByPackageName(*AssetPath, AllAssets); if ( AllAssets.Num() > 0 ) { UObject* ObjectToEdit = AllAssets[0].GetAsset(); if ( ObjectToEdit ) { GEditor->EditObject(ObjectToEdit); } } }) .Text(FText::FromString(TestStatus->GetDisplayNameWithDecoration())); #endif } else if ( !TestStatus->GetSourceFile().IsEmpty() ) { TestNameWidget = SNew(SHyperlink) .Style(FAutomationWindowStyle::Get(), "Common.GotoNativeCodeHyperlink") .OnNavigate_Lambda([=] { FSlateApplication::Get().GotoLineInSource(TestStatus->GetSourceFile(), TestStatus->GetSourceFileLine()); }) .Text(FText::FromString(TestStatus->GetDisplayNameWithDecoration())); } else { TestNameWidget = SNew(STextBlock) .HighlightText(HighlightText) .Text(FText::FromString(TestStatus->GetDisplayNameWithDecoration())); } return SNew(SHorizontalBox) +SHorizontalBox::Slot() .AutoWidth() .HAlign(HAlign_Center) .Padding(4.0f, 0.0f) [ //enabled/disabled check box SNew( SCheckBox ) .IsChecked(this, &SAutomationTestItem::IsTestEnabled) .OnCheckStateChanged(this, &SAutomationTestItem::HandleTestingCheckbox_Click) ] +SHorizontalBox::Slot() .AutoWidth() .VAlign(VAlign_Center) [ //this is where the tree is marked as expandable or not. SNew( SExpanderArrow, SharedThis( this ) ) ] +SHorizontalBox::Slot() .AutoWidth() .HAlign(HAlign_Center) [ //name of the test TestNameWidget ]; } else if( ColumnName == AutomationTestWindowConstants::SmokeTest ) { //icon to show if the test is considered fast or is the parent of a fast test return SNew( SImage) .Image( this, &SAutomationTestItem::GetSmokeTestImage ); } else if( ColumnName == AutomationTestWindowConstants::RequiredDeviceCount ) { // Should we display an icon to indicate that this test "Requires" more than one participant? if( TestStatus->GetNumParticipantsRequired() > 1 ) { TSharedPtr< SHorizontalBox > HBox = SNew( SHorizontalBox ); if( TestStatus->GetTotalNumChildren() == 0 ) { FFormatNamedArguments Args; Args.Add(TEXT("NumParticipantsRequired"), TestStatus->GetNumParticipantsRequired()); // Display a network PC and the number which are required for this test. HBox->AddSlot() [ SNew( SImage ) .Image(FAutomationWindowStyle::Get().GetBrush("Automation.Participant") ) ]; HBox->AddSlot() [ SNew( STextBlock ) .Text( FText::Format( LOCTEXT( "NumParticipantsRequiredWrapper", "x{NumParticipantsRequired}" ), Args ) ) ]; HBox->SetToolTipText(FText::Format(LOCTEXT("NumParticipantsRequiredMessage", "This test requires {NumParticipantsRequired} participants to be run."), Args)); } else { HBox->AddSlot() .HAlign(HAlign_Center) [ SNew( SImage ) .Image(FAutomationWindowStyle::Get().GetBrush("Automation.ParticipantsWarning") ) .ToolTipText( LOCTEXT("ParticipantsWarningToolTip", "Some tests require multiple participants") ) ]; } return HBox.ToSharedRef(); } } else if( ColumnName == AutomationTestWindowConstants::Status ) { TSharedRef HBox = SNew (SHorizontalBox); int32 NumClusters = FModuleManager::GetModuleChecked("AutomationController").GetAutomationController()->GetNumDeviceClusters(); //for each cluster, display a status icon for (int32 ClusterIndex = 0; ClusterIndex < NumClusters; ++ClusterIndex) { //if this is a leaf test if (TestStatus->GetTotalNumChildren() == 0) { //for leaf tests HBox->AddSlot() .MaxWidth(ColumnWidth) .FillWidth(1.0) [ SNew(SBorder) .BorderImage(FAutomationWindowStyle::Get().GetBrush("ErrorReporting.Box") ) .HAlign(HAlign_Center) .VAlign(VAlign_Center) .Padding( FMargin(3,0) ) .BorderBackgroundColor( FSlateColor( FLinearColor( 1.0f, 0.0f, 1.0f, 0.0f ) ) ) .ToolTipText( this, &SAutomationTestItem::GetTestToolTip, ClusterIndex ) [ SNew(SHorizontalBox) +SHorizontalBox::Slot() .AutoWidth() [ //image when complete or un-run SNew( SImage ) .Image( this, &SAutomationTestItem::ItemStatus_StatusImage, ClusterIndex ) .Visibility( this, &SAutomationTestItem::ItemStatus_GetStatusVisibility, ClusterIndex, false ) ] +SHorizontalBox::Slot() .AutoWidth() .HAlign(HAlign_Center) .VAlign(VAlign_Center) [ SNew(SBox) .WidthOverride(16.0f) .HeightOverride(16.0f) [ // Spinning Image while in process SNew(SSpinningImage) .Image( this, &SAutomationTestItem::ItemStatus_StatusImage, ClusterIndex ) .Visibility(this, &SAutomationTestItem::ItemStatus_GetStatusVisibility, ClusterIndex, true) ] ] ] ]; } else { //for internal tree nodes HBox->AddSlot() .MaxWidth(ColumnWidth) .FillWidth(1.0) [ SNew(SBorder) .BorderImage(FAutomationWindowStyle::Get().GetBrush("ErrorReporting.Box") ) .HAlign(HAlign_Center) .VAlign(VAlign_Center) .Padding( FMargin(3,0) ) .BorderBackgroundColor( FSlateColor( FLinearColor( 1.0f, 0.0f, 1.0f, 0.0f ) ) ) [ SNew(SHorizontalBox) +SHorizontalBox::Slot() .AutoWidth() .HAlign(HAlign_Center) .VAlign(VAlign_Center) [ //image when children complete or not run SNew(SImage) .Image(this, &SAutomationTestItem::ItemChildrenStatus_StatusImage, ClusterIndex) .Visibility(this, &SAutomationTestItem::ItemStatus_GetChildrenStatusVisibility, ClusterIndex, false) ] +SHorizontalBox::Slot() .AutoWidth() [ SNew(SBox) .WidthOverride(ColumnWidth - 8) .HeightOverride(16.0f) [ //progress bar for percent of enabled children completed SNew(SProgressBar) .Percent(this, &SAutomationTestItem::ItemStatus_ProgressFraction, ClusterIndex) .FillColorAndOpacity(this, &SAutomationTestItem::ItemStatus_ProgressColor, ClusterIndex) .Visibility(this, &SAutomationTestItem::ItemStatus_GetChildrenStatusVisibility, ClusterIndex, true) ] ] ] ]; } } return HBox; } else if( ColumnName == AutomationTestWindowConstants::Timing ) { return SNew( STextBlock ) .Text( this, &SAutomationTestItem::ItemStatus_DurationText); } else if (ColumnName == AutomationTestWindowConstants::IsToBeSkipped) { return SNew(SHorizontalBox) + SHorizontalBox::Slot() .HAlign(HAlign_Center) .AutoWidth() [ SNew(SCheckBox) .IsChecked(this, &SAutomationTestItem::IsToBeSkipped) .IsEnabled(this, &SAutomationTestItem::IsDirectlyExcluded) .OnCheckStateChanged(this, &SAutomationTestItem::SetSkipFlag) .ToolTipText(this, &SAutomationTestItem::GetExcludeReason) #if WITH_EDITOR ] + SHorizontalBox::Slot() .HAlign(HAlign_Center) .AutoWidth() [ SNew(SSimpleButton) .Icon(FAutomationWindowStyle::Get().GetBrush("Icons.Edit")) .Visibility(this, &SAutomationTestItem::IsDirectlyExcluded_GetVisibility) .ToolTipText(LOCTEXT("EditExcludeOptions", "Edit exclude options")) .OnClicked(FOnClicked::CreateSP(this, &SAutomationTestItem::OnEditExcludeOptionsClicked)) #endif ]; } return SNullWidget::NullWidget; } END_SLATE_FUNCTION_BUILD_OPTIMIZATION /* SAutomationTestItem Implementation *****************************************************************************/ const FSlateBrush* SAutomationTestItem::GetSmokeTestImage() const { const FSlateBrush* ImageToUse = nullptr; if ( TestStatus->GetTestFlags() & EAutomationTestFlags::SmokeFilter ) { if ( TestStatus->IsParent() ) { ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.SmokeTest"); } else { ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.SmokeTestParent"); } } return ImageToUse; } FText SAutomationTestItem::GetTestToolTip( int32 ClusterIndex ) const { FText TestToolTip; const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); EAutomationState TestState = TestStatus->GetState( ClusterIndex, PassIndex ); if ( TestState == EAutomationState::NotRun ) { TestToolTip = LOCTEXT("TestToolTipNotRun", "Not Run"); } else if( TestState == EAutomationState::Skipped ) { TestToolTip = LOCTEXT("ToolTipSkipped", "This test was skipped."); } else { FFormatNamedArguments Args; Args.Add(TEXT("GameName"), FText::FromString(TestStatus->GetGameInstanceName(ClusterIndex))); if (TestState == EAutomationState::InProcess) { TestToolTip = FText::Format(LOCTEXT("TestToolTipInProgress", "In progress on: {GameName}"), Args); } else if (TestState == EAutomationState::Success) { TestToolTip = FText::Format(LOCTEXT("TestToolTipComplete", "Completed on: {GameName}"), Args); } else { TestToolTip = FText::Format(LOCTEXT("TestToolTipFailed", "Failed on: {GameName}"), Args); } } return TestToolTip; } ECheckBoxState SAutomationTestItem::IsTestEnabled() const { return TestStatus->IsEnabled() ? ECheckBoxState::Checked : ECheckBoxState::Unchecked; } ECheckBoxState SAutomationTestItem::IsToBeSkipped() const { return TestStatus->IsToBeSkipped() ? ECheckBoxState::Checked : ECheckBoxState::Unchecked; } bool SAutomationTestItem::IsDirectlyExcluded() const { return WITH_EDITOR && !TestStatus->IsToBeSkippedByPropagation(); } EVisibility SAutomationTestItem::IsDirectlyExcluded_GetVisibility() const { return TestStatus->IsToBeSkipped() && IsDirectlyExcluded() ? EVisibility::Visible : EVisibility::Collapsed; } FText SAutomationTestItem::GetExcludeReason() const { FName Reason; bool IsToBeSkipped = TestStatus->IsToBeSkipped(&Reason); return IsToBeSkipped ? FText::FromName(Reason) : FText(); } void SAutomationTestItem::SetSkipFlag(ECheckBoxState Enable) { #if WITH_EDITOR if (Enable == ECheckBoxState::Checked) { OnEditExcludeOptionsClicked(); } else { TestStatus->SetSkipFlag(false); } #endif } FReply SAutomationTestItem::OnEditExcludeOptionsClicked() { #if WITH_EDITOR TSharedPtr Options = TestStatus->GetExcludeOptions(); TSharedPtr StructToDisplay = MakeShareable(new FStructOnScope(FAutomationTestExcludeOptions::StaticStruct(), (uint8*)Options.Get())); TSharedRef KismetInspector = SNew(SKismetInspector); KismetInspector->ShowSingleStruct(StructToDisplay); SGenericDialogWidget::FArguments DialogArguments; DialogArguments.OnOkPressed_Lambda([Options, this]() { auto Entry = FAutomationTestExcludelistEntry(*Options); TestStatus->SetSkipFlag(true, &Entry, false); }); SGenericDialogWidget::OpenDialog(LOCTEXT("ExcludeTestOptions", "Exclude Test Options"), KismetInspector, DialogArguments, true); #endif return FReply::Handled(); } FSlateColor SAutomationTestItem::ItemStatus_BackgroundColor(const int32 ClusterIndex) const { if (TestStatus->GetTotalNumChildren()==0) { const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); EAutomationState TestState = TestStatus->GetState(ClusterIndex,PassIndex); if (TestState == EAutomationState::Fail) { // Failure is marked by a red background. return FSlateColor( FLinearColor( 0.5f, 0.0f, 0.0f ) ); } else if (TestState == EAutomationState::InProcess) { // In Process, yellow. return FSlateColor( FLinearColor( 0.5f, 0.5f, 0.0f ) ); } else if (TestState == EAutomationState::Success) { // Success is marked by a green background. return FSlateColor( FLinearColor( 0.0f, 0.5f, 0.0f ) ); } // Not Scheduled will receive this color which is to say no color since alpha is 0. return FSlateColor( FLinearColor( 1.0f, 0.0f, 1.0f, 0.0f ) ); } else { // Not Scheduled will receive this color which is to say no color since alpha is 0. return FSlateColor( FLinearColor( 1.0f, 0.0f, 1.0f, 0.0f ) ); } } FText SAutomationTestItem::ItemStatus_DurationText() const { FText DurationText; float MinDuration; float MaxDuration; if (TestStatus->GetDurationRange(MinDuration, MaxDuration)) { FNumberFormattingOptions Options; Options.MaximumFractionalDigits = 4; Options.MaximumIntegralDigits = 4; FFormatNamedArguments Args; Args.Add(TEXT("MinDuration"), MinDuration); Args.Add(TEXT("MaxDuration"), MaxDuration); //if there is a duration range if (MinDuration != MaxDuration) { DurationText = FText::Format(LOCTEXT("ItemStatusDurationRange", "{MinDuration}s - {MaxDuration}s"), Args); } else { DurationText = FText::Format(LOCTEXT("ItemStatusDuration", "{MinDuration}s"), Args); } } return DurationText; } EVisibility SAutomationTestItem::ItemStatus_GetStatusVisibility(const int32 ClusterIndex, const bool bForInProcessThrobber) const { const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); EAutomationState TestState = TestStatus->GetState(ClusterIndex,PassIndex); bool bImageVisible = TestState != EAutomationState::InProcess; bool bFinalVisibility = bForInProcessThrobber ? !bImageVisible : bImageVisible; return bFinalVisibility ? EVisibility::Visible : EVisibility::Collapsed; } EVisibility SAutomationTestItem::ItemStatus_GetChildrenStatusVisibility(const int32 ClusterIndex, const bool bForInProcessThrobber) const { // Internal node: completion status image visible when all children completed bool bImageVisible = false; FAutomationCompleteState CompleteState; const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); TestStatus->GetCompletionStatus(ClusterIndex, PassIndex, CompleteState); uint32 TotalComplete = CompleteState.NumEnabledTestsPassed + CompleteState.NumEnabledTestsFailed + CompleteState.NumEnabledTestsCouldntBeRun; if ((TotalComplete > 0) && (CompleteState.TotalEnabled > 0)) { bImageVisible = (TotalComplete == CompleteState.TotalEnabled); } bool bFinalVisibility = bForInProcessThrobber ? !bImageVisible : bImageVisible; return bFinalVisibility ? EVisibility::Visible : EVisibility::Collapsed; } FText SAutomationTestItem::ItemStatus_NumParticipantsRequiredText() const { FFormatNamedArguments Args; Args.Add(TEXT("NumParticipantsRequired"), TestStatus->GetNumParticipantsRequired()); return FText::Format(LOCTEXT("NumParticipantsRequiredWrapper", "x{NumParticipantsRequired}"), Args); } FSlateColor SAutomationTestItem::ItemStatus_ProgressColor(const int32 ClusterIndex) const { FAutomationCompleteState CompleteState; const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); TestStatus->GetCompletionStatus(ClusterIndex,PassIndex, CompleteState); if (CompleteState.TotalEnabled > 0) { if (CompleteState.NumEnabledTestsFailed > 0) { // Failure is marked by a red background. return FSlateColor( FLinearColor( 1.0f, 0.0f, 0.0f ) ); } else if((CompleteState.NumEnabledTestsPassed != CompleteState.TotalEnabled) || (CompleteState.NumEnabledTestsWarnings > 0) || (CompleteState.NumEnabledTestsCouldntBeRun > 0 )) { // In Process, yellow. return FSlateColor( FLinearColor( 1.0f, 1.0f, 0.0f ) ); } else { // Success is marked by a green background. return FSlateColor( FLinearColor( 0.0f, 1.0f, 0.0f ) ); } } // Not Scheduled will receive this color which is to say no color since alpha is 0. return FSlateColor( FLinearColor( 1.0f, 0.0f, 1.0f, 0.0f ) ); } TOptional SAutomationTestItem::ItemStatus_ProgressFraction(const int32 ClusterIndex) const { FAutomationCompleteState CompleteState; const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); TestStatus->GetCompletionStatus(ClusterIndex, PassIndex, CompleteState); uint32 TotalComplete = CompleteState.NumEnabledTestsPassed + CompleteState.NumEnabledTestsFailed + CompleteState.NumEnabledTestsCouldntBeRun; // Only show a percentage if there is something interesting to report if( (TotalComplete> 0) && (CompleteState.TotalEnabled > 0) ) { return (float)TotalComplete/CompleteState.TotalEnabled; } // Return incomplete state return 0.0f; } const FSlateBrush* SAutomationTestItem::ItemStatus_StatusImage(const int32 ClusterIndex) const { const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); EAutomationState TestState = TestStatus->GetState(ClusterIndex,PassIndex); const FSlateBrush* ImageToUse; switch( TestState ) { case EAutomationState::Success: { FAutomationCompleteState CompleteState; TestStatus->GetCompletionStatus(ClusterIndex,PassIndex, CompleteState); //If there were ANY warnings in the results if (CompleteState.NumEnabledTestsWarnings || CompleteState.NumDisabledTestsWarnings) { ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.Warning"); } else { ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.Success"); } } break; case EAutomationState::Fail: ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.Fail"); break; case EAutomationState::NotRun: { ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.NotRun"); } break; case EAutomationState::Skipped: ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.Skipped"); break; default: case EAutomationState::InProcess: ImageToUse = FAutomationWindowStyle::Get().GetBrush("Automation.InProcess"); break; } return ImageToUse; } const FSlateBrush* SAutomationTestItem::ItemChildrenStatus_StatusImage(const int32 ClusterIndex) const { FAutomationCompleteState CompleteState; const int32 PassIndex = TestStatus->GetCurrentPassIndex(ClusterIndex); TestStatus->GetCompletionStatus(ClusterIndex, PassIndex, CompleteState); const FSlateBrush* ImageToUse = FAppStyle::GetBrush("Automation.InProcess"); uint32 TotalComplete = CompleteState.NumEnabledTestsPassed + CompleteState.NumEnabledTestsFailed + CompleteState.NumEnabledTestsCouldntBeRun; if ((TotalComplete > 0) && (CompleteState.TotalEnabled > 0) && TotalComplete == CompleteState.TotalEnabled) { if (TotalComplete == CompleteState.NumEnabledTestsPassed) { ImageToUse = FAppStyle::GetBrush("Automation.Success"); } else if (CompleteState.NumEnabledTestsFailed) { ImageToUse = FAppStyle::GetBrush("Automation.Fail"); } else if (CompleteState.NumEnabledTestsCouldntBeRun) { ImageToUse = FAppStyle::GetBrush("Automation.NotRun"); } } return ImageToUse; } /* SAutomationTestitem event handlers *****************************************************************************/ void SAutomationTestItem::HandleTestingCheckbox_Click(ECheckBoxState) { OnCheckedStateChangedDelegate.ExecuteIfBound(TestStatus); } #undef LOCTEXT_NAMESPACE