Skip to content
This repository was archived by the owner on Apr 20, 2023. It is now read-only.

Commit 3488a84

Browse files
author
Peter Huene
committed
Implement buildserver shutdown command.
This commit implements the `buildserver shutdown` command that can be used to shutdown MSBuild, VB/C# compiler, and Razor build servers. By default, all three build servers are shut down. Options can be passed to shut down a subset of the build servers. Fixes #8185.
1 parent 1043231 commit 3488a84

File tree

84 files changed

+2748
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+2748
-2
lines changed

src/Microsoft.DotNet.Cli.Utils/CommandResolution/MSBuildProject.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public MSBuildProject(
114114
{
115115
_projectRoot = msBuildExePath;
116116

117-
var globalProperties = new Dictionary<string, string>()
117+
var globalProperties = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
118118
{
119119
{ "MSBuildExtensionsPath", Path.GetDirectoryName(msBuildExePath) }
120120
};

src/Microsoft.DotNet.InternalAbstractions/DirectoryWrapper.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ public ITemporaryDirectory CreateTemporaryDirectory()
1919
return new TemporaryDirectory();
2020
}
2121

22+
public IEnumerable<string> EnumerateFiles(string path, string searchPattern)
23+
{
24+
return Directory.EnumerateFiles(path, searchPattern);
25+
}
26+
2227
public IEnumerable<string> EnumerateFileSystemEntries(string path)
2328
{
2429
return Directory.EnumerateFileSystemEntries(path);

src/Microsoft.DotNet.InternalAbstractions/IDirectory.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ internal interface IDirectory
1111

1212
ITemporaryDirectory CreateTemporaryDirectory();
1313

14+
IEnumerable<string> EnumerateFiles(string path, string searchPattern);
15+
1416
IEnumerable<string> EnumerateFileSystemEntries(string path);
1517

1618
IEnumerable<string> EnumerateFileSystemEntries(string path, string searchPattern);
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) .NET Foundation and contributors. All rights reserved.
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using System;
5+
using System.Threading.Tasks;
6+
7+
namespace Microsoft.DotNet.BuildServer
8+
{
9+
internal interface IBuildServerManager
10+
{
11+
string ServerName { get; }
12+
13+
Task<Result> ShutdownServerAsync();
14+
}
15+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Copyright (c) .NET Foundation and contributors. All rights reserved.
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using Microsoft.Extensions.EnvironmentAbstractions;
7+
8+
namespace Microsoft.DotNet.BuildServer
9+
{
10+
internal interface IRazorAssemblyResolver
11+
{
12+
IEnumerable<FilePath> EnumerateRazorToolAssemblies();
13+
}
14+
}
Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="MSBuildServer" xml:space="preserve">
121+
<value>MSBuild server</value>
122+
</data>
123+
<data name="VBCSCompilerServer" xml:space="preserve">
124+
<value>VB/C# compiler server</value>
125+
</data>
126+
<data name="RazorServer" xml:space="preserve">
127+
<value>Razor build server</value>
128+
</data>
129+
<data name="NoRazorProjectFound" xml:space="preserve">
130+
<value>a Razor project was not found in the current directory.</value>
131+
</data>
132+
</root>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Copyright (c) .NET Foundation and contributors. All rights reserved.
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using System;
5+
using System.Threading.Tasks;
6+
using Microsoft.Build.Execution;
7+
8+
namespace Microsoft.DotNet.BuildServer
9+
{
10+
internal class MSBuildServerManager : IBuildServerManager
11+
{
12+
public string ServerName => LocalizableStrings.MSBuildServer;
13+
14+
public Task<Result> ShutdownServerAsync()
15+
{
16+
return Task.Run(() => {
17+
try
18+
{
19+
BuildManager.DefaultBuildManager.ShutdownAllNodes();
20+
return new Result(ResultKind.Success);
21+
}
22+
catch (Exception ex)
23+
{
24+
return new Result(ex);
25+
}
26+
});
27+
}
28+
}
29+
}
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Copyright (c) .NET Foundation and contributors. All rights reserved.
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using System.IO;
7+
using System.Linq;
8+
using Microsoft.DotNet.Cli.Utils;
9+
using Microsoft.Build.Execution;
10+
using Microsoft.Extensions.EnvironmentAbstractions;
11+
12+
namespace Microsoft.DotNet.BuildServer
13+
{
14+
internal class RazorAssemblyResolver : IRazorAssemblyResolver
15+
{
16+
private readonly IDirectory _directory;
17+
18+
public RazorAssemblyResolver(IDirectory directory = null)
19+
{
20+
_directory = directory ?? FileSystemWrapper.Default.Directory;
21+
}
22+
23+
public IEnumerable<FilePath> EnumerateRazorToolAssemblies()
24+
{
25+
HashSet<string> seen = new HashSet<string>();
26+
27+
var globalProperties = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
28+
{
29+
// This property disables default item globbing to improve performance
30+
// This should be safe because we are not evaluating items, only properties
31+
{ Constants.EnableDefaultItems, "false" }
32+
};
33+
34+
foreach (var projectFile in _directory.EnumerateFiles(Directory.GetCurrentDirectory(), "*.*proj"))
35+
{
36+
var project = new ProjectInstance(projectFile, globalProperties, null);
37+
var path = project.GetPropertyValue("_RazorToolAssembly");
38+
if (string.IsNullOrEmpty(path))
39+
{
40+
continue;
41+
}
42+
43+
if (!seen.Add(path))
44+
{
45+
continue;
46+
}
47+
48+
yield return new FilePath(path);
49+
}
50+
}
51+
}
52+
}
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Copyright (c) .NET Foundation and contributors. All rights reserved.
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using System;
5+
using System.IO;
6+
using System.Threading.Tasks;
7+
using Microsoft.Build.Exceptions;
8+
using Microsoft.DotNet.Cli;
9+
using Microsoft.DotNet.Cli.Utils;
10+
using Microsoft.DotNet.Tools;
11+
using Microsoft.Extensions.EnvironmentAbstractions;
12+
13+
namespace Microsoft.DotNet.BuildServer
14+
{
15+
internal class RazorServerManager : IBuildServerManager
16+
{
17+
private readonly IRazorAssemblyResolver _resolver;
18+
private readonly ICommandFactory _commandFactory;
19+
20+
public RazorServerManager(IRazorAssemblyResolver resolver = null, ICommandFactory commandFactory = null)
21+
{
22+
_resolver = resolver ?? new RazorAssemblyResolver();
23+
_commandFactory = commandFactory ?? new DotNetCommandFactory(alwaysRunOutOfProc: true);
24+
}
25+
26+
public string ServerName => LocalizableStrings.RazorServer;
27+
28+
public Task<Result> ShutdownServerAsync()
29+
{
30+
return Task.Run(() => {
31+
try
32+
{
33+
bool haveRazorAssembly = false;
34+
35+
foreach (var toolAssembly in _resolver.EnumerateRazorToolAssemblies())
36+
{
37+
haveRazorAssembly = true;
38+
39+
var command = _commandFactory
40+
.Create("exec", new string[] { toolAssembly.Value, "shutdown" })
41+
.CaptureStdOut()
42+
.CaptureStdErr();
43+
44+
var result = command.Execute();
45+
if (result.ExitCode != 0)
46+
{
47+
return new Result(ResultKind.Failure, result.StdErr);
48+
}
49+
}
50+
51+
if (!haveRazorAssembly)
52+
{
53+
return new Result(ResultKind.Skipped, LocalizableStrings.NoRazorProjectFound);
54+
}
55+
56+
return new Result(ResultKind.Success);
57+
}
58+
catch (InvalidProjectFileException ex)
59+
{
60+
return new Result(ex);
61+
}
62+
});
63+
}
64+
}
65+
}

src/dotnet/BuildServer/Result.cs

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Copyright (c) .NET Foundation and contributors. All rights reserved.
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using System;
5+
6+
namespace Microsoft.DotNet.BuildServer
7+
{
8+
internal enum ResultKind
9+
{
10+
Success,
11+
Failure,
12+
Skipped
13+
}
14+
15+
internal struct Result
16+
{
17+
public Result(ResultKind kind, string message = null)
18+
{
19+
Kind = kind;
20+
Message = message;
21+
Exception = null;
22+
}
23+
24+
public Result(Exception exception)
25+
{
26+
Kind = ResultKind.Failure;
27+
Message = exception.Message;
28+
Exception = exception;
29+
}
30+
31+
public ResultKind Kind { get; private set; }
32+
33+
public string Message { get; private set; }
34+
35+
public Exception Exception { get; private set; }
36+
}
37+
}

0 commit comments

Comments
 (0)