Update UseIdenticalParametersForDSC rule logic

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.

Author: Kapil Borle

Rules/UseIdenticalMandatoryParametersDSC.cs

@@ -36,6 +36,10 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
     public class UseIdenticalMandatoryParametersDSC : IDSCResourceRule
     {
         private bool isDSCClassCacheInitialized = false;
+        private Ast ast;
+        private string fileName;
+        private IDictionary<string, string> propAttrDict;
+        private IEnumerable<FunctionDefinitionAst> resourceFunctions;
 
         /// <summary>
         /// AnalyzeDSCResource: Analyzes given DSC Resource
@@ -56,10 +60,15 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName
             }
 
             // Get the keys in the corresponding mof file
-            var propAttrDict = GetKeys(fileName);
+            this.ast = ast;
+            this.fileName = fileName;
+            this.propAttrDict = GetKeys(fileName);
+            this.resourceFunctions = Helper.Instance.DscResourceFunctions(ast)
+                .Cast<FunctionDefinitionAst>()
+                .ToArray();
 
             // Loop through Set/Test/Get TargetResource DSC cmdlets
-            foreach (FunctionDefinitionAst functionDefinitionAst in Helper.Instance.DscResourceFunctions(ast))
+            foreach (var functionDefinitionAst in resourceFunctions)
             {
                 var manParams = GetMandatoryParameters(functionDefinitionAst)
                                     .Select(p => p.Name.VariablePath.UserPath);
@@ -79,6 +88,47 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName
                      fileName);
                 }
             }
+
+            var funcManParamMap = resourceFunctions
+                .ToDictionary(
+                    f => f.Name,
+                    f => Tuple.Create(
+                        f,
+                        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))
+            {
+                foreach(var func in funcManParamMap.Keys.Except(paramFuncMap[param]))
+                {
+                    var functionDefinitionAst = funcManParamMap[func].Item1;
+                    yield return new DiagnosticRecord(
+                     string.Format(
+                         CultureInfo.InvariantCulture,
+                         Strings.UseIdenticalMandatoryParametersDSCError,
+                         "mandatory",
+                         param,
+                         functionDefinitionAst.Name),
+                     Helper.Instance.GetScriptExtentForFunctionName(functionDefinitionAst),
+                     GetName(),
+                     DiagnosticSeverity.Error,
+                     fileName);
+                }
+            }
         }
 
         /// <summary>

Tests/Rules/DSCResourceModule/DSCResources/MSFT_WaitForAnyNoIdenticalMandatoryParameter/MSFT_WaitForAnyNoIdenticalMandatoryParameter.psm1

@@ -18,6 +18,9 @@ function Get-TargetResource {
         [ValidateNotNullOrEmpty()]
         [PSCredential] $Credential,
 
+        [parameter(Mandatory)]
+        $ParamOnlyInGet,
+
         [ValidateRange(1, [Uint64]::MaxValue)]
         [Uint64] $RetryIntervalSec = 1,
 
@@ -60,6 +63,9 @@ function Set-TargetResource {
         [ValidateNotNullOrEmpty()]
         [string[]] $NodeName,
 
+        [parameter(Mandatory)]
+        $ParameterOnlyInSet,
+
         [ValidateRange(1, [Uint64]::MaxValue)]
         [Uint64] $RetryIntervalSec = 1,
 
@@ -118,6 +124,9 @@ function Test-TargetResource {
         [ValidateNotNullOrEmpty()]
         [PSCredential] $Credential,
 
+        [parameter(Mandatory)]
+        $ParameterOnlyInTest,
+
         [ValidateRange(1,[Uint64]::MaxValue)]
         [Uint64] $RetryIntervalSec = 1,
 

Tests/Rules/UseIdenticalMandatoryParametersForDSC.tests.ps1

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