mirror of
https://github.com/actions/runner.git
synced 2025-12-12 05:37:01 +00:00
GitHub Actions Runner
This commit is contained in:
Tingluo Huang
215
src/Runner.Worker/Worker.cs
Normal file
215
src/Runner.Worker/Worker.cs
Normal file
@@ -0,0 +1,215 @@
|
||||
using GitHub.DistributedTask.WebApi;
|
||||
using Pipelines = GitHub.DistributedTask.Pipelines;
|
||||
using GitHub.Runner.Common.Util;
|
||||
using Newtonsoft.Json;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using GitHub.Services.WebApi;
|
||||
using GitHub.Runner.Common;
|
||||
using GitHub.Runner.Sdk;
|
||||
|
||||
namespace GitHub.Runner.Worker
|
||||
{
|
||||
[ServiceLocator(Default = typeof(Worker))]
|
||||
public interface IWorker : IRunnerService
|
||||
{
|
||||
Task<int> RunAsync(string pipeIn, string pipeOut);
|
||||
}
|
||||
|
||||
public sealed class Worker : RunnerService, IWorker
|
||||
{
|
||||
private readonly TimeSpan _workerStartTimeout = TimeSpan.FromSeconds(30);
|
||||
private ManualResetEvent _completedCommand = new ManualResetEvent(false);
|
||||
|
||||
// Do not mask the values of these secrets
|
||||
private static HashSet<String> SecretVariableMaskWhitelist = new HashSet<String>(StringComparer.OrdinalIgnoreCase){
|
||||
Constants.Variables.Actions.StepDebug,
|
||||
Constants.Variables.Actions.RunnerDebug
|
||||
};
|
||||
|
||||
public async Task<int> RunAsync(string pipeIn, string pipeOut)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Setup way to handle SIGTERM/unloading signals
|
||||
_completedCommand.Reset();
|
||||
HostContext.Unloading += Worker_Unloading;
|
||||
|
||||
// Validate args.
|
||||
ArgUtil.NotNullOrEmpty(pipeIn, nameof(pipeIn));
|
||||
ArgUtil.NotNullOrEmpty(pipeOut, nameof(pipeOut));
|
||||
var runnerWebProxy = HostContext.GetService<IRunnerWebProxy>();
|
||||
var runnerCertManager = HostContext.GetService<IRunnerCertificateManager>();
|
||||
VssUtil.InitializeVssClientSettings(HostContext.UserAgent, runnerWebProxy.WebProxy, runnerCertManager.VssClientCertificateManager);
|
||||
var jobRunner = HostContext.CreateService<IJobRunner>();
|
||||
|
||||
using (var channel = HostContext.CreateService<IProcessChannel>())
|
||||
using (var jobRequestCancellationToken = CancellationTokenSource.CreateLinkedTokenSource(HostContext.RunnerShutdownToken))
|
||||
using (var channelTokenSource = new CancellationTokenSource())
|
||||
{
|
||||
// Start the channel.
|
||||
channel.StartClient(pipeIn, pipeOut);
|
||||
|
||||
// Wait for up to 30 seconds for a message from the channel.
|
||||
HostContext.WritePerfCounter("WorkerWaitingForJobMessage");
|
||||
Trace.Info("Waiting to receive the job message from the channel.");
|
||||
WorkerMessage channelMessage;
|
||||
using (var csChannelMessage = new CancellationTokenSource(_workerStartTimeout))
|
||||
{
|
||||
channelMessage = await channel.ReceiveAsync(csChannelMessage.Token);
|
||||
}
|
||||
|
||||
// Deserialize the job message.
|
||||
Trace.Info("Message received.");
|
||||
ArgUtil.Equal(MessageType.NewJobRequest, channelMessage.MessageType, nameof(channelMessage.MessageType));
|
||||
ArgUtil.NotNullOrEmpty(channelMessage.Body, nameof(channelMessage.Body));
|
||||
var jobMessage = StringUtil.ConvertFromJson<Pipelines.AgentJobRequestMessage>(channelMessage.Body);
|
||||
ArgUtil.NotNull(jobMessage, nameof(jobMessage));
|
||||
HostContext.WritePerfCounter($"WorkerJobMessageReceived_{jobMessage.RequestId.ToString()}");
|
||||
|
||||
// Initialize the secret masker and set the thread culture.
|
||||
InitializeSecretMasker(jobMessage);
|
||||
SetCulture(jobMessage);
|
||||
|
||||
// Start the job.
|
||||
Trace.Info($"Job message:{Environment.NewLine} {StringUtil.ConvertToJson(WorkerUtilities.ScrubPiiData(jobMessage))}");
|
||||
Task<TaskResult> jobRunnerTask = jobRunner.RunAsync(jobMessage, jobRequestCancellationToken.Token);
|
||||
|
||||
// Start listening for a cancel message from the channel.
|
||||
Trace.Info("Listening for cancel message from the channel.");
|
||||
Task<WorkerMessage> channelTask = channel.ReceiveAsync(channelTokenSource.Token);
|
||||
|
||||
// Wait for one of the tasks to complete.
|
||||
Trace.Info("Waiting for the job to complete or for a cancel message from the channel.");
|
||||
Task.WaitAny(jobRunnerTask, channelTask);
|
||||
// Handle if the job completed.
|
||||
if (jobRunnerTask.IsCompleted)
|
||||
{
|
||||
Trace.Info("Job completed.");
|
||||
channelTokenSource.Cancel(); // Cancel waiting for a message from the channel.
|
||||
return TaskResultUtil.TranslateToReturnCode(await jobRunnerTask);
|
||||
}
|
||||
|
||||
// Otherwise a cancel message was received from the channel.
|
||||
Trace.Info("Cancellation/Shutdown message received.");
|
||||
channelMessage = await channelTask;
|
||||
switch (channelMessage.MessageType)
|
||||
{
|
||||
case MessageType.CancelRequest:
|
||||
jobRequestCancellationToken.Cancel(); // Expire the host cancellation token.
|
||||
break;
|
||||
case MessageType.RunnerShutdown:
|
||||
HostContext.ShutdownRunner(ShutdownReason.UserCancelled);
|
||||
break;
|
||||
case MessageType.OperatingSystemShutdown:
|
||||
HostContext.ShutdownRunner(ShutdownReason.OperatingSystemShutdown);
|
||||
break;
|
||||
default:
|
||||
throw new ArgumentOutOfRangeException(nameof(channelMessage.MessageType), channelMessage.MessageType, nameof(channelMessage.MessageType));
|
||||
}
|
||||
|
||||
// Await the job.
|
||||
return TaskResultUtil.TranslateToReturnCode(await jobRunnerTask);
|
||||
}
|
||||
}
|
||||
finally
|
||||
{
|
||||
HostContext.Unloading -= Worker_Unloading;
|
||||
_completedCommand.Set();
|
||||
}
|
||||
}
|
||||
|
||||
private void InitializeSecretMasker(Pipelines.AgentJobRequestMessage message)
|
||||
{
|
||||
Trace.Entering();
|
||||
ArgUtil.NotNull(message, nameof(message));
|
||||
ArgUtil.NotNull(message.Resources, nameof(message.Resources));
|
||||
|
||||
// Add mask hints for secret variables
|
||||
foreach (var variable in (message.Variables ?? new Dictionary<string, VariableValue>()))
|
||||
{
|
||||
// Need to ignore values on whitelist
|
||||
if (variable.Value.IsSecret && !SecretVariableMaskWhitelist.Contains(variable.Key))
|
||||
{
|
||||
var value = variable.Value.Value?.Trim() ?? string.Empty;
|
||||
|
||||
// Add the entire value, even if it contains CR or LF. During expression tracing,
|
||||
// invidual trace info may contain line breaks.
|
||||
HostContext.SecretMasker.AddValue(value);
|
||||
|
||||
// Also add each individual line. Typically individual lines are processed from STDOUT of child processes.
|
||||
var split = value.Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries);
|
||||
foreach (var item in split)
|
||||
{
|
||||
HostContext.SecretMasker.AddValue(item.Trim());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Add mask hints
|
||||
foreach (MaskHint maskHint in (message.MaskHints ?? new List<MaskHint>()))
|
||||
{
|
||||
if (maskHint.Type == MaskType.Regex)
|
||||
{
|
||||
HostContext.SecretMasker.AddRegex(maskHint.Value);
|
||||
|
||||
// We need this because the worker will print out the job message JSON to diag log
|
||||
// and SecretMasker has JsonEscapeEncoder hook up
|
||||
HostContext.SecretMasker.AddValue(maskHint.Value);
|
||||
}
|
||||
else
|
||||
{
|
||||
// TODO: Should we fail instead? Do any additional pains need to be taken here? Should the job message not be traced?
|
||||
Trace.Warning($"Unsupported mask type '{maskHint.Type}'.");
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: Avoid adding redundant secrets. If the endpoint auth matches the system connection, then it's added as a value secret and as a regex secret. Once as a value secret b/c of the following code that iterates over each endpoint. Once as a regex secret due to the hint sent down in the job message.
|
||||
|
||||
// Add masks for service endpoints
|
||||
foreach (ServiceEndpoint endpoint in message.Resources.Endpoints ?? new List<ServiceEndpoint>())
|
||||
{
|
||||
foreach (string value in endpoint.Authorization?.Parameters?.Values ?? new string[0])
|
||||
{
|
||||
if (!string.IsNullOrEmpty(value))
|
||||
{
|
||||
HostContext.SecretMasker.AddValue(value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Add masks for secure file download tickets
|
||||
foreach (SecureFile file in message.Resources.SecureFiles ?? new List<SecureFile>())
|
||||
{
|
||||
if (!string.IsNullOrEmpty(file.Ticket))
|
||||
{
|
||||
HostContext.SecretMasker.AddValue(file.Ticket);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void SetCulture(Pipelines.AgentJobRequestMessage message)
|
||||
{
|
||||
// Extract the culture name from the job's variable dictionary.
|
||||
VariableValue culture;
|
||||
ArgUtil.NotNull(message, nameof(message));
|
||||
ArgUtil.NotNull(message.Variables, nameof(message.Variables));
|
||||
if (message.Variables.TryGetValue(Constants.Variables.System.Culture, out culture))
|
||||
{
|
||||
// Set the default thread culture.
|
||||
HostContext.SetDefaultCulture(culture.Value);
|
||||
}
|
||||
}
|
||||
|
||||
private void Worker_Unloading(object sender, EventArgs e)
|
||||
{
|
||||
if (!HostContext.RunnerShutdownToken.IsCancellationRequested)
|
||||
{
|
||||
HostContext.ShutdownRunner(ShutdownReason.UserCancelled);
|
||||
_completedCommand.WaitOne(Constants.Runner.ExitOnUnloadTimeout);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user