File: CommandTests\Test\GivenDotnetTestBuildsAndRunsArtifactPostProcessing.cs
Web Access
Project: ..\..\..\test\dotnet.Tests\dotnet.Tests.csproj (dotnet.Tests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
#nullable disable
 
using System.Xml;
using Microsoft.DotNet.Cli.Commands.Test;
using CommandResult = Microsoft.DotNet.Cli.Utils.CommandResult;
 
namespace Microsoft.DotNet.Cli.Test.Tests
{
    public class GivenDotnetTestBuildsAndRunsArtifactPostProcessing : SdkTest
    {
        private static object s_dataCollectorInitLock = new();
        private static string s_dataCollectorDll;
        private static string s_dataCollectorNoMergeDll;
 
        public GivenDotnetTestBuildsAndRunsArtifactPostProcessing(ITestOutputHelper log) : base(log)
        {
            BuildDataCollector();
            BuildDataCollectorNoMerge();
        }
 
        [Theory]
        [InlineData(true)]
        [InlineData(false)]
        public void ArtifactPostProcessing_SolutionProjects(bool merge)
        {
            TestAsset testInstance = _testAssetsManager.CopyTestAsset("VSTestMultiProjectSolution", Guid.NewGuid().ToString())
                .WithSource();
 
            string runsettings = GetRunsetting(testInstance.Path);
 
            CommandResult result = new DotnetTestCommand(Log, disableNewOutput: true)
                                    .WithWorkingDirectory(testInstance.Path)
                                    .WithEnvironmentVariable(FeatureFlag.DISABLE_ARTIFACTS_POSTPROCESSING, "0")
                                    .Execute(
                                        "--configuration", "release",
                                        "--collect", "SampleDataCollector",
                                        "--test-adapter-path", merge ? Path.GetDirectoryName(s_dataCollectorDll) : Path.GetDirectoryName(s_dataCollectorNoMergeDll),
                                        "--settings", runsettings,
                                        "--diag", testInstance.Path + "/logs/");
 
            result.ExitCode.Should().Be(0);
            AssertOutput(result.StdOut, merge);
        }
 
        [Theory]
        [InlineData(true)]
        [InlineData(false)]
        public void ArtifactPostProcessing_TestContainers(bool merge)
        {
            TestAsset testInstance = _testAssetsManager.CopyTestAsset("VSTestMultiProjectSolution", Guid.NewGuid().ToString())
                .WithSource();
 
            string runsettings = GetRunsetting(testInstance.Path);
 
            new PublishCommand(Log, Path.Combine(testInstance.Path, "sln.sln")).Execute("/p:Configuration=Release").Should().Pass();
 
            CommandResult result = new DotnetTestCommand(Log, disableNewOutput: false)
                                    .WithWorkingDirectory(testInstance.Path)
                                    .WithEnvironmentVariable(FeatureFlag.DISABLE_ARTIFACTS_POSTPROCESSING, "0")
                                    .WithEnvironmentVariable("DOTNET_CLI_VSTEST_TRACE", "1")
                                    .Execute(
                                    Directory.GetFiles(testInstance.Path, "test1.dll", SearchOption.AllDirectories).SingleOrDefault(x => x.Contains("publish")),
                                    Directory.GetFiles(testInstance.Path, "test2.dll", SearchOption.AllDirectories).SingleOrDefault(x => x.Contains("publish")),
                                    Directory.GetFiles(testInstance.Path, "test3.dll", SearchOption.AllDirectories).SingleOrDefault(x => x.Contains("publish")),
                                    "--collect:SampleDataCollector",
                                    $"--test-adapter-path:{(merge ? Path.GetDirectoryName(s_dataCollectorDll) : Path.GetDirectoryName(s_dataCollectorNoMergeDll))}",
                                    $"--settings:{runsettings}",
                                    "--diag:" + testInstance.Path + "/logs/");
 
            result.ExitCode.Should().Be(0);
            AssertOutput(result.StdOut, merge);
        }
 
        [Theory]
        [InlineData(true)]
        [InlineData(false)]
        public void ArtifactPostProcessing_VSTest_TestContainers(bool merge)
        {
            TestAsset testInstance = _testAssetsManager.CopyTestAsset("VSTestMultiProjectSolution", Guid.NewGuid().ToString())
                .WithSource();
 
            string runsettings = GetRunsetting(testInstance.Path);
 
            new PublishCommand(Log, Path.Combine(testInstance.Path, "sln.sln")).Execute("/p:Configuration=Release").Should().Pass();
 
            CommandResult result = new DotnetVSTestCommand(Log)
                                    .WithWorkingDirectory(testInstance.Path)
                                    .WithEnvironmentVariable(FeatureFlag.DISABLE_ARTIFACTS_POSTPROCESSING, "0")
                                    .Execute(
                                        Directory.GetFiles(testInstance.Path, "test1.dll", SearchOption.AllDirectories).SingleOrDefault(x => x.Contains("publish")),
                                        Directory.GetFiles(testInstance.Path, "test2.dll", SearchOption.AllDirectories).SingleOrDefault(x => x.Contains("publish")),
                                        Directory.GetFiles(testInstance.Path, "test3.dll", SearchOption.AllDirectories).SingleOrDefault(x => x.Contains("publish")),
                                        "--collect:SampleDataCollector",
                                        $"--testAdapterPath:{(merge ? Path.GetDirectoryName(s_dataCollectorDll) : Path.GetDirectoryName(s_dataCollectorNoMergeDll))}",
                                        $"--settings:{runsettings}",
                                        $"--diag:{testInstance.Path}/logs/");
 
            result.ExitCode.Should().Be(0);
            AssertOutput(result.StdOut, merge);
        }
 
        private static void AssertOutput(string stdOut, bool merge)
        {
            List<string> output = new();
            using StringReader reader = new(stdOut);
            while (true)
            {
                string line = reader.ReadLine()?.Trim();
                if (line is null) break;
                output.Add(line);
            }
 
            if (merge)
            {
                output[^3].Trim().Should().BeEmpty();
                output[^2].Trim().Should().Be("Attachments:");
                string mergedFile = output[^1].Trim();
 
                var fileContent = new HashSet<string>();
                using var streamReader = new StreamReader(mergedFile);
                LoadLines(streamReader, fileContent);
                fileContent.Count.Should().Be(3);
            }
            else
            {
                output[^5].Trim().Should().BeEmpty();
                output[^4].Trim().Should().Be("Attachments:");
 
                int currentLine = 0;
                for (int i = 3; i > 0; i--)
                {
                    currentLine = output.Count - i;
                    string file = output[currentLine].Trim();
                    var fileContent = new HashSet<string>();
                    using var streamReader = new StreamReader(file);
                    LoadLines(streamReader, fileContent);
                    fileContent.Count.Should().Be(1);
                }
 
                output.Count.Should().Be(currentLine + 1);
            }
 
            static void LoadLines(StreamReader stream, HashSet<string> fileContent)
            {
                while (!stream.EndOfStream)
                {
                    string line = stream.ReadLine();
                    line.Should().StartWith("SessionEnded_Handler_");
                    fileContent.Add(line);
                }
            }
        }
 
        private void BuildDataCollector()
            => LazyInitializer.EnsureInitialized(ref s_dataCollectorDll, ref s_dataCollectorInitLock, () =>
                {
                    TestAsset testInstance = _testAssetsManager.CopyTestAsset("VSTestDataCollectorSample").WithSource();
 
                    string testProjectDirectory = testInstance.Path;
 
                    new BuildCommand(testInstance)
                        .Execute("/p:Configuration=Release")
                        .Should()
                        .Pass();
 
                    return Directory.GetFiles(testProjectDirectory, "AttachmentProcessorDataCollector.dll", SearchOption.AllDirectories).Single(x => x.Contains("bin"));
                });
 
        private void BuildDataCollectorNoMerge()
            => LazyInitializer.EnsureInitialized(ref s_dataCollectorNoMergeDll, ref s_dataCollectorInitLock, () =>
            {
                TestAsset testInstance = _testAssetsManager.CopyTestAsset("VSTestDataCollectorSampleNoMerge").WithSource();
 
                string testProjectDirectory = testInstance.Path;
 
                new BuildCommand(testInstance)
                            .Execute("/p:Configuration=Release")
                            .Should()
                            .Pass();
 
                return Directory.GetFiles(testProjectDirectory, "AttachmentProcessorDataCollector.dll", SearchOption.AllDirectories).Single(x => x.Contains("bin"));
            });
 
        private static string GetRunsetting(string directory)
        {
            string runSettings = GetRunsettingsFilePath(directory);
            // Set datacollector parameters
            XElement runSettingsXml = XElement.Load(runSettings);
            runSettingsXml.Element("DataCollectionRunSettings")
                .Element("DataCollectors")
                .Element("DataCollector")
                .Add(new XElement("Configuration", new XElement("MergeFile", "MergedFile.txt")));
            runSettingsXml.Save(runSettings);
            return runSettings;
        }
 
        private static string GetRunsettingsFilePath(string resultsDir)
        {
            string runsettingsPath = Path.Combine(resultsDir, "test_" + Guid.NewGuid() + ".runsettings");
            var dataCollectionAttributes = new Dictionary<string, string>
            {
                { "friendlyName", "SampleDataCollector" },
                { "uri", "my://sample/datacollector" }
            };
 
            CreateDataCollectionRunSettingsFile(runsettingsPath, dataCollectionAttributes);
            return runsettingsPath;
        }
 
        private static void CreateDataCollectionRunSettingsFile(string destinationRunsettingsPath, Dictionary<string, string> dataCollectionAttributes)
        {
            var doc = new XmlDocument();
            XmlNode xmlDeclaration = doc.CreateNode(XmlNodeType.XmlDeclaration, string.Empty, string.Empty);
 
            doc.AppendChild(xmlDeclaration);
            XmlElement runSettingsNode = doc.CreateElement("RunSettings");
            doc.AppendChild(runSettingsNode);
            XmlElement dcConfigNode = doc.CreateElement("DataCollectionRunSettings");
            runSettingsNode.AppendChild(dcConfigNode);
            XmlElement dataCollectorsNode = doc.CreateElement("DataCollectors");
            dcConfigNode.AppendChild(dataCollectorsNode);
            XmlElement dataCollectorNode = doc.CreateElement("DataCollector");
            dataCollectorsNode.AppendChild(dataCollectorNode);
 
            foreach (KeyValuePair<string, string> kvp in dataCollectionAttributes)
            {
                dataCollectorNode.SetAttribute(kvp.Key, kvp.Value);
            }
 
            using var stream = new FileStream(destinationRunsettingsPath, FileMode.Create);
            doc.Save(stream);
        }
    }
}