Update UseIdenticalParametersForDSC rule logic

This removes the constraint that a parameter needs to be declared `mandatory` in the `Get/Test/Set` functions if any of them declares the parameter as `mandatory`.

These DSC functions are supposed to take in parameters that declared in the corresponding mof file and only the parameters that are declared as `key` or `required` should be mandatory in all the three functions.

Author: Kapil Borle

RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md

@@ -4,15 +4,11 @@
 
 ## Description
 
-For script based DSC resources the `Get-TargetResource`, `Test-TargetResource` and `Set-TargetResource` functions:
-
-1. If a parameter is declared as `mandatory` in any of the `Get/Set/Test` functions, then it should be a mandatory parameter in all the three functions.
-1. If a property is declared with attributes `Key` of `Required` in a mof file, then is should be present as a mandatory parameter in the `Get/Set/Test` functions of the corresponding resource file.
+For script based DSC resources, if a property is declared with attributes `Key` of `Required` in a mof file, then is should be present as a mandatory parameter in the corresponding `Get-TargetResource`, `Set-TargetResource` and `Test-TargetResource` functions.
 
 ## How
 
-1. Make sure `Get/Set/Test` declare identical mandatory parameters.
-1. Make sure all the properties with `Key` and `Required` attributes have equivalent mandatory parameters in the `Get/Set/Test` functions.
+Make sure all the properties with `Key` and `Required` attributes have equivalent mandatory parameters in the `Get/Set/Test` functions.
 
 ## Example
 

Rules/UseIdenticalMandatoryParametersDSC.cs

@@ -67,28 +67,6 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName
                 .Cast<FunctionDefinitionAst>()
                 .ToArray();
 
-            // Loop through Set/Test/Get TargetResource DSC cmdlets
-            foreach (var functionDefinitionAst in resourceFunctions)
-            {
-                var manParams = GetMandatoryParameters(functionDefinitionAst)
-                                    .Select(p => p.Name.VariablePath.UserPath);
-
-                foreach (var key in propAttrDict.Keys.Except(manParams))
-                {
-                    yield return new DiagnosticRecord(
-                     string.Format(
-                         CultureInfo.InvariantCulture,
-                         Strings.UseIdenticalMandatoryParametersDSCError,
-                         propAttrDict[key],
-                         key,
-                         functionDefinitionAst.Name),
-                     Helper.Instance.GetScriptExtentForFunctionName(functionDefinitionAst),
-                     GetName(),
-                     DiagnosticSeverity.Error,
-                     fileName);
-                }
-            }
-
             var funcManParamMap = resourceFunctions
                 .ToDictionary(
                     f => f.Name,
@@ -97,31 +75,20 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName
                         GetMandatoryParameters(f)
                             .Select(p => p.Name.VariablePath.UserPath)
                             .ToArray()));
-            var paramFuncMap = new Dictionary<string, List<string>>();
-            foreach (var kvp in funcManParamMap)
-            {
-                foreach (var param in kvp.Value.Item2)
-                {
-                    if (!paramFuncMap.ContainsKey(param))
-                    {
-                        paramFuncMap.Add(param, new List<string>());
-                    }
 
-                    paramFuncMap[param].Add(kvp.Key);
-                }
-            }
-
-            foreach(var param in paramFuncMap.Keys.Except(propAttrDict.Keys))
+            // Loop through Set/Test/Get TargetResource DSC cmdlets
+            foreach (var kvp in funcManParamMap)
             {
-                foreach(var func in funcManParamMap.Keys.Except(paramFuncMap[param]))
+                var functionDefinitionAst = kvp.Value.Item1;
+                var manParams = kvp.Value.Item2;
+                foreach (var key in propAttrDict.Keys.Except(manParams))
                 {
-                    var functionDefinitionAst = funcManParamMap[func].Item1;
                     yield return new DiagnosticRecord(
                      string.Format(
                          CultureInfo.InvariantCulture,
                          Strings.UseIdenticalMandatoryParametersDSCError,
-                         "mandatory",
-                         param,
+                         propAttrDict[key],
+                         key,
                          functionDefinitionAst.Name),
                      Helper.Instance.GetScriptExtentForFunctionName(functionDefinitionAst),
                      GetName(),

Tests/Rules/UseIdenticalMandatoryParametersForDSC.tests.ps1

@@ -16,7 +16,7 @@ Describe "UseIdenticalMandatoryParametersForDSC" {
         }
 
         It "Should find a violations" {
-            $violations.Count | Should Be 11
+            $violations.Count | Should Be 5
         }
 
         It "Should mark only the function name" {