-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump System.Drawing.Common from 7.0.0 to 8.0.0 (#82)
Remove System.Drawing.Common, update library documentation checker code
- Loading branch information
1 parent
e358c41
commit b7c766a
Showing
4 changed files
with
110 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
108 changes: 108 additions & 0 deletions
108
LoadModules.Extensions.Tests/PackageListIsCorrectTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Text.RegularExpressions; | ||
| using NUnit.Framework; | ||
|
|
||
| namespace LoadModules.Extensions.Tests; | ||
|
|
||
| /// <summary> | ||
| /// Tests to confirm that the dependencies in csproj files (NuGet packages) match those in the .nuspec files and that packages.md | ||
| /// lists the correct versions (in documentation) | ||
| /// </summary> | ||
| public class PackageListIsCorrectTests | ||
| { | ||
| private static readonly EnumerationOptions EnumerationOptions = new() { RecurseSubdirectories = true,MatchCasing = MatchCasing.CaseInsensitive,IgnoreInaccessible = true}; | ||
|
|
||
| //<PackageReference Include="NUnit3TestAdapter" Version="3.13.0" /> | ||
| private static readonly Regex RPackageRef = new(@"<PackageReference\s+Include=""(.*)""\s+Version=""([^""]*)""", RegexOptions.IgnoreCase|RegexOptions.Compiled|RegexOptions.CultureInvariant); | ||
|
|
||
| // | Org.SomePackage | | ||
| // | ||
| private static readonly Regex RMarkdownEntry = new(@"^\|\s*\[?([^ |\]]+)(\]\([^)]+\))?\s*\|", RegexOptions.IgnoreCase|RegexOptions.Compiled|RegexOptions.CultureInvariant); | ||
|
|
||
|
|
||
| /// <summary> | ||
| /// Enumerate non-test packages, check that they are listed in PACKAGES.md | ||
| /// </summary> | ||
| /// <param name="rootPath"></param> | ||
| [TestCase] | ||
| public void TestPackagesDocumentCorrect(string rootPath=null) | ||
| { | ||
| var root= FindRoot(rootPath); | ||
| var undocumented = new StringBuilder(); | ||
|
|
||
| // Extract the named packages from PACKAGES.md | ||
| var packagesMarkdown = GetPackagesMarkdown(root).SelectMany(File.ReadAllLines) | ||
| .Select(line => RMarkdownEntry.Match(line)) | ||
| .Where(m=>m.Success) | ||
| .Select(m => m.Groups[1].Value) | ||
| .Except(new[]{"Package", "-------" }) | ||
| .ToHashSet(StringComparer.InvariantCultureIgnoreCase); | ||
|
|
||
| // Extract the named packages from csproj files | ||
| var usedPackages = GetCsprojFiles(root).Select(File.ReadAllText).SelectMany(s => RPackageRef.Matches(s)) | ||
| .Select(m => m.Groups[1].Value).ToHashSet(StringComparer.InvariantCultureIgnoreCase); | ||
|
|
||
| // Then subtract those listed in PACKAGES.md (should be empty) | ||
| var undocumentedPackages = usedPackages.Except(packagesMarkdown).Select(BuildRecommendedMarkdownLine); | ||
| undocumented.AppendJoin(Environment.NewLine, undocumentedPackages); | ||
|
|
||
| var unusedPackages = packagesMarkdown.Except(usedPackages).ToArray(); | ||
| Assert.IsEmpty(unusedPackages, | ||
| $"The following packages are listed in PACKAGES.md but are not used in any csproj file: {string.Join(", ", unusedPackages)}"); | ||
| Assert.IsEmpty(undocumented.ToString()); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Generate the report entry for an undocumented package | ||
| /// </summary> | ||
| /// <param name="package"></param> | ||
| /// <returns></returns> | ||
| private static object BuildRecommendedMarkdownLine(string package) => $"Package {package} is not documented in PACKAGES.md. Recommended line is:\r\n| {package} | [GitHub]() | LICENCE GOES HERE | |"; | ||
|
|
||
| /// <summary> | ||
| /// Find the root of this repo, which is usually the directory containing the .sln file | ||
| /// If the .sln file lives elsewhere, you can override this by passing in a path explicitly. | ||
| /// </summary> | ||
| /// <param name="path"></param> | ||
| /// <returns></returns> | ||
| private static DirectoryInfo FindRoot(string path = null) | ||
| { | ||
| if (path != null) | ||
| { | ||
| if (!Path.IsPathRooted(path)) path = Path.Combine(TestContext.CurrentContext.TestDirectory, path); | ||
| return new DirectoryInfo(path); | ||
| } | ||
| var root = new DirectoryInfo(TestContext.CurrentContext.TestDirectory); | ||
| while (!root.EnumerateFiles("*.sln", SearchOption.TopDirectoryOnly).Any() && root.Parent != null) | ||
| root = root.Parent; | ||
| Assert.IsNotNull(root.Parent, "Could not find root of repository"); | ||
| return root; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns all csproj files in the repository, except those containing the string 'tests' | ||
| /// </summary> | ||
| /// <param name="root"></param> | ||
| /// <returns></returns> | ||
| private static IEnumerable<string> GetCsprojFiles(DirectoryInfo root) | ||
| { | ||
| return root.EnumerateFiles("*.csproj", EnumerationOptions).Select(f => f.FullName).Where(f => !f.Contains("tests", StringComparison.InvariantCultureIgnoreCase)); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Find the sole packages.md file wherever in the repo it lives. Error if multiple or none. | ||
| /// </summary> | ||
| /// <param name="root"></param> | ||
| /// <returns></returns> | ||
| private static string[] GetPackagesMarkdown(DirectoryInfo root) | ||
| { | ||
| var path = root.EnumerateFiles("packages.md", EnumerationOptions).Select(f => f.FullName).ToArray(); | ||
| Assert.False(path.Length==0, "Could not find packages.md"); | ||
| return path; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters