Skip to content
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

Plugin Tool CLI: avoid NRE during package creation #406

Merged
merged 6 commits into from
Feb 3, 2025
Merged

Plugin Tool CLI: avoid NRE during package creation #406

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
04cbb5b
Update error handling during plugin CLI packaging
mslukebo Jan 30, 2025
84b83dc
Follow docstrings
mslukebo Jan 30, 2025
23a7bea
Organize imports
mslukebo Jan 30, 2025
99926cd
Rename variables
mslukebo Jan 30, 2025
f99224f
Move check
mslukebo Jan 31, 2025
c7fe620
Return false
mslukebo Jan 31, 2025
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
126 changes: 117 additions & 9 deletions ...em/Tools/Microsoft.Performance.Toolkit.Plugins.Cli/Processing/PluginArtifactsProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
using Microsoft.Performance.Toolkit.Plugins.Core;
using Microsoft.Performance.Toolkit.Plugins.Core.Metadata;
using NuGet.Versioning;
using LicenseInfo = Microsoft.Performance.Toolkit.Plugins.Core.Metadata.LicenseInfo;
using ProcessingSourceInfo = Microsoft.Performance.Toolkit.Plugins.Core.Metadata.ProcessingSourceInfo;
using ProjectInfo = Microsoft.Performance.Toolkit.Plugins.Core.Metadata.ProjectInfo;

