public void Execute(IExecutionContext context, Command command)
{
ArgUtil.NotNull(context, nameof(context));
Dictionary <string, string> eventProperties = command.Properties;
string data = command.Data;
string area;
if (!eventProperties.TryGetValue(WellKnownEventTrackProperties.Area, out area) || string.IsNullOrEmpty(area))
{
throw new ArgumentException(StringUtil.Loc("ArgumentNeeded", "Area"));
}
string feature;
if (!eventProperties.TryGetValue(WellKnownEventTrackProperties.Feature, out feature) || string.IsNullOrEmpty(feature))
{
throw new ArgumentException(StringUtil.Loc("ArgumentNeeded", "Feature"));
}
if (string.IsNullOrEmpty(data))
{
throw new ArgumentException(StringUtil.Loc("ArgumentNeeded", "EventTrackerData"));
}
CustomerIntelligenceEvent ciEvent;
try
{
var ciProperties = JsonConvert.DeserializeObject <Dictionary <string, object> >(data);
ciEvent = new CustomerIntelligenceEvent()
{
Area = area,
Feature = feature,
Properties = ciProperties
};
}
catch (Exception ex)
{
throw new ArgumentException(StringUtil.Loc("TelemetryCommandDataError", data, ex.Message));
}
ICustomerIntelligenceServer ciService;
VssConnection vssConnection;
try
{
ciService = context.GetHostContext().GetService <ICustomerIntelligenceServer>();
vssConnection = WorkerUtilities.GetVssConnection(context);
ciService.Initialize(vssConnection);
}
catch (Exception ex)
{
context.Warning(StringUtil.Loc("TelemetryCommandFailed", ex.Message));
return;
}
var commandContext = context.GetHostContext().CreateService <IAsyncCommandContext>();
commandContext.InitializeCommandContext(context, StringUtil.Loc("Telemetry"));
commandContext.Task = PublishEventsAsync(context, ciService, ciEvent);
}
private void ProcessPublishTestResultsCommand(IExecutionContext context, Dictionary <string, string> eventProperties, string data)
{
ArgUtil.NotNull(context, nameof(context));
_executionContext = context;
LoadPublishTestResultsInputs(context, eventProperties, data);
string teamProject = context.Variables.System_TeamProject;
string owner = context.Variables.Build_RequestedFor;
string buildUri = context.Variables.Build_BuildUri;
int buildId = context.Variables.Build_BuildId ?? 0;
string pullRequestTargetBranchName = context.Variables.System_PullRequest_TargetBranch;
string stageName = context.Variables.System_StageName;
string phaseName = context.Variables.System_PhaseName;
string jobName = context.Variables.System_JobName;
int stageAttempt = context.Variables.System_StageAttempt ?? 0;
int phaseAttempt = context.Variables.System_PhaseAttempt ?? 0;
int jobAttempt = context.Variables.System_JobAttempt ?? 0;
//Temporary fix to support publish in RM scenarios where there might not be a valid Build ID associated.
//TODO: Make a cleaner fix after TCM User Story 401703 is completed.
if (buildId == 0)
{
_platform = _configuration = null;
}
string releaseUri = null;
string releaseEnvironmentUri = null;
// Check to identify if we are in the Release management flow; if not, then release fields will be kept null while publishing to TCM
if (!string.IsNullOrWhiteSpace(context.Variables.Release_ReleaseUri))
{
releaseUri = context.Variables.Release_ReleaseUri;
releaseEnvironmentUri = context.Variables.Release_ReleaseEnvironmentUri;
}
IResultReader resultReader = GetTestResultReader(_testRunner);
TestRunContext runContext = new TestRunContext(owner, _platform, _configuration, buildId, buildUri, releaseUri, releaseEnvironmentUri);
runContext.StageName = stageName;
runContext.StageAttempt = stageAttempt;
runContext.PhaseName = phaseName;
runContext.PhaseAttempt = phaseAttempt;
runContext.JobName = jobName;
runContext.JobAttempt = jobAttempt;
runContext.PullRequestTargetBranchName = pullRequestTargetBranchName;
VssConnection connection = WorkerUtilities.GetVssConnection(_executionContext);
var publisher = HostContext.GetService <ITestRunPublisher>();
publisher.InitializePublisher(context, connection, teamProject, resultReader);
var commandContext = HostContext.CreateService <IAsyncCommandContext>();
commandContext.InitializeCommandContext(context, StringUtil.Loc("PublishTestResults"));
if (_mergeResults)
{
commandContext.Task = PublishAllTestResultsToSingleTestRunAsync(_testResultFiles, publisher, buildId, runContext, resultReader.Name, context.CancellationToken);
}
else
{
commandContext.Task = PublishToNewTestRunPerTestResultFileAsync(_testResultFiles, publisher, runContext, resultReader.Name, PublishBatchSize, context.CancellationToken);
}
_executionContext.AsyncCommands.Add(commandContext);
if (_isTestRunOutcomeFailed)
{
_executionContext.Result = TaskResult.Failed;
_executionContext.Error(StringUtil.Loc("FailedTestsInResults"));
}
}
private void ProcessArtifactAssociateCommand(IExecutionContext context, Dictionary <string, string> eventProperties, string data)
{
ArgUtil.NotNull(context, nameof(context));
ArgUtil.NotNull(context.Endpoints, nameof(context.Endpoints));
ServiceEndpoint systemConnection = context.Endpoints.FirstOrDefault(e => string.Equals(e.Name, ServiceEndpoints.SystemVssConnection, StringComparison.OrdinalIgnoreCase));
ArgUtil.NotNull(systemConnection, nameof(systemConnection));
ArgUtil.NotNull(systemConnection.Url, nameof(systemConnection.Url));
Uri projectUrl = systemConnection.Url;
VssCredentials projectCredential = ApiUtil.GetVssCredential(systemConnection);
Guid projectId = context.Variables.System_TeamProjectId ?? Guid.Empty;
ArgUtil.NotEmpty(projectId, nameof(projectId));
int?buildId = context.Variables.Build_BuildId;
ArgUtil.NotNull(buildId, nameof(buildId));
string artifactName;
if (!eventProperties.TryGetValue(ArtifactAssociateEventProperties.ArtifactName, out artifactName) ||
string.IsNullOrEmpty(artifactName))
{
throw new Exception(StringUtil.Loc("ArtifactNameRequired"));
}
string artifactLocation = data;
if (string.IsNullOrEmpty(artifactLocation))
{
throw new Exception(StringUtil.Loc("ArtifactLocationRequired"));
}
string artifactType;
if (!eventProperties.TryGetValue(ArtifactAssociateEventProperties.ArtifactType, out artifactType))
{
artifactType = InferArtifactResourceType(context, artifactLocation);
}
if (string.IsNullOrEmpty(artifactType))
{
throw new Exception(StringUtil.Loc("ArtifactTypeRequired"));
}
if (!IsUncSharePath(context, artifactLocation) && (context.Variables.System_HostType != HostTypes.Build))
{
throw new Exception(StringUtil.Loc("AssociateArtifactCommandNotSupported", context.Variables.System_HostType));
}
var propertyDictionary = ExtractArtifactProperties(eventProperties);
string artifactData = "";
if (IsContainerPath(artifactLocation) ||
IsValidServerPath(artifactLocation))
{
//if artifactlocation is a file container path or a tfvc server path
artifactData = artifactLocation;
}
else if (IsUncSharePath(context, artifactLocation))
{
//if artifactlocation is a UNC share path
artifactData = new Uri(artifactLocation).LocalPath;
}
else
{
throw new Exception(StringUtil.Loc("ArtifactLocationNotSupport", artifactLocation));
}
// queue async command task to associate artifact.
context.Debug($"Associate artifact: {artifactName} with build: {buildId.Value} at backend.");
var commandContext = HostContext.CreateService <IAsyncCommandContext>();
commandContext.InitializeCommandContext(context, StringUtil.Loc("AssociateArtifact"));
commandContext.Task = AssociateArtifactAsync(commandContext,
WorkerUtilities.GetVssConnection(context),
projectId,
buildId.Value,
artifactName,
artifactType,
artifactData,
propertyDictionary,
context.CancellationToken);
context.AsyncCommands.Add(commandContext);
}
private void ProcessArtifactUploadCommand(IExecutionContext context, Dictionary <string, string> eventProperties, string data)
{
ArgUtil.NotNull(context, nameof(context));
ArgUtil.NotNull(context.Endpoints, nameof(context.Endpoints));
Guid projectId = context.Variables.System_TeamProjectId ?? Guid.Empty;
ArgUtil.NotEmpty(projectId, nameof(projectId));
int?buildId = context.Variables.Build_BuildId;
ArgUtil.NotNull(buildId, nameof(buildId));
long?containerId = context.Variables.Build_ContainerId;
ArgUtil.NotNull(containerId, nameof(containerId));
string artifactName;
if (!eventProperties.TryGetValue(ArtifactAssociateEventProperties.ArtifactName, out artifactName) ||
string.IsNullOrEmpty(artifactName))
{
throw new Exception(StringUtil.Loc("ArtifactNameRequired"));
}
string containerFolder;
if (!eventProperties.TryGetValue(ArtifactUploadEventProperties.ContainerFolder, out containerFolder) ||
string.IsNullOrEmpty(containerFolder))
{
containerFolder = artifactName;
}
var propertyDictionary = ExtractArtifactProperties(eventProperties);
string localPath = data;
if (string.IsNullOrEmpty(localPath))
{
throw new Exception(StringUtil.Loc("ArtifactLocationRequired"));
}
if (!IsUncSharePath(context, localPath) && (context.Variables.System_HostType != HostTypes.Build))
{
throw new Exception(StringUtil.Loc("UploadArtifactCommandNotSupported", context.Variables.System_HostType));
}
string fullPath = Path.GetFullPath(localPath);
if (!File.Exists(fullPath) && !Directory.Exists(fullPath))
{
// if localPath is not a file or folder on disk
throw new FileNotFoundException(StringUtil.Loc("PathNotExist", localPath));
}
else if (Directory.Exists(fullPath) && Directory.EnumerateFiles(fullPath, "*", SearchOption.AllDirectories).FirstOrDefault() == null)
{
// if localPath is a folder but the folder contains nothing
context.Warning(StringUtil.Loc("DirectoryIsEmptyForArtifact", fullPath, artifactName));
return;
}
// queue async command task to associate artifact.
context.Debug($"Upload artifact: {fullPath} to server for build: {buildId.Value} at backend.");
var commandContext = HostContext.CreateService <IAsyncCommandContext>();
commandContext.InitializeCommandContext(context, StringUtil.Loc("UploadArtifact"));
commandContext.Task = UploadArtifactAsync(commandContext,
WorkerUtilities.GetVssConnection(context),
projectId,
containerId.Value,
containerFolder,
buildId.Value,
artifactName,
propertyDictionary,
fullPath,
context.CancellationToken);
context.AsyncCommands.Add(commandContext);
}
private async Task PublishCodeCoverageAsync(
IExecutionContext executionContext,
IAsyncCommandContext commandContext,
ICodeCoveragePublisher codeCoveragePublisher,
IEnumerable <CodeCoverageStatistics> coverageData,
string project,
Guid projectId,
long containerId,
CancellationToken cancellationToken)
{
//step 2: publish code coverage summary to TFS
if (coverageData != null && coverageData.Count() > 0)
{
commandContext.Output(StringUtil.Loc("PublishingCodeCoverage"));
foreach (var coverage in coverageData)
{
commandContext.Output(StringUtil.Format(" {0}- {1} of {2} covered.", coverage.Label, coverage.Covered, coverage.Total));
}
await codeCoveragePublisher.PublishCodeCoverageSummaryAsync(commandContext, coverageData, project, cancellationToken);
}
// step 3: publish code coverage files as build artifacts
string additionalCodeCoverageFilePath = null;
string destinationSummaryFile = null;
var newReportDirectory = _reportDirectory;
try
{
var filesToPublish = new List <Tuple <string, string> >();
if (!Directory.Exists(newReportDirectory))
{
if (!string.IsNullOrWhiteSpace(newReportDirectory))
{
// user gave a invalid report directory. Write warning and continue.
executionContext.Warning(StringUtil.Loc("DirectoryNotFound", newReportDirectory));
}
newReportDirectory = GetCoverageDirectory(_buildId.ToString(), CodeCoverageConstants.ReportDirectory);
Directory.CreateDirectory(newReportDirectory);
}
var summaryFileName = Path.GetFileName(_summaryFileLocation);
destinationSummaryFile = Path.Combine(newReportDirectory, CodeCoverageConstants.SummaryFileDirectory + _buildId, summaryFileName);
Directory.CreateDirectory(Path.GetDirectoryName(destinationSummaryFile));
File.Copy(_summaryFileLocation, destinationSummaryFile, true);
commandContext.Output(StringUtil.Loc("ModifyingCoberturaIndexFile"));
ModifyCoberturaIndexDotHTML(newReportDirectory, executionContext);
filesToPublish.Add(new Tuple <string, string>(newReportDirectory, GetCoverageDirectoryName(_buildId.ToString(), CodeCoverageConstants.ReportDirectory)));
if (_additionalCodeCoverageFiles != null && _additionalCodeCoverageFiles.Count != 0)
{
additionalCodeCoverageFilePath = GetCoverageDirectory(_buildId.ToString(), CodeCoverageConstants.RawFilesDirectory);
CodeCoverageUtilities.CopyFilesFromFileListWithDirStructure(_additionalCodeCoverageFiles, ref additionalCodeCoverageFilePath);
filesToPublish.Add(new Tuple <string, string>(additionalCodeCoverageFilePath, GetCoverageDirectoryName(_buildId.ToString(), CodeCoverageConstants.RawFilesDirectory)));
}
commandContext.Output(StringUtil.Loc("PublishingCodeCoverageFiles"));
ChangeHtmExtensionToHtmlIfRequired(newReportDirectory, executionContext);
await codeCoveragePublisher.PublishCodeCoverageFilesAsync(commandContext, projectId, executionContext.Variables.System_JobId, containerId, filesToPublish, File.Exists(Path.Combine(newReportDirectory, CodeCoverageConstants.DefaultIndexFile)), cancellationToken);
}
catch (SocketException ex)
{
#pragma warning disable CA2000 // Dispose objects before losing scope
ExceptionsUtil.HandleSocketException(ex, WorkerUtilities.GetVssConnection(executionContext).Uri.ToString(), executionContext.Warning);
#pragma warning restore CA2000 // Dispose objects before losing scope
}
catch (Exception ex)
{
executionContext.Warning(StringUtil.Loc("ErrorOccurredWhilePublishingCCFiles", ex.Message));
}
finally
{
// clean temporary files.
if (!string.IsNullOrEmpty(additionalCodeCoverageFilePath))
{
if (Directory.Exists(additionalCodeCoverageFilePath))
{
Directory.Delete(path: additionalCodeCoverageFilePath, recursive: true);
}
}
if (!string.IsNullOrEmpty(destinationSummaryFile))
{
var summaryFileDirectory = Path.GetDirectoryName(destinationSummaryFile);
if (Directory.Exists(summaryFileDirectory))
{
Directory.Delete(path: summaryFileDirectory, recursive: true);
}
}
if (!Directory.Exists(_reportDirectory))
{
if (Directory.Exists(newReportDirectory))
{
//delete the generated report directory
Directory.Delete(path: newReportDirectory, recursive: true);
}
}
}
}
public void Execute(IExecutionContext context, Command command)
{
ArgUtil.NotNull(context, nameof(context));
ArgUtil.NotNull(context.Endpoints, nameof(context.Endpoints));
ArgUtil.NotNull(command, nameof(command));
var eventProperties = command.Properties;
var data = command.Data;
ServiceEndpoint systemConnection = context.Endpoints.FirstOrDefault(e => string.Equals(e.Name, WellKnownServiceEndpointNames.SystemVssConnection, StringComparison.OrdinalIgnoreCase));
ArgUtil.NotNull(systemConnection, nameof(systemConnection));
ArgUtil.NotNull(systemConnection.Url, nameof(systemConnection.Url));
Uri projectUrl = systemConnection.Url;
VssCredentials projectCredential = VssUtil.GetVssCredential(systemConnection);
Guid projectId = context.Variables.System_TeamProjectId ?? Guid.Empty;
ArgUtil.NotEmpty(projectId, nameof(projectId));
int?buildId = context.Variables.Build_BuildId;
ArgUtil.NotNull(buildId, nameof(buildId));
string artifactName;
if (!eventProperties.TryGetValue(ArtifactAssociateEventProperties.ArtifactName, out artifactName) ||
string.IsNullOrEmpty(artifactName))
{
throw new Exception(StringUtil.Loc("ArtifactNameRequired"));
}
string artifactType;
if (!eventProperties.TryGetValue(ArtifactAssociateEventProperties.ArtifactType, out artifactType))
{
artifactType = ArtifactCommandExtensionUtil.InferArtifactResourceType(context, data);
}
if (string.IsNullOrEmpty(artifactType))
{
throw new Exception(StringUtil.Loc("ArtifactTypeRequired"));
}
else if ((artifactType.Equals(ArtifactResourceTypes.Container, StringComparison.OrdinalIgnoreCase) ||
artifactType.Equals(ArtifactResourceTypes.FilePath, StringComparison.OrdinalIgnoreCase) ||
artifactType.Equals(ArtifactResourceTypes.VersionControl, StringComparison.OrdinalIgnoreCase)) &&
string.IsNullOrEmpty(data))
{
throw new Exception(StringUtil.Loc("ArtifactLocationRequired"));
}
if (!artifactType.Equals(ArtifactResourceTypes.FilePath, StringComparison.OrdinalIgnoreCase) &&
context.Variables.System_HostType != HostTypes.Build)
{
throw new Exception(StringUtil.Loc("AssociateArtifactCommandNotSupported", context.Variables.System_HostType));
}
var propertyDictionary = ArtifactCommandExtensionUtil.ExtractArtifactProperties(eventProperties);
string artifactData = "";
if (ArtifactCommandExtensionUtil.IsContainerPath(data) ||
ArtifactCommandExtensionUtil.IsValidServerPath(data))
{
//if data is a file container path or a tfvc server path
artifactData = data;
}
else if (ArtifactCommandExtensionUtil.IsUncSharePath(context, data))
{
//if data is a UNC share path
artifactData = new Uri(data).LocalPath;
}
else
{
artifactData = data ?? string.Empty;
}
// queue async command task to associate artifact.
context.Debug($"Associate artifact: {artifactName} with build: {buildId.Value} at backend.");
var commandContext = context.GetHostContext().CreateService <IAsyncCommandContext>();
commandContext.InitializeCommandContext(context, StringUtil.Loc("AssociateArtifact"));
commandContext.Task = ArtifactCommandExtensionUtil.AssociateArtifactAsync(commandContext,
WorkerUtilities.GetVssConnection(context),
projectId,
buildId.Value,
artifactName,
context.Variables.System_JobId,
artifactType,
artifactData,
propertyDictionary,
context.CancellationToken);
context.AsyncCommands.Add(commandContext);
}
