Merge branch 'develop'

update main codebase

Author: silverhack

.github/workflows/publishMonkeyToPSGallery.yml

@@ -0,0 +1,84 @@
+name: Publish to PowerShell Gallery
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  PublishMonkeyToGallery:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Publish
+        shell: powershell
+        env:
+          NUGET_KEY: ${{ secrets.PSGALLERY }}
+        run: |
+          $remove = @('.git', '.github', '.gitignore', 'docs', 'mkdocs.yml')
+          Write-Output "INFO: Preparing Windows-based GitHub runner for publishing module to the PowerShell Gallery."
+          Write-Output "INFO: Setting the PowerShell Gallery as a trusted repository."
+          Set-PSRepository psgallery -InstallationPolicy trusted
+          Write-Output "INFO: Locating module manifest in '$env:GITHUB_WORKSPACE'."
+          $moduleManifest = Get-ChildItem -Path $env:GITHUB_WORKSPACE -Filter *.psd1
+          If ($moduleManifest) {
+              Write-Output ("SUCCESS: Manifest {0} found in {1}." -f $moduleManifest.FullName, $env:GITHUB_WORKSPACE)
+          } Else {
+              Write-Output ("FAILURE: Manifest not found in {0}." -f $env:GITHUB_WORKSPACE)
+          }
+          If ($moduleManifest.Name -match '^(.*)\.psd1$') {
+            $moduleName = $Matches[1]
+            Write-Output "SUCCESS: Determining module name from manifest file name '$moduleName'."
+          } Else {
+                Write-Error "FAILED: Determining module name from manifest file name '$moduleName'."
+          }
+          $manifest = Test-ModuleManifest -Path $moduleManifest.FullName
+          $prerelease = $manifest.PrivateData.PSData['Prerelease']
+          If ($prerelease -and $prerelease.StartsWith('-')){
+              $version = ("{0}{1}" -f $manifest.version,$prerelease)
+          }
+          Else{
+              $version = ("{0}-{1}" -f $manifest.version,$prerelease)
+          }
+          $modulePath = Join-Path -Path $env:RUNNER_TEMP -ChildPath $moduleName
+          $createModulePath = New-Item -Path $modulePath -ItemType Directory -Force
+          If ($createModulePath) {
+              Write-Output "SUCCESS: Creating staging path '$modulePath'."
+          } Else {
+              Write-Error "FAILED: Creating staging path '$modulePath'."
+          }
+          Write-Output "INFO: Setting location to the GitHub workspace at '$env:GITHUB_WORKSPACE'."
+          Set-Location $env:GITHUB_WORKSPACE
+          Write-Output "INFO: Publishing module to the PowerShell Gallery."
+          Get-ChildItem -Force | Where-Object { $_.Name -notin $remove } | Copy-Item -Destination $modulePath -Recurse
+          #Get-ChildItem -Depth 5 -Path $modulePath | Format-Table -AutoSize
+          $moduleManifest_ = Join-Path -Path $modulePath -ChildPath ("{0}.psd1" -f $moduleName)
+          If (Test-Path -Path $moduleManifest_) {
+              #Check if module is already loaded
+              If($prerelease){
+                  $module = Find-Module -Name $moduleName -RequiredVersion ("{0}" -f $version) -AllowPrerelease -ErrorAction Ignore
+              }
+              Else{
+                  $module = Find-Module -Name $moduleName -RequiredVersion ("{0}" -f $version) -ErrorAction Ignore
+              }
+              If($null -eq $module){
+                  Publish-Module -Path $modulePath -NuGetApiKey $env:NUGET_KEY -Force
+                  Start-Sleep -Seconds 30
+                  If($prerelease){
+                      $module = Find-Module -Name $moduleName -RequiredVersion ("{0}" -f $version) -AllowPrerelease
+                  }
+                  Else{
+                      $module = Find-Module -Name $moduleName -RequiredVersion ("{0}" -f $version)
+                  }
+                  If ($module) {
+                      Write-Output "SUCCESS: Publishing module '$moduleName' version '$version' to PowerShell Gallery."
+                  }
+                  Else {
+                      Write-Error "FAILED: Publishing module '$moduleName' version '$version' to PowerShell Gallery."
+                  }
+              }
+              Else{
+                  Write-Output "SUCCESS: Module '$moduleName' version '$version' is already available in PowerShell Gallery."
+              }
+          } Else {
+              Write-Error "FAILED: Module manifest file not found at path '$moduleManifest_'."
+          }

.github/workflows/release.yml

