Merge pull request #230 from Lombiq/issue/OSOE-466

OSOE-466: Fixing that TestOutput.log not included in failure dump when run in GitHub Actions
Lombiq · Nov 13, 2022 · 5d070b3 · 5d070b3
2 parents fb10e99 + b3bead0
commit 5d070b3
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 12 deletions.
diff --git a/Lombiq.Tests.UI/OrchardCoreUITestBase.cs b/Lombiq.Tests.UI/OrchardCoreUITestBase.cs
@@ -236,7 +236,7 @@ protected virtual async Task ExecuteTestAsync(
 
         var originalTestOutputHelper = _testOutputHelper;
         (_testOutputHelper, var afterTest) =
-            GitHubActionsGroupingTestOutputHelper.CreateWrapper(_testOutputHelper, testManifest);
+            GitHubActionsGroupingTestOutputHelper.CreateDecorator(_testOutputHelper, testManifest);
 
         var configuration = new OrchardCoreUITestExecutorConfiguration
         {

diff --git a/Lombiq.Tests.UI/Services/GitHubActionsGroupingTestOutputHelper.cs b/Lombiq.Tests.UI/Services/GitHubActionsGroupingTestOutputHelper.cs
@@ -1,51 +1,52 @@
-using Lombiq.Tests.UI.Models;
+using Lombiq.Tests.UI.Models;
 using System;
 using Xunit.Abstractions;
 
 namespace Lombiq.Tests.UI.Services;
 
-internal sealed class GitHubActionsGroupingTestOutputHelper : ITestOutputHelper
+internal sealed class GitHubActionsGroupingTestOutputHelper : ITestOutputHelperDecorator
 {
     public static Lazy<bool> IsGitHubEnvironment { get; } = new(() =>
         !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("GITHUB_ENV")));
 
-    private readonly ITestOutputHelper _inner;
     private readonly string _groupName;
 
     private bool _isStarted;
 
-    public GitHubActionsGroupingTestOutputHelper(ITestOutputHelper inner, string groupName)
+    public ITestOutputHelper Decorated { get; private set; }
+
+    public GitHubActionsGroupingTestOutputHelper(ITestOutputHelper decorated, string groupName)
     {
-        _inner = inner;
+        Decorated = decorated;
         _groupName = groupName;
     }
 
     public void WriteLine(string message)
     {
         Start();
-        _inner.WriteLine(message);
+        Decorated.WriteLine(message);
     }
 
     public void WriteLine(string format, params object[] args)
     {
         Start();
-        _inner.WriteLine(format, args);
+        Decorated.WriteLine(format, args);
     }
 
     private void Start()
     {
         if (_isStarted) return;
 
-        _inner.WriteLine($"::group::{_groupName}");
+        Decorated.WriteLine($"::group::{_groupName}");
         _isStarted = true;
     }
 
     private void EndGroup()
     {
-        if (_isStarted) _inner.WriteLine("::endgroup::");
+        if (_isStarted) Decorated.WriteLine("::endgroup::");
     }
 
-    public static (ITestOutputHelper WrappedOutputHelper, Action AfterTest) CreateWrapper(
+    public static (ITestOutputHelper DecoratedOutputHelper, Action AfterTest) CreateDecorator(
         ITestOutputHelper testOutputHelper,
         UITestManifest testManifest)
     {

diff --git a/Lombiq.Tests.UI/Services/ITestOutputHelperDecorator.cs b/Lombiq.Tests.UI/Services/ITestOutputHelperDecorator.cs
@@ -0,0 +1,14 @@
+using Xunit.Abstractions;
+
+namespace Lombiq.Tests.UI.Services;
+
+/// <summary>
+/// Defines an <see cref="ITestOutputHelper"/> that decorates another <see cref="ITestOutputHelper"/>.
+/// </summary>
+public interface ITestOutputHelperDecorator : ITestOutputHelper
+{
+    /// <summary>
+    /// Gets the decorated <see cref="ITestOutputHelper"/> instance.
+    /// </summary>
+    ITestOutputHelper Decorated { get; }
+}
diff --git a/Lombiq.Tests.UI/Services/UITestExecutionSession.cs b/Lombiq.Tests.UI/Services/UITestExecutionSession.cs
@@ -315,7 +315,10 @@ private async Task SaveTestOutputAsync(string debugInformationPath)
     {
         try
         {
-            if (_testOutputHelper is TestOutputHelper concreteTestOutputHelper)
+            var concreteTestOutputHelper = _testOutputHelper as TestOutputHelper;
+            concreteTestOutputHelper ??= (_testOutputHelper as ITestOutputHelperDecorator)?.Decorated as TestOutputHelper;
+
+            if (concreteTestOutputHelper != null)
             {
                 // While this depends on the directory creation in the above try block it needs to come after the catch
                 // otherwise the message saved there wouldn't be included.