Fix issue with generated URL (#76)

IEvangelist · web-flow · commit 8fc057b5dfb1 · 2022-10-28T14:02:03.000-05:00
* Fix URL creation

* Perpare unit tests
diff --git a/src/DotNet.GitHub/GlobalUsings.cs b/src/DotNet.GitHub/GlobalUsings.cs
@@ -14,3 +14,5 @@
 global using Octokit;
 global using Octokit.Internal;
 global using ModelProject = DotNet.Models.Project;
+
+[assembly: System.Runtime.CompilerServices.InternalsVisibleTo("DotNet.GitHubTests")]
diff --git a/src/DotNet.GitHub/ModelExtensions.cs b/src/DotNet.GitHub/ModelExtensions.cs
@@ -8,9 +8,9 @@ public static class ModelExtensions
     public static string ToMarkdownBody(
         this ISet<ProjectSupportReport> psrs,
         string tfm,
-        string rootDirectory,
-        string branch)
+        IRepoOptions options)
     {
+        var (rootDirectory, branch) = (options.Directory, options.Branch);
         IMarkdownDocument document = new MarkdownDocument();
 
         document.AppendParagraph(
@@ -44,17 +44,8 @@ public static string ToMarkdownBody(
             new MarkdownList(
                 psrs.OrderBy(psr => psr.Project.FullPath).Select(psr =>
                 {
-                    var relativePath =
-                        Path.GetRelativePath(rootDirectory, psr.Project.FullPath);
-
-                    var lineNumberFileReference =
-                        $"../blob/{branch}/{relativePath.Replace("\\", "/")}#L{psr.Project.TfmLineNumber}"
-                            .EscapeUriString();
-                    var name = relativePath.ShrinkPath("...");
-
-                    // Must force anchor link, as GitHub assumes site-relative links.
-                    var anchor = $"<a href='{lineNumberFileReference}' title='{name} at line number {psr.Project.TfmLineNumber:#,0}'>{name}</a>";
-
+                    var anchor = ToLineNumberUrl(
+                        psr.Project.FullPath, psr.Project.TfmLineNumber, options);
                     return new MarkdownCheckListItem(false, anchor);
                 })));
 
@@ -79,9 +70,9 @@ public static string ToMarkdownBody(
     public static string ToMarkdownBody(
         this ISet<DockerfileSupportReport> dfsr,
         string tfm,
-        string rootDirectory,
-        string branch)
+        IRepoOptions options)
     {
+        var (rootDirectory, branch) = (options.Directory, options.Branch);
         IMarkdownDocument document = new MarkdownDocument();
 
         document.AppendParagraph(
@@ -115,20 +106,13 @@ public static string ToMarkdownBody(
             new MarkdownList(
                 dfsr.SelectMany(sr => sr.TargetFrameworkMonikerSupports.Select(tfms => (sr.Dockerfile, tfms)))
                     .OrderBy(t => t.Dockerfile.FullPath)
-                    .Select(t =>
+                    .SelectMany(t =>
                     {
-                        var relativePath =
-                            Path.GetRelativePath(rootDirectory, t.Dockerfile.FullPath);
-                        // TODO: 1
-                        var lineNumberFileReference =
-                            $"../blob/{branch}/{relativePath.Replace("\\", "/")}#L{1}"
-                                .EscapeUriString();
-                        var name = relativePath.ShrinkPath("...");
-
-                        // Must force anchor link, as GitHub assumes site-relative links.
-                        var anchor = $"<a href='{lineNumberFileReference}' title='{name} at line number {1:#,0}'>{name}</a>";
-
-                        return new MarkdownCheckListItem(false, anchor);
+                        return t.Dockerfile.ImageDetails!.Select(i =>
+                        {
+                            var anchor = ToLineNumberUrl(t.Dockerfile.FullPath, i.LineNumber, options);
+                            return new MarkdownCheckListItem(false, anchor);
+                        });
                     })));
 
         document.AppendParagraph(
@@ -149,6 +133,25 @@ public static string ToMarkdownBody(
         return document.ToString();
     }
 
+    private static string ToLineNumberUrl(
+        string fullPath, int lineNumber, IRepoOptions options)
+    {
+        if (fullPath is null)
+        {
+            return "N/A";
+        }
+
+        var relativePath =
+                Path.GetRelativePath(options.Directory, fullPath!)
+                    .Replace("\\", "/");
+        var lineNumberFileReference =
+            $"https://github.com/{options.Owner}/{options.Name}/blob/{options.Branch}/{relativePath}#L{lineNumber}";
+        var name = relativePath.ShrinkPath("...");
+
+        // Must force anchor link, as GitHub assumes site-relative links.
+        return $"<a href='{lineNumberFileReference}' title='{name}'>{name}</a>";
+    }
+
     public static bool TryCreateIssueContent(
         this ISet<ModelProject> projects,
         string rootDirectory,
diff --git a/src/DotNet.Models/IRepoOptions.cs b/src/DotNet.Models/IRepoOptions.cs
@@ -0,0 +1,12 @@
+﻿// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace DotNet.Models;
+
+public interface IRepoOptions
+{
+    string Owner { get; }
+    string Name { get; }
+    string Branch { get; }
+    string Directory { get; }
+}
diff --git a/src/DotNet.Releases/Core/CoreReleaseIndexService.cs b/src/DotNet.Releases/Core/CoreReleaseIndexService.cs
@@ -3,7 +3,7 @@
 
 namespace DotNet.Releases;
 
-public sealed class CoreReleaseIndexService : ICoreReleaseIndexService
+internal sealed class CoreReleaseIndexService : ICoreReleaseIndexService
 {
     const string NetCoreKey = nameof(NetCoreKey);
 
diff --git a/src/DotNet.Releases/Framework/FrameworkReleaseIndexService.cs b/src/DotNet.Releases/Framework/FrameworkReleaseIndexService.cs
@@ -3,7 +3,7 @@
 
 namespace DotNet.Releases;
 
-public sealed class FrameworkReleaseIndexService : IFrameworkReleaseIndexService
+internal sealed class FrameworkReleaseIndexService : IFrameworkReleaseIndexService
 {
     /// <summary>
     /// https://github.com/dotnet/website-resources/tree/master/data/dotnet-framework-releases
diff --git a/src/DotNet.Releases/Framework/FrameworkReleaseService.cs b/src/DotNet.Releases/Framework/FrameworkReleaseService.cs
@@ -3,7 +3,7 @@
 
 namespace DotNet.Releases;
 
-public sealed class FrameworkReleaseService : IFrameworkReleaseService
+internal sealed class FrameworkReleaseService : IFrameworkReleaseService
 {
     readonly IMemoryCache _cache;
     readonly IFrameworkReleaseIndexService _indexService;
diff --git a/src/DotNet.Releases/GlobalUsings.cs b/src/DotNet.Releases/GlobalUsings.cs
@@ -9,3 +9,6 @@
 global using DotNet.Releases.Extensions;
 global using Microsoft.Deployment.DotNet.Releases;
 global using Microsoft.Extensions.Caching.Memory;
+
+[assembly: System.Runtime.CompilerServices.InternalsVisibleTo("DotNet.GitHubTests")]
+[assembly: System.Runtime.CompilerServices.InternalsVisibleTo("DotNet.ReleasesTests")]
diff --git a/src/DotNet.Releases/LabeledVersion.cs b/src/DotNet.Releases/LabeledVersion.cs
@@ -22,7 +22,7 @@ public LabeledVersion(Version version, string? label = null) =>
 
     public static bool TryParse(string? input, out LabeledVersion? labeledVersion)
     {
-        if (input is not null and { Length: > 0 })
+        if (input is { Length: > 0 })
         {
             var split = input.Split("-");
             if (Version.TryParse(split[0], out var version))
diff --git a/src/DotNet.VersionSweeper/Options.cs b/src/DotNet.VersionSweeper/Options.cs
@@ -3,7 +3,7 @@
 
 namespace DotNet.VersionSweeper;
 
-public sealed class Options
+public sealed class Options : IRepoOptions
 {
     string _repositoryName = null!;
     string _branchName = null!;
diff --git a/src/DotNet.VersionSweeper/Program.cs b/src/DotNet.VersionSweeper/Program.cs
@@ -176,15 +176,15 @@ static void AppendGrouping<T>(
             await CreateAndEnqueueAsync(
                 graphQLClient, issueQueue, job,
                 $"Upgrade from `{tfm}` to LTS (or current) image tag",
-                options, o => dockerfileSupportReports.ToMarkdownBody(tfm, o.Directory, o.Branch));
+                options, o => dockerfileSupportReports.ToMarkdownBody(tfm, o));
         }
 
         foreach (var (tfm, projectSupportReports) in tfmToProjectSupportReports)
         {
             await CreateAndEnqueueAsync(
                 graphQLClient, issueQueue, job,
                 $"Upgrade from `{tfm}` to LTS (or current) version",
-                options, o => projectSupportReports.ToMarkdownBody(tfm, o.Directory, o.Branch));
+                options, o => projectSupportReports.ToMarkdownBody(tfm, o));
         }
 
         if (nonSdkStyleProjects.TryCreateIssueContent(
diff --git a/test/DotNet.GitHubTests/Constants.cs b/test/DotNet.GitHubTests/Constants.cs
@@ -0,0 +1,25 @@
+﻿// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace DotNet.GitHubTests;
+
+internal static  class Constants
+{
+    internal const string TestProjectXml = @"<Project Sdk=""Microsoft.NET.Sdk"">
+
+  <PropertyGroup>
+    <TargetFramework>net5.0</TargetFramework>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include=""Microsoft.NET.Test.Sdk"" Version=""16.5.0"" />
+    <PackageReference Include=""MSTest.TestAdapter"" Version=""2.1.0"" />
+    <PackageReference Include=""MSTest.TestFramework"" Version=""2.1.0"" />
+    <PackageReference Include=""coverlet.collector"" Version=""1.2.0"" />
+    <PackageReference Include=""xunit"" Version=""2.4.1"" />
+    <PackageReference Include=""xunit.runner.visualstudio"" Version=""2.4.1"" />
+  </ItemGroup>
+
+</Project>";
+}
diff --git a/test/DotNet.GitHubTests/DotNet.GitHubTests.csproj b/test/DotNet.GitHubTests/DotNet.GitHubTests.csproj
@@ -29,6 +29,8 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\DotNet.GitHub\DotNet.GitHub.csproj" />
+    <ProjectReference Include="..\..\src\DotNet.IO\DotNet.IO.csproj" />
+    <ProjectReference Include="..\..\src\DotNet.Releases\DotNet.Releases.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/test/DotNet.GitHubTests/ModelExtensionsTests.cs b/test/DotNet.GitHubTests/ModelExtensionsTests.cs
@@ -0,0 +1,88 @@
+﻿// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using DotNet.GitHub;
+using DotNet.IO;
+using DotNet.Models;
+using DotNet.Releases;
+using Microsoft.Extensions.Caching.Memory;
+using Microsoft.Extensions.Options;
+using Xunit;
+
+namespace DotNet.GitHubTests;
+
+public sealed class ModelExtensionsTests
+{
+    readonly MemoryCache _cache = new(Options.Create(new MemoryCacheOptions()));
+
+    [Fact]
+    public async Task ToMarkDownCorrectlyGeneratesContentTest()
+    {
+        var projectPath = "test.csproj";
+
+        try
+        {
+            await File.WriteAllTextAsync(projectPath, Constants.TestProjectXml);
+
+            IProjectFileReader reader = new ProjectFileReader();
+            Project project = await reader.ReadProjectAsync(projectPath);
+            ICoreReleaseIndexService coreService = new CoreReleaseIndexService(_cache);
+            IFrameworkReleaseService frameworkService =
+                new FrameworkReleaseService(new FrameworkReleaseIndexService(), _cache);
+
+            IUnsupportedProjectReporter reporter =
+                new UnsupportedProjectReporter(coreService, frameworkService);
+
+            await foreach (var report in reporter.ReportAsync(project, 90))
+            {
+                var expected = @"The following project file(s) target a .NET version which is no longer supported. This is an auto-generated issue, detailed and discussed in [dotnet/docs#22271](https://github.com/dotnet/docs/issues/22271).
+
+| Target version | End of life | Release notes | Nearest LTS TFM version |
+| --- | --- | --- | --- |
+| `net5.0` | May, 10 2022 | [net5.0 release notes](https://dotnetcli.blob.core.windows.net/dotnet/release-metadata/5.0/releases.json) | `net6.0` |
+
+  - [ ] <a href='https://github.com/dotnet/docs/blob/main/test.csproj#L4' title='test.csproj'>test.csproj</a>
+
+Consider upgrading projects to either the current release, or the nearest LTS TFM version.
+
+If any of these projects listed in this issue are intentionally targeting an unsupported version, you can optionally configure to ignore these results in future automation executions. Create a (or update the) *dotnet-versionsweeper.json* file at the root of the repository and add an `ignore` entry following the [globbing patterns detailed here](https://learn.microsoft.com/dotnet/core/extensions/file-globbing).
+
+```json
+{
+    ""ignore"": [
+        ""**/path/to/example.csproj""
+    ]
+}
+```
+"
+.ReplaceLineEndings();
+                var actual = new HashSet<ProjectSupportReport>                
+                    {
+                        report
+                    }
+                    .ToMarkdownBody(
+                        tfm: "net5.0",
+                        options: new TestOptions(
+                            Path.GetDirectoryName(
+                                Path.GetFullPath(projectPath))))
+                    .ReplaceLineEndings();
+                
+                Assert.Equal(expected, actual);
+            }
+        }
+        finally
+        {
+            File.Delete(projectPath);
+        }
+    }
+}
+
+internal class TestOptions : IRepoOptions
+{
+    public string Owner => "dotnet";
+    public string Name => "docs";
+    public string Branch => "main";
+    public string Directory { get; }
+
+    public TestOptions(string directory) => Directory = directory;
+}
diff --git a/test/DotNet.ReleasesTests/Core/CoreReleaseIndexServiceTests.cs b/test/DotNet.ReleasesTests/Core/CoreReleaseIndexServiceTests.cs
@@ -21,15 +21,16 @@ public sealed class CoreReleaseIndexServiceTests
         InlineData("1.0.0", "3.1"),
         InlineData("2.2.8", "3.1"),
         InlineData("3.0.3", "3.1"),
-        InlineData("3.1.11", "3.1")
+        InlineData("3.1.11", "3.1"),
+        InlineData("5.0.17", "6.0")
     ]
     public async Task GetNextLtsVersionAsyncTest(
-        string releaseVersion, string expectedVersion)
+        string releaseVersion, string expected)
     {
         ICoreReleaseIndexService service = new CoreReleaseIndexService(_cache);
 
-        var result = await service.GetNextLtsVersionAsync(releaseVersion);
-        Assert.Equal(expectedVersion, result.ProductVersion);
+        var actual = await service.GetNextLtsVersionAsync(releaseVersion);
+        Assert.Equal(expected, actual.ProductVersion);
     }
 
     [
@@ -41,7 +42,7 @@ public async Task GetNextLtsVersionAsyncTest(
         InlineData("5.0", ".NET", "net5.0")
     ]
     public void ReleasesIndexCorrectlyRepresentsTfm(
-        string version, string productName, string expectedTfm)
+        string version, string productName, string expected)
     {
         var product = "{}".FromJson<Product>();
         static void WorkAroundDeserializationLimitation<T>(Product product, string propName, T propValue)
@@ -52,6 +53,6 @@ static void WorkAroundDeserializationLimitation<T>(Product product, string propN
         WorkAroundDeserializationLimitation(product, nameof(Product.ProductVersion), version);
         WorkAroundDeserializationLimitation(product, nameof(Product.ProductName), productName);
 
-        Assert.Equal(expectedTfm, product.GetTargetFrameworkMoniker());
+        Assert.Equal(expected, product.GetTargetFrameworkMoniker());
     }
 }
diff --git a/test/DotNet.ReleasesTests/Framework/FrameworkReleaseServiceTests.cs b/test/DotNet.ReleasesTests/Framework/FrameworkReleaseServiceTests.cs
@@ -15,6 +15,9 @@ public sealed class FrameworkReleaseServiceTests
 
     [
         Theory,
+        InlineData("3.0", "3.5.0-sp1"),
+        InlineData("3.5", "3.5.0-sp1"),
+        InlineData("4.0", "4.8"),
         InlineData("4.5", "4.8"),
         InlineData("4.5.2", "4.8"),
         InlineData("4.6.1", "4.8"),
@@ -23,12 +26,12 @@ public sealed class FrameworkReleaseServiceTests
         InlineData("4.6", "4.8")
     ]
     public async Task GetNextLtsVersionAsyncTest(
-        string releaseVersion, string expectedVersion)
+        string releaseVersion, string expected)
     {
         IFrameworkReleaseService service =
             new FrameworkReleaseService(_indexService, _cache);
 
-        var result = await service.GetNextLtsVersionAsync(releaseVersion);
-        Assert.Equal(expectedVersion, result.Version);
+        var actual = await service.GetNextLtsVersionAsync(releaseVersion);
+        Assert.Equal(expected, actual.Version);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace DotNet.Releases;`
`5`	`5`
`6`		`-public sealed class CoreReleaseIndexService : ICoreReleaseIndexService`
	`6`	`+internal sealed class CoreReleaseIndexService : ICoreReleaseIndexService`
`7`	`7`	`{`
`8`	`8`	`const string NetCoreKey = nameof(NetCoreKey);`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace DotNet.Releases;`
`5`	`5`
`6`		`-public sealed class FrameworkReleaseIndexService : IFrameworkReleaseIndexService`
	`6`	`+internal sealed class FrameworkReleaseIndexService : IFrameworkReleaseIndexService`
`7`	`7`	`{`
`8`	`8`	`/// <summary>`
`9`	`9`	`/// https://github.com/dotnet/website-resources/tree/master/data/dotnet-framework-releases`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace DotNet.Releases;`
`5`	`5`
`6`		`-public sealed class FrameworkReleaseService : IFrameworkReleaseService`
	`6`	`+internal sealed class FrameworkReleaseService : IFrameworkReleaseService`
`7`	`7`	`{`
`8`	`8`	`readonly IMemoryCache _cache;`
`9`	`9`	`readonly IFrameworkReleaseIndexService _indexService;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public LabeledVersion(Version version, string? label = null) =>`
`22`	`22`
`23`	`23`	`public static bool TryParse(string? input, out LabeledVersion? labeledVersion)`
`24`	`24`	`{`
`25`		`- if (input is not null and { Length: > 0 })`
	`25`	`+ if (input is { Length: > 0 })`
`26`	`26`	`{`
`27`	`27`	`var split = input.Split("-");`
`28`	`28`	`if (Version.TryParse(split[0], out var version))`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace DotNet.VersionSweeper;`
`5`	`5`
`6`		`-public sealed class Options`
	`6`	`+public sealed class Options : IRepoOptions`
`7`	`7`	`{`
`8`	`8`	`string _repositoryName = null!;`
`9`	`9`	`string _branchName = null!;`
Original file line number	Diff line number	Diff line change
`@@ -176,15 +176,15 @@ static void AppendGrouping<T>(`
`176`	`176`	`await CreateAndEnqueueAsync(`
`177`	`177`	`graphQLClient, issueQueue, job,`
`178`	`178`	$"Upgrade from `{tfm}` to LTS (or current) image tag",
`179`		`- options, o => dockerfileSupportReports.ToMarkdownBody(tfm, o.Directory, o.Branch));`
	`179`	`+ options, o => dockerfileSupportReports.ToMarkdownBody(tfm, o));`
`180`	`180`	`}`
`181`	`181`
`182`	`182`	`foreach (var (tfm, projectSupportReports) in tfmToProjectSupportReports)`
`183`	`183`	`{`
`184`	`184`	`await CreateAndEnqueueAsync(`
`185`	`185`	`graphQLClient, issueQueue, job,`
`186`	`186`	$"Upgrade from `{tfm}` to LTS (or current) version",
`187`		`- options, o => projectSupportReports.ToMarkdownBody(tfm, o.Directory, o.Branch));`
	`187`	`+ options, o => projectSupportReports.ToMarkdownBody(tfm, o));`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`if (nonSdkStyleProjects.TryCreateIssueContent(`