Skip to content

Adds text and markdown reporter for the MinimalCsomPermissionsPlugin. Closes #1082 #1086

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
garrytrinder merged 1 commit into from
Mar 29, 2025
Merged

Adds text and markdown reporter for the MinimalCsomPermissionsPlugin. Closes #1082 #1086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions dev-proxy-plugins/Reporters/MarkdownReporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ public class MarkdownReporter(IPluginEvents pluginEvents, IProxyContext context,
{ typeof(HttpFileGeneratorPlugin), TransformHttpFileGeneratorReport },
{ typeof(GraphMinimalPermissionsGuidancePluginReport), TransformGraphMinimalPermissionsGuidanceReport },
{ typeof(GraphMinimalPermissionsPluginReport), TransformGraphMinimalPermissionsReport },
{ typeof(MinimalCsomPermissionsPluginReport), TransformMinimalCsomPermissionsReport },
{ typeof(MinimalPermissionsPluginReport), TransformMinimalPermissionsReport },
{ typeof(OpenApiSpecGeneratorPluginReport), TransformOpenApiSpecGeneratorReport },
{ typeof(UrlDiscoveryPluginReport), TransformUrlDiscoveryReport }
Expand Down Expand Up @@ -577,4 +578,39 @@ void transformPermissionsInfo(GraphMinimalPermissionsInfo permissionsInfo, strin

return sb.ToString();
}

private static string? TransformMinimalCsomPermissionsReport(object report)
{
var minimalPermissionsReport = (MinimalCsomPermissionsPluginReport)report;

var sb = new StringBuilder();
sb.AppendLine($"# Minimal CSOM permissions report");
sb.AppendLine();

sb.AppendLine("## Actions");
sb.AppendLine();
sb.AppendJoin(Environment.NewLine, minimalPermissionsReport.Actions.Select(a => $"- {a}"));
sb.AppendLine();

sb.AppendLine();
sb.AppendLine("## Minimal permissions");
sb.AppendLine();
sb.AppendJoin(Environment.NewLine, minimalPermissionsReport.MinimalPermissions.Select(p => $"- {p}"));
sb.AppendLine();

if (minimalPermissionsReport.Errors.Length != 0)
{
sb.AppendLine();
sb.AppendLine("## 🛑 Errors");
sb.AppendLine();
sb.AppendLine("Couldn't determine minimal permissions for the following actions:");
sb.AppendLine();
sb.AppendJoin(Environment.NewLine, minimalPermissionsReport.Errors.Select(e => $"- {e}"));
sb.AppendLine();
}

sb.AppendLine();

return sb.ToString();
}
}
30 changes: 30 additions & 0 deletions dev-proxy-plugins/Reporters/PlainTextReporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ public class PlainTextReporter(IPluginEvents pluginEvents, IProxyContext context
{ typeof(HttpFileGeneratorPluginReport), TransformHttpFileGeneratorReport },
{ typeof(GraphMinimalPermissionsGuidancePluginReport), TransformGraphMinimalPermissionsGuidanceReport },
{ typeof(GraphMinimalPermissionsPluginReport), TransformGraphMinimalPermissionsReport },
{ typeof(MinimalCsomPermissionsPluginReport), TransformMinimalCsomPermissionsReport },
{ typeof(MinimalPermissionsPluginReport), TransformMinimalPermissionsReport },
{ typeof(OpenApiSpecGeneratorPluginReport), TransformOpenApiSpecGeneratorReport },
{ typeof(UrlDiscoveryPluginReport), TransformUrlDiscoveryReport }
Expand Down Expand Up @@ -510,4 +511,33 @@ void transformPermissionsInfo(GraphMinimalPermissionsInfo permissionsInfo, strin

return sb.ToString();
}

private static string? TransformMinimalCsomPermissionsReport(object report)
{
var minimalPermissionsReport = (MinimalCsomPermissionsPluginReport)report;

var sb = new StringBuilder();

sb.AppendLine($"Minimal CSOM permissions report");
sb.AppendLine();
sb.AppendLine("Actions:");
sb.AppendLine();
sb.AppendJoin(Environment.NewLine, minimalPermissionsReport.Actions.Select(a => $"- {a}"));
sb.AppendLine();
sb.AppendLine();
sb.AppendLine("Minimal permissions:");
sb.AppendLine();
sb.AppendJoin(Environment.NewLine, minimalPermissionsReport.MinimalPermissions.Select(p => $"- {p}"));

if (minimalPermissionsReport.Errors.Length != 0)
{
sb.AppendLine();
sb.AppendLine();
sb.AppendLine("Couldn't determine minimal permissions for the following actions:");
sb.AppendLine();
sb.AppendJoin(Environment.NewLine, minimalPermissionsReport.Errors.Select(e => $"- {e}"));
}

return sb.ToString();
}
}