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
//ITerminal registers a CTRL-C handler, which keeps the Runner.Worker process running
//and lets the Runner.Listener handle gracefully the exit.
var term = context.GetService <ITerminal>();
try
{
trace.Info($"Version: {BuildConstants.RunnerPackage.Version}");
trace.Info($"Commit: {BuildConstants.Source.CommitHash}");
trace.Info($"Culture: {CultureInfo.CurrentCulture.Name}");
trace.Info($"UI Culture: {CultureInfo.CurrentUICulture.Name}");
context.WritePerfCounter("WorkerProcessStarted");
// Validate args.
ArgUtil.NotNull(args, nameof(args));
ArgUtil.Equal(3, args.Length, nameof(args.Length));
ArgUtil.NotNullOrEmpty(args[0], $"{nameof(args)}[0]");
ArgUtil.Equal("spawnclient", args[0].ToLowerInvariant(), $"{nameof(args)}[0]");
ArgUtil.NotNullOrEmpty(args[1], $"{nameof(args)}[1]");
ArgUtil.NotNullOrEmpty(args[2], $"{nameof(args)}[2]");
var worker = context.GetService <IWorker>();
// Run the worker.
return(await worker.RunAsync(
pipeIn : args[1],
pipeOut : args[2]));
}
catch (Exception ex)
{
// Populate any exception that cause worker failure back to runner.
Console.WriteLine(ex.ToString());
try
{
trace.Error(ex);
}
catch (Exception e)
{
// make sure we don't crash the app on trace error.
// since IOException will throw when we run out of disk space.
Console.WriteLine(e.ToString());
}
}
return(1);
}
private static async Task <int> MainAsync(IHostContext context, string[] args)
{
//ITerminal registers a CTRL-C handler, which keeps the Agent.Worker process running
//and lets the Agent.Listener handle gracefully the exit.
var term = context.GetService <ITerminal>();
Tracing trace = context.GetTrace(nameof(Program));
try
{
trace.Info($"Version: {BuildConstants.AgentPackage.Version}");
trace.Info($"Commit: {BuildConstants.Source.CommitHash}");
trace.Info($"Culture: {CultureInfo.CurrentCulture.Name}");
trace.Info($"UI Culture: {CultureInfo.CurrentUICulture.Name}");
context.WritePerfCounter("WorkerProcessStarted");
// Validate args.
ArgUtil.NotNull(args, nameof(args));
ArgUtil.Equal(3, args.Length, nameof(args.Length));
ArgUtil.NotNullOrEmpty(args[0], $"{nameof(args)}[0]");
ArgUtil.Equal("spawnclient", args[0].ToLowerInvariant(), $"{nameof(args)}[0]");
ArgUtil.NotNullOrEmpty(args[1], $"{nameof(args)}[1]");
ArgUtil.NotNullOrEmpty(args[2], $"{nameof(args)}[2]");
var worker = context.GetService <IWorker>();
// Run the worker.
return(await worker.RunAsync(
pipeIn : args[1],
pipeOut : args[2]));
}
catch (AggregateException ex)
{
ExceptionsUtil.HandleAggregateException((AggregateException)ex, trace.Error);
}
catch (Exception ex)
{
// Populate any exception that cause worker failure back to agent.
Console.WriteLine(ex.ToString());
try
{
trace.Error(ex);
}
catch (Exception e)
{
// make sure we don't crash the app on trace error.
// since IOException will throw when we run out of disk space.
Console.WriteLine(e.ToString());
}
}
return(1);
}
// Return code definition: (this will be used by service host to determine whether it will re-launch agent.listener)
// 0: Agent exit
// 1: Terminate failure
// 2: Retriable failure
// 3: Exit for self update
public async static Task <int> MainAsync(IHostContext context, string[] args)
{
Tracing trace = context.GetTrace("AgentProcess");
trace.Info($"Agent package {BuildConstants.AgentPackage.PackageName}.");
trace.Info($"Running on {PlatformUtil.HostOS} ({PlatformUtil.HostArchitecture}).");
trace.Info($"RuntimeInformation: {RuntimeInformation.OSDescription}.");
context.WritePerfCounter("AgentProcessStarted");
var terminal = context.GetService <ITerminal>();
// TODO: check that the right supporting tools are available for this platform
// (replaces the check for build platform vs runtime platform)
try
{
trace.Info($"Version: {BuildConstants.AgentPackage.Version}");
trace.Info($"Commit: {BuildConstants.Source.CommitHash}");
trace.Info($"Culture: {CultureInfo.CurrentCulture.Name}");
trace.Info($"UI Culture: {CultureInfo.CurrentUICulture.Name}");
// Validate directory permissions.
string agentDirectory = context.GetDirectory(WellKnownDirectory.Root);
trace.Info($"Validating directory permissions for: '{agentDirectory}'");
try
{
IOUtil.ValidateExecutePermission(agentDirectory);
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
if (PlatformUtil.RunningOnWindows)
{
// Validate PowerShell 3.0 or higher is installed.
var powerShellExeUtil = context.GetService <IPowerShellExeUtil>();
try
{
powerShellExeUtil.GetPath();
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
// Validate .NET Framework 4.5 or higher is installed.
if (!NetFrameworkUtil.Test(new Version(4, 5), trace))
{
terminal.WriteError(StringUtil.Loc("MinimumNetFramework"));
return(Constants.Agent.ReturnCode.TerminatedError);
}
}
// Add environment variables from .env file
string envFile = Path.Combine(context.GetDirectory(WellKnownDirectory.Root), ".env");
if (File.Exists(envFile))
{
var envContents = File.ReadAllLines(envFile);
foreach (var env in envContents)
{
if (!string.IsNullOrEmpty(env) && env.IndexOf('=') > 0)
{
string envKey = env.Substring(0, env.IndexOf('='));
string envValue = env.Substring(env.IndexOf('=') + 1);
Environment.SetEnvironmentVariable(envKey, envValue);
}
}
}
// Parse the command line args.
var command = new CommandSettings(context, args);
trace.Info("Arguments parsed");
// Up front validation, warn for unrecognized commandline args.
var unknownCommandlines = command.Validate();
if (unknownCommandlines.Count > 0)
{
terminal.WriteError(StringUtil.Loc("UnrecognizedCmdArgs", string.Join(", ", unknownCommandlines)));
}
// Defer to the Agent class to execute the command.
IAgent agent = context.GetService <IAgent>();
try
{
return(await agent.ExecuteCommand(command));
}
catch (OperationCanceledException) when(context.AgentShutdownToken.IsCancellationRequested)
{
trace.Info("Agent execution been cancelled.");
return(Constants.Agent.ReturnCode.Success);
}
catch (NonRetryableException e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.RetryableError);
}
}
// Return code definition: (this will be used by service host to determine whether it will re-launch Runner.Listener)
// 0: Runner exit
// 1: Terminate failure
// 2: Retriable failure
// 3: Exit for self update
private async static Task <int> MainAsync(IHostContext context, string[] args)
{
Tracing trace = context.GetTrace(nameof(GitHub.Runner.Listener));
trace.Info($"Runner is built for {Constants.Runner.Platform} ({Constants.Runner.PlatformArchitecture}) - {BuildConstants.RunnerPackage.PackageName}.");
trace.Info($"RuntimeInformation: {RuntimeInformation.OSDescription}.");
context.WritePerfCounter("RunnerProcessStarted");
var terminal = context.GetService <ITerminal>();
// Validate the binaries intended for one OS are not running on a different OS.
switch (Constants.Runner.Platform)
{
case Constants.OSPlatform.Linux:
if (!RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
terminal.WriteLine("This runner version is built for Linux. Please install a correct build for your OS.");
return(Constants.Runner.ReturnCode.TerminatedError);
}
break;
case Constants.OSPlatform.OSX:
if (!RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
{
terminal.WriteLine("This runner version is built for OSX. Please install a correct build for your OS.");
return(Constants.Runner.ReturnCode.TerminatedError);
}
break;
case Constants.OSPlatform.Windows:
if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
terminal.WriteLine("This runner version is built for Windows. Please install a correct build for your OS.");
return(Constants.Runner.ReturnCode.TerminatedError);
}
break;
default:
terminal.WriteLine($"Running the runner on this platform is not supported. The current platform is {RuntimeInformation.OSDescription} and it was built for {Constants.Runner.Platform.ToString()}.");
return(Constants.Runner.ReturnCode.TerminatedError);
}
try
{
trace.Info($"Version: {BuildConstants.RunnerPackage.Version}");
trace.Info($"Commit: {BuildConstants.Source.CommitHash}");
trace.Info($"Culture: {CultureInfo.CurrentCulture.Name}");
trace.Info($"UI Culture: {CultureInfo.CurrentUICulture.Name}");
// Validate directory permissions.
string runnerDirectory = context.GetDirectory(WellKnownDirectory.Root);
trace.Info($"Validating directory permissions for: '{runnerDirectory}'");
try
{
IOUtil.ValidateExecutePermission(runnerDirectory);
}
catch (Exception e)
{
terminal.WriteError($"An error occurred: {e.Message}");
trace.Error(e);
return(Constants.Runner.ReturnCode.TerminatedError);
}
// Parse the command line args.
var command = new CommandSettings(context, args);
trace.Info("Arguments parsed");
// Up front validation, warn for unrecognized commandline args.
var unknownCommandlines = command.Validate();
if (unknownCommandlines.Count > 0)
{
terminal.WriteError($"Unrecognized command-line input arguments: '{string.Join(", ", unknownCommandlines)}'. For usage refer to: .\\config.cmd --help or ./config.sh --help");
}
// Defer to the Runner class to execute the command.
IRunner runner = context.GetService <IRunner>();
try
{
return(await runner.ExecuteCommand(command));
}
catch (OperationCanceledException) when(context.RunnerShutdownToken.IsCancellationRequested)
{
trace.Info("Runner execution been cancelled.");
return(Constants.Runner.ReturnCode.Success);
}
catch (NonRetryableException e)
{
terminal.WriteError($"An error occurred: {e.Message}");
trace.Error(e);
return(Constants.Runner.ReturnCode.TerminatedError);
}
}
catch (Exception e)
{
terminal.WriteError($"An error occurred: {e.Message}");
trace.Error(e);
return(Constants.Runner.ReturnCode.RetryableError);
}
}
// Return code definition: (this will be used by service host to determine whether it will re-launch agent.listener)
// 0: Agent exit
// 1: Terminate failure
// 2: Retriable failure
// 3: Exit for self update
public async static Task <int> MainAsync(IHostContext context, string[] args)
{
Tracing trace = context.GetTrace("AgentProcess");
trace.Info($"Agent is built for {Constants.Agent.Platform} - {BuildConstants.AgentPackage.PackageName}.");
trace.Info($"RuntimeInformation: {RuntimeInformation.OSDescription}.");
context.WritePerfCounter("AgentProcessStarted");
var terminal = context.GetService <ITerminal>();
// Validate the binaries intended for one OS are not running on a different OS.
switch (Constants.Agent.Platform)
{
case Constants.OSPlatform.Linux:
if (!RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
terminal.WriteLine(StringUtil.Loc("NotLinux"));
return(Constants.Agent.ReturnCode.TerminatedError);
}
break;
case Constants.OSPlatform.OSX:
if (!RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
{
terminal.WriteLine(StringUtil.Loc("NotOSX"));
return(Constants.Agent.ReturnCode.TerminatedError);
}
break;
case Constants.OSPlatform.Windows:
if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
terminal.WriteLine(StringUtil.Loc("NotWindows"));
return(Constants.Agent.ReturnCode.TerminatedError);
}
break;
default:
terminal.WriteLine(StringUtil.Loc("PlatformNotSupport", RuntimeInformation.OSDescription, Constants.Agent.Platform.ToString()));
return(Constants.Agent.ReturnCode.TerminatedError);
}
try
{
trace.Info($"Version: {Constants.Agent.Version}");
trace.Info($"Commit: {BuildConstants.Source.CommitHash}");
trace.Info($"Culture: {CultureInfo.CurrentCulture.Name}");
trace.Info($"UI Culture: {CultureInfo.CurrentUICulture.Name}");
// Validate directory permissions.
string agentDirectory = context.GetDirectory(WellKnownDirectory.Root);
trace.Info($"Validating directory permissions for: '{agentDirectory}'");
try
{
IOUtil.ValidateExecutePermission(agentDirectory);
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
#if OS_WINDOWS
// Validate PowerShell 3.0 or higher is installed.
var powerShellExeUtil = context.GetService <IPowerShellExeUtil>();
try
{
powerShellExeUtil.GetPath();
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
// Validate .NET Framework 4.5 or higher is installed.
if (!NetFrameworkUtil.Test(new Version(4, 5), trace))
{
terminal.WriteError(StringUtil.Loc("MinimumNetFramework"));
return(Constants.Agent.ReturnCode.TerminatedError);
}
#endif
// Add environment variables from .env file
string envFile = Path.Combine(context.GetDirectory(WellKnownDirectory.Root), ".env");
if (File.Exists(envFile))
{
var envContents = File.ReadAllLines(envFile);
foreach (var env in envContents)
{
if (!string.IsNullOrEmpty(env) && env.IndexOf('=') > 0)
{
string envKey = env.Substring(0, env.IndexOf('='));
string envValue = env.Substring(env.IndexOf('=') + 1);
Environment.SetEnvironmentVariable(envKey, envValue);
}
}
}
// Parse the command line args.
var command = new CommandSettings(context, args);
trace.Info("Arguments parsed");
// Up front validation, warn for unrecognized commandline args.
var unknownCommandlines = command.Validate();
if (unknownCommandlines.Count > 0)
{
terminal.WriteError(StringUtil.Loc("UnrecognizedCmdArgs", string.Join(", ", unknownCommandlines)));
}
// Defer to the Agent class to execute the command.
IAgent agent = context.GetService <IAgent>();
try
{
return(await agent.ExecuteCommand(command));
}
catch (OperationCanceledException) when(context.AgentShutdownToken.IsCancellationRequested)
{
trace.Info("Agent execution been cancelled.");
return(Constants.Agent.ReturnCode.Success);
}
catch (NonRetryableException e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.RetryableError);
}
}
// Return code definition: (this will be used by service host to determine whether it will re-launch agent.listener)
// 0: Agent exit
// 1: Terminate failure
// 2: Retriable failure
// 3: Exit for self update
private async static Task <int> MainAsync(IHostContext context, string[] args)
{
Tracing trace = context.GetTrace("AgentProcess");
trace.Info($"Agent package {BuildConstants.AgentPackage.PackageName}.");
trace.Info($"Running on {PlatformUtil.HostOS} ({PlatformUtil.HostArchitecture}).");
trace.Info($"RuntimeInformation: {RuntimeInformation.OSDescription}.");
context.WritePerfCounter("AgentProcessStarted");
var terminal = context.GetService <ITerminal>();
// TODO: check that the right supporting tools are available for this platform
// (replaces the check for build platform vs runtime platform)
try
{
trace.Info($"Version: {BuildConstants.AgentPackage.Version}");
trace.Info($"Commit: {BuildConstants.Source.CommitHash}");
trace.Info($"Culture: {CultureInfo.CurrentCulture.Name}");
trace.Info($"UI Culture: {CultureInfo.CurrentUICulture.Name}");
// Validate directory permissions.
string agentDirectory = context.GetDirectory(WellKnownDirectory.Root);
trace.Info($"Validating directory permissions for: '{agentDirectory}'");
try
{
IOUtil.ValidateExecutePermission(agentDirectory);
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
if (PlatformUtil.UseLegacyHttpHandler)
{
trace.Warning($"You are using the legacy HTTP handler because you set ${AgentKnobs.LegacyHttpVariableName}.");
trace.Warning($"This feature will go away with .NET 5.0, and we recommend you don't use it.");
trace.Warning($"If you continue using it, you must ensure libcurl is installed on your system.");
}
if (PlatformUtil.RunningOnWindows)
{
// Validate PowerShell 3.0 or higher is installed.
var powerShellExeUtil = context.GetService <IPowerShellExeUtil>();
try
{
powerShellExeUtil.GetPath();
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
// Validate .NET Framework 4.5 or higher is installed.
if (!NetFrameworkUtil.Test(new Version(4, 5), trace))
{
terminal.WriteError(StringUtil.Loc("MinimumNetFramework"));
// warn only, like configurationmanager.cs does. this enables windows edition with just .netcore to work
}
// Upgrade process priority to avoid Listener starvation
using (Process p = Process.GetCurrentProcess())
{
try
{
p.PriorityClass = ProcessPriorityClass.AboveNormal;
}
catch (Exception e)
{
trace.Warning("Unable to change Windows process priority");
trace.Warning(e.Message);
}
}
}
// Add environment variables from .env file
string envFile = Path.Combine(context.GetDirectory(WellKnownDirectory.Root), ".env");
if (File.Exists(envFile))
{
var envContents = File.ReadAllLines(envFile);
foreach (var env in envContents)
{
if (!string.IsNullOrEmpty(env) && env.IndexOf('=') > 0)
{
string envKey = env.Substring(0, env.IndexOf('='));
string envValue = env.Substring(env.IndexOf('=') + 1);
Environment.SetEnvironmentVariable(envKey, envValue);
}
}
}
// Parse the command line args.
var command = new CommandSettings(context, args, new SystemEnvironment());
trace.Info("Arguments parsed");
// Print any Parse Errros
if (command.ParseErrors?.Any() == true)
{
List <string> errorStr = new List <string>();
foreach (var error in command.ParseErrors)
{
if (error is TokenError tokenError)
{
errorStr.Add(tokenError.Token);
}
else
{
// Unknown type of error dump to log
terminal.WriteError(StringUtil.Loc("ErrorOccurred", error.Tag));
}
}
terminal.WriteError(
StringUtil.Loc("UnrecognizedCmdArgs",
string.Join(", ", errorStr)));
}
// Defer to the Agent class to execute the command.
IAgent agent = context.GetService <IAgent>();
try
{
return(await agent.ExecuteCommand(command));
}
catch (OperationCanceledException) when(context.AgentShutdownToken.IsCancellationRequested)
{
trace.Info("Agent execution been cancelled.");
return(Constants.Agent.ReturnCode.Success);
}
catch (NonRetryableException e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.TerminatedError);
}
}
catch (Exception e)
{
terminal.WriteError(StringUtil.Loc("ErrorOccurred", e.Message));
trace.Error(e);
return(Constants.Agent.ReturnCode.RetryableError);
}
}
