Skip to content

Point CI Reliability report tool to NuGet.Client CI pipeline #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
donnie-msft merged 2 commits into from
Jul 9, 2024
Merged

Point CI Reliability report tool to NuGet.Client CI pipeline #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6633417
Point CI Reliability report tool to NuGet.Client CI pipeline
donnie-msft Jun 28, 2024
710cacd
Support multiple pipelines in Reliability Report
donnie-msft Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 96 additions & 41 deletions GithubIssueTagger/Reports/CiReliability/CiReliabilityReport.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,38 @@ public async Task RunAsync(string sprintName, string outFile)
{
using FileStream fileStream = OpenOutputFile(outFile);

ReportData data = await GetDataAsync(sprintName);
PipelineData buildPipelineData = new PipelineData()
{
PipelineName = "NuGet.Client-PrivateDev",
BranchFilterQueryString = "101196%2C101196%2C101196%2C101196%2C101196",
DatabaseName = "AzureDevOps",
OrganizationName = "devdiv",
ProjectId = "0bdbc590-a062-4c3f-b0f6-9383f67865ee",
ProjectName = "DevDiv",
DefinitionId = "8118",
SourceBranch = "refs/heads/dev",
Reason = "schedule",
};

ReportData buildReportData = await GetDataAsync(sprintName, queryName: "dev branch builds", buildPipelineData);

PipelineData funcUnitTestPipelineData = new PipelineData()
{
PipelineName = "NuGet.Client CI",
DatabaseName = "AzureDevOps",
BranchFilterQueryString = "86197%2C86197%2C86197",
OrganizationName = "dnceng-public",
ProjectId = "cbb18261-c48f-4abb-8651-8cdcb5474649",
ProjectName = "public",
DefinitionId = "289",
SourceBranch = "refs/heads/dev",
Reason = "individualCI",
};

Output(data, fileStream);
ReportData funcUnitTestReportData = await GetDataAsync(sprintName, queryName: "dev branch Functional & Unit tests", funcUnitTestPipelineData);

var data = new Tuple<PipelineData, ReportData>[] { new(buildPipelineData, buildReportData), new(funcUnitTestPipelineData, funcUnitTestReportData) };
Output(data, fileStream, reportSprintName: sprintName);
}

private FileStream OpenOutputFile(string outFile)
Expand All @@ -52,7 +81,7 @@ private FileStream OpenOutputFile(string outFile)
return fileStream;
}

