add test output helper injection for transferring output to custom logging (#238)

* add logging

* apply updates

* update azure config

* update image

* return missed param

* update image

* change ubuntu image version

* update image version

* undo image changes

Author: YuliiaKovalova

azure-pipelines.yml

@@ -172,10 +172,10 @@ stages:
     pool:
       ${{ if eq(variables._RunAsPublic, True) }}:
         name: NetCore1ESPool-Public
-        demands: ImageOverride -equals Build.Ubuntu.1604.Amd64.Open
+        demands: ImageOverride -equals Build.Ubuntu.1804.Amd64.Open
       ${{ if eq(variables._RunAsInternal, True) }}:
         name: NetCore1ESPool-Internal
-        demands: ImageOverride -equals Build.Ubuntu.1604.Amd64
+        demands: ImageOverride -equals Build.Ubuntu.1804.Amd64
     steps:
     - checkout: self
       displayName: Checkout Self

tests/Install-Scripts.Test/AkaMsLinksTests.cs

@@ -391,7 +391,6 @@ public void NoFallbackIfQualityIsGiven(string channel, string runtime, string qu
 
             commandResult.Should().Fail();
             commandResult.Should().HaveStdErrContaining("Failed to locate the latest version in the channel");
-
         }
 
         [Fact]

tests/Install-Scripts.Test/GivenThatIWantToInstallDotnetFromAScript.cs

@@ -12,11 +12,13 @@
 using System.Text.RegularExpressions;
 using System.Linq;
 using Install_Scripts.Test.Utils;
+using Xunit.Abstractions;
 
 namespace Microsoft.DotNet.InstallationScript.Tests
 {
     public class GivenThatIWantToInstallDotnetFromAScript : IDisposable
     {
+
         /// <summary>
         /// All the channels that will be tested.
         /// </summary>
@@ -142,12 +144,16 @@ public static IEnumerable<object?[]> InstallRuntimeFromChannelTestCases
         /// </summary>
         private readonly string _sdkInstallationDirectory;
 
+        private readonly ITestOutputHelper outputHelper;
+
         /// <summary>
         /// Instantiates a GivenThatIWantToInstallTheSdkFromAScript instance.
         /// </summary>
         /// <remarks>This constructor is called once for each of the tests to run.</remarks>
-        public GivenThatIWantToInstallDotnetFromAScript()
+        public GivenThatIWantToInstallDotnetFromAScript(ITestOutputHelper testOutputHelper)
         {
+            outputHelper = testOutputHelper;
+
             _sdkInstallationDirectory = Path.Combine(
                 Path.GetTempPath(),
                 "InstallScript-Tests",
@@ -184,6 +190,7 @@ public void Dispose()
         }
 
         [Theory]
+        [Trait("MonitoringTest", "true")]
         [MemberData(nameof(InstallSdkFromChannelTestCases))]
         public void WhenInstallingTheSdk(string channel, string? quality, string versionRegex)
         {
@@ -210,9 +217,12 @@ public void WhenInstallingTheSdk(string channel, string? quality, string version
             string regex = Regex.Escape("  ") + versionRegex + Regex.Escape(" ") + installPathRegex;
             dotnetCommandResult.Should().HaveStdOutMatching(regex);
             commandResult.Should().NotHaveStdErr();
+
+            TestOutputHelper.PopulateTestLoggerOutput(outputHelper, commandResult);
         }
 
         [Theory]
+        [Trait("MonitoringTest", "true")]
         [MemberData(nameof(InstallRuntimeFromChannelTestCases))]
         public void WhenInstallingDotnetRuntime(string channel, string? quality, string versionRegex)
         {
@@ -239,9 +249,12 @@ public void WhenInstallingDotnetRuntime(string channel, string? quality, string
             string regex = lineStartRegex + versionRegex + lineEndRegex;
             dotnetCommandResult.Should().HaveStdOutMatching(regex);
             commandResult.Should().NotHaveStdErr();
+
+            TestOutputHelper.PopulateTestLoggerOutput(outputHelper, commandResult);
         }
 
         [Theory]
+        [Trait("MonitoringTest", "true")]
         [MemberData(nameof(InstallRuntimeFromChannelTestCases))]
         public void WhenInstallingAspNetCoreRuntime(string channel, string? quality, string versionRegex)
         {
@@ -275,9 +288,12 @@ public void WhenInstallingAspNetCoreRuntime(string channel, string? quality, str
             string regex = lineStartRegex + versionRegex + lineEndRegex;
             dotnetCommandResult.Should().HaveStdOutMatching(regex);
             commandResult.Should().NotHaveStdErr();
+
+            TestOutputHelper.PopulateTestLoggerOutput(outputHelper, commandResult);
         }
 
         [Theory]
+        [Trait("MonitoringTest", "true")]
         [MemberData(nameof(InstallRuntimeFromChannelTestCases))]
         public void WhenInstallingWindowsdesktopRuntime(string channel, string? quality, string versionRegex)
         {
@@ -313,6 +329,8 @@ public void WhenInstallingWindowsdesktopRuntime(string channel, string? quality,
             commandResult.Should().NotHaveStdErr();
             commandResult.Should().HaveStdOutContaining("Installation finished");
 
+            TestOutputHelper.PopulateTestLoggerOutput(outputHelper, commandResult);
+
             // Dotnet CLI is not included in the windowsdesktop runtime. Therefore, version validation cannot be tested.
             // Add the validation once the becomes available in the artifacts.
         }

tests/Install-Scripts.Test/Utils/CommandResultExtensions.cs

@@ -2,7 +2,6 @@
 // Taken from https://github.com/dotnet/sdk/
 
 using Microsoft.DotNet.Cli.Utils;
-using Xunit.Abstractions;
 
 namespace Microsoft.NET.TestFramework.Assertions
 {

tests/Install-Scripts.Test/Utils/TestOutputHelper.cs

@@ -0,0 +1,29 @@
+using Microsoft.DotNet.Cli.Utils;
+using Xunit.Abstractions;
+
+namespace Install_Scripts.Test.Utils
+{
+    internal class TestOutputHelper
+    {
+        private const string TraceLogMarker = "#ISCO-TRACE";
+        private const string ErrorLogMarker = "#ISCO-ERROR";
+        private const string LogMarkerDelimiter = "!!";
+
+        // Transfers information to custom test adapter. E.g. install-scripts-monitoring -> TestLogger
+        public static void PopulateTestLoggerOutput(ITestOutputHelper outputHelper, CommandResult commandResult)
+        {
+            if (!string.IsNullOrEmpty(commandResult.StdOut))
+            {
+                outputHelper.WriteLine(GetFormattedLogOutput(TraceLogMarker, commandResult.StdOut));
+            }
+
+            if (!string.IsNullOrEmpty(commandResult.StdErr))
+            {
+                outputHelper.WriteLine(GetFormattedLogOutput(ErrorLogMarker, commandResult.StdErr));
+            }
+        }
+
+        private static string GetFormattedLogOutput(string logMarker, string message) =>
+            $"{logMarker}-START{LogMarkerDelimiter}:{message}{logMarker}-END-{LogMarkerDelimiter}";
+    }
+}