Update the analysers (#702)

* Update the analysers Update the analysers And the new version is a lot stricter on exception types * This extra code was just playing * Need the base class JsonException * Check for null rather than rely on exception
NuKeeperDotNet · Apr 6, 2019 · 4fa9dcd · 4fa9dcd
1 parent 8f33869
commit 4fa9dcd
Show file tree

Hide file tree

Showing 23 changed files with 62 additions and 73 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -16,9 +16,8 @@
     <RepositoryUrl>https://github.com/NuKeeperDotNet/NuKeeper.git</RepositoryUrl>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.3" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.CodeQuality.Analyzers" Version="2.6.3" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.NetCore.Analyzers" Version="2.6.3" PrivateAssets="All" />
-    <PackageReference Include="Text.Analyzers" Version="2.6.3" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.1" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeQuality.Analyzers" Version="2.9.1" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.NetCore.Analyzers" Version="2.9.1" PrivateAssets="All" />
   </ItemGroup>
 </Project>
diff --git a/NuKeeper.Abstractions/Configuration/FileSettingsReader.cs b/NuKeeper.Abstractions/Configuration/FileSettingsReader.cs
@@ -37,11 +37,16 @@ private FileSettings ReadFile(string fullPath)
                 _logger.Detailed($"Read settings file at {fullPath}");
                 return result;
             }
-            catch (Exception ex)
+            catch (IOException ex)
             {
                 _logger.Error($"Cannot read settings file at {fullPath}", ex);
-                return FileSettings.Empty();
             }
+            catch (JsonException ex)
+            {
+                _logger.Error($"Cannot read json from settings file at {fullPath}", ex);
+            }
+
+            return FileSettings.Empty();
         }
     }
 }
