From d39d5c62ff908cf644e6bc287469c063b35ffc35 Mon Sep 17 00:00:00 2001
From: Justin Grote <jgrote@allieddigital.net>
Date: Fri, 19 Jun 2020 16:13:13 +0000
Subject: [PATCH] Powershell Initial Commit

---
 .../test/powershell/powershell_bad_1.ps1      | 14 ++++++++++++
 .../test/powershell/powershell_good_1.ps1     |  1 +
 TEMPLATES/.powershell-psscriptanalyzer.psd1   | 18 +++++++++++++++
 lib/linter.sh                                 | 22 ++++++++++++++++---
 4 files changed, 52 insertions(+), 3 deletions(-)
 create mode 100644 .automation/test/powershell/powershell_bad_1.ps1
 create mode 100644 .automation/test/powershell/powershell_good_1.ps1
 create mode 100644 TEMPLATES/.powershell-psscriptanalyzer.psd1

diff --git a/.automation/test/powershell/powershell_bad_1.ps1 b/.automation/test/powershell/powershell_bad_1.ps1
new file mode 100644
index 00000000..f1709a0a
--- /dev/null
+++ b/.automation/test/powershell/powershell_bad_1.ps1
@@ -0,0 +1,14 @@
+#Plaintext Parameters
+function BadFunction {
+    param(
+        [String]$Username = 'me',
+        [String]$Password = 'password'
+    )
+    $Username
+    $Password
+    $VariableThatIsNotUsedLater = '5'
+    try {
+        'Empty Catch Block' 
+    } catch {}
+}
+
diff --git a/.automation/test/powershell/powershell_good_1.ps1 b/.automation/test/powershell/powershell_good_1.ps1
new file mode 100644
index 00000000..d762886f
--- /dev/null
+++ b/.automation/test/powershell/powershell_good_1.ps1
@@ -0,0 +1 @@
+Write-Output "hello world!"
\ No newline at end of file
diff --git a/TEMPLATES/.powershell-psscriptanalyzer.psd1 b/TEMPLATES/.powershell-psscriptanalyzer.psd1
new file mode 100644
index 00000000..ab462662
--- /dev/null
+++ b/TEMPLATES/.powershell-psscriptanalyzer.psd1
@@ -0,0 +1,18 @@
+#Documentation: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-settings
+@{
+    #CustomRulePath='path\to\CustomRuleModule.psm1'
+    #RecurseCustomRulePath='path\of\customrules'
+    #Severity = @(
+    #    'Error'
+    #    'Warning'
+    #)
+    #IncludeDefaultRules=$true
+    #ExcludeRules = @(
+    #    'PSAvoidUsingWriteHost',
+    #    'MyCustomRuleName'
+    #)
+    #IncludeRules = @(
+    #    'PSAvoidUsingWriteHost',
+    #    'MyCustomRuleName'
+    #)
+}
\ No newline at end of file
diff --git a/lib/linter.sh b/lib/linter.sh
index 473f53cd..32687755 100755
--- a/lib/linter.sh
+++ b/lib/linter.sh
@@ -48,20 +48,24 @@ GO_LINTER_RULES="$DEFAULT_RULES_LOCATION/$GO_FILE_NAME"             # Path to th
 # Terraform Vars
 TERRAFORM_FILE_NAME='.tflint.hcl'                                        # Name of the file
 TERRAFORM_LINTER_RULES="$DEFAULT_RULES_LOCATION/$TERRAFORM_FILE_NAME"    # Path to the Terraform lint rules
+# Powershell Vars
+POWERSHELL_FILE_NAME='.powershell-psccriptanalyzer.psd1'                  # Name of the file
+POWERSHELL_LINTER_RULES="$DEFAULT_RULES_LOCATION/$POWERSHELL_FILE_NAME"    # Path to the Powershell lint rules
+
 
 #######################################
 # Linter array for information prints #
 #######################################
 LINTER_ARRAY=("jsonlint" "yamllint" "xmllint" "markdownlint" "shellcheck"
   "pylint" "perl" "rubocop" "coffeelint" "eslint" "standard"
-  "ansible-lint" "/dockerfilelint/bin/dockerfilelint" "golangci-lint" "tflint")
+  "ansible-lint" "/dockerfilelint/bin/dockerfilelint" "golangci-lint" "tflint" "powershell")
 
 #############################
 # Language array for prints #
 #############################
 LANGUAGE_ARRAY=('YML' 'JSON' 'XML' 'MARKDOWN' 'BASH' 'PERL' 'RUBY' 'PYTHON'
   'COFFEESCRIPT' 'ANSIBLE' 'JAVASCRIPT_STANDARD' 'JAVASCRIPT_ES'
-  'TYPESCRIPT_STANDARD' 'TYPESCRIPT_ES' 'DOCKER' 'GO' 'TERRAFORM')
+  'TYPESCRIPT_STANDARD' 'TYPESCRIPT_ES' 'DOCKER' 'GO' 'TERRAFORM' 'POWERSHELL')
 
 ###################
 # GitHub ENV Vars #
@@ -88,6 +92,7 @@ VALIDATE_TYPESCRIPT_STANDARD="${VALIDATE_TYPESCRIPT_STANDARD}"  # Boolean to val
 VALIDATE_DOCKER="${VALIDATE_DOCKER}"                  # Boolean to validate language
 VALIDATE_GO="${VALIDATE_GO}"                          # Boolean to validate language
 VALIDATE_TERRAFORM="${VALIDATE_TERRAFORM}"            # Boolean to validate language
+VALIDATE_POWERSHELL="${VALIDATE_POWERSHELL}"          # Boolean to validate language
 TEST_CASE_RUN="${TEST_CASE_RUN}"                      # Boolean to validate only test cases
 
 ##############
@@ -2225,7 +2230,18 @@ if [ "$VALIDATE_DOCKER" == "true" ]; then
   LintCodebase "DOCKER" "/dockerfilelint/bin/dockerfilelint" "/dockerfilelint/bin/dockerfilelint" ".*\(Dockerfile\)\$" "${FILE_ARRAY_DOCKER[@]}"
 fi
 
+######################
+# POWERSHELL LINTING #
+######################
+if [ "$VALIDATE_POWERSHELL" == "true" ]; then
+  #############################
+  # Lint the powershell files #
+  #############################
+  # LintCodebase "FILE_TYPE" "LINTER_NAME" "LINTER_CMD" "FILE_TYPES_REGEX" "FILE_ARRAY"
+  LintCodebase "POWERSHELL" "pwsh" "pwsh -c 'Invoke-ScriptAnalyzer -Settings $POWERSHELL_LINTER_RULES -Path' " 'ps[md]?1$' "${FILE_ARRAY_POWERSHELL[@]}"
+fi
+
 ##########
 # Footer #
 ##########
-Footer
+Footer
\ No newline at end of file