Merge pull request #30 from AsBuiltReport/dev

v0.4.6 public release
AsBuiltReport · Nov 4, 2024 · 3f7b657 · 3f7b657
2 parents 3a3b5ed + 32590bd
commit 3f7b657
Show file tree

Hide file tree

Showing 19 changed files with 243 additions and 204 deletions.
diff --git a/.github/workflows/PSScriptAnalyzer.yml b/.github/workflows/PSScriptAnalyzer.yml
@@ -5,7 +5,7 @@ jobs:
     name: Run PSScriptAnalyzer
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: lint
       uses: devblackops/github-action-psscriptanalyzer@master
       with:

diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -8,7 +8,7 @@ jobs:
   publish-to-gallery:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set PSRepository to Trusted for PowerShell Gallery
         shell: pwsh
         run: |
@@ -25,7 +25,7 @@ jobs:
     needs: publish-to-gallery
     runs-on: ubuntu-latest
     steps:
-      - uses: Eomm/why-don-t-you-tweet@v1
+      - uses: Eomm/why-don-t-you-tweet@v2
         # We don't want to tweet if the repository is not a public one
         if: ${{ !github.event.repository.private }}
         with:

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -0,0 +1,47 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+#
+# https://github.com/microsoft/action-psscriptanalyzer
+# For more information on PSScriptAnalyzer in general, see
+# https://github.com/PowerShell/PSScriptAnalyzer
+
+name: CodeQL
+
+on:
+  push:
+    branches: [ "dev" ]
+  pull_request:
+    branches: [ "dev" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: PSScriptAnalyzer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run PSScriptAnalyzer
+        uses: microsoft/psscriptanalyzer-action@v1.1
+        with:
+          # Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
+          # The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
+          path: .\
+          recurse: true
+          # Include your own basic security rules. Removing this option will run all the rules
+          excludeRule: '"PSAvoidUsingPlainTextForPassword", "PSAvoidUsingUsernameAndPasswordParams", "PSAvoidUsingConvertToSecureStringWithPlainText"'
+          output: results.sarif
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif
diff --git a/AsBuiltReport.VMware.SRM.psd1 b/AsBuiltReport.VMware.SRM.psd1
@@ -12,7 +12,7 @@
 RootModule = 'AsBuiltReport.VMware.SRM.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.4.5'
+ModuleVersion = '0.4.6'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -54,7 +54,7 @@ PowerShellVersion = '5.1'
 RequiredModules = @(
     @{
         ModuleName = 'AsBuiltReport.Core';
-        ModuleVersion = '1.3.0'
+        ModuleVersion = '1.4.0'
     }
 )
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # :arrows_clockwise: VMware SRM As Built Report Changelog
 
+## [0.4.6] - 2024-11-04
+
+### Changed
+
+- Changed Required Modules to AsBuiltReport.Core v1.4.0
+
+### Fixed
+
+- Fix [#28](https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM/issues/28)
+
 ## [0.4.5] - 2023-11-09
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -60,8 +60,8 @@ Tested On:
 This report is compatible with the following PowerShell versions;
 
 <!-- ********** Update supported PowerShell versions ********** -->
-| Windows PowerShell 5.1 |     PowerShell 7    |
-|:----------------------:|:--------------------:|
+| Windows PowerShell 5.1 |    PowerShell 7    |
+| :--------------------: | :----------------: |
 |   :white_check_mark:   | :white_check_mark: |
 
 ## :wrench: System Requirements
@@ -125,23 +125,23 @@ The following provides information of how to configure each schema within the re
 
 The **Report** schema provides configuration of the VMware SRM report information.
 
-| Sub-Schema          | Setting      | Default                        | Description                                                  |
-|---------------------|--------------|--------------------------------|--------------------------------------------------------------|
+| Sub-Schema          | Setting      | Default                    | Description                                                  |
+| ------------------- | ------------ | -------------------------- | ------------------------------------------------------------ |
 | Name                | User defined | VMware SRM As Built Report | The name of the As Built Report                              |
-| Version             | User defined | 1.0                            | The report version                                           |
-| Status              | User defined | Released                       | The report release status                                    |
-| ShowCoverPageImage  | true / false | true                           | Toggle to enable/disable the display of the cover page image |
-| ShowTableOfContents | true / false | true                           | Toggle to enable/disable table of contents                   |
-| ShowHeaderFooter    | true / false | true                           | Toggle to enable/disable document headers & footers          |
-| ShowTableCaptions   | true / false | true                           | Toggle to enable/disable table captions/numbering            |
+| Version             | User defined | 1.0                        | The report version                                           |
+| Status              | User defined | Released                   | The report release status                                    |
+| ShowCoverPageImage  | true / false | true                       | Toggle to enable/disable the display of the cover page image |
+| ShowTableOfContents | true / false | true                       | Toggle to enable/disable table of contents                   |
+| ShowHeaderFooter    | true / false | true                       | Toggle to enable/disable document headers & footers          |
+| ShowTableCaptions   | true / false | true                       | Toggle to enable/disable table captions/numbering            |
 
 ### Options
 
 The **Options** schema allows certain options within the report to be toggled on or off.
 
-| Sub-Schema      | Setting      | Default | Description                                                                                                                                                                                 |
-|-----------------|--------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| ShowDefinitionInfo | true / false | false    | Toggle to enable/disable VMware SRM Section Documentation
+| Sub-Schema         | Setting      | Default | Description                                               |
+| ------------------ | ------------ | ------- | --------------------------------------------------------- |
+| ShowDefinitionInfo | true / false | false   | Toggle to enable/disable VMware SRM Section Documentation |
 
 <!-- ********** Add/Remove the number of InfoLevels as required ********** -->
 ### InfoLevel
@@ -150,30 +150,30 @@ The **InfoLevel** schema allows configuration of each section of the report at a
 
 There are 4 levels (0-3) of detail granularity for each section as follows;
 
-| Setting | InfoLevel         | Description                                                                                                                                |
-|:-------:|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
-|    0    | Disabled          | Does not collect or display any information                                                                                                |
-|    1    | Enabled / Summary | Provides summarised information for a collection of objects                                                                                |
-|    2    | Adv Summary       | Provides condensed, detailed information for a collection of objects                                                                       |
-|    3    | Detailed          | Provides detailed information for individual objects                                                                                       |
+| Setting | InfoLevel         | Description                                                          |
+| :-----: | ----------------- | -------------------------------------------------------------------- |
+|    0    | Disabled          | Does not collect or display any information                          |
+|    1    | Enabled / Summary | Provides summarised information for a collection of objects          |
+|    2    | Adv Summary       | Provides condensed, detailed information for a collection of objects |
+|    3    | Detailed          | Provides detailed information for individual objects                 |
 
 The table below outlines the default and maximum **InfoLevel** settings for each section.
 
-| Sub-Schema   | Default Setting | Maximum Setting |
-|--------------|:---------------:|:---------------:|
-| ArrayPairs      |        1        |        1        |
-| SRA      |        1        |        1        |
-| Sites      |        1        |        1        |
-| License      |        1        |        1        |
-| Summary      |        1        |        1        |
-| FolderMapping      |        1        |        1        |
-| NetworkMapping      |        1        |        1        |
-| ResourceMapping      |        1        |        1        |
-| PlaceholderDatastores      |        1        |        1        |
-| Permission    |        1        |        1        |
-| ProtectionGroup |        1        |        3        |
-| RecoveryPlan |        1        |        3        |
-| Permission     |        1        |        1        |
+| Sub-Schema            | Default Setting | Maximum Setting |
+| --------------------- | :-------------: | :-------------: |
+| ArrayPairs            |        1        |        1        |
+| SRA                   |        1        |        1        |
+| Sites                 |        1        |        1        |
+| License               |        1        |        1        |
+| Summary               |        1        |        1        |
+| FolderMapping         |        1        |        1        |
+| NetworkMapping        |        1        |        1        |
+| ResourceMapping       |        1        |        1        |
+| PlaceholderDatastores |        1        |        1        |
+| Permission            |        1        |        1        |
+| ProtectionGroup       |        1        |        3        |
+| RecoveryPlan          |        1        |        3        |
+| Permission            |        1        |        1        |
 
 ### Healthcheck
 

diff --git a/Src/Private/Get-AbrSRMArrayPairs.ps1 → Src/Private/Get-AbrSRMArrayPair.ps1 b/Src/Private/Get-AbrSRMArrayPairs.ps1 → Src/Private/Get-AbrSRMArrayPair.ps1
@@ -1,11 +1,11 @@
-function Get-AbrSRMArrayPairs {
+function Get-AbrSRMArrayPair {
     <#
     .SYNOPSIS
         Used by As Built Report to retrieve VMware SRM Array Pairs information.
     .DESCRIPTION
         Documents the configuration of VMware SRM in Word/HTML/Text formats using PScribo.
     .NOTES
-        Version:        0.4.3
+        Version:        0.4.6
         Author:         Tim Carman
         Twitter:        @tpcarman
         Github:         @tpcarman
@@ -21,10 +21,10 @@ function Get-AbrSRMArrayPairs {
         try {
             try {
                 $LocalArrayPair = $LocalSRM.ExtensionData.Storage.QueryArrayManagers().GetArrayInfo()
-            } catch { Write-PScriboMessage -IsWarning "Unable to get Protected Site array information"}
+            } catch { Write-PScriboMessage -IsWarning "Unable to get Protected Site array information" }
             try {
                 $RemoteArrayPair = $RemoteSRM.ExtensionData.Storage.QueryArrayManagers().GetArrayInfo()
-            } catch { Write-PScriboMessage -IsWarning "Unable to get Recovery Site array information"}
+            } catch { Write-PScriboMessage -IsWarning "Unable to get Recovery Site array information" }
 
             if (($LocalArrayPair) -and ($RemoteArrayPair)) {
                 Section -Style Heading2 'Array Pairs' {
@@ -42,13 +42,13 @@ function Get-AbrSRMArrayPairs {
                         "$($ProtectedSiteName)" = "$($HashObj.Keys) <--> $($HashObj.Values)"
                         "$($RecoverySiteName)" = "$($HashObj.Values) <--> $($HashObj.Keys)"
                     }
-                    $OutObj += [pscustomobject]$inobj
+                    $OutObj += [pscustomobject](ConvertTo-HashToYN $inObj)
 
 
                     $TableParams = @{
                         Name = "Array Pairs"
                         List = $false
-                        ColumnWidths = 50,50
+                        ColumnWidths = 50, 50
                     }
                     if ($Report.ShowTableCaptions) {
                         $TableParams['Caption'] = "- $($TableParams.Name)"
@@ -63,4 +63,4 @@ function Get-AbrSRMArrayPairs {
 
     end {}
 
-}
+}
diff --git a/Src/Private/Get-AbrSRMFolderMapping.ps1 b/Src/Private/Get-AbrSRMFolderMapping.ps1
@@ -5,7 +5,7 @@ function Get-AbrSRMFolderMapping {
     .DESCRIPTION
         Documents the configuration of VMware SRM in Word/HTML/Text formats using PScribo.
     .NOTES
-        Version:        0.4.0
+        Version:        0.4.6
         Author:         Jonathan Colon & Tim Carman
         Twitter:        @jcolonfzenpr / @tpcarman
         Github:         @rebelinux / @tpcarman
@@ -28,7 +28,7 @@ function Get-AbrSRMFolderMapping {
             Section -Style Heading2 'Folder Mappings' {
                 if ($Options.ShowDefinitionInfo) {
                     Paragraph "Folder mappings allow you to specify how Site Recovery Manager maps virtual machine folders on the protected site to virtual machine folders on the recovery site."
-                    Blankline
+                    BlankLine
                 }
                 $OutObj = @()
                 foreach ($ObjMap in $FolderMappings) {
@@ -43,7 +43,7 @@ function Get-AbrSRMFolderMapping {
                             "$($ProtectedSiteName)" = $HashObj.Keys
                             "$($RecoverySiteName)" = $HashObj.Values
                         }
-                        $OutObj += [pscustomobject]$inobj
+                        $OutObj += [pscustomobject](ConvertTo-HashToYN $inObj)
                     } catch {
                         Write-PScriboMessage -IsWarning $_.Exception.Message
                     }

diff --git a/Src/Private/Get-AbrSRMNetworkMapping.ps1 b/Src/Private/Get-AbrSRMNetworkMapping.ps1
@@ -5,7 +5,7 @@ function Get-AbrSRMNetworkMapping {
     .DESCRIPTION
         Documents the configuration of VMware SRM in Word/HTML/Text formats using PScribo.
     .NOTES
-        Version:        0.4.0
+        Version:        0.4.6
         Author:         Jonathan Colon & Tim Carman
         Twitter:        @jcolonfzenpr / @tpcarman
         Github:         @rebelinux / @tpcarman
@@ -31,7 +31,7 @@ function Get-AbrSRMNetworkMapping {
             Section -Style Heading2 'Network Mappings' {
                 if ($Options.ShowDefinitionInfo) {
                     Paragraph "Network mappings allow you to specify how Site Recovery Manager maps virtual machine networks on the protected site to virtual machine networks on the recovery site."
-                    Blankline
+                    BlankLine
                 }
 
                 if ($LocalNetworkMappings) {
@@ -42,14 +42,14 @@ function Get-AbrSRMNetworkMapping {
                                 'Protected Network' = Get-View $ObjMap.PrimaryObject -Server $LocalvCenter | Select-Object -ExpandProperty Name -Unique
                                 'Recovery Network' = Get-View $ObjMap.SecondaryObject -Server $RemotevCenter | Select-Object -ExpandProperty Name -Unique
                                 'Test Network' = & {
-                                    if ($LocalTestNetworkMappings | Where-Object {$_.Key -eq $ObjMap.SecondaryObject}) {
-                                        Get-View (($LocalTestNetworkMappings | Where-Object {$_.Key -eq $ObjMap.SecondaryObject}).TestNetwork) -Server $LocalvCenter
+                                    if ($LocalTestNetworkMappings | Where-Object { $_.Key -eq $ObjMap.SecondaryObject }) {
+                                        Get-View (($LocalTestNetworkMappings | Where-Object { $_.Key -eq $ObjMap.SecondaryObject }).TestNetwork) -Server $LocalvCenter
                                     } else {
                                         'Isolated network (auto created)'
                                     }
                                 }
                             }
-                            $OutObj += [pscustomobject]$inobj
+                            $OutObj += [pscustomobject](ConvertTo-HashToYN $inObj)
                         }
 
                         $TableParams = @{
@@ -74,14 +74,14 @@ function Get-AbrSRMNetworkMapping {
                                 'Protected Network' = Get-View $ObjMap.PrimaryObject -Server $RemotevCenter | Select-Object -ExpandProperty Name -Unique
                                 'Recovery Network' = Get-View $ObjMap.SecondaryObject -Server $LocalvCenter | Select-Object -ExpandProperty Name -Unique
                                 'Test Network' = & {
-                                    if ($RemoteTestNetworkMappings | Where-Object {$_.Key -eq $ObjMap.SecondaryObject}) {
-                                        Get-View (($RemoteTestNetworkMappings | Where-Object {$_.Key -eq $ObjMap.SecondaryObject}).TestNetwork) -Server $RemotevCenter
+                                    if ($RemoteTestNetworkMappings | Where-Object { $_.Key -eq $ObjMap.SecondaryObject }) {
+                                        Get-View (($RemoteTestNetworkMappings | Where-Object { $_.Key -eq $ObjMap.SecondaryObject }).TestNetwork) -Server $RemotevCenter
                                     } else {
                                         'Isolated network (auto created)'
                                     }
                                 }
                             }
-                            $OutObj += [pscustomobject]$inobj
+                            $OutObj += [pscustomobject](ConvertTo-HashToYN $inObj)
                         }
 
                         $TableParams = @{