diff --git a/NuKeeper.AzureDevOps/AzureDevOpsRestClient.cs b/NuKeeper.AzureDevOps/AzureDevOpsRestClient.cs
@@ -78,7 +78,7 @@ private async Task<T> HandleResponse<T>(HttpResponseMessage response, [CallerMem
             {
                 return JsonConvert.DeserializeObject<T>(responseBody);
             }
-            catch (Exception ex)
+            catch (JsonException ex)
             {
                 msg = $"{caller} failed to parse json to {typeof(T)}: {ex.Message}";
                 _logger.Error(msg);

diff --git a/NuKeeper.AzureDevOps/AzureDevOpsSettingsReader.cs b/NuKeeper.AzureDevOps/AzureDevOpsSettingsReader.cs
@@ -119,7 +119,7 @@ private RepositorySettings CreateSettingsFromLocal(Uri repositoryUri, string tar
             return CreateRepositorySettings(org, repositoryUri, project, repoName, remoteInfo);
         }
 
-        private RepositorySettings CreateRepositorySettings(string org, Uri repositoryUri, string project, string repoName, RemoteInfo remoteInfo = null) => new RepositorySettings
+        private static RepositorySettings CreateRepositorySettings(string org, Uri repositoryUri, string project, string repoName, RemoteInfo remoteInfo = null) => new RepositorySettings
         {
             ApiUri = new Uri($"https://dev.azure.com/{org}/"),
             RepositoryUri = repositoryUri,

diff --git a/NuKeeper.AzureDevOps/VSTSSettingsReader.cs b/NuKeeper.AzureDevOps/VSTSSettingsReader.cs
@@ -138,7 +138,7 @@ private RepositorySettings CreateSettingsFromLocal(Uri repositoryUri, string tar
             return RepositorySettings(org, project, repoName, remoteInfo);
         }
 
-        private RepositorySettings RepositorySettings(string org, string project, string repoName, RemoteInfo remoteInfo = null) => new RepositorySettings
+        private static RepositorySettings RepositorySettings(string org, string project, string repoName, RemoteInfo remoteInfo = null) => new RepositorySettings
         {
             ApiUri = new Uri($"https://{org}.visualstudio.com/"),
             RepositoryUri = new Uri($"https://{org}.visualstudio.com/{project}/_git/{repoName}/"),

diff --git a/NuKeeper.GitHub/OctokitClient.cs b/NuKeeper.GitHub/OctokitClient.cs
@@ -112,7 +112,7 @@ public async Task<Repository> MakeUserFork(string owner, string repositoryName)
                 _logger.Normal($"User fork created at {result.GitUrl} for {result.Owner.Login}");
                 return new GitHubRepository(result);
             }
-            catch (Exception ex)
+            catch (ApiException ex)
             {
                 _logger.Error("User fork not created", ex);
                 return null;
@@ -184,7 +184,7 @@ await _client.Issue.Labels.AddToIssue(target.Owner, target.Name, issueNumber,
                         labelsToApply);
 
                 }
-                catch (Exception ex)
+                catch (ApiException ex)
                 {
                     _logger.Error("Failed to add labels. Continuing", ex);
                 }

diff --git a/NuKeeper.Gitlab/GitlabRestClient.cs b/NuKeeper.Gitlab/GitlabRestClient.cs
@@ -100,6 +100,7 @@ private async Task<T> HandleResponse<T>(HttpResponseMessage response,
                 if (customErrorHandling != null)
                 {
                     var result = customErrorHandling(response.StatusCode);
+
                     if (result.IsSuccessful)
                         return result.Value;
                 }
@@ -125,7 +126,7 @@ private async Task<T> HandleResponse<T>(HttpResponseMessage response,
             {
                 return JsonConvert.DeserializeObject<T>(responseBody);
             }
-            catch (Exception ex)
+            catch (JsonException ex)
             {
                 msg = $"{caller} failed to parse json to {typeof(T)}: {ex.Message}";
                 _logger.Error(msg);

diff --git a/NuKeeper.Gitlab/Result.cs b/NuKeeper.Gitlab/Result.cs
@@ -22,6 +22,6 @@ public static Result<T> Success(T value)
 
     public static Result<T> Failure()
     {
-        return new Result<T>(default(T), false);
+        return new Result<T>(default, false);
     }
 }
diff --git a/NuKeeper.Inspection/Files/Folder.cs b/NuKeeper.Inspection/Files/Folder.cs
@@ -29,7 +29,7 @@ public IReadOnlyCollection<FileInfo> Find(string pattern)
                     .ToList();
 
             }
-            catch (Exception ex)
+            catch (IOException ex)
             {
                 _logger.Minimal(ex.Message);
                 return new List<FileInfo>();
@@ -45,7 +45,7 @@ public void TryDelete()
                 DeleteDirectoryInternal(_root.FullName);
                 _logger.Detailed($"Deleted folder {_root.FullName}");
             }
-            catch (Exception ex)
+            catch (IOException ex)
             {
                 _logger.Detailed($"Folder delete failed: {ex.GetType().Name} {ex.Message}");
             }

diff --git a/NuKeeper.Inspection/NuGetApi/PackageVersionsLookup.cs b/NuKeeper.Inspection/NuGetApi/PackageVersionsLookup.cs
@@ -48,7 +48,9 @@ private async Task<IEnumerable<PackageSearchMedatadata>> RunFinderForSource(
                 var metadatas = await FindPackage(metadataResource, packageName, includePrerelease);
                 return metadatas.Select(m => BuildPackageData(source, m));
             }
+#pragma warning disable CA1031
             catch (Exception ex)
+#pragma warning restore CA1031
             {
                 _nuKeeperLogger.Normal($"Getting {packageName} from {source} returned exception: {ex.Message}");
                 return Enumerable.Empty<PackageSearchMedatadata>();

diff --git a/NuKeeper.Inspection/RepositoryInspection/DirectoryBuildTargetsReader.cs b/NuKeeper.Inspection/RepositoryInspection/DirectoryBuildTargetsReader.cs
@@ -29,7 +29,7 @@ public IReadOnlyCollection<PackageInProject> ReadFile(string baseDirectory, stri
                     return Read(fileContents, packagePath);
                 }
             }
-            catch (Exception ex)
+            catch (IOException ex)
             {
                 throw new NuKeeperException($"Unable to parse file {packagePath.FullName}", ex);
             }
@@ -61,22 +61,14 @@ public IReadOnlyCollection<PackageInProject> Read(Stream fileContents, PackagePa
 
         private PackageInProject XmlToPackage(XElement el, PackagePath path)
         {
-            try
+            var id = el.Attribute("Include")?.Value;
+            if (id == null)
             {
-                var id = el.Attribute("Include")?.Value;
-                if (id == null)
-                {
-                    id = el.Attribute("Update")?.Value;
-                }
-                var version = el.Attribute("Version")?.Value;
-
-                return _packageInProjectReader.Read(id, version, path, null);
-            }
-            catch (Exception ex)
-            {
-                _logger.Error($"Could not read package from {el} in file {path.FullName}", ex);
-                return null;
+                id = el.Attribute("Update")?.Value;
             }
+            var version = el.Attribute("Version")?.Value;
+
+            return _packageInProjectReader.Read(id, version, path, null);
         }
     }
 }
diff --git a/NuKeeper.Inspection/RepositoryInspection/NuspecFileReader.cs b/NuKeeper.Inspection/RepositoryInspection/NuspecFileReader.cs
@@ -29,7 +29,7 @@ public IReadOnlyCollection<PackageInProject> ReadFile(string baseDirectory, stri
                     return Read(fileContents, packagePath);
                 }
             }
-            catch (Exception ex)
+            catch (IOException ex)
             {
                 throw new NuKeeperException($"Unable to parse file {packagePath.FullName}", ex);
             }
@@ -61,19 +61,10 @@ public IReadOnlyCollection<PackageInProject> Read(Stream fileContents, PackagePa
 
         private PackageInProject XmlToPackage(XElement el, PackagePath path)
         {
-            try
-            {
-                var id = el.Attribute("id")?.Value;
-                var version = el.Attribute("version")?.Value;
-
-                return _packageInProjectReader.Read(id, version, path, null);
+            var id = el.Attribute("id")?.Value;
+            var version = el.Attribute("version")?.Value;
 
-            }
-            catch (Exception ex)
-            {
-                _logger.Error($"Could not read package from {el} in file {path.FullName}", ex);
-                return null;
-            }
+            return _packageInProjectReader.Read(id, version, path, null);
         }
     }
 }
diff --git a/NuKeeper.Inspection/RepositoryInspection/PackagesFileReader.cs b/NuKeeper.Inspection/RepositoryInspection/PackagesFileReader.cs
@@ -29,7 +29,7 @@ public IReadOnlyCollection<PackageInProject> ReadFile(string baseDirectory, stri
                     return Read(fileContents, packagePath);
                 }
             }
-            catch (Exception ex)
+            catch (IOException ex)
             {
                 throw new ApplicationException($"Unable to parse file {packagePath.FullName}", ex);
             }
@@ -61,18 +61,10 @@ public IReadOnlyCollection<PackageInProject> Read(Stream fileContents, PackagePa
 
         private PackageInProject XmlToPackage(XElement el, PackagePath path)
         {
-            try
-            {
-                var id = el.Attribute("id")?.Value;
-                var version = el.Attribute("version")?.Value;
+            var id = el.Attribute("id")?.Value;
+            var version = el.Attribute("version")?.Value;
 
-                return _packageInProjectReader.Read(id, version, path, null);
-            }
-            catch (Exception ex)
-            {
-                _logger.Error($"Could not read package from {el} in file {path.FullName}", ex);
-                return null;
-            }
+            return _packageInProjectReader.Read(id, version, path, null);
         }
     }
 }
