(maint) removed some warnings.

nils-a · nils-a · commit 7d8173f28693 · 2021-03-09T14:48:15.000+01:00
and pinned gh-actions environment.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -13,7 +13,7 @@ jobs:
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       matrix:
-        os: [windows-latest, ubuntu-latest, macos-latest]
+        os:  [ ubuntu-18.04, windows-2019, macos-10.15 ]
 
     steps:
       - uses: actions/checkout@v2.3.4
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -17,7 +17,7 @@ on:
 jobs:
   analyze:
     name: Analyze
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
 
     strategy:
       fail-fast: false
@@ -49,7 +49,7 @@ jobs:
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    - run: ./build.ps1
+    - run: ./build.ps1 --target=DotNetCore-Build
       shell: pwsh
 
     - name: Perform CodeQL Analysis
diff --git a/build.sh b/build.sh
diff --git a/docs/input/guidelines/CakeContribIcon.md b/docs/input/guidelines/CakeContribIcon.md
@@ -11,7 +11,6 @@ Title: CakeContrib-Icon
 - [Related rules](#related-rules)
 - [Usage](#usage)
 - [Settings](#settings)
-  - [Icon-Location](#icon-location)
   - [Icon include in project](#icon-include-in-project)
 - [Migrating from an existing project](#migrating-from-an-existing-project)
 
diff --git a/src/Guidelines/build/TargetFrameworkVersions.targets b/src/Guidelines/build/TargetFrameworkVersions.targets
@@ -14,6 +14,7 @@
         <!-- All other rules have some "configuration" here, this rules required/suggested targets are hard-coded in the task. Sadly. -->
 
         <TargetFrameworkVersions
+            ProjectFile="$(MSBuildProjectFullPath)"
             References="@(PackageReference)"
             TargetFramework="$(TargetFramework)"
             TargetFrameworks="$(TargetFrameworks)"
diff --git a/src/Tasks.IntegrationTests/E2eTests.cs b/src/Tasks.IntegrationTests/E2eTests.cs
@@ -112,8 +112,8 @@ public void PackageIcon_Tag_with_wrong_extension_and_custom_Icon_include_results
             var result = fixture.Run();
 
             // then
-            result.IsErrorExitCode.Should().BeTrue();
-            result.ErrorLines.Should().Contain(l => l.IndexOf("CCG0003", StringComparison.Ordinal) > -1);
+            result.IsErrorExitCode.Should().BeFalse();
+            result.WarningLines.Should().Contain(l => l.IndexOf("CCG0003", StringComparison.Ordinal) > -1);
         }
 
         [Fact]
diff --git a/src/Tasks.Tests/EnsureCakeContribIconTests.cs b/src/Tasks.Tests/EnsureCakeContribIconTests.cs
@@ -1,3 +1,4 @@
+using System.IO;
 using System.Linq;
 
 using CakeContrib.Guidelines.Tasks.Tests.Fixtures;
@@ -28,7 +29,7 @@ public void Should_Output_DefaultPackageIcon_If_None_Is_Specified()
         public void Should_Output_PackageIcon_If_One_Is_Specified()
         {
             // given
-            const string iconPath = "some/cool-icon.png";
+            var iconPath = Path.Combine("some", "cool-icon.png");
             var fixture = new EnsureCakeContribIconFixture();
             fixture.WithPackageIcon(iconPath);
 
@@ -260,7 +261,6 @@ public void Should_Log_Correct_ErrorSourceFile_On_Error_With_Given_ProjectFile()
         public void Should_Warn_CCG0003_On_Omit_Set_But_Wrong_Icon()
         {
             // given
-            const string projectFileName = "some.project.csproj";
             var fixture = new EnsureCakeContribIconFixture();
             fixture.WithPackageIcon("foo.png");
             fixture.WithIconFileReference("foo.png", "");
diff --git a/src/Tasks.Tests/Extensions/StringExtensionTests.cs b/src/Tasks.Tests/Extensions/StringExtensionTests.cs
@@ -0,0 +1,32 @@
+﻿// unset
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+
+using CakeContrib.Guidelines.Tasks.Extensions;
+
+using FluentAssertions;
+
+using Xunit;
+
+namespace CakeContrib.Guidelines.Tasks.Tests.Extensions
+{
+    public class StringExtensionTests
+    {
+        [Theory]
+        [MemberData(nameof(NormalizePathSeparatorsData))]
+        public void NormalizePathSeparators(string actual, string expected)
+        {
+            // This is not a good tests, as the outcome
+            // will be different on different OS.
+            actual.NormalizePathSeparators().Should().Be(expected);
+        }
+
+        public static IEnumerable<object[]> NormalizePathSeparatorsData()
+        {
+            yield return new object[] { "Foo/Bar\\baz", Path.Combine("Foo", "Bar", "baz")  };
+            yield return new object[] { "C:\\Foo\\Bar/baz.txt", Path.Combine($"C:{Path.DirectorySeparatorChar}Foo", "Bar", "baz.txt")  };
+        }
+    }
+}
diff --git a/src/Tasks/CcgLogError.cs b/src/Tasks/CcgLogError.cs
@@ -1,5 +1,7 @@
 using CakeContrib.Guidelines.Tasks.Extensions;
 
+using JetBrains.Annotations;
+
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
@@ -9,6 +11,7 @@ namespace CakeContrib.Guidelines.Tasks
     /// <summary>
     /// This is a convenience-Task to call CcgError from inside the msbuild.
     /// </summary>
+    [UsedImplicitly]
     public class CcgLogError : Task
     {
         /// <summary>
diff --git a/src/Tasks/CcgLogWarning.cs b/src/Tasks/CcgLogWarning.cs
@@ -1,5 +1,7 @@
 using CakeContrib.Guidelines.Tasks.Extensions;
 
+using JetBrains.Annotations;
+
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
@@ -9,6 +11,7 @@ namespace CakeContrib.Guidelines.Tasks
     /// <summary>
     /// This is a convenience-Task to call CcgWarning from inside the msbuild.
     /// </summary>
+    [UsedImplicitly]
     public class CcgLogWarning : Task
     {
         /// <summary>
diff --git a/src/Tasks/EnsureCakeContribIcon.cs b/src/Tasks/EnsureCakeContribIcon.cs
@@ -93,15 +93,15 @@ public override bool Execute()
                     return false;
                 }
 
-                PackageIconOutput = Path.GetFileName(CakeContribIconPath);
+                PackageIconOutput = Path.GetFileName(CakeContribIconPath.NormalizePathSeparators());
                 Log.LogMessage(
                     LogLevel,
                     $"PackageIcon was not set. Setting it to {PackageIconOutput}.");
             }
 
-            PackageIconOutput = PackageIconOutput.Replace("\\", "/");
+            PackageIconOutput = PackageIconOutput.NormalizePathSeparators();
             var packageIconOutputPath =
-                (Path.GetDirectoryName(PackageIconOutput) ?? string.Empty).Replace("\\", "/");
+                (Path.GetDirectoryName(PackageIconOutput) ?? string.Empty).NormalizePathSeparators();
 
             // find icon in FileSystem from References
             var mappedReferences = NoneReferences.Select(MapToDataStructure).ToList();
@@ -190,7 +190,7 @@ private PackDataStructure MapToDataStructure(ITaskItem item)
             var pack = item.GetMetadata("Pack");
             var data = new PackDataStructure
             {
-                SourceInFileSystem = item.ToString(),
+                SourceInFileSystem = item.ToString().NormalizePathSeparators(),
                 DestinationInPackage = item.GetMetadata("PackagePath") ?? string.Empty,
                 Pack = !string.IsNullOrEmpty(pack) && Convert.ToBoolean(pack),
             };
@@ -200,15 +200,15 @@ private PackDataStructure MapToDataStructure(ITaskItem item)
                 return data;
             }
 
-            data.DestinationInPackage = data.DestinationInPackage.Replace("\\", "/").TrimEnd('/');
+            data.DestinationInPackage = data.DestinationInPackage.NormalizePathSeparators();
             var fileName = Path.GetFileName(data.SourceInFileSystem);
             var fileExtension = Path.GetExtension(fileName);
             if (!data.DestinationInPackage.EndsWith(fileExtension, StringComparison.OrdinalIgnoreCase))
             {
                 data.DestinationInPackage =
                     string.IsNullOrEmpty(data.DestinationInPackage)
                         ? fileName
-                        : $"{data.DestinationInPackage}/{fileName}";
+                        : Path.Combine(data.DestinationInPackage, fileName);
             }
 
             return data;
diff --git a/src/Tasks/Extensions/StringExtensions.cs b/src/Tasks/Extensions/StringExtensions.cs
@@ -0,0 +1,43 @@
+using System;
+using System.IO;
+using System.Linq;
+
+namespace CakeContrib.Guidelines.Tasks.Extensions
+{
+    /// <summary>
+    /// INTERNAL USE.
+    /// </summary>
+    internal static class StringExtensions
+    {
+        /// <summary>
+        /// Normalizes DirectorySeparators to <see cref="Path.DirectorySeparatorChar"/>, so
+        /// they are comparable and Path.GetFileName etc works nicely.
+        /// </summary>
+        /// <param name="path">The path to work on.</param>
+        /// <returns>Resulting path.</returns>
+        internal static string NormalizePathSeparators(this string path)
+        {
+            var directorySeparator = Path.DirectorySeparatorChar.ToString();
+            var variants = new[]
+            {
+                Path.AltDirectorySeparatorChar.ToString(),
+                "\\",
+                "/",
+            }
+                .Distinct()
+                .Where(x => !x.Equals(directorySeparator, StringComparison.Ordinal))
+                .ToArray();
+
+            var result = path;
+            foreach (var sep in variants)
+            {
+                if (result.IndexOf(sep, StringComparison.Ordinal) > -1)
+                {
+                    result = result.Replace(sep, directorySeparator);
+                }
+            }
+
+            return result;
+        }
+    }
+}
diff --git a/src/Tasks/RequiredFileEditorconfig.cs b/src/Tasks/RequiredFileEditorconfig.cs
@@ -14,6 +14,11 @@ namespace CakeContrib.Guidelines.Tasks
     /// </summary>
     public class RequiredFileEditorconfig : Task
     {
+#if DEBUG
+        private const MessageImportance LogLevel = MessageImportance.High;
+#else
+        private const MessageImportance LogLevel = MessageImportance.Low;
+#endif
         private const string FileName = ".editorconfig";
 
         /// <summary>
@@ -49,7 +54,7 @@ public override bool Execute()
                 .Where(x => !string.IsNullOrEmpty(x))
                 .Any(x => x.Equals(FileName, StringComparison.OrdinalIgnoreCase)))
             {
-                Log.LogMessage(MessageImportance.Low, $"Recommended file '{FileName}' is set to omit.");
+                Log.LogMessage(LogLevel, $"Recommended file '{FileName}' is set to omit.");
                 return true;
             }
 
diff --git a/src/Tasks/TargetFrameworkVersions.cs b/src/Tasks/TargetFrameworkVersions.cs
@@ -100,6 +100,12 @@ public class TargetFrameworkVersions : Task
         /// </summary>
         public ITaskItem[] Omitted { get; set; }
 
+        /// <summary>
+        /// Gets or sets the project file.
+        /// </summary>
+        [Required]
+        public string ProjectFile { get; set; }
+
         /// <inheritdoc />
         public override bool Execute()
         {
@@ -118,7 +124,7 @@ public override bool Execute()
             {
                 Log.CcgWarning(
                     7,
-                    BuildEngine.ProjectFileOfTaskNode,
+                    ProjectFile,
                     $"Cake.Core has a version of {cakeCore.GetMetadata("version")} which is not a valid version. Using default TargetVersions.");
                 return Execute(DefaultTarget);
             }
@@ -195,7 +201,7 @@ private bool Execute(TargetsDefinitions targets)
 
                 Log.CcgError(
                     7,
-                    BuildEngine.ProjectFileOfTaskNode,
+                    ProjectFile,
                     "Missing required target: " + requiredTarget.Name);
                 return false;
             }
@@ -228,7 +234,7 @@ private bool Execute(TargetsDefinitions targets)
 
                 Log.CcgWarning(
                     7,
-                    BuildEngine.ProjectFileOfTaskNode,
+                    ProjectFile,
                     "Missing suggested target: " + suggestedTarget.Name);
             }
 
diff --git a/src/Tasks/Tasks.csproj b/src/Tasks/Tasks.csproj
@@ -14,6 +14,7 @@
     </ItemGroup>
 
     <ItemGroup>
+        <PackageReference Include="JetBrains.Annotations" Version="2020.3.0" />
         <PackageReference Include="Microsoft.Build.Utilities.Core" Version="16.9.0" CopyLocal="false" Publish="false" ExcludeAssets="runtime" PrivateAssets="All" />
         <PackageReference Include="Microsoft.Build.Framework" Version="16.9.0" CopyLocal="false" Publish="false" ExcludeAssets="runtime" PrivateAssets="All" />
         <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="5.0.3">
diff --git a/src/Tasks/Testability/FileSearcher.cs b/src/Tasks/Testability/FileSearcher.cs
@@ -1,25 +1,28 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 
 namespace CakeContrib.Guidelines.Tasks.Testability
 {
     /// <inheritdoc />
+    [ExcludeFromCodeCoverage]
     internal class FileSearcher : IFileSearcher
     {
         /// <inheritdoc />
         public bool HasFileInFolderStructure(string startFolder, string fileName)
         {
             var folder = startFolder;
-            var found = false;
-            while (folder != null && !found)
+            do
             {
-                found = File.Exists(Path.Combine(folder, fileName));
+                var found = File.Exists(Path.Combine(folder, fileName));
                 if (found)
                 {
                     return true;
                 }
 
                 folder = Path.GetDirectoryName(folder);
             }
+            while (folder != null);
 
             return false;
         }

Original file line number	Diff line number	Diff line change
`@@ -112,8 +112,8 @@ public void PackageIcon_Tag_with_wrong_extension_and_custom_Icon_include_results`
`112`	`112`	`var result = fixture.Run();`
`113`	`113`
`114`	`114`	`// then`
`115`		`- result.IsErrorExitCode.Should().BeTrue();`
`116`		`- result.ErrorLines.Should().Contain(l => l.IndexOf("CCG0003", StringComparison.Ordinal) > -1);`
	`115`	`+ result.IsErrorExitCode.Should().BeFalse();`
	`116`	`+ result.WarningLines.Should().Contain(l => l.IndexOf("CCG0003", StringComparison.Ordinal) > -1);`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`[Fact]`