Added Tests for the new Rule; Fixed minor bugs in the rule

Author: raghushantha

Rules/Strings.Designer.cs

@@ -745,13 +745,13 @@
     <value>UseUTF8EncodingForHelpFile</value>
   </data>
   <data name="UseBOMForUnicodeEncodedFileCommonName" xml:space="preserve">
-    <value>test</value>
+    <value>Use BOM encoding for non-ASCII files</value>
   </data>
   <data name="UseBOMForUnicodeEncodedFileDescription" xml:space="preserve">
-    <value>test</value>
+    <value>For a file encoded with a format other than ASCII, ensure BOM is present to ensure that any application consuming this file can interpret it correctly.</value>
   </data>
   <data name="UseBOMForUnicodeEncodedFileError" xml:space="preserve">
-    <value>test</value>
+    <value>Missing BOM encoding for non-ASCII encoded file '{0}'</value>
   </data>
   <data name="UseBOMForUnicodeEncodedFileName" xml:space="preserve">
     <value>UseBOMForUnicodeEncodedFile</value>

Rules/Strings.resx

@@ -0,0 +1 @@
+# Test Script

Tests/Rules/TestFiles/BOMAbsent_ASCIIEncodedScript.ps1

@@ -0,0 +1,40 @@
+Import-Module PSScriptAnalyzer
+$violationMessageOne = "Missing BOM encoding for non-ASCII encoded file 'BOMAbsent_UTF16EncodedScript.ps1'"
+$violationMessageTwo = "Missing BOM encoding for non-ASCII encoded file 'BOMAbsent_UnknownEncodedScript.ps1'"
+$violationName = "PSUseBOMForUnicodeEncodedFile"
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violationsOne = Invoke-ScriptAnalyzer "$directory\TestFiles\BOMAbsent_UTF16EncodedScript.ps1" | Where-Object {$_.RuleName -eq $violationName}
+$violationsTwo = Invoke-ScriptAnalyzer "$directory\TestFiles\BOMAbsent_UnknownEncodedScript.ps1" | Where-Object {$_.RuleName -eq $violationName}
+$noViolationsOne = Invoke-ScriptAnalyzer "$directory\TestFiles\BOMPresent_UTF16EncodedScript.ps1" | Where-Object {$_.RuleName -eq $violationName}
+$noViolationsTwo = Invoke-ScriptAnalyzer "$directory\TestFiles\BOMAbsent_ASCIIEncodedScript.ps1" | Where-Object {$_.RuleName -eq $violationName}
+
+Describe "UseBOMForUnicodeEncodedFile" {
+    Context "When there are violations" {
+        It "has 1 rule violation for BOM Absent - UTF16 Encoded file" {
+            $violationsOne.Count | Should Be 1
+        }
+
+        It "has the correct description message for BOM Absent - UTF16 Encoded file" {
+            $violationsOne[0].Message | Should Match $violationMessageOne
+        }
+
+        It "has 1 rule violation for BOM Absent - Unknown Encoded file" {
+            $violationsTwo.Count | Should Be 1
+        }
+
+        It "has the correct description message for BOM Absent - Unknown Encoded file" {
+            $violationsTwo[0].Message | Should Match $violationMessageTwo
+        }
+
+    }
+
+    Context "When there are no violations" {
+        It "returns no violations for BOM Present - UTF16 Encoded File" {
+            $noViolationsOne.Count | Should Be 0
+        }
+
+        It "returns no violations for BOM Absent - ASCII Encoded File" {
+            $noViolationsTwo.Count | Should Be 0
+        }
+    }
+}