Changes in AnalyzeDSCClass to be called only for class based resource

Author: KarolKaczmarek

Rules/DscExamplesPresent.cs

@@ -75,41 +75,37 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCClass(Ast ast, string fileName)
         {
             String resourceName = null;
 
-            // Obtain class based resource name
-            IEnumerable<Ast> typeDefinitionAsts = (ast.FindAll(dscAst => dscAst is TypeDefinitionAst, true));
-            foreach (TypeDefinitionAst typeDefinitionAst in typeDefinitionAsts)
+            IEnumerable<Ast> dscClasses = ast.FindAll(item =>
+                item is TypeDefinitionAst
+                && ((item as TypeDefinitionAst).IsClass)
+                && (item as TypeDefinitionAst).Attributes.Any(attr => String.Equals("DSCResource", attr.TypeName.FullName, StringComparison.OrdinalIgnoreCase)), true);
+
+            foreach (TypeDefinitionAst dscClass in dscClasses)
             {
-                var attributes = typeDefinitionAst.Attributes;
-                foreach(var attribute in attributes)
+                resourceName = dscClass.Name;
+
+                String examplesQuery = "*" + resourceName + "*";
+                Boolean examplesPresent = false;
+                String expectedExamplesPath = fileName + "\\..\\Examples";
+
+                // Verify examples are present
+                if (Directory.Exists(expectedExamplesPath))
                 {
-                    if (attribute.TypeName.FullName.Equals("DscResource"))
+                    DirectoryInfo examplesFolder = new DirectoryInfo(expectedExamplesPath);
+                    FileInfo[] exampleFiles = examplesFolder.GetFiles(examplesQuery);
+                    if (exampleFiles.Length != 0)
                     {
-                        resourceName = typeDefinitionAst.Name;
+                        examplesPresent = true;
                     }
                 }
-            }
-
-            String examplesQuery = "*" + resourceName + "*";
-            Boolean examplesPresent = false;
-            String expectedExamplesPath = fileName + "\\..\\Examples";
 
-            // Verify examples are present
-            if (Directory.Exists(expectedExamplesPath))
-            {
-                DirectoryInfo examplesFolder = new DirectoryInfo(expectedExamplesPath);
-                FileInfo[] exampleFiles = examplesFolder.GetFiles(examplesQuery);
-                if (exampleFiles.Length != 0)
+                // Return error if no examples present
+                if (!examplesPresent)
                 {
-                    examplesPresent = true;
+                    yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.DscExamplesPresentNoExamplesError, resourceName),
+                                null, GetName(), DiagnosticSeverity.Information, fileName);
                 }
-            }
-
-            // Return error if no examples present
-            if (!examplesPresent)
-            {
-                yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.DscExamplesPresentNoExamplesError, resourceName),
-                            null, GetName(), DiagnosticSeverity.Information, fileName);
-            }
+            }       
         }
 
         /// <summary>

Tests/Rules/DscExamplesPresent.tests.ps1

@@ -32,6 +32,39 @@ Describe "DscExamplesPresent rule in class based resource" {
             $noViolations.Count | Should Be 0
         }
 
+        Remove-Item -Path $examplesPath -Recurse -Force
+    }
+}
+
+Describe "DscExamplesPresent rule in regular (non-class) based resource" {
+    
+    $examplesPath = "$currentPath\Examples"
+    $resourcePath = "$currentPath\DSCResources\MSFT_WaitForAll\MSFT_WaitForAll.psm1"
+
+    Context "When examples absent" {
+        
+        $violations = Invoke-ScriptAnalyzer -ErrorAction SilentlyContinue $resourcePath | Where-Object {$_.RuleName -eq $ruleName}
+        $violationMessage = "No examples found for resource 'MSFT_WaitForAll'"
+
+        It "has 1 missing examples violation" {
+            $violations.Count | Should Be 1
+        }
+
+        It "has the correct description message" {
+            $violations[0].Message | Should Match $violationMessage
+        }
+    }
+
+    Context "When examples present" {  
+        New-Item -Path $examplesPath -ItemType Directory
+        New-Item -Path "$examplesPath\MSFT_WaitForAll_Example.psm1" -ItemType File
+
+        $noViolations = Invoke-ScriptAnalyzer -ErrorAction SilentlyContinue $resourcePath | Where-Object {$_.RuleName -eq $ruleName}
+
+        It "returns no violations" {
+            $noViolations.Count | Should Be 0
+        }
+
         Remove-Item -Path $examplesPath -Recurse -Force
     }
 }