actions/runner
1
0
Fork 0
mirror of https://github.com/actions/runner.git synced 2025-12-13 00:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Wait for debugger to attach in Runner.Worker process (#1101)

Browse Source 
* Wait for debugger to attach in Worker

Only if GITHUB_ACTIONS_RUNNER_ATTACH_DEBUGGER is set

* Only wait if env variable parses to boolean 'true'

* Add 30s timeout to the wait

* Clean up leftover line

* Decrease wait to 20s

* Use ConvertToBoolean isntead of TryParse
This commit is contained in:
Ferenc Hammerl
2021-05-27 16:05:48 +02:00
committed by GitHub
parent 8863b1fb2c
commit 93ec16e14f
1 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
src/Runner.Worker/Program.cs
View File

@@ -1,9 +1,9 @@
using GitHub.Runner.Common.Util; using System;
using System;
using System.Globalization; using System.Globalization;
using System.Threading.Tasks; using System.Threading.Tasks;
using GitHub.Runner.Common; using GitHub.Runner.Common;
using GitHub.Runner.Sdk; using GitHub.Runner.Sdk;
using System.Diagnostics;
namespace GitHub.Runner.Worker namespace GitHub.Runner.Worker
{ {
@@ -19,11 +19,16 @@ namespace GitHub.Runner.Worker
public static async Task<int> MainAsync(IHostContext context, string[] args) public static async Task<int> MainAsync(IHostContext context, string[] args)
{ {
Tracing trace = context.GetTrace(nameof(GitHub.Runner.Worker));
if (StringUtil.ConvertToBoolean(Environment.GetEnvironmentVariable("GITHUB_ACTIONS_RUNNER_ATTACH_DEBUGGER")))
{
await WaitForDebugger(trace);
}
// We may want to consider registering this handler in Worker.cs, similiar to the unloading/SIGTERM handler // We may want to consider registering this handler in Worker.cs, similiar to the unloading/SIGTERM handler
//ITerminal registers a CTRL-C handler, which keeps the Runner.Worker process running //ITerminal registers a CTRL-C handler, which keeps the Runner.Worker process running
//and lets the Runner.Listener handle gracefully the exit. //and lets the Runner.Listener handle gracefully the exit.
var term = context.GetService<ITerminal>(); var term = context.GetService<ITerminal>();
Tracing trace = context.GetTrace(nameof(GitHub.Runner.Worker));
try try
{ {
trace.Info($"Version: {BuildConstants.RunnerPackage.Version}"); trace.Info($"Version: {BuildConstants.RunnerPackage.Version}");
@@ -64,5 +69,25 @@ namespace GitHub.Runner.Worker
return 1; return 1;
} }
/// <summary>
/// Runner.Worker is started by Runner.Listener in a separate process,
/// so the two can't be debugged in the same session.
/// This method halts the Runner.Worker process until a debugger is attached,
/// allowing a developer to debug Runner.Worker from start to finish.
/// </summary>
private static async Task WaitForDebugger(Tracing trace)
{
trace.Info($"Waiting for a debugger to be attached. Edit the 'GITHUB_ACTIONS_RUNNER_ATTACH_DEBUGGER' environment variable to toggle this feature.");
int waitInSeconds = 20;
while (!Debugger.IsAttached && waitInSeconds-- > 0)
{
trace.Info($"Waiting for a debugger to be attached. {waitInSeconds} seconds left.");
await Task.Delay(1000);
}
Debugger.Break();
}
} }
} }