Initial PSRule without parameter files #206 (#207)

* Initial PSRule without parameter files #206

* Update triggers and reference extension

* Separate job to ignore build bicep code

* Update PSRule options to include Bicep samples

.github/workflows/bicep-build-to-validate.yml

@@ -4,8 +4,13 @@ on:
   pull_request:
     branches:
       - main
+
+      # TODO: Branch for integration testing, to be removed before integration into main.
+      - ps-rule
     paths:
       - "**.bicep"
+      - "ps-rule.yaml"
+      - ".ps-rule/*"
   workflow_dispatch: {}
 
 jobs:
@@ -34,3 +39,22 @@ jobs:
                 echo $output
               }   
           }
+
+  azure_waf:
+    name: Test Azure Well-Architected Framework
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      # Add pipeline tests for Azure Well-Architected Framework
+      - name: Run PSRule analysis
+        uses: Microsoft/ps-rule@v2.0.0
+        with:
+          modules: PSRule.Rules.Azure
+          baseline: Azure.GA_2022_03
+        continue-on-error: true

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "ms-azuretools.vscode-bicep",
+        "bewhite.psrule-vscode"
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,16 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "PSRule",
+            "problemMatcher": [
+                "$PSRule"
+            ],
+            "label": "PSRule: Run analysis",
+            "presentation": {
+                "panel": "dedicated",
+                "clear": true
+            }
+        }
+    ]
+}

docs/wiki/Contributing.md

@@ -55,6 +55,7 @@ The following tooling/extensions are recommended to assist you developing for th
 - [CodeTour extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour)
 - [ARM Tools extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools)
 - [ARM Template Viewer extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=bencoleman.armview)
+- [PSRule extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=bewhite.psrule-vscode)
 - For visibility of Bracket Pairs:
   - Use an Extension: [Bracket Pair Colorizer 2 extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=CoenraadS.bracket-pair-colorizer-2)
   - Use Native capability:

ps-rule.yaml

@@ -0,0 +1,59 @@
+#
+# PSRule for Azure configuration
+#
+
+# Please see the documentation for all configuration options:
+# https://aka.ms/ps-rule-azure
+
+# Use rules from the following modules/
+include:
+  module:
+  - 'PSRule.Rules.Azure'
+
+# Require a minimum version of modules that include referenced baseline.
+requires:
+  PSRule.Rules.Azure: '@pre >=1.14.2'
+
+# Reference the repository in output.
+repository:
+  url: https://github.com/Azure/ALZ-Bicep
+
+execution:
+  # Ignore warnings for resources and objects that don't have any rules.
+  notProcessedWarning: false
+
+configuration:
+  # Enable expansion for Bicep source files.
+  AZURE_BICEP_FILE_EXPANSION: true
+
+  # Expand Bicep module from Azure parameter files.
+  AZURE_PARAMETER_FILE_EXPANSION: true
+
+  # Set timeout for expanding Bicep source files.
+  AZURE_BICEP_FILE_EXPANSION_TIMEOUT: 15
+
+input:
+  pathIgnore:
+  # Ignore common files that don't need analysis.
+  - '**/bicepconfig.json'
+  - '*.md'
+  - '*.png'
+  - '.github/'
+
+  # Exclude Bicep docs files
+  - docs/scripts/callModuleFromACR.example.bicep
+
+  # Exclude Bicep module files
+  - 'infra-as-code/bicep/modules/**/*.bicep'
+  - 'infra-as-code/bicep/CRML/**/*.bicep'
+
+  # Include samples/ test files from modules
+  - '!infra-as-code/bicep/modules/**/samples/*.bicep'
+
+rule:
+  exclude:
+  # Ignore these recommendations for this repo.
+  - Azure.Resource.UseTags
+  - Azure.ACR.MinSku
+  - Azure.ACR.ContentTrust
+  - Azure.Policy.AssignmentAssignedBy