Put param/var names in linter messages where "Unused" (Azure#2899)

* WiP: Adding identifier name to Param Unused message for linter * Add unused variable name to linter warning message * Update test baselines * Fix up tests and baselines to expect named param/var in linter warning message Co-authored-by: jofleish <[email protected]> Co-authored-by: Bicep Automation <[email protected]>
geekswagg · Jun 1, 2021 · bf46a9c · bf46a9c
1 parent b186879
commit bf46a9c
Show file tree

Hide file tree

Showing 37 changed files with 741 additions and 651 deletions.
diff --git a/src/Bicep.Core.IntegrationTests/DecoratorTests.cs b/src/Bicep.Core.IntegrationTests/DecoratorTests.cs
@@ -85,7 +85,7 @@ public void ParameterDecorator_AttachedToOtherKindsOfDeclarations_CannotBeUsedAs
  {
  diagnosticsByFile[mainUri].Should().HaveDiagnostics(new[] {
  ("BCP126", DiagnosticLevel.Error, "Function \"maxLength\" cannot be used as a variable decorator."),
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("foo")),
  ("BCP127", DiagnosticLevel.Error, "Function \"allowed\" cannot be used as a resource decorator."),
  ("BCP128", DiagnosticLevel.Error, "Function \"secure\" cannot be used as a module decorator."),
  ("BCP129", DiagnosticLevel.Error, "Function \"minValue\" cannot be used as an output decorator."),
@@ -166,9 +166,9 @@ public void NonDecoratorFunction_AttachedToDeclaration_CannotBeUsedAsDecorator()
  {
  diagnosticsByFile[mainUri].Should().HaveDiagnostics(new[] {
  ("BCP152", DiagnosticLevel.Error, "Function \"resourceId\" cannot be used as a decorator."),
- (ParametersMustBeUsedRule.Code, DiagnosticLevel.Warning, new ParametersMustBeUsedRule().GetMessage()),
+ (ParametersMustBeUsedRule.Code, DiagnosticLevel.Warning, new ParametersMustBeUsedRule().GetMessage("foo")),
  ("BCP152", DiagnosticLevel.Error, "Function \"concat\" cannot be used as a decorator."),
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("bar")),
  ("BCP152", DiagnosticLevel.Error, "Function \"environment\" cannot be used as a decorator."),
  ("BCP152", DiagnosticLevel.Error, "Function \"union\" cannot be used as a decorator."),
  ("BCP152", DiagnosticLevel.Error, "Function \"guid\" cannot be used as a decorator."),

diff --git a/src/Bicep.Core.IntegrationTests/DeployTimeConstantTests.cs b/src/Bicep.Core.IntegrationTests/DeployTimeConstantTests.cs
@@ -60,7 +60,7 @@ public void DtcValidation_EntireResourceOrModuleAccessAtInvalidLocations_Produce
 ");
  result.Should().HaveDiagnostics(new[]
  {
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("foo")),
  ("BCP178", DiagnosticLevel.Error, "This expression is being used in the for-expression, which requires a value that can be calculated at the start of the deployment. Properties of dnsZone which can be calculated at the start include \"apiVersion\", \"id\", \"name\", \"type\"."),
  ("BCP178", DiagnosticLevel.Error, "This expression is being used in the for-expression, which requires a value that can be calculated at the start of the deployment. Properties of storageAccounts which can be calculated at the start include \"apiVersion\", \"id\", \"name\", \"type\"."),
  ("BCP178", DiagnosticLevel.Error, "This expression is being used in the for-expression, which requires a value that can be calculated at the start of the deployment. Properties of aRecord which can be calculated at the start include \"apiVersion\", \"id\", \"name\", \"type\"."),

diff --git a/src/Bicep.Core.IntegrationTests/ScenarioTests.cs b/src/Bicep.Core.IntegrationTests/ScenarioTests.cs
@@ -34,7 +34,7 @@ param l
  ("BCP028", DiagnosticLevel.Error, "Identifier \"l\" is declared multiple times. Remove or rename the duplicates."),
  ("BCP079", DiagnosticLevel.Error, "This expression is referencing its own declaration, which is not allowed."),
  ("BCP028", DiagnosticLevel.Error, "Identifier \"l\" is declared multiple times. Remove or rename the duplicates."),
- (ParametersMustBeUsedRule.Code, DiagnosticLevel.Warning, new ParametersMustBeUsedRule().GetMessage()),
+ (ParametersMustBeUsedRule.Code, DiagnosticLevel.Warning, new ParametersMustBeUsedRule().GetMessage("l")),
  ("BCP014", DiagnosticLevel.Error, "Expected a parameter type at this location. Please specify one of the following types: \"array\", \"bool\", \"int\", \"object\", \"string\"."),
  });
  }
@@ -361,7 +361,7 @@ public void Test_Issue1332()
 ");
 
  result.Should().HaveDiagnostics(new[] {
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage())
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("issue"))
  });
  result.Template.Should().HaveValueAtPath("$.variables.issue", "[if(true(), createObject('prop1', createObject(variables('propname'), createObject())), createObject())]");
  }
