public async Task TestDownloadArtifactAsync()
{
byte[] sourceContent1 = GenerateRandomData();
byte[] sourceContent2 = GenerateRandomData();
TestFile sourceFile1 = new TestFile(sourceContent1);
TestFile sourceFile2 = new TestFile(sourceContent2);
sourceFile1.PlaceItem(Path.Combine(Directory.GetCurrentDirectory(), Path.Combine(TestDownloadSourceFolder, "drop/test2.txt")));
sourceFile2.PlaceItem(Path.Combine(Directory.GetCurrentDirectory(), Path.Combine(TestDownloadSourceFolder, "drop/test3.txt")));
using (var hostContext = new TestHostContext(this))
{
var context = new AgentTaskPluginExecutionContext(hostContext.GetTrace());
var provider = new FileShareProvider(context, null, context.CreateArtifactsTracer(), new MockDedupManifestArtifactClientFactory());
string sourcePath = Path.Combine(Directory.GetCurrentDirectory(), TestDownloadSourceFolder);
string destPath = Path.Combine(Directory.GetCurrentDirectory(), TestDestFolder);
ArtifactDownloadParameters downloadParameters = new ArtifactDownloadParameters();
downloadParameters.TargetDirectory = destPath;
downloadParameters.MinimatchFilters = new string[] { "**" };
BuildArtifact buildArtifact = new BuildArtifact();
buildArtifact.Name = "drop";
buildArtifact.Resource = new ArtifactResource();
buildArtifact.Resource.Data = sourcePath;
await provider.DownloadMultipleArtifactsAsync(downloadParameters, new List <BuildArtifact> {
buildArtifact
}, CancellationToken.None, context);
var sourceFiles = Directory.GetFiles(sourcePath);
var destFiles = Directory.GetFiles(destPath);
Assert.Equal(sourceFiles.Length, destFiles.Length);
foreach (var file in sourceFiles)
{
string destFile = destFiles.FirstOrDefault(f => Path.GetFileName(f).Equals(Path.GetFileName(file)));
Assert.True(StructuralComparisons.StructuralEqualityComparer.Equals(ComputeHash(file), ComputeHash(destFile)));
}
TestCleanup();
}
}
protected override async Task ProcessCommandInternalAsync(
AgentTaskPluginExecutionContext context,
CancellationToken token)
{
ArgUtil.NotNull(context, nameof(context));
string artifactName = context.GetInput(ArtifactEventProperties.ArtifactName, required: false);
string branchName = context.GetInput(ArtifactEventProperties.BranchName, required: false);
string pipelineDefinition = context.GetInput(ArtifactEventProperties.PipelineDefinition, required: false);
string sourceRun = context.GetInput(ArtifactEventProperties.SourceRun, required: true);
string pipelineTriggering = context.GetInput(ArtifactEventProperties.PipelineTriggering, required: false);
string pipelineVersionToDownload = context.GetInput(ArtifactEventProperties.PipelineVersionToDownload, required: false);
string targetPath = context.GetInput(DownloadPath, required: true);
string environmentBuildId = context.Variables.GetValueOrDefault(BuildVariables.BuildId)?.Value ?? string.Empty; // BuildID provided by environment.
string itemPattern = context.GetInput(ArtifactEventProperties.ItemPattern, required: false);
string projectName = context.GetInput(ArtifactEventProperties.Project, required: false);
string tags = context.GetInput(ArtifactEventProperties.Tags, required: false);
string allowPartiallySucceededBuilds = context.GetInput(ArtifactEventProperties.AllowPartiallySucceededBuilds, required: false);
string allowFailedBuilds = context.GetInput(ArtifactEventProperties.AllowFailedBuilds, required: false);
string allowCanceledBuilds = context.GetInput(ArtifactEventProperties.AllowCanceledBuilds, required: false);
string userSpecifiedRunId = context.GetInput(RunId, required: false);
string defaultWorkingDirectory = context.Variables.GetValueOrDefault("system.defaultworkingdirectory").Value;
targetPath = Path.IsPathFullyQualified(targetPath) ? targetPath : Path.GetFullPath(Path.Combine(defaultWorkingDirectory, targetPath));
bool onPrem = !String.Equals(context.Variables.GetValueOrDefault(WellKnownDistributedTaskVariables.ServerType)?.Value, "Hosted", StringComparison.OrdinalIgnoreCase);
if (onPrem)
{
throw new InvalidOperationException(StringUtil.Loc("OnPremIsNotSupported"));
}
if (!PipelineArtifactPathHelper.IsValidArtifactName(artifactName))
{
throw new ArgumentException(StringUtil.Loc("ArtifactNameIsNotValid", artifactName));
}
string[] minimatchPatterns = itemPattern.Split(
new[] { "\n" },
StringSplitOptions.RemoveEmptyEntries
);
string[] tagsInput = tags.Split(
new[] { "," },
StringSplitOptions.None
);
if (!bool.TryParse(allowPartiallySucceededBuilds, out var allowPartiallySucceededBuildsBool))
{
allowPartiallySucceededBuildsBool = false;
}
if (!bool.TryParse(allowFailedBuilds, out var allowFailedBuildsBool))
{
allowFailedBuildsBool = false;
}
if (!bool.TryParse(allowCanceledBuilds, out var allowCanceledBuildsBool))
{
allowCanceledBuildsBool = false;
}
var resultFilter = GetResultFilter(allowPartiallySucceededBuildsBool, allowFailedBuildsBool, allowCanceledBuildsBool);
PipelineArtifactServer server = new PipelineArtifactServer(tracer);
ArtifactDownloadParameters downloadParameters;
if (sourceRun == sourceRunCurrent)
{
// TODO: use a constant for project id, which is currently defined in Microsoft.VisualStudio.Services.Agent.Constants.Variables.System.TeamProjectId (Ting)
string projectIdStr = context.Variables.GetValueOrDefault("system.teamProjectId")?.Value;
if (String.IsNullOrEmpty(projectIdStr))
{
throw new ArgumentNullException(StringUtil.Loc("CannotBeNullOrEmpty"), "Project ID");
}
Guid projectId = Guid.Parse(projectIdStr);
ArgUtil.NotEmpty(projectId, nameof(projectId));
int pipelineId = 0;
if (int.TryParse(environmentBuildId, out pipelineId) && pipelineId != 0)
{
OutputBuildInfo(context, pipelineId);
}
else
{
string hostType = context.Variables.GetValueOrDefault("system.hosttype")?.Value;
if (string.Equals(hostType, "Release", StringComparison.OrdinalIgnoreCase) ||
string.Equals(hostType, "DeploymentGroup", StringComparison.OrdinalIgnoreCase))
{
throw new InvalidOperationException(StringUtil.Loc("BuildIdIsNotAvailable", hostType ?? string.Empty, hostType ?? string.Empty));
}
else if (!string.Equals(hostType, "Build", StringComparison.OrdinalIgnoreCase))
{
throw new InvalidOperationException(StringUtil.Loc("CannotDownloadFromCurrentEnvironment", hostType ?? string.Empty));
}
else
{
// This should not happen since the build id comes from build environment. But a user may override that so we must be careful.
throw new ArgumentException(StringUtil.Loc("BuildIdIsNotValid", environmentBuildId));
}
}
downloadParameters = new ArtifactDownloadParameters
{
ProjectRetrievalOptions = BuildArtifactRetrievalOptions.RetrieveByProjectId,
ProjectId = projectId,
PipelineId = pipelineId,
ArtifactName = artifactName,
TargetDirectory = targetPath,
MinimatchFilters = minimatchPatterns,
MinimatchFilterWithArtifactName = true
};
}
else if (sourceRun == sourceRunSpecific)
{
if (String.IsNullOrEmpty(projectName))
{
throw new ArgumentNullException(StringUtil.Loc("CannotBeNullOrEmpty"), "Project Name");
}
Guid projectId;
bool isProjGuid = Guid.TryParse(projectName, out projectId);
if (!isProjGuid)
{
projectId = await GetProjectIdAsync(context, projectName);
}
// Set the default pipelineId to 0, which is an invalid build id and it has to be reassigned to a valid build id.
int pipelineId = 0;
bool pipelineTriggeringBool;
if (bool.TryParse(pipelineTriggering, out pipelineTriggeringBool) && pipelineTriggeringBool)
{
string hostType = context.Variables.GetValueOrDefault("system.hostType").Value;
string triggeringPipeline = null;
if (!string.IsNullOrWhiteSpace(hostType) && !hostType.Equals("build", StringComparison.OrdinalIgnoreCase)) // RM env.
{
var releaseAlias = context.Variables.GetValueOrDefault("release.triggeringartifact.alias")?.Value;
var definitionIdTriggered = context.Variables.GetValueOrDefault("release.artifacts." + releaseAlias ?? string.Empty + ".definitionId")?.Value;
if (!string.IsNullOrWhiteSpace(definitionIdTriggered) && definitionIdTriggered.Equals(pipelineDefinition, StringComparison.OrdinalIgnoreCase))
{
triggeringPipeline = context.Variables.GetValueOrDefault("release.artifacts." + releaseAlias ?? string.Empty + ".buildId")?.Value;
}
}
else
{
var definitionIdTriggered = context.Variables.GetValueOrDefault("build.triggeredBy.definitionId")?.Value;
if (!string.IsNullOrWhiteSpace(definitionIdTriggered) && definitionIdTriggered.Equals(pipelineDefinition, StringComparison.OrdinalIgnoreCase))
{
triggeringPipeline = context.Variables.GetValueOrDefault("build.triggeredBy.buildId")?.Value;
}
}
if (!string.IsNullOrWhiteSpace(triggeringPipeline))
{
pipelineId = int.Parse(triggeringPipeline);
}
}
if (pipelineId == 0)
{
if (pipelineVersionToDownload == pipelineVersionToDownloadLatest)
{
pipelineId = await this.GetPipelineIdAsync(context, pipelineDefinition, pipelineVersionToDownload, projectId.ToString(), tagsInput, resultFilter, null, cancellationToken : token);
}
else if (pipelineVersionToDownload == pipelineVersionToDownloadSpecific)
{
bool isPipelineIdNum = Int32.TryParse(userSpecifiedRunId, out pipelineId);
if (!isPipelineIdNum)
{
throw new ArgumentException(StringUtil.Loc("RunIDNotValid", userSpecifiedRunId));
}
}
else if (pipelineVersionToDownload == pipelineVersionToDownloadLatestFromBranch)
{
pipelineId = await this.GetPipelineIdAsync(context, pipelineDefinition, pipelineVersionToDownload, projectId.ToString(), tagsInput, resultFilter, branchName, cancellationToken : token);
}
else
{
throw new InvalidOperationException("Unreachable code!");
}
}
OutputBuildInfo(context, pipelineId);
downloadParameters = new ArtifactDownloadParameters
{
ProjectRetrievalOptions = BuildArtifactRetrievalOptions.RetrieveByProjectName,
ProjectName = projectName,
ProjectId = projectId,
PipelineId = pipelineId,
ArtifactName = artifactName,
TargetDirectory = targetPath,
MinimatchFilters = minimatchPatterns,
MinimatchFilterWithArtifactName = true
};
}
else
{
throw new InvalidOperationException($"Build type '{sourceRun}' is not recognized.");
}
string fullPath = this.CreateDirectoryIfDoesntExist(targetPath);
DownloadOptions downloadOptions;
if (string.IsNullOrEmpty(downloadParameters.ArtifactName))
{
downloadOptions = DownloadOptions.MultiDownload;
}
else
{
downloadOptions = DownloadOptions.SingleDownload;
}
context.Output(StringUtil.Loc("DownloadArtifactTo", targetPath));
await server.DownloadAsyncV2(context, downloadParameters, downloadOptions, token);
context.Output(StringUtil.Loc("DownloadArtifactFinished"));
}
protected override async Task ProcessCommandInternalAsync(
AgentTaskPluginExecutionContext context,
CancellationToken token)
{
ArgUtil.NotNull(context, nameof(context));
string artifactName = this.GetArtifactName(context);
string branchName = context.GetInput(ArtifactEventProperties.BranchName, required: false);
string buildPipelineDefinition = context.GetInput(ArtifactEventProperties.BuildPipelineDefinition, required: false);
string buildType = context.GetInput(ArtifactEventProperties.BuildType, required: true);
string buildTriggering = context.GetInput(ArtifactEventProperties.BuildTriggering, required: false);
string buildVersionToDownload = context.GetInput(ArtifactEventProperties.BuildVersionToDownload, required: false);
string targetPath = context.GetInput(TargetPath, required: true);
string environmentBuildId = context.Variables.GetValueOrDefault(BuildVariables.BuildId)?.Value ?? string.Empty; // BuildID provided by environment.
string itemPattern = context.GetInput(ArtifactEventProperties.ItemPattern, required: false);
string projectName = context.GetInput(ArtifactEventProperties.Project, required: false);
string tags = context.GetInput(ArtifactEventProperties.Tags, required: false);
string userSpecifiedpipelineId = context.GetInput(PipelineId, required: false);
// Empty input field "Matching pattern" must be recognised as default value '**'
itemPattern = string.IsNullOrEmpty(itemPattern) ? "**" : itemPattern;
string[] minimatchPatterns = itemPattern.Split(
new[] { "\n" },
StringSplitOptions.RemoveEmptyEntries
);
string[] tagsInput = tags.Split(
new[] { "," },
StringSplitOptions.None
);
PipelineArtifactServer server = new PipelineArtifactServer(tracer);
ArtifactDownloadParameters downloadParameters;
if (buildType == buildTypeCurrent)
{
// TODO: use a constant for project id, which is currently defined in Microsoft.VisualStudio.Services.Agent.Constants.Variables.System.TeamProjectId (Ting)
string projectIdStr = context.Variables.GetValueOrDefault("system.teamProjectId")?.Value;
if (String.IsNullOrEmpty(projectIdStr))
{
throw new ArgumentNullException("Project ID cannot be null.");
}
Guid projectId = Guid.Parse(projectIdStr);
ArgUtil.NotEmpty(projectId, nameof(projectId));
int pipelineId = 0;
if (int.TryParse(environmentBuildId, out pipelineId) && pipelineId != 0)
{
context.Output(StringUtil.Loc("DownloadingFromBuild", pipelineId));
}
else
{
string hostType = context.Variables.GetValueOrDefault("system.hosttype")?.Value;
if (string.Equals(hostType, "Release", StringComparison.OrdinalIgnoreCase) ||
string.Equals(hostType, "DeploymentGroup", StringComparison.OrdinalIgnoreCase))
{
throw new InvalidOperationException(StringUtil.Loc("BuildIdIsNotAvailable", hostType ?? string.Empty, hostType ?? string.Empty));
}
else if (!string.Equals(hostType, "Build", StringComparison.OrdinalIgnoreCase))
{
throw new InvalidOperationException(StringUtil.Loc("CannotDownloadFromCurrentEnvironment", hostType ?? string.Empty));
}
else
{
// This should not happen since the build id comes from build environment. But a user may override that so we must be careful.
throw new ArgumentException(StringUtil.Loc("BuildIdIsNotValid", environmentBuildId));
}
}
downloadParameters = new ArtifactDownloadParameters
{
ProjectRetrievalOptions = BuildArtifactRetrievalOptions.RetrieveByProjectId,
ProjectId = projectId,
PipelineId = pipelineId,
ArtifactName = artifactName,
TargetDirectory = targetPath,
MinimatchFilters = minimatchPatterns,
MinimatchFilterWithArtifactName = false
};
}
else if (buildType == buildTypeSpecific)
{
int?pipelineId = null;
bool buildTriggeringBool = false;
if (bool.TryParse(buildTriggering, out buildTriggeringBool) && buildTriggeringBool)
{
string triggeringPipeline = context.Variables.GetValueOrDefault("build.triggeredBy.buildId")?.Value;
if (!string.IsNullOrEmpty(triggeringPipeline))
{
pipelineId = int.Parse(triggeringPipeline);
}
}
if (!pipelineId.HasValue)
{
if (buildVersionToDownload == buildVersionToDownloadLatest)
{
pipelineId = await this.GetpipelineIdAsync(context, buildPipelineDefinition, buildVersionToDownload, projectName, tagsInput);
}
else if (buildVersionToDownload == buildVersionToDownloadSpecific)
{
pipelineId = Int32.Parse(userSpecifiedpipelineId);
}
else if (buildVersionToDownload == buildVersionToDownloadLatestFromBranch)
{
pipelineId = await this.GetpipelineIdAsync(context, buildPipelineDefinition, buildVersionToDownload, projectName, tagsInput, branchName);
}
else
{
throw new InvalidOperationException("Unreachable code!");
}
}
context.Output(StringUtil.Loc("DownloadingFromBuild", pipelineId));
downloadParameters = new ArtifactDownloadParameters
{
ProjectRetrievalOptions = BuildArtifactRetrievalOptions.RetrieveByProjectName,
ProjectName = projectName,
PipelineId = pipelineId.Value,
ArtifactName = artifactName,
TargetDirectory = targetPath,
MinimatchFilters = minimatchPatterns,
MinimatchFilterWithArtifactName = false
};
}
else
{
throw new InvalidOperationException($"Build type '{buildType}' is not recognized.");
}
string fullPath = this.CreateDirectoryIfDoesntExist(targetPath);
DownloadOptions downloadOptions;
if (string.IsNullOrEmpty(downloadParameters.ArtifactName))
{
downloadOptions = DownloadOptions.MultiDownload;
}
else
{
downloadOptions = DownloadOptions.SingleDownload;
}
context.Output(StringUtil.Loc("DownloadArtifactTo", targetPath));
await server.DownloadAsync(context, downloadParameters, downloadOptions, token);
context.Output(StringUtil.Loc("DownloadArtifactFinished"));
}