private async Task<ReportData> GetDataAsync(string sprintName)
private async Task<ReportData> GetDataAsync(string sprintName, string queryName, PipelineData pipelineData)
{
TextWriter? log;
if (Console.IsOutputRedirected)
Expand All @@ -71,11 +100,11 @@ private async Task<ReportData> GetDataAsync(string sprintName)
string failedBuildsQuery = $@"let start = startofday(datetime(""{startOfSprint.ToString("yyyy-MM-dd")}""));
let end = endofday(datetime(""{endOfSprint.ToString("yyyy-MM-dd")}""));
let nugetBuilds = Build
| where OrganizationName == 'devdiv' and ProjectId == '0bdbc590-a062-4c3f-b0f6-9383f67865ee' and DefinitionId == 8118 and FinishTime between (start..end) and SourceBranch == 'refs/heads/dev' and Reason == 'schedule';
| where OrganizationName == '{pipelineData.OrganizationName}' and ProjectId == '{pipelineData.ProjectId}' and DefinitionId == {pipelineData.DefinitionId} and FinishTime between (start..end) and SourceBranch == '{pipelineData.SourceBranch}' and Reason == '{pipelineData.Reason}';
let sprintBuilds = nugetBuilds
| project BuildId;
let previousAttempts = BuildTimelineRecord
| where OrganizationName == 'devdiv' and ProjectId == '0bdbc590-a062-4c3f-b0f6-9383f67865ee' and BuildId in (sprintBuilds)
| where OrganizationName == '{pipelineData.OrganizationName}' and ProjectId == '{pipelineData.ProjectId}' and BuildId in (sprintBuilds)
| summarize PreviousAttempts=countif(PreviousAttempts !in ('', '[]')) by BuildId
| where PreviousAttempts > 0
| project BuildId;
Expand All @@ -86,10 +115,10 @@ private async Task<ReportData> GetDataAsync(string sprintName)
string buildCountQuery = $@"let start = startofday(datetime(""{startOfSprint.ToString("yyyy-MM-dd")}""));
let end = endofday(datetime(""{endOfSprint.ToString("yyyy-MM-dd")}""));
Build
| where OrganizationName == 'devdiv' and ProjectId == '0bdbc590-a062-4c3f-b0f6-9383f67865ee' and DefinitionId == 8118 and FinishTime between (start..end) and SourceBranch == 'refs/heads/dev'
| where OrganizationName == '{pipelineData.OrganizationName}' and ProjectId == '{pipelineData.ProjectId}' and DefinitionId == {pipelineData.DefinitionId} and FinishTime between (start..end) and SourceBranch == '{pipelineData.SourceBranch}'
| summarize count()";

var connectionBuilder = new KustoConnectionStringBuilder("https://1es.kusto.windows.net/", "AzureDevOps")
var connectionBuilder = new KustoConnectionStringBuilder("https://1es.kusto.windows.net/", pipelineData.DatabaseName)
{
FederatedSecurity = true
};
Expand All @@ -102,15 +131,18 @@ private async Task<ReportData> GetDataAsync(string sprintName)

using (var client = KustoClientFactory.CreateCslQueryProvider(connectionBuilder))
{
log?.WriteLine("Query arguments: pipelineName =" + pipelineData.PipelineName + " | " + "organizationName = " + pipelineData.OrganizationName + " | " + "projectId=" + pipelineData.ProjectId + " | " + "definitionId ="
+ pipelineData.DefinitionId + " | " + "sourceBranch=" + pipelineData.SourceBranch + " | " + "reason=" + pipelineData.Reason);
log?.WriteLine($"Querying builds from {startOfSprint:yyyy-MM-dd} to {endOfSprint:yyyy-MM-dd}");
var (failedBuilds, trackingIssues) = await GetFailedBuilds(client, crp, failedBuildsQuery, log);
var (failedBuilds, trackingIssues) = await GetFailedBuilds(client, crp, failedBuildsQuery, pipelineData, log);

log?.WriteLine("Querying total builds in sprint");
int totalBuilds = await GetBuildCount(client, crp, buildCountQuery);
int totalBuilds = await GetBuildCount(client, crp, buildCountQuery, pipelineData);

data = new ReportData()
{
SprintName = sprintName,
QueryName = queryName,
KustoQuery = failedBuildsQuery,
FailedBuilds = failedBuilds,
TrackingIssues = trackingIssues,
Expand All @@ -121,9 +153,9 @@ private async Task<ReportData> GetDataAsync(string sprintName)
return data;
}

private async Task<int> GetBuildCount(ICslQueryProvider client, ClientRequestProperties crp, string query)
private async Task<int> GetBuildCount(ICslQueryProvider client, ClientRequestProperties crp, string query, PipelineData pipelineData)
{
using var result = await client.ExecuteQueryAsync("AzureDevOps", query, crp);
using var result = await client.ExecuteQueryAsync(pipelineData.DatabaseName, query, crp);

if (!result.Read())
{
Expand All @@ -141,12 +173,13 @@ private async Task<int> GetBuildCount(ICslQueryProvider client, ClientRequestPro
ICslQueryProvider client,
ClientRequestProperties crp,
string query,
PipelineData pipelineData,
TextWriter? log)
{
List<ReportData.FailedBuild> failedBuilds = new();
Dictionary<string, string> trackingIssues = new();

var result = await client.ExecuteQueryAsync("AzureDevOps", query, crp);
var result = await client.ExecuteQueryAsync(pipelineData.DatabaseName, query, crp);

int buildIdColumn = result.GetOrdinal("BuildId");
int buildNumberColumn = result.GetOrdinal("BuildNumber");
Expand All @@ -168,7 +201,7 @@ private async Task<int> GetBuildCount(ICslQueryProvider client, ClientRequestPro
{
log?.WriteLine($"Checking failed build {i + 1}/{failedBuilds.Count}");

var (details, tracking) = await GetFailedBuildDetails(failedBuilds[i].Id, client, crp);
var (details, tracking) = await GetFailedBuildDetails(failedBuilds[i].Id, client, crp, pipelineData);

foreach (var kvp in tracking)
{
Expand All @@ -190,16 +223,17 @@ private async Task<int> GetBuildCount(ICslQueryProvider client, ClientRequestPro
private async Task<(IReadOnlyList<ReportData.FailureDetail> details, IReadOnlyDictionary<string, string> tracking)> GetFailedBuildDetails(
long buildId,
ICslQueryProvider client,
ClientRequestProperties crp)
ClientRequestProperties crp,
PipelineData pipelineData)
{
List<ReportData.FailureDetail> details = new();
Dictionary<string, string> trackingIssues = new();

List<Dictionary<string, object>> rows = new();

var query = @"BuildTimelineRecord
| where OrganizationName == 'devdiv' and ProjectId == '0bdbc590-a062-4c3f-b0f6-9383f67865ee' and BuildId == " + buildId;
using (var result = await client.ExecuteQueryAsync("AzureDevOps", query, crp))
var query = $@"BuildTimelineRecord
| where OrganizationName == '{pipelineData.OrganizationName}' and ProjectId == '{pipelineData.ProjectId}' and BuildId == {buildId}";
using (var result = await client.ExecuteQueryAsync(pipelineData.DatabaseName, query, crp))
{
while (result.Read())
{
Expand Down Expand Up @@ -293,26 +327,57 @@ bool IsFailedTask(Dictionary<string, object> timelineEntry, string parentId)
}
}

private void Output(ReportData data, FileStream outputFileStream)
private void Output(Tuple<PipelineData, ReportData>[] pipelineReportDataList, FileStream outputFileStream, string reportSprintName)
{
if (data == null) { throw new ArgumentNullException(nameof(data)); }
if (outputFileStream is null || !outputFileStream.CanRead || !outputFileStream.CanWrite) { throw new ArgumentException(paramName: nameof(outputFileStream), message: "Cannot read and write to output file"); }
if (data.FailedBuilds == null) { throw new ArgumentException(paramName: nameof(data.FailedBuilds), message: "data.FailedBuilds must not be null"); }
using var sw = new StreamWriter(outputFileStream, new UTF8Encoding(encoderShouldEmitUTF8Identifier: false));

float reliability = (data.TotalBuilds - data.FailedBuilds.Count) * 100.0f / data.TotalBuilds;
int failedBuildsOnlyBecauseOfApex = data.FailedBuilds.Where(b => b.Details?.Count == 1 && b.Details[0].Job == "Apex Test Execution").Count();
float reliabilityIgnoringApex = (data.TotalBuilds - data.FailedBuilds.Count + failedBuildsOnlyBecauseOfApex) * 100.0f / data.TotalBuilds;
sw.WriteLine($"# NuGet Client CI Reliability " + reportSprintName);

using var sw = new StreamWriter(outputFileStream, new UTF8Encoding(encoderShouldEmitUTF8Identifier: false));
sw.WriteLine("# NuGet.Client CI Reliability " + data.SprintName);
foreach (var pipelineReportData in pipelineReportDataList)
{
var pipelineData = pipelineReportData.Item1;
var data = pipelineReportData.Item2;
if (data == null) { throw new ArgumentNullException(nameof(data)); }
if (data.FailedBuilds == null) { throw new ArgumentException(paramName: nameof(data.FailedBuilds), message: "data.FailedBuilds must not be null"); }

float reliability = (data.TotalBuilds - data.FailedBuilds.Count) * 100.0f / data.TotalBuilds;
int failedBuildsOnlyBecauseOfApex = data.FailedBuilds.Where(b => b.Details?.Count == 1 && b.Details[0].Job == "Apex Test Execution").Count();
float reliabilityIgnoringApex = (data.TotalBuilds - data.FailedBuilds.Count + failedBuildsOnlyBecauseOfApex) * 100.0f / data.TotalBuilds;

OutputPipelineData(pipelineData, data, reliability, reliabilityIgnoringApex, sw);

sw.WriteLine();
sw.WriteLine();
sw.WriteLine("### Tracking");
if (data.TrackingIssues.Count == 0)
{
sw.WriteLine("No tracking issues");
}
else
{
foreach (var kvp in data.TrackingIssues)
{
sw.WriteLine();
sw.WriteLine($"- {kvp.Key}");
sw.WriteLine();
sw.WriteLine(kvp.Value);
}
}
}
}

private static void OutputPipelineData(PipelineData pipelineData, ReportData data, float reliability, float reliabilityIgnoringApex, StreamWriter sw)
{
sw.WriteLine($"## {pipelineData.PipelineName}");
sw.WriteLine();
sw.WriteLine("[NuGet.Client-PR dev branch builds](https://dev.azure.com/devdiv/DevDiv/_build?definitionId=8118&branchFilter=101196%2C101196%2C101196%2C101196%2C101196)");
sw.WriteLine($"[{pipelineData.PipelineName} {data.QueryName}](https://dev.azure.com/{pipelineData.OrganizationName}/{pipelineData.ProjectName}/_build?definitionId={pipelineData.DefinitionId}&branchFilter={pipelineData.BranchFilterQueryString})");
sw.WriteLine();
sw.WriteLine("|Total Builds|Failed Builds|Reliability|Reliability Ignoring Apex|");
sw.WriteLine("|:--:|:--:|:--:|:--:|");
sw.WriteLine($"|{data.TotalBuilds}|{data.FailedBuilds.Count}|{reliability:f1}%|{reliabilityIgnoringApex:f1}%|");
sw.WriteLine();
sw.WriteLine("## Failed Builds");
sw.WriteLine("### Failed Builds");
sw.WriteLine();
sw.WriteLine("**Note:**: Includes builds that succeeded on retry, so first attempt failed");
sw.WriteLine();
Expand All @@ -339,11 +404,11 @@ private void Output(ReportData data, FileStream outputFileStream)
{
if (build.Details.Count > 1)
{
sw.WriteLine($" <td rowspan=\"{build.Details.Count}\"><a href=\"https://dev.azure.com/devdiv/DevDiv/_build/results?buildId={build.Id}\">{build.Number}</a></td>");
sw.WriteLine($" <td rowspan=\"{build.Details.Count}\"><a href=\"https://dev.azure.com/{pipelineData.OrganizationName}/{pipelineData.ProjectName}/_build/results?buildId={build.Id}\">{build.Number}</a></td>");
}
else
{
sw.WriteLine($" <td><a href=\"https://dev.azure.com/devdiv/DevDiv/_build/results?buildId={build.Id}\">{build.Number}</a></td>");
sw.WriteLine($" <td><a href=\"https://dev.azure.com/{pipelineData.OrganizationName}/{pipelineData.ProjectName}/_build/results?buildId={build.Id}\">{build.Number}</a></td>");
}
}
sw.WriteLine($" <td>{build.Details[i].Job}</td>");
Expand All @@ -353,16 +418,6 @@ private void Output(ReportData data, FileStream outputFileStream)
}
}
sw.WriteLine("</table>");
sw.WriteLine();
sw.WriteLine("### Tracking");

foreach (var kvp in data.TrackingIssues)
{
sw.WriteLine();
sw.WriteLine($"- {kvp.Key}");
sw.WriteLine();
sw.WriteLine(kvp.Value);
}
}

private class CiReliabilityCommandFactory : ICommandFactory
Expand All @@ -389,7 +444,7 @@ public Command CreateCommand(Type type, GitHubPatBinder patBinder)
return command;
}

public async Task RunAsync(string sprint, string outfile)
public async Task RunAsync(string sprint, string outFile)
{
var serviceProvider = new ServiceCollection()
.AddGithubIssueTagger()
Expand All @@ -399,7 +454,7 @@ public async Task RunAsync(string sprint, string outfile)
using (scopeFactory.CreateScope())
{
var report = serviceProvider.GetRequiredService<CiReliabilityReport>();
await report.RunAsync(sprint, outfile);
await report.RunAsync(sprint, outFile);
}
}
}
Expand Down
15 changes: 15 additions & 0 deletions GithubIssueTagger/Reports/CiReliability/PipelineData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
namespace GithubIssueTagger.Reports.CiReliability
{
internal struct PipelineData
{
public string? PipelineName { get; init; }
public string? BranchFilterQueryString { get; init; }
public string? DatabaseName { get; init; }
public string? OrganizationName { get; init; }
public string? ProjectId { get; init; }
public string? ProjectName { get; init; }
public string? DefinitionId { get; init; }
public string? SourceBranch { get; init; }
public string? Reason { get; init; }
}
}
2 changes: 2 additions & 0 deletions GithubIssueTagger/Reports/CiReliability/ReportData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ internal class ReportData
{
public string? SprintName { get; init; }

public string? QueryName { get; init; }

public string? KustoQuery { get; init; }

public required IReadOnlyList<FailedBuild> FailedBuilds { get; init; }
Expand Down