@@ -0,0 +1,61 @@
+name: Create Release
+
+on:
+  push:
+    branches:
+      - main
+jobs:
+  monkeyversion:
+    name: Get Monkey365 version
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Get current version
+        id: monkey365version
+        shell: pwsh
+        run: |
+          $manifest = Test-ModuleManifest -Path "./monkey365.psd1"
+          $prerelease = $manifest.PrivateData.PSData['Prerelease']
+          If ($prerelease -and $prerelease.StartsWith('-')){
+              $version = ("{0}{1}" -f $manifest.version,$prerelease)
+          }
+          else{
+              $version = ("{0}-{1}" -f $manifest.version,$prerelease)
+          }
+          $releaseName = ("Monkey365 v{0}" -f $version)
+          "monkey365version=$version" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+          "releasename=$releaseName" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+      - name: Get current date
+        id: date
+        run: echo "today=$(date +'%Y-%m-%d_%H%M%S')" >> $GITHUB_OUTPUT
+      - name: Set release
+        id: release_message
+        run: |
+          echo "message=Thanks for follow [Monkey365](https://github.com/silverhack/monkey365)!." >> $GITHUB_ENV
+      - name: Create Release
+        id: create_release
+        uses: comnoco/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ steps.monkey365version.outputs.monkey365version }}
+          release_name: ${{ steps.monkey365version.outputs.releasename }}
+          body: ${{ steps.release_message.outputs.message }}
+          draft: true
+          prerelease: false
+      # Create a zip of the folder
+      - name: Create ZIP file of the folder
+        if: steps.create_release.outcome  == 'success'
+        run: |
+          mkdir -p build
+          git archive --format zip --output ./build/monkey365.zip main
+          gh release upload ${{ steps.monkey365version.outputs.monkey365version }} ./build/monkey365.zip
+          sha256sum ./build/monkey365.zip | awk '{print $1}' > ./build/monkey365.zip.sha256
+          gh release upload ${{ steps.monkey365version.outputs.monkey365version }} ./build/monkey365.zip.sha256
+          sha512sum ./build/monkey365.zip | awk '{print $1}' > ./build/monkey365.zip.sha512
+          gh release upload ${{ steps.monkey365version.outputs.monkey365version }} ./build/monkey365.zip.sha512
+        env:
+          GITHUB_TOKEN: ${{ github.TOKEN }}

.github/workflows/psa.yml renamed to .github/workflows/scriptanalyzer.yml

@@ -1,4 +1,4 @@
-name: Scan Code with PSScriptAnalyzer
+name: Scan Monkey365 with PSScriptAnalyzer
 
 on:
   # Triggers the workflow on push or pull request events but only for the develop branch
@@ -9,12 +9,12 @@ on:
 
 jobs:
   psscriptanalyzer_job:
-    name: PsScriptAnalyzer Scan Job
+    name: PsScriptAnalyzer Monkey365 Scan Job
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
-      - name: Run PsScriptAnalyzer
+      - name: Run ScriptAnalyzer
         uses: ./
         with:
           path: .\

Invoke-Monkey365.ps1

@@ -521,18 +521,14 @@ Function Invoke-Monkey365{
             Write-Error $_
         }
         Finally{
-            #Remove Report variable
-            if($null -ne (Get-Variable -Name Report -Scope Script -ErrorAction Ignore)){
-                Remove-Variable -Name Report -Scope Script -Force
-            }
-            #Remove Report variable
-            if($null -ne (Get-Variable -Name returnData -Scope Script -ErrorAction Ignore)){
-                Remove-Variable -Name returnData -Scope Script -Force
-            }
+            #Remove OutFolder variable
+            Remove-Variable -Name OutFolder -Scope Script -Force -ErrorAction Ignore
+            #Remove returnData variable
+            Remove-Variable -Name returnData -Scope Script -Force -ErrorAction Ignore
+            #Remove LogQueue
+            Remove-Variable -Name MonkeyLogQueue -Scope Global -ErrorAction Ignore -Force
             #collect garbage
             [System.GC]::GetTotalMemory($true) | out-null
         }
     }
 }
-
-

README.md

@@ -7,6 +7,9 @@
   <a href="https://github.com/silverhack/monkey365"><img alt="ScriptAnalyzer" src="https://github.com/silverhack/monkey365/actions/workflows/psa.yml/badge.svg"></a>
   <a href="https://github.com/silverhack/monkey365"><img alt="Lines" src="https://img.shields.io/tokei/lines/github/silverhack/monkey365"></a>
   <a href="https://twitter.com/tr1ana"><img alt="Twitter" src="https://img.shields.io/twitter/follow/tr1ana?style=social"></a>
