V4 Code Analyzer for detecting NPE with Collection Initializers #3478
Conversation
… object initializer that could cause a null pointer exception for generated model collection properties.
| @@ -0,0 +1,26 @@ | |||
| using Microsoft.CodeAnalysis.CSharp.Testing; | |||
There was a problem hiding this comment.
Everything in the unit test project's Verifiers folder is code you get today when you create a new code analysis with the VS template. I have copied it here so for my new unit test I can take advantage of it. I suggest treating the Verifiers folder as generated code that can be ignored.
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.CodeAnalysis" Version="3.0.0" /> | ||
| </ItemGroup> | ||
| <ItemGroup> |
There was a problem hiding this comment.
This mock code analysis project is what the unit test uses.
| @@ -149,6 +150,12 @@ private void GeneratePropertyValueAnalyzer(string codeAnalysisRoot, ServiceConfi | |||
| GeneratorDriver.WriteFile(codeAnalysisRoot, "Generated", "PropertyValueAssignmentAnalyzer.cs", text); | |||
| } | |||
|
|
|||
| private void GenerateNullCollectionInitializerAnalyzer(string codeAnalysisRoot, ServiceConfiguration serviceConfiguration) | |||
There was a problem hiding this comment.
Each service's code analysis project gets a NullCollectionInitializerAnalyzer that identifies the model namespace to the base class.
| { | ||
| public abstract class AbstractNullCollectionInitializerAnalyzer : DiagnosticAnalyzer | ||
| { | ||
| public const string DiagnosticId = "AWSSDK2000"; |
There was a problem hiding this comment.
My thought process is we could reserve AWSSDK2XXX for any code analysis rules dealing with nullability.
There was a problem hiding this comment.
Could you please add this reasoning as a comment?
generator/ServiceClientGeneratorLib/Generators/CodeAnalysis/CodeAnalysisProjectFile.tt
Show resolved
Hide resolved
| <ItemGroup> | ||
| <PackageReference Include="AWSSDK.DynamoDBv2" Version="4.0.0-preview.2" /> | ||
| </ItemGroup> |
There was a problem hiding this comment.
Why do we have this package reference? Should this be a project reference?
There was a problem hiding this comment.
My thought process was I don't really need the SDK source to test this feature and didn't want to bring in a service package and core to have be part of the dev loop recompilation. I'm never debugging the the SDK I just need the types. If you feel strongly about using project references I can switch over but does add more projects to be compiled for the dev cycle.
| { | ||
| public abstract class AbstractNullCollectionInitializerAnalyzer : DiagnosticAnalyzer | ||
| { | ||
| public const string DiagnosticId = "AWSSDK2000"; |
There was a problem hiding this comment.
Could you please add this reasoning as a comment?
Description
Add code analyzer for detecting collection initializers outside of an object initializer that could cause a null pointer exception for generated model collection properties. The main code to review is the
AbstractNullCollectionInitializerAnalyzerclass. A lot of the other code is refreshing our code analysis project system since it hasn't been updated in years.Also did some code cleanup updating to newer versions of CodeAnalysis packages and fixing obsolete warnings.
This commit does not included the generated code to keep the PR size readable. Each service's CodeAnalysis project will get the following code generated into it which indicates to the base class the model namespace.
Testing
Added new unit tests.
Dry run pending
Screenshots (if appropriate)