Upgrade Endjin.RecommendedPractices to 2.1 (#375)

Fix resulting analyzer warnings
marain-dotnet · Feb 16, 2022 · 931baff · 931baff
1 parent 3e2e3f1
commit 931baff
Show file tree

Hide file tree

Showing 99 changed files with 472 additions and 413 deletions.
diff --git a/Solutions/.editorconfig b/Solutions/.editorconfig
@@ -1,6 +1,25 @@
+# Note: this file was added to your solution as a result of one or more projects using the Endjin.RecommendedPractices.Build.Common NuGet package.
+# You can edit this file (e.g., to remove these comments), and it will not be updated - the package just checks for its presence, and copies
+# this file. If you don't want this file (but you want to use the NuGet package that puts it here), add this setting to all projects
+# using Endjin.RecommendedPractices.Build.Common:
+#  <EndjinDisableCodeAnalysis>true</EndjinDisableCodeAnalysis>
+# and then delete this file. That setting will prevent the package from recreating this file.
+
 # Code style rules for enforcing the endjin house style
 # See: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
-[*.cs]
+
+# XML project files
+[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
+indent_size = 2
+
+# XML config files
+[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
+indent_size = 2
+
+# C# files
+[*.{cs,csx}]
+indent_size = 4
+insert_final_newline  = false
 
 # Core editorconfig formatting - indentation
 
@@ -18,10 +37,6 @@ csharp_new_line_before_catch = true
 csharp_new_line_before_else = true
 csharp_new_line_before_open_brace = object_collection, object_collection_array_initalizers, accessors, lambdas, control_blocks, methods, properties, types
 
-# Formatting - organize using options
-
-dotnet_sort_system_directives_first = true
-
 # Formatting - spacing options
 
 csharp_space_after_cast = false
@@ -68,3 +83,27 @@ dotnet_style_qualification_for_field = true:suggestion
 dotnet_style_qualification_for_method = true:suggestion
 dotnet_style_qualification_for_property = true:suggestion
 dotnet_style_qualification_for_event = true:suggestion
+
+# Style - using directives and namespace declarations
+dotnet_sort_system_directives_first = true
+
+# Code analyzer rules (formerly in StyleCop.ruleset)
+# SA1025 makes it impossible to write decent-looking switch expressions because it
+# doesn't allow multiple whitespace characters in a row. There seems to be no way to
+# disable this rule just inside switch expressions, so we reluctantly live without it.
+dotnet_diagnostic.SA1025.severity = None
+# StyleCop's insistence that constructors' summaries must always start with exactly
+# the same boilerplate text is not deeply helpful. Saying "Creates a Foo"
+# is in most cases better than the "Initializes a new instance of the Foo type"
+# that this rule insists on.
+dotnet_diagnostic.SA1642.severity = None
+
+# CLS Compliance - not relevant for most of what we work on.
+dotnet_diagnostic.CA1014.severity = None
+
+# Standard exception constructors - not helpful when the exception absolutely needs certain information
+dotnet_diagnostic.CA1032.severity = None
+dotnet_diagnostic.RCS1194.severity = None
+
+# Localize string constants - apps that want localization can turn this back on
+dotnet_diagnostic.CA1303.severity = None
diff --git a/Solutions/Directory.build.props b/Solutions/Directory.build.props
diff --git a/Solutions/Marain.Claims.Abstractions/Marain.Claims.Abstractions.csproj b/Solutions/Marain.Claims.Abstractions/Marain.Claims.Abstractions.csproj
@@ -13,7 +13,7 @@
 
   <ItemGroup>
     <PackageReference Include="Corvus.Tenancy.Abstractions" Version="3.0.0" />
-    <PackageReference Include="Endjin.RecommendedPractices" Version="1.2.0">
+    <PackageReference Include="Endjin.RecommendedPractices.GitHub" Version="2.1.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ClaimPermissions.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ClaimPermissions.cs
@@ -113,4 +113,4 @@ public bool HasPermissionFor(Uri resourceUri, string accessType)
             return matchingRules.AllAndAtLeastOne(x => x.Permission == Permission.Allow);
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ClaimPermissionsCollection.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ClaimPermissionsCollection.cs
@@ -22,4 +22,4 @@ public List<ClaimPermissions> Permissions
             set => this.permissions = value;
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ClaimTypes.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ClaimTypes.cs
@@ -19,4 +19,4 @@ public static class ClaimTypes
         /// </summary>
         public const string ObjectIdentifier = "http://schemas.microsoft.com/identity/claims/objectidentifier";
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/IClaimPermissionsStore.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/IClaimPermissionsStore.cs
@@ -79,4 +79,4 @@ public interface IClaimPermissionsStore
         /// </returns>
         Task<bool> AnyPermissions();
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/IResourceAccessRuleSetStore.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/IResourceAccessRuleSetStore.cs
@@ -79,4 +79,4 @@ public interface IResourceAccessRuleSetStore
         /// </returns>
         Task<ResourceAccessRuleSet> PersistAsync(ResourceAccessRuleSet resourceAccessRuleSet);
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/IdWithETag.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/IdWithETag.cs
@@ -71,4 +71,4 @@ public bool Equals(IdWithETag other)
         /// <inheritdoc/>
         public override int GetHashCode() => HashCode.Combine(this.Id, this.ETag);
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/Permission.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/Permission.cs
@@ -23,4 +23,4 @@ public enum Permission
         /// </summary>
         Allow,
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/PermissionResult.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/PermissionResult.cs
@@ -14,4 +14,4 @@ public class PermissionResult
         /// </summary>
         public Permission Permission { get; set; }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/Resource.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/Resource.cs
@@ -103,4 +103,4 @@ public bool Equals(Resource other)
                 Uri.Compare(this.Uri, other.Uri, UriComponents.AbsoluteUri, UriFormat.Unescaped, StringComparison.InvariantCultureIgnoreCase) == 0;
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessEvaluation.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessEvaluation.cs
@@ -19,4 +19,4 @@ public class ResourceAccessEvaluation
         /// </summary>
         public PermissionResult Result { get; set; }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessRule.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessRule.cs
@@ -147,4 +147,4 @@ public bool IsMatch(Uri resourceUri, string accessType)
             return resourceNameMatchResult.HasMatches && accessTypeMatchResult.HasMatches;
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessRuleSet.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessRuleSet.cs
@@ -55,4 +55,4 @@ public IList<ResourceAccessRule> Rules
             set { this.rules = value; }
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessRuleSetCollection.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessRuleSetCollection.cs
@@ -22,4 +22,4 @@ public List<ResourceAccessRuleSet> RuleSets
             set => this.ruleSets = value;
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessSubmission.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/ResourceAccessSubmission.cs
@@ -24,4 +24,4 @@ public class ResourceAccessSubmission
         /// </summary>
         public string ResourceAccessType { get; set; }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Abstractions/Marain/Claims/UpdateOperation.cs b/Solutions/Marain.Claims.Abstractions/Marain/Claims/UpdateOperation.cs
@@ -10,13 +10,13 @@ namespace Marain.Claims
     public enum UpdateOperation
     {
         /// <summary>
-        /// Add operation
+        /// Add operation.
         /// </summary>
         Add,
 
         /// <summary>
-        /// Remove operation
+        /// Remove operation.
         /// </summary>
         Remove,
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Benchmark/packages.lock.json b/Solutions/Marain.Claims.Benchmark/packages.lock.json
@@ -80,8 +80,8 @@
       "Microsoft.Extensions.Configuration.EnvironmentVariables": {
         "type": "Direct",
         "requested": "[6.0.*, )",
-        "resolved": "6.0.0",
-        "contentHash": "DjYkzqvhiHCq38LW71PcIxXk6nhtV6VySP9yDcSO0goPl7YCU1VG1f2Wbgy58lkA10pWkjHCblZPUyboCB93ZA==",
+        "resolved": "6.0.1",
+        "contentHash": "pnyXV1LFOsYjGveuC07xp0YHIyGq7jRq5Ncb5zrrIieMLWVwgMyYxcOH0jTnBedDT4Gh1QinSqsjqzcieHk1og==",
         "dependencies": {
           "Microsoft.Extensions.Configuration": "6.0.0",
           "Microsoft.Extensions.Configuration.Abstractions": "6.0.0"

diff --git a/Solutions/Marain.Claims.Client.OpenApi/Marain.Claims.Client.OpenApi.csproj b/Solutions/Marain.Claims.Client.OpenApi/Marain.Claims.Client.OpenApi.csproj
@@ -12,7 +12,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Endjin.RecommendedPractices" Version="1.2.0">
+    <PackageReference Include="Endjin.RecommendedPractices.GitHub" Version="2.1.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

diff --git a/...Marain.Claims.Client.OpenApi/Marain/Claims/Client/OpenApiClientResourceAccessEvaluator.cs b/...Marain.Claims.Client.OpenApi/Marain/Claims/Client/OpenApiClientResourceAccessEvaluator.cs
@@ -91,4 +91,4 @@ public async Task<List<ResourceAccessEvaluation>> EvaluateAsync(string tenantId,
                 .ToList();
         }
     }
-}
+}
diff --git a/...nApi/Microsoft/Extensions/DependencyInjection/OpenApiClaimsServiceCollectionExtensions.cs b/...nApi/Microsoft/Extensions/DependencyInjection/OpenApiClaimsServiceCollectionExtensions.cs
@@ -182,4 +182,4 @@ public static class OpenApiClaimsServiceCollectionExtensions
             return services;
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Client/Marain.Claims.Client.csproj b/Solutions/Marain.Claims.Client/Marain.Claims.Client.csproj
@@ -22,7 +22,7 @@
 
   <ItemGroup>
     <PackageReference Include="Corvus.Identity.MicrosoftRest" Version="3.0.0" />
-    <PackageReference Include="Endjin.RecommendedPractices" Version="1.2.0">
+    <PackageReference Include="Endjin.RecommendedPractices.GitHub" Version="2.1.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

diff --git a/Solutions/Marain.Claims.Client/Marain/Claims/Client/ClaimsClientOptions.cs b/Solutions/Marain.Claims.Client/Marain/Claims/Client/ClaimsClientOptions.cs
@@ -22,4 +22,4 @@ public class ClaimsClientOptions
         /// </summary>
         public string ResourceIdForMsiAuthentication { get; set; }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Client/Marain/Claims/Client/ClaimsClientWithCachingOptions.cs b/Solutions/Marain.Claims.Client/Marain/Claims/Client/ClaimsClientWithCachingOptions.cs
@@ -18,4 +18,4 @@ public class ClaimsClientWithCachingOptions : ClaimsClientOptions
         /// </summary>
         public Dictionary<HttpStatusCode, TimeSpan> CacheExpirationPerHttpResponseCode { get; set; }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Client/Marain/Claims/Client/UnauthenticatedClaimsService.cs b/Solutions/Marain.Claims.Client/Marain/Claims/Client/UnauthenticatedClaimsService.cs
@@ -29,4 +29,4 @@ public UnauthenticatedClaimsService(Uri baseUri, params DelegatingHandler[] hand
         {
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Host.Functions/Marain.Claims.Host.Functions.csproj b/Solutions/Marain.Claims.Host.Functions/Marain.Claims.Host.Functions.csproj
@@ -32,18 +32,14 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Endjin.RecommendedPractices" Version="1.2.0">
+    <PackageReference Include="Endjin.RecommendedPractices.GitHub" Version="2.1.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.Azure.Functions.Extensions" Version="1.1.0" />
     <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="4.0.1" />
     <PackageReference Include="Microsoft.OpenApi.Readers" Version="1.2.3" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="[6.0.*,)" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Marain.Claims.Hosting.AspNetCore\Marain.Claims.Hosting.AspNetCore.csproj" />

diff --git a/Solutions/Marain.Claims.Host.Functions/Marain/Claims/Functions/ClaimsHost.cs b/Solutions/Marain.Claims.Host.Functions/Marain/Claims/Functions/ClaimsHost.cs
@@ -39,4 +39,4 @@ public Task<IActionResult> RunAsync([HttpTrigger(AuthorizationLevel.Anonymous, "
             return this.host.HandleRequestAsync(req.Path, req.Method, req, new { ExecutionContext = executionContext });
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Host.Functions/Marain/Claims/Functions/Startup.cs b/Solutions/Marain.Claims.Host.Functions/Marain/Claims/Functions/Startup.cs
@@ -62,4 +62,4 @@ private static void ConfigureAuthenticationStrategies(IServiceCollection service
             services.AddClaimsProviderStrategy<EasyAuthJwtStrategy>();
         }
     }
-}
+}
diff --git a/Solutions/Marain.Claims.Host.Functions/local.settings.template.json b/Solutions/Marain.Claims.Host.Functions/local.settings.template.json
@@ -4,6 +4,7 @@
     "AzureWebJobsStorage": "UseDevelopmentStorage=true",
     "AzureWebJobsDashboard": "UseDevelopmentStorage=true",
     "FUNCTIONS_WORKER_RUNTIME": "dotnet",
+    "FUNCTIONS_EXTENSION_VERSION": "~4",
     "APPINSIGHTS_INSTRUMENTATIONKEY": "",
     "AI:DeveloperMode": "true",