+  [![latest PsGallery version](https://img.shields.io/powershellgallery/v/monkey365.svg?label=latest+version)](https://www.powershellgallery.com/packages/monkey365)
+  [![Downloads](https://img.shields.io/powershellgallery/dt/monkey365.svg?label=downloads)](https://www.powershellgallery.com/packages/monkey365)
+  ![GitHub Downloads](https://img.shields.io/github/downloads/silverhack/monkey365/total)
 </p>
 
 <p
@@ -19,7 +22,29 @@ Monkey365 is a collector-based PowerShell module that can be used to review the
 
 # Installation
 
-You can either download the latest zip by clicking [this link](https://github.com/silverhack/monkey365/archive/refs/heads/main.zip) or download Monkey365 by cloning the [repository](https://github.com/silverhack/monkey365.git):
+## PowerShell Gallery
+
+You can install Monkey365 using the built-in `Install-Module` command. The examples below will install Monkey365 in your  <a href="https://learn.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershellget-3.x#-scope" target="_blank">installation scope</a> depending on your PowerShell version. You can control this using the `-Scope <AllUsers/CurrentUser>` parameter.
+
+``` powershell
+Install-Module -Name monkey365 -Scope CurrentUser
+```
+
+To install a beta version, you can use the following command:
+
+``` powershell
+Install-Module -Name monkey365 -Scope CurrentUser -AllowPrerelease
+```
+
+To update monkey365:
+
+``` powershell
+Update-Module -Name monkey365 -Scope CurrentUser
+```
+
+## GitHub
+
+You can download the latest release by clicking [here](https://github.com/silverhack/monkey365/releases). Once downloaded, you must extract the file and extract the files to a suitable directory.
 
 Once downloaded, you must extract the files to a suitable directory. Once you have unzipped the zip file, you can use the PowerShell V3 Unblock-File cmdlet to unblock files:
 

action.yml

@@ -57,21 +57,17 @@ runs:
     - name: Run PSScriptAnalyzer
       shell: pwsh
       run: |
-        $PSA_args = [ordered]@{ Path = '${{ inputs.path }}'; }
-        if(![string]::IsNullOrEmpty('${{ inputs.customRulePath }}')) { $PSA_args.add('CustomRulePath', @(${{ inputs.customRulePath }})) }
-        if(![string]::IsNullOrEmpty('${{ inputs.recurseCustomRulePath }}')) { $PSA_args.add('RecurseCustomRulePath', $true) }
-        if(![string]::IsNullOrEmpty('${{ inputs.excludeRule }}')) { $PSA_args.add('ExcludeRule', @(${{ inputs.excludeRule }})) }
-        if(![string]::IsNullOrEmpty('${{ inputs.includeDefaultRules }}') -and '${{ inputs.includeDefaultRules }}' -ne 'false') { $PSA_args.add('IncludeDefaultRules', $true) }
-        if(![string]::IsNullOrEmpty('${{ inputs.includeRule }}')) { $PSA_args.add('IncludeRule', @(${{ inputs.includeRule }})) }
-        if(![string]::IsNullOrEmpty('${{ inputs.severity }}')) { $PSA_args.add('Severity', @(${{ inputs.severity }})) }
-        if(![string]::IsNullOrEmpty('${{ inputs.recurse }}') -and '${{ inputs.includeDefaultRules }}' -ne 'false') { $PSA_args.add('Recurse', $true) }
-        if(![string]::IsNullOrEmpty('${{ inputs.fix }}')) { $PSA_args.add('Fix', $true) }
-        if(![string]::IsNullOrEmpty('${{ inputs.enableExit }}')) { $PSA_args.add('EnableExit', $true) }
-        if(![string]::IsNullOrEmpty('${{ inputs.settings }}')) { $PSA_args.add('Settings', '${{ inputs.settings }}') }
-        [System.Void](Invoke-ScriptAnalyzer @PSA_args -Outvariable issues)
-        $errors   = $issues.Where({($_.Severity -eq 'Error') -or ($_.Severity -eq 'ParseError')})
-        $warnings = $issues.Where({$_.Severity -eq 'Warning'})
-        $info = $issues.Where({$_.Severity -eq 'Information'})
+        $ExcludeDirs = @('pipelines','docs','rules','tests')
+        $files = Get-ChildItem -Path ${{ inputs.path }}  -Recurse | Where-Object {$_.FullName -notmatch ($ExcludeDirs -join '|')}
+        $ScriptAnalyzer = @{
+            Config = @{IncludeDefaultRules = $true;}
+            Rules = Get-ScriptAnalyzerRule
+        }
+        $Config = $ScriptAnalyzer.Config
+        $ScriptAnalyzer.Results = $files | Invoke-ScriptAnalyzer @Config
+        $errors   = $ScriptAnalyzer.Results.Where({($_.Severity -eq 'Error') -or ($_.Severity -eq 'ParseError')})
+        $warnings = $ScriptAnalyzer.Results.Where({$_.Severity -eq 'Warning'})
+        $info = $ScriptAnalyzer.Results.Where({$_.Severity -eq 'Information'})
         if($errors){
           foreach ($e in $errors){
             $message = ("file={0},line={1},message{2}" -f $e.ScriptName,$e.Line,$e.Message)

assets.zip

@@ -78,4 +78,3 @@ $param = @{
 Write-information @param
 #Start process
 Start-Process docker -ArgumentList $buildArgs -NoNewWindow -Wait
-

build.ps1

@@ -131,4 +131,3 @@ function Get-MonkeyAZAPIM {
 
 
 
-

collectors/azure/APIM/Get-MonkeyAZAPIM.ps1

@@ -138,4 +138,3 @@ function Get-MonkeyAzSecurityAlert {
 
 
 
-