@@ -906,7 +906,7 @@ public void Test_Issue1817()
  result.Should().HaveDiagnostics(new[] {
  ("BCP032", DiagnosticLevel.Error, "The value must be a compile-time constant."),
  ("BCP057", DiagnosticLevel.Error, "The name \"w\" does not exist in the current context."),
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("foo")),
  });
  }
 
@@ -929,8 +929,8 @@ public void Test_Issue1630()
 ");
 
  result.Should().HaveDiagnostics(new[] {
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("firstApiVersion")),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("firstResourceFirstApiVersion")),
  });
  result.Template.Should().HaveValueAtPath("$.variables['singleResource']", "[providers('Microsoft.Insights', 'components')]");
  result.Template.Should().HaveValueAtPath("$.variables['firstApiVersion']", "[variables('singleResource').apiVersions[0]]");
@@ -964,7 +964,7 @@ public void Test_Issue1627()
 
  result.Should().HaveDiagnostics(new[] {
  ("BCP104", DiagnosticLevel.Error, "The referenced module has errors."),
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("bar")),
  });
  }
 
@@ -1558,7 +1558,7 @@ public void Variable_loops_should_not_cause_infinite_recursion()
 ");
 
  result.Should().HaveDiagnostics(new[]{
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("arrayOfObjectsViaLoop")),
  });
  result.Template.Should().NotBeNull();
  }
@@ -1934,7 +1934,7 @@ public void Test_Issue2484()
 ");
 
  result.Should().HaveDiagnostics(new[] {
- (ParametersMustBeUsedRule.Code, DiagnosticLevel.Warning, new ParametersMustBeUsedRule().GetMessage()),
+ (ParametersMustBeUsedRule.Code, DiagnosticLevel.Warning, new ParametersMustBeUsedRule().GetMessage("foo")),
  ("BCP027", DiagnosticLevel.Error, "The parameter expects a default value of type \"'apple' | 'banana'\" but provided value is of type \"'peach'\"."),
  });
  }
@@ -2018,7 +2018,7 @@ public void Test_Issue2624()
 ");
 
  result.Should().HaveDiagnostics(new[] {
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("foo")),
  });
  }
 
@@ -2091,7 +2091,7 @@ public void Test_Issue2248_UnionTypeInArrayAccessBaseExpression()
 var primaryLocation = locations[0]
 ");
  result.Should().HaveDiagnostics(new[] {
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("primaryLocation")),
  });
  }
 
@@ -2105,7 +2105,7 @@ public void Test_Issue2248_UnionTypeInArrayAccessBaseExpression_NegativeCase()
 ");
  result.Should().HaveDiagnostics(new[]
  {
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("primaryFoo")),
  ("BCP076",DiagnosticLevel.Error,"Cannot index over expression of type \"array | bool\". Arrays or objects are required.")
  });
  }
