mirror of
https://github.com/actions/runner.git
synced 2025-12-10 20:36:49 +00:00
GitHub Actions Runner
This commit is contained in:
Tingluo Huang
314
src/Runner.Sdk/ActionPlugin.cs
Normal file
314
src/Runner.Sdk/ActionPlugin.cs
Normal file
@@ -0,0 +1,314 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Net.Http;
|
||||
using System.Net.Http.Headers;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using GitHub.DistributedTask.Pipelines.ContextData;
|
||||
using GitHub.DistributedTask.WebApi;
|
||||
using GitHub.Services.Common;
|
||||
using GitHub.Services.WebApi;
|
||||
using Newtonsoft.Json;
|
||||
using Pipelines = GitHub.DistributedTask.Pipelines;
|
||||
|
||||
namespace GitHub.Runner.Sdk
|
||||
{
|
||||
public interface IRunnerActionPlugin
|
||||
{
|
||||
Task RunAsync(RunnerActionPluginExecutionContext executionContext, CancellationToken token);
|
||||
}
|
||||
|
||||
public class RunnerActionPluginExecutionContext : ITraceWriter
|
||||
{
|
||||
private readonly string DebugEnvironmentalVariable = "ACTIONS_STEP_DEBUG";
|
||||
private VssConnection _connection;
|
||||
private readonly object _stdoutLock = new object();
|
||||
private readonly ITraceWriter _trace; // for unit tests
|
||||
|
||||
public RunnerActionPluginExecutionContext()
|
||||
: this(null)
|
||||
{ }
|
||||
|
||||
public RunnerActionPluginExecutionContext(ITraceWriter trace)
|
||||
{
|
||||
_trace = trace;
|
||||
this.Endpoints = new List<ServiceEndpoint>();
|
||||
this.Inputs = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
|
||||
this.Variables = new Dictionary<string, VariableValue>(StringComparer.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
public List<ServiceEndpoint> Endpoints { get; set; }
|
||||
public Dictionary<string, VariableValue> Variables { get; set; }
|
||||
public Dictionary<string, string> Inputs { get; set; }
|
||||
public DictionaryContextData Context { get; set; } = new DictionaryContextData();
|
||||
|
||||
[JsonIgnore]
|
||||
public VssConnection VssConnection
|
||||
{
|
||||
get
|
||||
{
|
||||
if (_connection == null)
|
||||
{
|
||||
_connection = InitializeVssConnection();
|
||||
}
|
||||
return _connection;
|
||||
}
|
||||
}
|
||||
|
||||
public VssConnection InitializeVssConnection()
|
||||
{
|
||||
var headerValues = new List<ProductInfoHeaderValue>();
|
||||
headerValues.Add(new ProductInfoHeaderValue($"GitHubActionsRunner-Plugin", BuildConstants.RunnerPackage.Version));
|
||||
headerValues.Add(new ProductInfoHeaderValue($"({RuntimeInformation.OSDescription.Trim()})"));
|
||||
|
||||
if (VssClientHttpRequestSettings.Default.UserAgent != null && VssClientHttpRequestSettings.Default.UserAgent.Count > 0)
|
||||
{
|
||||
headerValues.AddRange(VssClientHttpRequestSettings.Default.UserAgent);
|
||||
}
|
||||
|
||||
VssClientHttpRequestSettings.Default.UserAgent = headerValues;
|
||||
|
||||
#if OS_LINUX || OS_OSX
|
||||
// The .NET Core 2.1 runtime switched its HTTP default from HTTP 1.1 to HTTP 2.
|
||||
// This causes problems with some versions of the Curl handler.
|
||||
// See GitHub issue https://github.com/dotnet/corefx/issues/32376
|
||||
VssClientHttpRequestSettings.Default.UseHttp11 = true;
|
||||
#endif
|
||||
|
||||
var certSetting = GetCertConfiguration();
|
||||
if (certSetting != null)
|
||||
{
|
||||
if (!string.IsNullOrEmpty(certSetting.ClientCertificateArchiveFile))
|
||||
{
|
||||
VssClientHttpRequestSettings.Default.ClientCertificateManager = new RunnerClientCertificateManager(certSetting.ClientCertificateArchiveFile, certSetting.ClientCertificatePassword);
|
||||
}
|
||||
|
||||
if (certSetting.SkipServerCertificateValidation)
|
||||
{
|
||||
VssClientHttpRequestSettings.Default.ServerCertificateValidationCallback = HttpClientHandler.DangerousAcceptAnyServerCertificateValidator;
|
||||
}
|
||||
}
|
||||
|
||||
var proxySetting = GetProxyConfiguration();
|
||||
if (proxySetting != null)
|
||||
{
|
||||
if (!string.IsNullOrEmpty(proxySetting.ProxyAddress))
|
||||
{
|
||||
VssHttpMessageHandler.DefaultWebProxy = new RunnerWebProxyCore(proxySetting.ProxyAddress, proxySetting.ProxyUsername, proxySetting.ProxyPassword, proxySetting.ProxyBypassList);
|
||||
}
|
||||
}
|
||||
|
||||
ServiceEndpoint systemConnection = this.Endpoints.FirstOrDefault(e => string.Equals(e.Name, WellKnownServiceEndpointNames.SystemVssConnection, StringComparison.OrdinalIgnoreCase));
|
||||
ArgUtil.NotNull(systemConnection, nameof(systemConnection));
|
||||
ArgUtil.NotNull(systemConnection.Url, nameof(systemConnection.Url));
|
||||
|
||||
VssCredentials credentials = VssUtil.GetVssCredential(systemConnection);
|
||||
ArgUtil.NotNull(credentials, nameof(credentials));
|
||||
return VssUtil.CreateConnection(systemConnection.Url, credentials);
|
||||
}
|
||||
|
||||
public string GetInput(string name, bool required = false)
|
||||
{
|
||||
string value = null;
|
||||
if (this.Inputs.ContainsKey(name))
|
||||
{
|
||||
value = this.Inputs[name];
|
||||
}
|
||||
|
||||
Debug($"Input '{name}': '{value ?? string.Empty}'");
|
||||
|
||||
if (string.IsNullOrEmpty(value) && required)
|
||||
{
|
||||
throw new ArgumentNullException(name);
|
||||
}
|
||||
|
||||
return value;
|
||||
}
|
||||
|
||||
public void Info(string message)
|
||||
{
|
||||
Debug(message);
|
||||
}
|
||||
|
||||
public void Verbose(string message)
|
||||
{
|
||||
Debug(message);
|
||||
}
|
||||
|
||||
public void Error(string message)
|
||||
{
|
||||
Output($"##[error]{Escape(message)}");
|
||||
}
|
||||
|
||||
public void Debug(string message)
|
||||
{
|
||||
var debugString = Variables.GetValueOrDefault(DebugEnvironmentalVariable)?.Value;
|
||||
if (StringUtil.ConvertToBoolean(debugString))
|
||||
{
|
||||
var multilines = message?.Replace("\r\n", "\n")?.Split("\n");
|
||||
if (multilines != null)
|
||||
{
|
||||
foreach (var line in multilines)
|
||||
{
|
||||
Output($"##[debug]{Escape(line)}");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public void Warning(string message)
|
||||
{
|
||||
Output($"##[warning]{Escape(message)}");
|
||||
}
|
||||
|
||||
public void Output(string message)
|
||||
{
|
||||
lock (_stdoutLock)
|
||||
{
|
||||
if (_trace == null)
|
||||
{
|
||||
Console.WriteLine(message);
|
||||
}
|
||||
else
|
||||
{
|
||||
_trace.Info(message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public void AddMask(string secret)
|
||||
{
|
||||
Output($"##[add-mask]{Escape(secret)}");
|
||||
}
|
||||
|
||||
public void Command(string command)
|
||||
{
|
||||
Output($"##[command]{Escape(command)}");
|
||||
}
|
||||
|
||||
public void SetRepositoryPath(string repoName, string path, bool workspaceRepo)
|
||||
{
|
||||
Output($"##[internal-set-repo-path repoFullName={repoName};workspaceRepo={workspaceRepo.ToString()}]{path}");
|
||||
}
|
||||
|
||||
public void SetIntraActionState(string name, string value)
|
||||
{
|
||||
Output($"##[save-state name={Escape(name)}]{Escape(value)}");
|
||||
}
|
||||
|
||||
public String GetRunnerContext(string contextName)
|
||||
{
|
||||
this.Context.TryGetValue("runner", out var context);
|
||||
var runnerContext = context as DictionaryContextData;
|
||||
ArgUtil.NotNull(runnerContext, nameof(runnerContext));
|
||||
if (runnerContext.TryGetValue(contextName, out var data))
|
||||
{
|
||||
return data as StringContextData;
|
||||
}
|
||||
else
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
public String GetGitHubContext(string contextName)
|
||||
{
|
||||
this.Context.TryGetValue("github", out var context);
|
||||
var githubContext = context as DictionaryContextData;
|
||||
ArgUtil.NotNull(githubContext, nameof(githubContext));
|
||||
if (githubContext.TryGetValue(contextName, out var data))
|
||||
{
|
||||
return data as StringContextData;
|
||||
}
|
||||
else
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
public RunnerCertificateSettings GetCertConfiguration()
|
||||
{
|
||||
bool skipCertValidation = StringUtil.ConvertToBoolean(GetRunnerContext("SkipCertValidation"));
|
||||
string caFile = GetRunnerContext("CAInfo");
|
||||
string clientCertFile = GetRunnerContext("ClientCert");
|
||||
|
||||
if (!string.IsNullOrEmpty(caFile) || !string.IsNullOrEmpty(clientCertFile) || skipCertValidation)
|
||||
{
|
||||
var certConfig = new RunnerCertificateSettings();
|
||||
certConfig.SkipServerCertificateValidation = skipCertValidation;
|
||||
certConfig.CACertificateFile = caFile;
|
||||
|
||||
if (!string.IsNullOrEmpty(clientCertFile))
|
||||
{
|
||||
certConfig.ClientCertificateFile = clientCertFile;
|
||||
string clientCertKey = GetRunnerContext("ClientCertKey");
|
||||
string clientCertArchive = GetRunnerContext("ClientCertArchive");
|
||||
string clientCertPassword = GetRunnerContext("ClientCertPassword");
|
||||
|
||||
certConfig.ClientCertificatePrivateKeyFile = clientCertKey;
|
||||
certConfig.ClientCertificateArchiveFile = clientCertArchive;
|
||||
certConfig.ClientCertificatePassword = clientCertPassword;
|
||||
|
||||
certConfig.VssClientCertificateManager = new RunnerClientCertificateManager(clientCertArchive, clientCertPassword);
|
||||
}
|
||||
|
||||
return certConfig;
|
||||
}
|
||||
else
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
public RunnerWebProxySettings GetProxyConfiguration()
|
||||
{
|
||||
string proxyUrl = GetRunnerContext("ProxyUrl");
|
||||
if (!string.IsNullOrEmpty(proxyUrl))
|
||||
{
|
||||
string proxyUsername = GetRunnerContext("ProxyUsername");
|
||||
string proxyPassword = GetRunnerContext("ProxyPassword");
|
||||
List<string> proxyBypassHosts = StringUtil.ConvertFromJson<List<string>>(GetRunnerContext("ProxyBypassList") ?? "[]");
|
||||
return new RunnerWebProxySettings()
|
||||
{
|
||||
ProxyAddress = proxyUrl,
|
||||
ProxyUsername = proxyUsername,
|
||||
ProxyPassword = proxyPassword,
|
||||
ProxyBypassList = proxyBypassHosts,
|
||||
WebProxy = new RunnerWebProxyCore(proxyUrl, proxyUsername, proxyPassword, proxyBypassHosts)
|
||||
};
|
||||
}
|
||||
else
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private string Escape(string input)
|
||||
{
|
||||
foreach (var mapping in _commandEscapeMappings)
|
||||
{
|
||||
input = input.Replace(mapping.Key, mapping.Value);
|
||||
}
|
||||
|
||||
return input;
|
||||
}
|
||||
|
||||
private Dictionary<string, string> _commandEscapeMappings = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
|
||||
{
|
||||
{
|
||||
";", "%3B"
|
||||
},
|
||||
{
|
||||
"\r", "%0D"
|
||||
},
|
||||
{
|
||||
"\n", "%0A"
|
||||
},
|
||||
{
|
||||
"]", "%5D"
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user