Adding implementation for class based resources

Author: KarolKaczmarek

Rules/DscExamplesPresent.cs

@@ -17,11 +17,17 @@
 using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
 using System.ComponentModel.Composition;
 using System.Globalization;
+using System.IO;
+using System.Management.Automation;
 
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// DscExamplesExist: Checks that DSC examples for given resource are present
+    /// DscExamplesPresent: Checks that DSC examples for given resource are present.
+    /// Rule expects directory Examples to be present:
+    ///     For non-class based resources it should exist at the same folder level as DSCResources folder.
+    ///     For class based resources it should be present at the same folder level as resource psm1 file. 
+    /// Examples folder should contain sample configuration for given resource - file name should contain resource's name.
     /// </summary>
     [Export(typeof(IDSCResourceRule))]
     public class DscExamplesPresent : IDSCResourceRule
@@ -34,7 +40,29 @@ public class DscExamplesPresent : IDSCResourceRule
         /// <returns>The results of the analysis</returns>
         public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName)
         {
+            String fileNameOnly = fileName.Substring(fileName.LastIndexOf("\\", StringComparison.Ordinal) + 1);
+            String resourceName = fileNameOnly.Substring(0, fileNameOnly.Length - ".psm1".Length);
+            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)
+                {
+                    examplesPresent = true;
+                }
+            }
+
+            // 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>
@@ -45,9 +73,44 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName
         /// <returns></returns>
         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)
+            {
+                var attributes = typeDefinitionAst.Attributes;
+                foreach(var attribute in attributes)
+                {
+                    if (attribute.TypeName.FullName.Equals("DscResource"))
+                    {
+                        resourceName = typeDefinitionAst.Name;
+                    }
+                }
+            }
+
+            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)
+                {
+                    examplesPresent = true;
+                }
+            }
+
+            // 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>
         /// GetName: Retrieves the name of this rule.

Rules/ScriptAnalyzerBuiltinRules.csproj

@@ -68,6 +68,7 @@
     <Compile Include="AvoidUsingPlainTextForPassword.cs" />
     <Compile Include="AvoidUsingWMIObjectCmdlet.cs" />
     <Compile Include="AvoidUsingWriteHost.cs" />
+    <Compile Include="DscExamplesPresent.cs" />
     <Compile Include="UseOutputTypeCorrectly.cs" />
     <Compile Include="MissingModuleManifestField.cs" />
     <Compile Include="PossibleIncorrectComparisonWithNull.cs" />

Rules/Strings.Designer.cs

@@ -699,4 +699,7 @@
   <data name="DscExamplesPresentDescription" xml:space="preserve">
     <value>Every DSC resource module should contain folder "Examples" with sample configurations for every resource. Sample configurations should have resource name they are demonstrating in the title.</value>
   </data>
+  <data name="DscExamplesPresentNoExamplesError" xml:space="preserve">
+    <value>No examples found for resource '{0}'</value>
+  </data>
 </root>