msbuild/src/Build.UnitTests/BackEnd/DebugUtils_tests.cs at a8981a310e5a47efdb923b486dd4e349b3224f63 · dotnet/msbuild · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.IO;
using System.Linq;
using Microsoft.Build.Framework;
using Microsoft.Build.Shared;
using Microsoft.Build.Shared.Debugging;
using Shouldly;
using Xunit;

#nullable disable

namespace Microsoft.Build.UnitTests
{
    public class DebugUtils_Tests
    {
        [Fact]
        public void DumpExceptionToFileShouldWriteInDebugDumpPath()
        {
            DebugUtils.ResetDebugDumpPathInRunningTests = true;
            var exceptionFilesBefore =
                Directory.Exists(DebugUtils.DebugDumpPath) ? Directory.GetFiles(DebugUtils.DebugDumpPath, "MSBuild_*failure.txt") : Array.Empty<string>();

            string[] exceptionFiles = null;

            try
            {
                DebugUtils.DumpExceptionToFile(new Exception("hello world"));
                exceptionFiles = Directory.GetFiles(DebugUtils.DebugDumpPath, "MSBuild_*failure.txt");
            }
            finally
            {
                exceptionFilesBefore.ShouldNotBeNull();
                exceptionFiles.ShouldNotBeNull();
                (exceptionFiles.Length - exceptionFilesBefore.Length).ShouldBe(1);

                var exceptionFile = exceptionFiles.Except(exceptionFilesBefore).Single();
                File.ReadAllText(exceptionFile).ShouldContain("hello world");
                File.Delete(exceptionFile);
            }
        }

        [Fact]
        public void SetDebugPath_WhenUserSetRelativePath()
        {
            using TestEnvironment env = TestEnvironment.Create();
            {
                TransientTestProjectWithFiles dummyProject = env.CreateTestProjectWithFiles(@"
            <Project xmlns='msbuildnamespace'>
                <Target Name='Build' />
            </Project>");

                string testCurrentDir = Path.GetDirectoryName(dummyProject.ProjectFile);
                env.SetCurrentDirectory(testCurrentDir);

                string relativePath = "./TestLogs";
                var transientEnvVar = env.SetEnvironmentVariable("MSBUILDDEBUGPATH", relativePath);
                var transientDebugEngine = env.SetEnvironmentVariable("MSBuildDebugEngine", "1");
                try
                {
                    FrameworkDebugUtils.SetDebugPath();
                    string resultPath = FrameworkDebugUtils.DebugPath;
                    resultPath.ShouldNotBeNull();
                    resultPath.ShouldBe(Path.Combine(relativePath, ".MSBuild_Logs"));
                    Directory.Exists(resultPath).ShouldBeTrue();
                }
                finally
                {
                    // Reset DebugPath to not affect other tests
                    transientEnvVar.Revert();
                    transientDebugEngine.Revert();
                    FrameworkDebugUtils.SetDebugPath();
                }
            }
        }

        [Fact]
        public void SetDebugPath_WhenUserSetAbsolutePath()
        {
            using TestEnvironment env = TestEnvironment.Create();
            {
                TransientTestProjectWithFiles dummyProject = env.CreateTestProjectWithFiles(@"
            <Project xmlns='msbuildnamespace'>
                <Target Name='Build' />
            </Project>");

                string testCurrentDir = Path.GetDirectoryName(dummyProject.ProjectFile);
                env.SetCurrentDirectory(testCurrentDir);

                string inSolutionPath = Path.Combine(testCurrentDir, "AbsoluteLogs");
                string fullInSolutionPath = Path.GetFullPath(inSolutionPath);
                var transientEnvVar = env.SetEnvironmentVariable("MSBUILDDEBUGPATH", inSolutionPath);
                var transientDebugEngine = env.SetEnvironmentVariable("MSBuildDebugEngine", "1");
                try
                {
                    FrameworkDebugUtils.SetDebugPath();
                    string resultPath = FrameworkDebugUtils.DebugPath;
                    resultPath.ShouldNotBeNull();
                    resultPath.ShouldBe(Path.Combine(fullInSolutionPath, ".MSBuild_Logs"));
                }
                finally
                {
                    // Reset DebugPath to not affect other tests
                    transientEnvVar.Revert();
                    transientDebugEngine.Revert();
                    FrameworkDebugUtils.SetDebugPath();
                }
            }
        }

        [Fact]
        public void SetDebugPath_WhenUserNotSetDebugPath()
        {
            using (TestEnvironment env = TestEnvironment.Create())
            {
                TransientTestProjectWithFiles dummyProject = env.CreateTestProjectWithFiles(@"
            <Project xmlns='msbuildnamespace'>
                <Target Name='Build' />
            </Project>");

                string testCurrentDir = Path.GetDirectoryName(dummyProject.ProjectFile);
                env.SetCurrentDirectory(testCurrentDir);
                var transientEnvVar = env.SetEnvironmentVariable("MSBUILDDEBUGPATH", null);
                var transientDebugEngine = env.SetEnvironmentVariable("MSBuildDebugEngine", "1");
                try
                {
                    FrameworkDebugUtils.SetDebugPath();
                    string resultPath = FrameworkDebugUtils.DebugPath;
                    resultPath.ShouldNotBeNull();
                    resultPath.ShouldBe(Path.Combine(Directory.GetCurrentDirectory(), ".MSBuild_Logs"));
                }
                finally
                {
                    // Reset DebugPath to not affect other tests
                    transientEnvVar.Revert();
                    transientDebugEngine.Revert();
                    FrameworkDebugUtils.SetDebugPath();
                }
            }
        }

        [Fact]
        public void IsInTaskHostNode_ReturnsFalseForCentralNode()
        {
            // When running in the main test process (no /nodemode argument),
            // we should not be in a TaskHost node
            FrameworkDebugUtils.IsInTaskHostNode().ShouldBeFalse();
        }
    }
}