diff --git a/NuKeeper.Inspection/RepositoryInspection/ProjectFileReader.cs b/NuKeeper.Inspection/RepositoryInspection/ProjectFileReader.cs
@@ -29,7 +29,7 @@ public IReadOnlyCollection<PackageInProject> ReadFile(string baseDirectory, stri
                     return Read(fileContents, baseDirectory, relativePath);
                 }
             }
-            catch (Exception ex)
+            catch (IOException ex)
             {
                 throw new ApplicationException($"Unable to parse file {filePath}", ex);
             }
@@ -92,18 +92,10 @@ private static PackagePath CreatePackagePath(XNamespace xmlNamespace, string bas
         private PackageInProject XmlToPackage(XNamespace ns, XElement el,
             PackagePath path, IEnumerable<string> projectReferences)
         {
-            try
-            {
-                var id = el.Attribute("Include")?.Value;
-                var version = el.Attribute("Version")?.Value ?? el.Element(ns + "Version")?.Value;
+            var id = el.Attribute("Include")?.Value;
+            var version = el.Attribute("Version")?.Value ?? el.Element(ns + "Version")?.Value;
 
-                return _packageInProjectReader.Read(id, version, path, projectReferences);
-            }
-            catch (Exception ex)
-            {
-                _logger.Error($"Could not read package from {el} in file {path.FullName}", ex);
-                return null;
-            }
+            return _packageInProjectReader.Read(id, version, path, projectReferences);
         }
     }
 }
diff --git a/NuKeeper/Commands/CollaborationPlatformCommand.cs b/NuKeeper/Commands/CollaborationPlatformCommand.cs
@@ -84,7 +84,9 @@ protected override ValidationResult PopulateSettings(SettingsContainer settings)
                     return collaborationResult;
                 }
             }
+#pragma warning disable CA1031
             catch (Exception ex)
+#pragma warning restore CA1031
             {
                 return ValidationResult.Failure(ex.Message);
             }