@@ -2127,7 +2127,7 @@ public void Test_Issue2248_UnionTypeInPropertyAccessBaseExpression()
 var p = chosenOne.foo
 ");
  result.Should().HaveDiagnostics(new[] {
- (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage()),
+ (UnusedVariableRule.Code, DiagnosticLevel.Warning, new UnusedVariableRule().GetMessage("p")),
  });
  }
 

diff --git a/src/Bicep.Core.IntegrationTests/Semantics/SemanticModelTests.cs b/src/Bicep.Core.IntegrationTests/Semantics/SemanticModelTests.cs
@@ -1,13 +1,5 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-using System;
-using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
-using System.IO;
-using System.Linq;
-using System.Text;
-using Bicep.Core.Diagnostics;
-using Bicep.Core.FileSystem;
 using Bicep.Core.Navigation;
 using Bicep.Core.Samples;
 using Bicep.Core.Semantics;
@@ -17,8 +9,12 @@
 using Bicep.Core.UnitTests.Assertions;
 using Bicep.Core.UnitTests.Utils;
 using FluentAssertions;
-using FluentAssertions.Execution;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Linq;
 
 namespace Bicep.Core.IntegrationTests.Semantics
 {

diff --git a/src/Bicep.Core.Samples/DataSet.cs b/src/Bicep.Core.Samples/DataSet.cs
@@ -1,5 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
+using Bicep.Core.Parsing;
+using Bicep.Core.UnitTests.Utils;
+using FluentAssertions;
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
@@ -8,10 +11,6 @@
 using System.Linq;
 using System.Reflection;
 using System.Threading;
-using Bicep.Core.Parsing;
-using Bicep.Core.UnitTests.Utils;
-using FluentAssertions;
-using Microsoft.VisualStudio.TestTools.UnitTesting;
 
 namespace Bicep.Core.Samples
 {

diff --git a/src/Bicep.Core.Samples/Files/AKS_LF/main.diagnostics.bicep b/src/Bicep.Core.Samples/Files/AKS_LF/main.diagnostics.bicep
@@ -20,7 +20,7 @@ param osDiskSizeGB int = 0
 @minValue(1)
 @maxValue(50)
 param agentCount int = 3
-//@[6:16) [no-unused-params (Warning)] Parameter is declared but never used. (CodeDescription: bicep core(https://aka.ms/bicep/linter/no-unused-params)) |agentCount|
+//@[6:16) [no-unused-params (Warning)] Parameter "agentCount" is declared but never used. (CodeDescription: bicep core(https://aka.ms/bicep/linter/no-unused-params)) |agentCount|
 
 param agentVMSize string = 'Standard_DS2_v2'
 // osType was a defaultValue with only one allowedValue, which seems strange?, could be a good TTK test

diff --git a/src/Bicep.Core.Samples/Files/InvalidCycles_CRLF/main.diagnostics.bicep b/src/Bicep.Core.Samples/Files/InvalidCycles_CRLF/main.diagnostics.bicep
@@ -51,7 +51,7 @@ var two = one.f
 //@[10:13) [BCP080 (Error)] The expression is involved in a cycle ("one" -> "two"). (CodeDescription: none) |one|
 // #completionTest(17) -> empty
 var twotwo = one.
-//@[4:10) [no-unused-vars (Warning)] Variable is declared but never used. (CodeDescription: bicep core(https://aka.ms/bicep/linter/no-unused-vars)) |twotwo|
+//@[4:10) [no-unused-vars (Warning)] Variable "twotwo" is declared but never used. (CodeDescription: bicep core(https://aka.ms/bicep/linter/no-unused-vars)) |twotwo|
 //@[13:16) [BCP080 (Error)] The expression is involved in a cycle ("one" -> "two"). (CodeDescription: none) |one|
 //@[17:17) [BCP020 (Error)] Expected a function or property name at this location. (CodeDescription: none) ||