Merge branch 'release/0.7.3'

pascalberger · pascalberger · commit 0964b77db620 · 2019-10-06T00:46:54.000+02:00
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -27,4 +27,4 @@ branches:
 #  Build Cache                    #
 #---------------------------------#
 cache:
-- tools -> setup.cake
+- tools -> recipe.cake
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-# Project specific 
+# Project specific
 
 BuildArtifacts/
 tests/integration/tools/*
@@ -233,7 +233,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk 
+# Including strong name files can present a security risk
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -329,7 +329,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output 
+# Azure Stream Analytics local run output
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -338,7 +338,9 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder 
+# MFractors (Xamarin productivity tool) working folder
 .mfractor/
 
 # End of https://www.gitignore.io/api/cake,visualstudio
+
+.dotnet
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This addin for the Cake Build Automation System allows you to analyze Git reposi
 using the [Cake Issues addin](https://github.com/cake-contrib/Cake.Issues).
 
 For more information about this add-in see the [Cake.Issues website](https://cakeissues.net)
-and for general information about the Cake build automation system see the [Cake website](http://cakebuild.net)
+and for general information about the Cake build automation system see the [Cake website](http://cakebuild.net).
 
 [![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/cake-contrib/Cake.Issues.GitRepository/blob/feature/build/LICENSE)
 
@@ -34,7 +34,7 @@ and for general information about the Cake build automation system see the [Cake
 
 ## Chat Room
 
-Come join in the conversation about this addin in our Gitter Chat Room
+Come join in the conversation about this addin in our Gitter Chat Room.
 
 [![Join the chat at https://gitter.im/cake-contrib/Lobby](https://badges.gitter.im/cake-contrib/Lobby.svg)](https://gitter.im/cake-contrib/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
diff --git a/build.ps1 b/build.ps1
@@ -35,7 +35,7 @@ http://cakebuild.net
 
 [CmdletBinding()]
 Param(
-    [string]$Script = "setup.cake",
+    [string]$Script = "recipe.cake",
     [string]$Target = "Default",
     [ValidateSet("Release", "Debug")]
     [string]$Configuration = "Release",
@@ -181,4 +181,4 @@ if (!(Test-Path $CAKE_EXE)) {
 # Start Cake
 Write-Host "Running build script..."
 Invoke-Expression "& `"$CAKE_EXE`" `"$Script`" -target=`"$Target`" -configuration=`"$Configuration`" -verbosity=`"$Verbosity`" $UseMono $UseDryRun $UseExperimental $ScriptArgs"
-exit $LASTEXITCODE
+exit $LASTEXITCODE
diff --git a/build.sh b/build.sh
@@ -99,4 +99,4 @@ fi
 ###########################################################################
 
 # Start Cake
-exec mono "$CAKE_EXE" setup.cake --verbosity=$VERBOSITY --configuration=$CONFIGURATION --target=$TARGET $DRYRUN "${SCRIPT_ARGUMENTS[@]}"
+exec mono "$CAKE_EXE" recipe.cake --verbosity=$VERBOSITY --configuration=$CONFIGURATION --target=$TARGET $DRYRUN "${SCRIPT_ARGUMENTS[@]}"
diff --git a/docs/rules/FilePathTooLong.md b/docs/rules/FilePathTooLong.md
@@ -0,0 +1,24 @@
+---
+Title: FilePathTooLong
+Description: The path of a file is too long.
+---
+
+<?# Table Class=table HeaderRows=0 ?>
+<?*
+"Rule Id" FilePathTooLong
+Priority Warning
+?>
+<?#/ Table ?>
+
+## Cause
+
+The path of a file in the repository is too long.
+
+## Rule description
+
+Some operating systems and applications have a limitation of maximum path length which they can handle.
+To guarantee proper building this length should not be exceeded.
+
+## How to fix violations
+
+Rename the name of the file or shorten the path name.
diff --git a/nuspec/nuget/Cake.Issues.GitRepository.nuspec b/nuspec/nuget/Cake.Issues.GitRepository.nuspec
@@ -24,7 +24,7 @@ See the Project Site for an overview of the whole ecosystem of addins for workin
     <repository type="git" url="https://github.com/cake-contrib/Cake.Issues.GitRepository.git"/>
     <copyright>Copyright © Pascal Berger</copyright>
     <tags>Cake Script Cake-Issues Cake-IssueProvider CodeAnalysis Linting Git</tags>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/0.7.2</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/0.7.3</releaseNotes>
   </metadata>
   <files>
     <file src="netstandard2.0/Cake.Issues.GitRepository.dll" target="lib\netstandard2.0" />
diff --git a/recipe.cake b/recipe.cake
diff --git a/src/Cake.Issues.GitRepository.sln b/src/Cake.Issues.GitRepository.sln
@@ -9,7 +9,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cake.Issues.GitRepository.T
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{44A982C3-1A02-497A-96B0-238D1F181BD5}"
 	ProjectSection(SolutionItems) = preProject
-		..\setup.cake = ..\setup.cake
+		..\recipe.cake = ..\recipe.cake
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "nuspec", "nuspec", "{8419B5EA-AC0C-41FD-AFB3-28FAE7B63CB1}"
diff --git a/src/Cake.Issues.GitRepository/Cake.Issues.GitRepository.csproj b/src/Cake.Issues.GitRepository/Cake.Issues.GitRepository.csproj
@@ -33,7 +33,7 @@
       <Version>0.7.0</Version>
     </PackageReference>
     <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers">
-      <Version>2.9.4</Version>
+      <Version>2.9.6</Version>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
diff --git a/src/Cake.Issues.GitRepository/FilePathTooLongRuleDescription.cs b/src/Cake.Issues.GitRepository/FilePathTooLongRuleDescription.cs
@@ -0,0 +1,14 @@
+﻿namespace Cake.Issues.GitRepository
+{
+    /// <summary>
+    /// Description of the rule which checks if the path of a file in the repository is too long.
+    /// </summary>
+    public class FilePathTooLongRuleDescription : BaseGitRepositoryIssuesRuleDescription
+    {
+        /// <inheritdoc />
+        public override string RuleName => "FilePathTooLong";
+
+        /// <inheritdoc />
+        public override IssuePriority Priority => IssuePriority.Warning;
+    }
+}
diff --git a/src/Cake.Issues.GitRepository/GitRepositoryIssuesProvider.cs b/src/Cake.Issues.GitRepository/GitRepositoryIssuesProvider.cs
@@ -14,6 +14,9 @@
     internal class GitRepositoryIssuesProvider : BaseIssueProvider
     {
         private readonly GitRunner runner;
+        private readonly Lazy<IEnumerable<string>> allFiles;
+        private readonly Lazy<IEnumerable<string>> textFiles;
+        private readonly Lazy<IEnumerable<string>> binaryFiles;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="GitRepositoryIssuesProvider"/> class.
@@ -41,6 +44,19 @@ public GitRepositoryIssuesProvider(
 
             this.IssueProviderSettings = issueProviderSettings;
             this.runner = new GitRunner(fileSystem, environment, processRunner, toolLocator);
+
+            this.allFiles =
+                new Lazy<IEnumerable<string>>(
+                    new Func<IEnumerable<string>>(
+                        () => this.GetAllFilesFromRepository()));
+            this.textFiles =
+                new Lazy<IEnumerable<string>>(
+                    new Func<IEnumerable<string>>(
+                        () => this.GetTextFilesFromRepository()));
+            this.binaryFiles =
+                new Lazy<IEnumerable<string>>(
+                    new Func<IEnumerable<string>>(
+                        () => this.DetermineBinaryFiles(this.allFiles.Value, this.textFiles.Value)));
         }
 
         /// <summary>
@@ -67,6 +83,11 @@ protected override IEnumerable<IIssue> InternalReadIssues(IssueCommentFormat for
                 result.AddRange(this.CheckForBinaryFilesNotTrackedByLfs(format));
             }
 
+            if (this.IssueProviderSettings.CheckFilesPathLength)
+            {
+                result.AddRange(this.CheckForFilesPathLength(format));
+            }
+
             return result;
         }
 
@@ -77,22 +98,19 @@ protected override IEnumerable<IIssue> InternalReadIssues(IssueCommentFormat for
         /// <returns>List of issues for binary files which are not tracked by LFS.</returns>
         private IEnumerable<IIssue> CheckForBinaryFilesNotTrackedByLfs(IssueCommentFormat format)
         {
-            var allFiles = this.GetAllFilesFromRepository();
-            if (!allFiles.Any())
+            if (!this.allFiles.Value.Any())
             {
                 return new List<IIssue>();
             }
 
-            var textFiles = this.GetTextFilesFromRepository();
-
-            var binaryFiles = this.DetermineBinaryFiles(allFiles, textFiles);
-            if (!binaryFiles.Any())
+            if (!this.binaryFiles.Value.Any())
             {
                 return new List<IIssue>();
             }
 
             var lfsTrackedFiles = this.GetLfsTrackedFilesFromRepository();
-            var binaryFilesNotTrackedByLfs = this.DetermineBinaryFilesNotTrackedWithLfs(binaryFiles, lfsTrackedFiles);
+            var binaryFilesNotTrackedByLfs =
+                this.DetermineBinaryFilesNotTrackedWithLfs(this.binaryFiles.Value, lfsTrackedFiles);
 
             var result = new List<IIssue>();
             foreach (var file in binaryFilesNotTrackedByLfs)
@@ -124,6 +142,54 @@ private IEnumerable<IIssue> CheckForBinaryFilesNotTrackedByLfs(IssueCommentForma
             return result;
         }
 
+        /// <summary>
+        /// Checks for files path length.
+        /// </summary>
+        /// <param name="format">Preferred format of the messages.</param>
+        /// <returns>List of issues for repository files with paths exceeding the allowed maximum.</returns>
+        private IEnumerable<IIssue> CheckForFilesPathLength(IssueCommentFormat format)
+        {
+            if (!this.allFiles.Value.Any())
+            {
+                return new List<IIssue>();
+            }
+
+            var result = new List<IIssue>();
+            foreach (string file in this.allFiles.Value)
+            {
+                if (file.Length > this.IssueProviderSettings.MaxFilePathLength)
+                {
+                    string message = null;
+                    switch (format)
+                    {
+                        case IssueCommentFormat.Markdown:
+                            message =
+                                $"The path for the file `{file}` is too long. Maximum allowed path length is {this.IssueProviderSettings.MaxFilePathLength}, actual path length is {file.Length}.";
+                            break;
+                        case IssueCommentFormat.Html:
+                            message =
+                                $"The path for the file <pre>{file}</pre> is too long. Maximum allowed path length is {this.IssueProviderSettings.MaxFilePathLength}, actual path length is {file.Length}.";
+                            break;
+                        default:
+                            message =
+                                $"The path for the file \"{file}\" is too long. Maximum allowed path length is {this.IssueProviderSettings.MaxFilePathLength}, actual path length is {file.Length}.";
+                            break;
+                    }
+
+                    var ruleDescription = new FilePathTooLongRuleDescription();
+
+                    result.Add(
+                        IssueBuilder
+                            .NewIssue(message, this)
+                            .InFile(file)
+                            .OfRule(ruleDescription)
+                            .Create());
+                }
+            }
+
+            return result;
+        }
+
         /// <summary>
         /// Returns a list of the files in the repository.
         /// </summary>
diff --git a/src/Cake.Issues.GitRepository/GitRepositoryIssuesSettings.cs b/src/Cake.Issues.GitRepository/GitRepositoryIssuesSettings.cs
@@ -11,5 +11,17 @@ public class GitRepositoryIssuesSettings
         /// Requires Git and Git-LFS to be available through Cake tool resolution.
         /// </summary>
         public bool CheckBinaryFilesTrackedByLfs { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the repository should be checked for
+        /// files path longer than <see cref="MaxFilePathLength"/>.
+        /// </summary>
+        public bool CheckFilesPathLength { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating the maximum allowed length of file paths if
+        /// <see cref="CheckFilesPathLength"/> is enabled.
+        /// </summary>
+        public int MaxFilePathLength { get; set; }
     }
 }
diff --git a/tests/integration/tests.cake b/tests/integration/tests.cake
@@ -46,7 +46,39 @@ Task("CheckBinaryFilesTrackedByLfs")
     var reportDir =
         repoRootDir.Combine("BuildArtifacts").Combine("TestResults").Combine("Integration");
     var reportFilePath =
-        reportDir.CombineWithFilePath("issues-report.html");
+        reportDir.CombineWithFilePath("CheckBinaryFilesTrackedByLfs.html");
+    EnsureDirectoryExists(reportDir);
+
+    CreateIssueReport(
+        issues,
+        GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDiagnostic),
+        repoRootDir,
+        reportFilePath);
+});
+
+Task("CheckFilesPathLength")
+    .Does(() =>
+{
+    var repoRootDir = MakeAbsolute(Directory("../../"));
+
+    var issues =
+        ReadIssues(
+            GitRepositoryIssuesAliases.GitRepositoryIssues(
+                Context,
+                new GitRepositoryIssuesSettings
+                {
+                    CheckFilesPathLength = true,
+                    MaxFilePathLength = 60
+                }),
+            new ReadIssuesSettings(repoRootDir)
+            {
+                 Format = IssueCommentFormat.Html
+            });
+
+    var reportDir =
+        repoRootDir.Combine("BuildArtifacts").Combine("TestResults").Combine("Integration");
+    var reportFilePath =
+        reportDir.CombineWithFilePath("FilePathTooLong.html");
     EnsureDirectoryExists(reportDir);
 
     CreateIssueReport(
@@ -57,7 +89,8 @@ Task("CheckBinaryFilesTrackedByLfs")
 });
 
 Task("Run-All-Tests")
-    .IsDependentOn("CheckBinaryFilesTrackedByLfs");
+    .IsDependentOn("CheckBinaryFilesTrackedByLfs")
+    .IsDependentOn("CheckFilesPathLength");
 
 //////////////////////////////////////////////////
 
