Moved timeout management to the top process.

gfraiteur · gfraiteur · commit 991aac0e7c77 · 2025-09-25T13:39:10.000+02:00
diff --git a/Build.ps1 b/Build.ps1
@@ -4,7 +4,7 @@
 [CmdletBinding(PositionalBinding = $false)]
 param(
     [switch]$Interactive, # Opens an interactive PowerShell session
-    [switch]$VsDebug, # Enable the remote debugger.
+    [switch]$StartVsmon, # Enable the remote debugger.
     [Parameter(ValueFromRemainingArguments)]
     [string[]]$BuildArgs   # Arguments passed to `Build.ps1` within the container.
 )
@@ -15,7 +15,7 @@ $EngPath = 'eng'
 $ProductName = 'PostSharpEngineering'
 ####
 
-if ( $VsDebug  )
+if ( $StartVsmon  )
 {
     $vsmonport = 4024
     Write-Host "Starting Visual Studio Remote Debugger, listening at port $vsmonport." -ForegroundColor Cyan
@@ -47,7 +47,7 @@ if ( -not $Interactive -or $BuildArgs )
         # Run the project.
         & dotnet run --project "$PSScriptRoot\$EngPath\src\Build$ProductName.csproj" -- $BuildArgs
 
-        if ($VsDebug)
+        if ($StartVsmon)
         {
             Write-Host ""
             Write-Host "Killing vsmon.exe."
diff --git a/DockerBuild.ps1 b/DockerBuild.ps1
@@ -12,7 +12,7 @@ param(
     [string]$ImageName, # Image name (defaults to a name based on the directory).
     [string]$BuildAgentPath = 'C:\BuildAgent',
     [switch]$LoadEnvFromKeyVault, # Forces loading environment variables form the key vault.
-    [switch]$VsDebug, # Enable the remote debugger.
+    [switch]$StartVsmon, # Enable the remote debugger.
     [Parameter(ValueFromRemainingArguments)]
     [string[]]$BuildArgs   # Arguments passed to `Build.ps1` within the container.
 )
@@ -187,7 +187,7 @@ if (-not $NoNuGetCache)
 }
 
 # Mount VS Remote Debugger
-if ($VsDebug)
+if ($StartVsmon)
 {
     if (-not $env:DevEnvDir)
     {
@@ -277,9 +277,9 @@ if (-not $BuildImage)
     Write-Host "Building the product in the container." -ForegroundColor Green
 
     # Prepare Build.ps1 arguments
-    if ($VsDebug)
+    if ($StartVsmon)
     {
-        $BuildArgs = @("-VsDebug") + $BuildArgs
+        $BuildArgs = @("-StartVsmon") + $BuildArgs
     }
 
     if ($Interactive)
diff --git a/src/PostSharp.Engineering.BuildTools/BaseCommand.cs b/src/PostSharp.Engineering.BuildTools/BaseCommand.cs
@@ -12,6 +12,7 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Text.Json;
+using System.Threading;
 
 namespace PostSharp.Engineering.BuildTools
 {
@@ -23,6 +24,8 @@ public abstract class BaseCommand<T> : Command<T>
     {
         public sealed override int Execute( CommandContext context, T settings )
         {
+            CancellationTokenSource? timeoutCancellation = null;
+
             try
             {
                 var stopwatch = Stopwatch.StartNew();
@@ -42,6 +45,13 @@ public sealed override int Execute( CommandContext context, T settings )
                     buildContext = buildContext.WithUseProjectDirectoryAsWorkingDirectory( true );
                 }
 
+                // Sets up a timeout. The Timer class does not support long periods, so we use CancellationTokenSource.
+                if ( settings.Timeout != null )
+                {
+                    timeoutCancellation = new CancellationTokenSource( TimeSpan.FromMinutes( settings.Timeout.Value ) );
+                    timeoutCancellation.Token.Register( () => OnTimeout( buildContext, stopwatch ) );
+                }
+
                 MSBuildHelper.InitializeLocator();
 
                 if ( buildContext.IsRunningUnderContainer )
@@ -152,8 +162,23 @@ public sealed override int Execute( CommandContext context, T settings )
 
                 return 10;
             }
+            finally
+            {
+                timeoutCancellation?.Dispose();
+            }
         }
 
         protected abstract bool ExecuteCore( BuildContext context, T settings );
+
+        private static void OnTimeout( BuildContext buildContext, Stopwatch stopwatch )
+        {
+            // ReSharper disable AccessToModifiedClosure
+
+            buildContext.Console.WriteError( $"The process timed out after {stopwatch.Elapsed}. Dumping and killing the process tree." );
+            var directory = Path.Combine( buildContext.RepoDirectory, buildContext.Product.DumpDirectory );
+            ProcessHelper.DumpAndKillProcessTree( buildContext.Console, Process.GetCurrentProcess(), directory );
+
+            // ReSharper restore AccessToModifiedClosure
+        }
     }
 }
diff --git a/src/PostSharp.Engineering.BuildTools/Build/BuildContext.cs b/src/PostSharp.Engineering.BuildTools/Build/BuildContext.cs
@@ -185,7 +185,7 @@ internal TimeSpan BuildTimeout
         {
             get
             {
-                var setting = (this.Settings as BuildSettings)?.Timeout;
+                var setting = this.Settings.Timeout;
 
 #pragma warning disable CS0618 // Type or member is obsolete
                 return setting == null ? this.Product.BuildTimeout : TimeSpan.FromMinutes( setting.Value );
diff --git a/src/PostSharp.Engineering.BuildTools/Build/BuildSettings.cs b/src/PostSharp.Engineering.BuildTools/Build/BuildSettings.cs
@@ -179,10 +179,6 @@ public int? SolutionId
         [CommandOption( "--user" )]
         public string UserName { get; set; } = Environment.GetEnvironmentVariable( EnvironmentVariableNames.EngUserName ) ?? Environment.UserName;
 
-        [Description( "Overrides the build timeout." )]
-        [CommandOption( "--timeout" )]
-        public int? Timeout { get; set; }
-
         public BuildSettings WithIncludeTests( bool value )
         {
             var clone = (BuildSettings) this.MemberwiseClone();
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Solutions/DotNetSolution.cs b/src/PostSharp.Engineering.BuildTools/Build/Solutions/DotNetSolution.cs
@@ -32,8 +32,7 @@ public override bool Restore( BuildContext context, BuildSettings settings )
         private string GetFinalSolutionPath( BuildContext context )
             => FileSystemHelper.GetFinalPath( Path.Combine( context.RepoDirectory, this.SolutionPath ) );
 
-        private ToolInvocationOptions CreateInvocationOptions( BuildContext context )
-            => new( this.EnvironmentVariables ) { ExecutionTimeout = context.BuildTimeout, MinidumpDirectory = context.Product.DumpDirectory };
+        private ToolInvocationOptions CreateInvocationOptions() => new( this.EnvironmentVariables );
 
         private bool RunDotNet(
             BuildContext context,
@@ -48,7 +47,7 @@ private bool RunDotNet(
                 command,
                 arguments,
                 addConfigurationFlag,
-                this.CreateInvocationOptions( context ) );
+                this.CreateInvocationOptions() );
 
         private bool RunBuildOrTests(
             BuildContext context,
@@ -91,7 +90,7 @@ private bool RunBuildOrTests(
                 args = "";
             }
 
-            var options = this.CreateInvocationOptions( context );
+            var options = this.CreateInvocationOptions();
 
             bool success;
 
diff --git a/src/PostSharp.Engineering.BuildTools/CommonCommandSettings.cs b/src/PostSharp.Engineering.BuildTools/CommonCommandSettings.cs
@@ -41,6 +41,11 @@ protected virtual void AppendSettings( StringBuilder stringBuilder )
             {
                 stringBuilder.Append( "--ci " );
             }
+
+            if ( this.Timeout != null )
+            {
+                stringBuilder.Append( $"--timeout {this.Timeout} " );
+            }
         }
 
         public override string ToString()
@@ -74,11 +79,11 @@ public override string ToString()
         [Description( "Simulate a continuous integration build by setting the build ContinuousIntegrationBuild property to TRUE." )]
         [CommandOption( "--ci" )]
         public bool SimulateContinuousIntegration { get; set; }
-        
+
         [Description( "Use the project or solution directory as a working directory." )]
         [CommandOption( "--project-dir-as-working-dir" )]
         public bool UseProjectDirectoryAsWorkingDirectory { get; set; }
-        
+
         [Description( "Use local dependencies instead of build server dependencies." )]
         [CommandOption( "--use-local-dependencies" )]
         public bool UseLocalDependencies { get; set; }
@@ -94,23 +99,26 @@ protected set
                 this._unparsedProperties = value;
 
                 this.Properties = this.Properties.AddRange(
-                    value.Select(
-                        v =>
+                    value.Select( v =>
+                    {
+                        var split = v.Split( '=' );
+
+                        if ( split.Length > 1 )
                         {
-                            var split = v.Split( '=' );
-
-                            if ( split.Length > 1 )
-                            {
-                                return new KeyValuePair<string, string>( split[0].Trim(), split[1].Trim() );
-                            }
-                            else
-                            {
-                                return new KeyValuePair<string, string>( split[0].Trim(), "True" );
-                            }
-                        } ) );
+                            return new KeyValuePair<string, string>( split[0].Trim(), split[1].Trim() );
+                        }
+                        else
+                        {
+                            return new KeyValuePair<string, string>( split[0].Trim(), "True" );
+                        }
+                    } ) );
             }
         }
 
+        [Description( "Overrides the build timeout." )]
+        [CommandOption( "--timeout" )]
+        public int? Timeout { get; set; }
+
         public ImmutableDictionary<string, string> Properties { get; protected set; } =
             ImmutableDictionary.Create<string, string>( StringComparer.OrdinalIgnoreCase );
 
diff --git a/src/PostSharp.Engineering.BuildTools/Utilities/ToolInvocationHelper.cs b/src/PostSharp.Engineering.BuildTools/Utilities/ToolInvocationHelper.cs
@@ -265,30 +265,9 @@ public static bool InvokeTool(
                 }
 
                 Process process = new() { StartInfo = startInfo };
-                var stopwatch = Stopwatch.StartNew();
-
-                // Sets up a timeout. The Timer class does not support long periods, so we use CancellationTokenSource.
-                CancellationTokenSource? timeoutCancellation = null;
-
-                if ( options.ExecutionTimeout != null )
-                {
-                    timeoutCancellation = new CancellationTokenSource( options.ExecutionTimeout.Value );
-                    timeoutCancellation.Token.Register( OnTimeout );
-
-                    void OnTimeout()
-                    {
-                        // ReSharper disable AccessToModifiedClosure
-
-                        console.WriteError( $"The process timed out after {stopwatch.Elapsed}. Dumping and killing the process tree." );
-                        ProcessHelper.DumpAndKillProcessTree( console, process, options.MinidumpDirectory );
-
-                        // ReSharper restore AccessToModifiedClosure
-                    }
-                }
 
                 using ( ManualResetEvent stdErrorClosed = new( false ) )
                 using ( ManualResetEvent stdOutClosed = new( false ) )
-                using ( timeoutCancellation )
                 {
                     // Filters process output where matching RegEx value indicates process failure.
                     void FilterProcessOutput( string output )
diff --git a/src/PostSharp.Engineering.BuildTools/Utilities/ToolInvocationOptions.cs b/src/PostSharp.Engineering.BuildTools/Utilities/ToolInvocationOptions.cs
@@ -34,10 +34,6 @@ public record ToolInvocationOptions(
 
     public TimeSpan OutputReadingTimeout { get; init; } = TimeSpan.FromSeconds( 10 );
 
-    public TimeSpan? ExecutionTimeout { get; init; }
-
-    public string? MinidumpDirectory { get; init; }
-
     public static TimeSpan LongOutputReadingTimeout => TimeSpan.FromSeconds( 60 );
 
     public ToolInvocationOptions WithEnvironmentVariables( ImmutableDictionary<string, string?> additionalEnvironmentVariables )

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ param(`
`12`	`12`	`[string]$ImageName, # Image name (defaults to a name based on the directory).`
`13`	`13`	`[string]$BuildAgentPath = 'C:\BuildAgent',`
`14`	`14`	`[switch]$LoadEnvFromKeyVault, # Forces loading environment variables form the key vault.`
`15`		`- [switch]$VsDebug, # Enable the remote debugger.`
	`15`	`+ [switch]$StartVsmon, # Enable the remote debugger.`
`16`	`16`	`[Parameter(ValueFromRemainingArguments)]`
`17`	`17`	[string[]]$BuildArgs # Arguments passed to `Build.ps1` within the container.
`18`	`18`	`)`
`@@ -187,7 +187,7 @@ if (-not $NoNuGetCache)`
`187`	`187`	`}`
`188`	`188`
`189`	`189`	`# Mount VS Remote Debugger`
`190`		`-if ($VsDebug)`
	`190`	`+if ($StartVsmon)`
`191`	`191`	`{`
`192`	`192`	`if (-not $env:DevEnvDir)`
`193`	`193`	`{`
`@@ -277,9 +277,9 @@ if (-not $BuildImage)`
`277`	`277`	`Write-Host "Building the product in the container." -ForegroundColor Green`
`278`	`278`
`279`	`279`	`# Prepare Build.ps1 arguments`
`280`		`- if ($VsDebug)`
	`280`	`+ if ($StartVsmon)`
`281`	`281`	`{`
`282`		`- $BuildArgs = @("-VsDebug") + $BuildArgs`
	`282`	`+ $BuildArgs = @("-StartVsmon") + $BuildArgs`
`283`	`283`	`}`
`284`	`284`
`285`	`285`	`if ($Interactive)`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`using System.Linq;`
`13`	`13`	`using System.Runtime.InteropServices;`
`14`	`14`	`using System.Text.Json;`
	`15`	`+using System.Threading;`
`15`	`16`
`16`	`17`	`namespace PostSharp.Engineering.BuildTools`
`17`	`18`	`{`
`@@ -23,6 +24,8 @@ public abstract class BaseCommand<T> : Command<T>`
`23`	`24`	`{`
`24`	`25`	`public sealed override int Execute( CommandContext context, T settings )`
`25`	`26`	`{`
	`27`	`+ CancellationTokenSource? timeoutCancellation = null;`
	`28`	`+`
`26`	`29`	`try`
`27`	`30`	`{`
`28`	`31`	`var stopwatch = Stopwatch.StartNew();`
`@@ -42,6 +45,13 @@ public sealed override int Execute( CommandContext context, T settings )`
`42`	`45`	`buildContext = buildContext.WithUseProjectDirectoryAsWorkingDirectory( true );`
`43`	`46`	`}`
`44`	`47`
	`48`	`+ // Sets up a timeout. The Timer class does not support long periods, so we use CancellationTokenSource.`
	`49`	`+ if ( settings.Timeout != null )`
	`50`	`+ {`
	`51`	`+ timeoutCancellation = new CancellationTokenSource( TimeSpan.FromMinutes( settings.Timeout.Value ) );`
	`52`	`+ timeoutCancellation.Token.Register( () => OnTimeout( buildContext, stopwatch ) );`
	`53`	`+ }`
	`54`	`+`
`45`	`55`	`MSBuildHelper.InitializeLocator();`
`46`	`56`
`47`	`57`	`if ( buildContext.IsRunningUnderContainer )`
`@@ -152,8 +162,23 @@ public sealed override int Execute( CommandContext context, T settings )`
`152`	`162`
`153`	`163`	`return 10;`
`154`	`164`	`}`
	`165`	`+ finally`
	`166`	`+ {`
	`167`	`+ timeoutCancellation?.Dispose();`
	`168`	`+ }`
`155`	`169`	`}`
`156`	`170`
`157`	`171`	`protected abstract bool ExecuteCore( BuildContext context, T settings );`
	`172`	`+`
	`173`	`+ private static void OnTimeout( BuildContext buildContext, Stopwatch stopwatch )`
	`174`	`+ {`
	`175`	`+ // ReSharper disable AccessToModifiedClosure`
	`176`	`+`
	`177`	`+ buildContext.Console.WriteError( $"The process timed out after {stopwatch.Elapsed}. Dumping and killing the process tree." );`
	`178`	`+ var directory = Path.Combine( buildContext.RepoDirectory, buildContext.Product.DumpDirectory );`
	`179`	`+ ProcessHelper.DumpAndKillProcessTree( buildContext.Console, Process.GetCurrentProcess(), directory );`
	`180`	`+`
	`181`	`+ // ReSharper restore AccessToModifiedClosure`
	`182`	`+ }`
`158`	`183`	`}`
`159`	`184`	`}`
Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ internal TimeSpan BuildTimeout`
`185`	`185`	`{`
`186`	`186`	`get`
`187`	`187`	`{`
`188`		`- var setting = (this.Settings as BuildSettings)?.Timeout;`
	`188`	`+ var setting = this.Settings.Timeout;`
`189`	`189`
`190`	`190`	`#pragma warning disable CS0618 // Type or member is obsolete`
`191`	`191`	`return setting == null ? this.Product.BuildTimeout : TimeSpan.FromMinutes( setting.Value );`