mirror of
https://github.com/actions/runner.git
synced 2025-12-13 10:05:23 +00:00
GitHub Actions Runner
This commit is contained in:
Tingluo Huang
308
src/Test/L0/Worker/WorkerL0.cs
Normal file
308
src/Test/L0/Worker/WorkerL0.cs
Normal file
@@ -0,0 +1,308 @@
|
||||
using GitHub.DistributedTask.WebApi;
|
||||
using GitHub.DistributedTask.ObjectTemplating.Tokens;
|
||||
using GitHub.Runner.Worker;
|
||||
using Moq;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Xunit;
|
||||
using GitHub.Services.WebApi;
|
||||
using Pipelines = GitHub.DistributedTask.Pipelines;
|
||||
|
||||
namespace GitHub.Runner.Common.Tests.Worker
|
||||
{
|
||||
public sealed class WorkerL0
|
||||
{
|
||||
private Mock<IProcessChannel> _processChannel;
|
||||
private Mock<IJobRunner> _jobRunner;
|
||||
private Mock<IRunnerWebProxy> _proxy;
|
||||
private Mock<IRunnerCertificateManager> _cert;
|
||||
|
||||
public WorkerL0()
|
||||
{
|
||||
_processChannel = new Mock<IProcessChannel>();
|
||||
_jobRunner = new Mock<IJobRunner>();
|
||||
_proxy = new Mock<IRunnerWebProxy>();
|
||||
_cert = new Mock<IRunnerCertificateManager>();
|
||||
}
|
||||
|
||||
private Pipelines.AgentJobRequestMessage CreateJobRequestMessage(string jobName)
|
||||
{
|
||||
TaskOrchestrationPlanReference plan = new TaskOrchestrationPlanReference() { PlanId = Guid.NewGuid() };
|
||||
TimelineReference timeline = null;
|
||||
Dictionary<string, VariableValue> variables = new Dictionary<string, VariableValue>(StringComparer.OrdinalIgnoreCase);
|
||||
variables[Constants.Variables.System.Culture] = "en-US";
|
||||
Pipelines.JobResources resources = new Pipelines.JobResources();
|
||||
var serviceEndpoint = new ServiceEndpoint();
|
||||
serviceEndpoint.Authorization = new EndpointAuthorization();
|
||||
serviceEndpoint.Authorization.Parameters.Add("nullValue", null);
|
||||
resources.Endpoints.Add(serviceEndpoint);
|
||||
|
||||
List<Pipelines.JobStep> tasks = new List<Pipelines.JobStep>();
|
||||
tasks.Add(new Pipelines.TaskStep()
|
||||
{
|
||||
Id = Guid.NewGuid(),
|
||||
Reference = new Pipelines.TaskStepDefinitionReference()
|
||||
{
|
||||
Id = Guid.NewGuid(),
|
||||
Name = "TestTask",
|
||||
Version = "1.0.0"
|
||||
}
|
||||
});
|
||||
Guid JobId = Guid.NewGuid();
|
||||
var sidecarContainers = new MappingToken(null, null, null)
|
||||
{
|
||||
{
|
||||
new StringToken(null, null, null, "nginx"),
|
||||
new MappingToken(null, null, null)
|
||||
{
|
||||
{
|
||||
new StringToken(null, null, null, "image"),
|
||||
new StringToken(null, null, null, "nginx")
|
||||
},
|
||||
}
|
||||
},
|
||||
};
|
||||
var context = new Pipelines.ContextData.DictionaryContextData
|
||||
{
|
||||
{
|
||||
"github",
|
||||
new Pipelines.ContextData.DictionaryContextData()
|
||||
},
|
||||
};
|
||||
var jobRequest = new Pipelines.AgentJobRequestMessage(plan, timeline, JobId, jobName, jobName, new StringToken(null, null, null, "ubuntu"), sidecarContainers, null, variables, new List<MaskHint>(), resources, context, null, tasks, null);
|
||||
return jobRequest;
|
||||
}
|
||||
|
||||
private JobCancelMessage CreateJobCancelMessage(Guid jobId)
|
||||
{
|
||||
return new JobCancelMessage(jobId, TimeSpan.FromSeconds(0));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
[Trait("Level", "L0")]
|
||||
[Trait("Category", "Worker")]
|
||||
public async void DispatchRunNewJob()
|
||||
{
|
||||
//Arrange
|
||||
using (var hc = new TestHostContext(this))
|
||||
using (var tokenSource = new CancellationTokenSource())
|
||||
{
|
||||
var worker = new GitHub.Runner.Worker.Worker();
|
||||
hc.EnqueueInstance<IProcessChannel>(_processChannel.Object);
|
||||
hc.EnqueueInstance<IJobRunner>(_jobRunner.Object);
|
||||
hc.SetSingleton<IRunnerWebProxy>(_proxy.Object);
|
||||
hc.SetSingleton<IRunnerCertificateManager>(_cert.Object);
|
||||
worker.Initialize(hc);
|
||||
var jobMessage = CreateJobRequestMessage("job1");
|
||||
var arWorkerMessages = new WorkerMessage[]
|
||||
{
|
||||
new WorkerMessage
|
||||
{
|
||||
Body = JsonUtility.ToString(jobMessage),
|
||||
MessageType = MessageType.NewJobRequest
|
||||
}
|
||||
};
|
||||
var workerMessages = new Queue<WorkerMessage>(arWorkerMessages);
|
||||
|
||||
_processChannel
|
||||
.Setup(x => x.ReceiveAsync(It.IsAny<CancellationToken>()))
|
||||
.Returns(async () =>
|
||||
{
|
||||
// Return the job message.
|
||||
if (workerMessages.Count > 0)
|
||||
{
|
||||
return workerMessages.Dequeue();
|
||||
}
|
||||
|
||||
// Wait for the text to run
|
||||
await Task.Delay(-1, tokenSource.Token);
|
||||
return default(WorkerMessage);
|
||||
});
|
||||
_jobRunner.Setup(x => x.RunAsync(It.IsAny<Pipelines.AgentJobRequestMessage>(), It.IsAny<CancellationToken>()))
|
||||
.Returns(Task.FromResult<TaskResult>(TaskResult.Succeeded));
|
||||
|
||||
//Act
|
||||
await worker.RunAsync(pipeIn: "1", pipeOut: "2");
|
||||
|
||||
//Assert
|
||||
_processChannel.Verify(x => x.StartClient("1", "2"), Times.Once());
|
||||
_jobRunner.Verify(x => x.RunAsync(
|
||||
It.Is<Pipelines.AgentJobRequestMessage>(y => IsMessageIdentical(y, jobMessage)), It.IsAny<CancellationToken>()));
|
||||
tokenSource.Cancel();
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
[Trait("Level", "L0")]
|
||||
[Trait("Category", "Worker")]
|
||||
public async void DispatchCancellation()
|
||||
{
|
||||
//Arrange
|
||||
using (var hc = new TestHostContext(this))
|
||||
{
|
||||
var worker = new GitHub.Runner.Worker.Worker();
|
||||
hc.EnqueueInstance<IProcessChannel>(_processChannel.Object);
|
||||
hc.EnqueueInstance<IJobRunner>(_jobRunner.Object);
|
||||
hc.SetSingleton<IRunnerWebProxy>(_proxy.Object);
|
||||
hc.SetSingleton<IRunnerCertificateManager>(_cert.Object);
|
||||
worker.Initialize(hc);
|
||||
var jobMessage = CreateJobRequestMessage("job1");
|
||||
var cancelMessage = CreateJobCancelMessage(jobMessage.JobId);
|
||||
var arWorkerMessages = new WorkerMessage[]
|
||||
{
|
||||
new WorkerMessage
|
||||
{
|
||||
Body = JsonUtility.ToString(jobMessage),
|
||||
MessageType = MessageType.NewJobRequest
|
||||
},
|
||||
new WorkerMessage
|
||||
{
|
||||
Body = JsonUtility.ToString(cancelMessage),
|
||||
MessageType = MessageType.CancelRequest
|
||||
}
|
||||
|
||||
};
|
||||
var workerMessages = new Queue<WorkerMessage>(arWorkerMessages);
|
||||
|
||||
_processChannel.Setup(x => x.ReceiveAsync(It.IsAny<CancellationToken>()))
|
||||
.Returns(() => Task.FromResult(workerMessages.Dequeue()));
|
||||
_jobRunner.Setup(x => x.RunAsync(It.IsAny<Pipelines.AgentJobRequestMessage>(), It.IsAny<CancellationToken>()))
|
||||
.Returns(
|
||||
async (Pipelines.AgentJobRequestMessage jm, CancellationToken ct) =>
|
||||
{
|
||||
await Task.Delay(-1, ct);
|
||||
return TaskResult.Canceled;
|
||||
});
|
||||
|
||||
//Act
|
||||
await Assert.ThrowsAsync<TaskCanceledException>(
|
||||
async () => await worker.RunAsync("1", "2"));
|
||||
|
||||
//Assert
|
||||
_processChannel.Verify(x => x.StartClient("1", "2"), Times.Once());
|
||||
_jobRunner.Verify(x => x.RunAsync(
|
||||
It.Is<Pipelines.AgentJobRequestMessage>(y => IsMessageIdentical(y, jobMessage)), It.IsAny<CancellationToken>()));
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
[Trait("Level", "L0")]
|
||||
[Trait("Category", "Worker")]
|
||||
public void VerifyJobRequestMessagePiiDataIsScrubbed()
|
||||
{
|
||||
// Arrange
|
||||
Pipelines.AgentJobRequestMessage message = CreateJobRequestMessage("jobwithpiidata");
|
||||
|
||||
// Populate PII variables
|
||||
foreach (string piiVariable in Variables.PiiVariables)
|
||||
{
|
||||
message.Variables.Add(piiVariable, "MyPiiVariable");
|
||||
}
|
||||
|
||||
foreach (string piiVariableSuffix in Variables.PiiArtifactVariableSuffixes)
|
||||
{
|
||||
message.Variables.Add($"{Variables.PiiArtifactVariablePrefix}.MyArtifact.{piiVariableSuffix}", "MyPiiVariable");
|
||||
}
|
||||
|
||||
// Populate the repository PII data
|
||||
Pipelines.RepositoryResource repository = new Pipelines.RepositoryResource();
|
||||
|
||||
repository.Properties.Set(
|
||||
Pipelines.RepositoryPropertyNames.VersionInfo,
|
||||
new Pipelines.VersionInfo()
|
||||
{
|
||||
Author = "MyAuthor",
|
||||
Message = "MyMessage"
|
||||
});
|
||||
|
||||
message.Resources.Repositories.Add(repository);
|
||||
|
||||
// Act
|
||||
Pipelines.AgentJobRequestMessage scrubbedMessage = WorkerUtilities.ScrubPiiData(message);
|
||||
|
||||
// Assert
|
||||
foreach (string piiVariable in Variables.PiiVariables)
|
||||
{
|
||||
scrubbedMessage.Variables.TryGetValue(piiVariable, out VariableValue value);
|
||||
|
||||
Assert.Equal("[PII]", value.Value);
|
||||
}
|
||||
|
||||
foreach (string piiVariableSuffix in Variables.PiiArtifactVariableSuffixes)
|
||||
{
|
||||
scrubbedMessage.Variables.TryGetValue($"{Variables.PiiArtifactVariablePrefix}.MyArtifact.{piiVariableSuffix}", out VariableValue value);
|
||||
|
||||
Assert.Equal("[PII]", value.Value);
|
||||
}
|
||||
|
||||
Pipelines.RepositoryResource scrubbedRepo = scrubbedMessage.Resources.Repositories[0];
|
||||
Pipelines.VersionInfo scrubbedInfo = scrubbedRepo.Properties.Get<Pipelines.VersionInfo>(Pipelines.RepositoryPropertyNames.VersionInfo);
|
||||
|
||||
Assert.Equal("[PII]", scrubbedInfo.Author);
|
||||
}
|
||||
|
||||
private bool IsMessageIdentical(Pipelines.AgentJobRequestMessage source, Pipelines.AgentJobRequestMessage target)
|
||||
{
|
||||
if (source == null && target == null)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
if (source != null && target == null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source == null && target != null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (JsonUtility.ToString(source.JobContainer) != JsonUtility.ToString(target.JobContainer))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.JobDisplayName != target.JobDisplayName)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.JobId != target.JobId)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.JobName != target.JobName)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.MaskHints.Count != target.MaskHints.Count)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.MessageType != target.MessageType)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.Plan.PlanId != target.Plan.PlanId)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.RequestId != target.RequestId)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.Resources.Endpoints.Count != target.Resources.Endpoints.Count)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.Steps.Count != target.Steps.Count)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (source.Variables.Count != target.Variables.Count)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user