diff --git a/NuKeeper/Commands/CommandBase.cs b/NuKeeper/Commands/CommandBase.cs
@@ -203,7 +203,7 @@ private ValidationResult PopulatePackageIncludes(
             {
                 settings.PackageFilters.Includes = new Regex(value);
             }
-            catch (Exception ex)
+            catch (ArgumentException ex)
             {
                 {
                     return ValidationResult.Failure(
@@ -230,7 +230,7 @@ private ValidationResult PopulatePackageExcludes(
             {
                 settings.PackageFilters.Excludes = new Regex(value);
             }
-            catch (Exception ex)
+            catch (ArgumentException ex)
             {
                 {
                     return ValidationResult.Failure(

diff --git a/NuKeeper/Commands/MultipleRepositoryCommand.cs b/NuKeeper/Commands/MultipleRepositoryCommand.cs
@@ -70,7 +70,7 @@ private ValidationResult PopulateIncludeRepos(SettingsContainer settings)
             {
                 settings.SourceControlServerSettings.IncludeRepos = new Regex(value);
             }
-            catch (Exception ex)
+            catch (ArgumentException ex)
             {
                 return ValidationResult.Failure($"Unable to parse regex '{value}' for IncludeRepos: {ex.Message}");
             }
@@ -93,7 +93,7 @@ private ValidationResult PopulateExcludeRepos(SettingsContainer settings)
             {
                 settings.SourceControlServerSettings.ExcludeRepos = new Regex(value);
             }
-            catch (Exception ex)
+            catch (ArgumentException ex)
             {
                 return ValidationResult.Failure($"Unable to parse regex '{value}' for ExcludeRepos: {ex.Message}");
             }

diff --git a/NuKeeper/Commands/RepositoryCommand.cs b/NuKeeper/Commands/RepositoryCommand.cs
@@ -29,13 +29,18 @@ public RepositoryCommand(ICollaborationEngine engine, IConfigureLogger logger, I
 
         protected override ValidationResult PopulateSettings(SettingsContainer settings)
         {
+            if (string.IsNullOrWhiteSpace(RepositoryUri))
+            {
+                return ValidationResult.Failure($"Missing repository URI");
+            }
+
             Uri repoUri;
 
             try
             {
                 repoUri = RepositoryUri.ToUri();
             }
-            catch
+            catch (UriFormatException)
             {
                 return ValidationResult.Failure($"Bad repository URI: '{RepositoryUri}'");
             }

diff --git a/NuKeeper/Engine/GitRepositoryEngine.cs b/NuKeeper/Engine/GitRepositoryEngine.cs
@@ -90,7 +90,9 @@ public async Task<int> Run(RepositorySettings repository,
 
                 return updatesDone;
             }
+#pragma warning disable CA1031
             catch (Exception ex)
+#pragma warning restore CA1031
             {
                 _logger.Error($"Failed on repo {repository.RepositoryName}", ex);
                 return 1;

diff --git a/NuKeeper/Engine/Packages/ExistingBranchFilter.cs b/NuKeeper/Engine/Packages/ExistingBranchFilter.cs
@@ -27,7 +27,9 @@ public async Task<bool> CanMakeBranchFor(PackageUpdateSet packageUpdateSet,
                 var branchExists = await _collaborationFactory.CollaborationPlatform.RepositoryBranchExists(pushFork.Owner, pushFork.Name, branchName);
                 return !branchExists;
             }
+#pragma warning disable CA1031
             catch (Exception ex)
+#pragma warning restore CA1031
             {
                 _logger.Error($"Failed on existing branch check at {pushFork.Owner}/{pushFork.Name}", ex);
                 return false;

diff --git a/NuKeeper/Engine/Packages/PackageUpdater.cs b/NuKeeper/Engine/Packages/PackageUpdater.cs
@@ -50,7 +50,9 @@ public async Task<int> MakeUpdatePullRequests(
                     totalCount += updatesMade;
                 }
             }
+#pragma warning disable CA1031
             catch (Exception ex)
+#pragma warning restore CA1031
             {
                 _logger.Error("Updates failed", ex);
             }

diff --git a/NuKeeper/Engine/RepositoryFilter.cs b/NuKeeper/Engine/RepositoryFilter.cs
@@ -45,7 +45,9 @@ public async Task<bool> ContainsDotNetProjects(RepositorySettings repository)
 
                 return true;
             }
+#pragma warning disable CA1031
             catch (Exception ex)
+#pragma warning restore CA1031
             {
                 _logger.Error("Repository search failed.", ex);
             }

diff --git a/Nukeeper.BitBucketLocal/BitbucketLocalRestClient.cs b/Nukeeper.BitBucketLocal/BitbucketLocalRestClient.cs
@@ -78,7 +78,7 @@ private async Task<T> HandleResponse<T>(HttpResponseMessage response, [CallerMem
             {
                 return JsonConvert.DeserializeObject<T>(responseBody);
             }
-            catch (Exception)
+            catch (JsonException)
             {
                 msg = $"{caller}: Json exception";
                 _logger.Error(msg);