namespace Microsoft.Performance.Toolkit.Plugins.Cli.Processing
{
Expand Down Expand Up @@ -311,29 +313,135 @@ private bool TryGetAboutInfo(ProcessingSourceReference psr, [NotNullWhen(true)]
if (methodInfo == null || methodInfo.DeclaringType == typeof(ProcessingSource))
{
this.logger.LogError($"Unable to generate processing source info: {psr.Name} does not override the virtual method {nameof(ProcessingSource)}.{nameof(ProcessingSource.GetAboutInfo)}.");
return false;
}
mslukebo marked this conversation as resolved.
Show resolved Hide resolved

List<string> errors = new();

if (!TryGetOwners(psr, aboutInfo, out Core.Metadata.ContactInfo[]? owners, out string? ownersError))
{
errors.Add(ownersError);
}

if (!TryGetProjectInfo(psr, aboutInfo, out ProjectInfo? projectInfo, out string? projectInfoError))
{
errors.Add(projectInfoError);
}

if (!TryGetLicenseInfo(psr, aboutInfo, out LicenseInfo? licenseInfo, out string? licenseInfoError))
{
errors.Add(licenseInfoError);
}

if (errors.Any())
{
this.logger.LogError($"Unable to generate processing source info. The following error{ (errors.Count == 1 ? " was" : "s were") } encountered:{string.Join("", errors.Select(e => $"\n\t - {e}"))}");
return false;
}

var owners = aboutInfo.Owners
.Select(o => new Core.Metadata.ContactInfo(o.Name, o.Address, o.EmailAddresses, o.PhoneNumbers))
processingSourceInfo = new ProcessingSourceInfo(owners, projectInfo, licenseInfo, aboutInfo.CopyrightNotice, aboutInfo.AdditionalInformation);
return true;
}

private bool TryGetOwners(
ProcessingSourceReference processSource,
Microsoft.Performance.SDK.Processing.ProcessingSourceInfo info,
[NotNullWhen(true)] out Core.Metadata.ContactInfo[]? owners,
[NotNullWhen(false)] out string? error)
{
error = null;
owners = null;

if (info.Owners == null)
{
error = $"The {nameof(ProcessingSourceInfo.Owners)} property of {processSource.Name}'s {nameof(ProcessingSourceInfo)} is null.";
return false;
}

owners = info.Owners
.Select(o => new Core.Metadata.ContactInfo(o.Name, o.Address, o.EmailAddresses ?? [], o.PhoneNumbers ?? []))
.ToArray();

if (!Uri.TryCreate(aboutInfo.ProjectInfo.Uri, UriKind.Absolute, out Uri? projectUri))
if (owners.Any(o => o.EmailAddresses.Any(string.IsNullOrWhiteSpace)))
{
this.logger.LogError($"Unable to generate processing source info: {aboutInfo.ProjectInfo.Uri} is not an absolute URI.");
error = $"One or more of the {nameof(ProcessingSourceInfo.Owners)}'s {nameof(Core.Metadata.ContactInfo.EmailAddresses)} on {processSource.Name}'s {nameof(ProcessingSourceInfo)} is null or whitespace.";
}
mslukebo marked this conversation as resolved.
Show resolved Hide resolved

if (owners.Any(o => o.PhoneNumbers.Any(string.IsNullOrWhiteSpace)))
{
error = $"One or more of the {nameof(ProcessingSourceInfo.Owners)}'s {nameof(Core.Metadata.ContactInfo.PhoneNumbers)} on {processSource.Name}'s {nameof(ProcessingSourceInfo)} is null or whitespace.";
}
mslukebo marked this conversation as resolved.
Show resolved Hide resolved

return true;
}

private bool TryGetProjectInfo(
ProcessingSourceReference processSource,
Microsoft.Performance.SDK.Processing.ProcessingSourceInfo processingSourceInfo,
out ProjectInfo? projectInfo,
[NotNullWhen(false)] out string? error)
{
error = null;
projectInfo = null;

if (processingSourceInfo.ProjectInfo == null)
{
// This is an optional field
projectInfo = null;
return true;
}

if (processingSourceInfo.ProjectInfo.Uri == null)
{
error = $"The {nameof(ProcessingSourceInfo.ProjectInfo)}.{nameof(ProcessingSourceInfo.ProjectInfo.Uri)} property of {processSource.Name}'s {nameof(ProcessingSourceInfo)} is null.";
return false;
}

if (!Uri.TryCreate(processingSourceInfo.ProjectInfo.Uri, UriKind.Absolute, out Uri? uri))
{
error = $"{processingSourceInfo.ProjectInfo.Uri} is not an absolute URI.";
return false;
}

Core.Metadata.ProjectInfo projectInfo = new(projectUri);
projectInfo = new ProjectInfo(uri);
return true;
}

private bool TryGetLicenseInfo(
ProcessingSourceReference processSource,
Microsoft.Performance.SDK.Processing.ProcessingSourceInfo processingSourceInfo,
out LicenseInfo? licenseInfo,
[NotNullWhen(false)] out string? error)
{
error = null;
licenseInfo = null;

if (processingSourceInfo.LicenseInfo == null)
{
// This is an optional field
licenseInfo = null;
return true;
}

if (processingSourceInfo.LicenseInfo.Uri == null)
{
error = $"The {nameof(ProcessingSourceInfo.LicenseInfo)}.{nameof(ProcessingSourceInfo.LicenseInfo.Uri)} property of {processSource.Name}'s {nameof(ProcessingSourceInfo)} is null.";
return false;
}

if (!Uri.TryCreate(aboutInfo.LicenseInfo.Uri, UriKind.Absolute, out Uri? licenseUri))
if (string.IsNullOrWhiteSpace(processingSourceInfo.LicenseInfo.Name))
{
this.logger.LogError($"Unable to generate processing source info: {aboutInfo.LicenseInfo.Uri} is not an absolute URI.");
error = $"The {nameof(ProcessingSourceInfo.LicenseInfo)}.{nameof(ProcessingSourceInfo.LicenseInfo.Name)} property of {processSource.Name}'s {nameof(ProcessingSourceInfo)} is null or whitespace.";
return false;
}

Core.Metadata.LicenseInfo licenseInfo = new(aboutInfo.LicenseInfo.Name, licenseUri, aboutInfo.LicenseInfo.Text);
if (!Uri.TryCreate(processingSourceInfo.LicenseInfo.Uri, UriKind.Absolute, out Uri? uri))
{
error = $"{processingSourceInfo.LicenseInfo.Uri} is not an absolute URI.";
return false;
}

processingSourceInfo = new ProcessingSourceInfo(owners, projectInfo, licenseInfo, aboutInfo.CopyrightNotice, aboutInfo.AdditionalInformation);
licenseInfo = new LicenseInfo(processingSourceInfo.LicenseInfo.Name, uri, processingSourceInfo.LicenseInfo.Text);
return true;
}

Expand Down
Loading