Added generating of results

maester365 · Mar 16, 2024 · 09b9398 · 09b9398
1 parent ca93228
commit 09b9398
Show file tree

Hide file tree

Showing 8 changed files with 176 additions and 138 deletions.
diff --git a/.gitignore b/.gitignore
@@ -485,4 +485,7 @@ dist
 testResults.html
 test.json
 
-.idea
+.idea
+
+# Don't allow test results in the main branch
+test-results
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+title: Introduction
 ---
 
 # Introduction
@@ -12,8 +13,9 @@ To get started install the Maester PowerShell module and clone the pre-defined r
 
 ```powershell
 Install-Module Maester
-git clone https://github.com/maester365/maester
-Invoke-Maester
+git clone https://github.com/maester365/maester-tests
+cd maester-tests
+./Invoke-Maester.ps1
 ```
 
 ## Reporting Test Results
@@ -53,4 +55,4 @@ Follow the guides here to setup daily automated tests.
 
 ### Octopus Deploy
 
-[TBD]
+[TBD]
diff --git a/src/Maester.psd1 b/src/Maester.psd1
@@ -8,141 +8,141 @@
 
 @{
 
-# Script module or binary module file associated with this manifest.
-RootModule = 'Maester.psm1'
+    # Script module or binary module file associated with this manifest.
+    RootModule           = 'Maester.psm1'
 
-# Version number of this module.
-ModuleVersion = '0.0.16'
+    # Version number of this module.
+    ModuleVersion        = '0.0.16'
 
-# Supported PSEditions
-CompatiblePSEditions = 'Core', 'Desktop'
+    # Supported PSEditions
+    CompatiblePSEditions = 'Core', 'Desktop'
 
-# ID used to uniquely identify this module
-GUID = '502a7fe7-b1ae-4bf5-98db-00831b14ed6f'
+    # ID used to uniquely identify this module
+    GUID                 = '502a7fe7-b1ae-4bf5-98db-00831b14ed6f'
 
-# Author of this module
-Author = 'Maester'
+    # Author of this module
+    Author               = 'Maester'
 
-# Company or vendor of this module
-CompanyName = 'Maester'
+    # Company or vendor of this module
+    CompanyName          = 'Maester'
 
-# Copyright statement for this module
-Copyright = 'Maester. All rights reserved.'
+    # Copyright statement for this module
+    Copyright            = 'Maester. All rights reserved.'
 
-# Description of the functionality provided by this module
-Description = 'This cmdlets in this module help you write Pester tests for your Microsoft 365 tenant configuration.'
+    # Description of the functionality provided by this module
+    Description          = 'This cmdlets in this module help you write Pester tests for your Microsoft 365 tenant configuration.'
 
-# Minimum version of the PowerShell engine required by this module
-PowerShellVersion = '5.1'
+    # Minimum version of the PowerShell engine required by this module
+    PowerShellVersion    = '5.1'
 
-# Name of the PowerShell host required by this module
-# PowerShellHostName = ''
+    # Name of the PowerShell host required by this module
+    # PowerShellHostName = ''
 
-# Minimum version of the PowerShell host required by this module
-# PowerShellHostVersion = ''
+    # Minimum version of the PowerShell host required by this module
+    # PowerShellHostVersion = ''
 
-# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# DotNetFrameworkVersion = ''
+    # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # DotNetFrameworkVersion = ''
 
-# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# ClrVersion = ''
+    # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # ClrVersion = ''
 
-# Processor architecture (None, X86, Amd64) required by this module
-# ProcessorArchitecture = ''
+    # Processor architecture (None, X86, Amd64) required by this module
+    # ProcessorArchitecture = ''
 
-# Modules that must be imported into the global environment prior to importing this module
-RequiredModules = @(@{ModuleName = 'Microsoft.Graph.Authentication'; GUID = '883916f2-9184-46ee-b1f8-b6a2fb784cee'; ModuleVersion = '2.2.0'; })
+    # Modules that must be imported into the global environment prior to importing this module
+    RequiredModules      = @(@{ModuleName = 'Microsoft.Graph.Authentication'; GUID = '883916f2-9184-46ee-b1f8-b6a2fb784cee'; ModuleVersion = '2.2.0'; })
 
-# Assemblies that must be loaded prior to importing this module
-# RequiredAssemblies = @()
+    # Assemblies that must be loaded prior to importing this module
+    # RequiredAssemblies = @()
 
-# Script files (.ps1) that are run in the caller's environment prior to importing this module.
-# ScriptsToProcess = @()
+    # Script files (.ps1) that are run in the caller's environment prior to importing this module.
+    # ScriptsToProcess = @()
 
-# Type files (.ps1xml) to be loaded when importing this module
-# TypesToProcess = @()
+    # Type files (.ps1xml) to be loaded when importing this module
+    # TypesToProcess = @()
 
-# Format files (.ps1xml) to be loaded when importing this module
-# FormatsToProcess = @()
+    # Format files (.ps1xml) to be loaded when importing this module
+    # FormatsToProcess = @()
 
-# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-NestedModules = @()
+    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+    NestedModules        = @()
 
-# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = 'Clear-MtGraphCache', 'Export-MtHtmlReport', 
-               'Get-MtConditionalAccessPolicies', 'Invoke-MtGraphRequest', 
-               'Test-MtAppManagementPolicyEnabled', 'Test-MtCaAllAppsExists', 
-               'Test-MtCaApplicationEnforcedRestrictions', 
-               'Test-MtCaBlockLegacyExchangeActiveSyncAuthentication', 
-               'Test-MtCaBlockLegacyOtherAuthentication', 
-               'Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms', 
-               'Test-MtCaDeviceComplianceAdminsExists', 
-               'Test-MtCaDeviceComplianceExists', 'Test-MtCaEmergencyAccessExists', 
-               'Test-MtCaEnforceNonPersistentBrowserSession', 
-               'Test-MtCaEnforceSignInFrequency', 
-               'Test-MtCaExclusionForDirectorySyncAccounts', 
-               'Test-MtCaMfaForAdminManagement', 'Test-MtCaMfaForAdmins', 
-               'Test-MtCaMfaForAllUsers', 'Test-MtCaMfaForGuests', 
-               'Test-MtCaMfaForRiskySignIns', 
-               'Test-MtCaRequirePasswordChangeForHighUserRisk', 
-               'Test-MtCaSecureSecurityInfoRegistration'
+    # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
+    FunctionsToExport    = 'Clear-MtGraphCache', 'Connect-MtGraph'. 'Export-MtHtmlReport',
+    'Get-MtConditionalAccessPolicies', 'Get-MtGraphScopes', 'Invoke-MtGraphRequest',
+    'Test-MtAppManagementPolicyEnabled', 'Test-MtCaAllAppsExists',
+    'Test-MtCaApplicationEnforcedRestrictions',
+    'Test-MtCaBlockLegacyExchangeActiveSyncAuthentication',
+    'Test-MtCaBlockLegacyOtherAuthentication',
+    'Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms',
+    'Test-MtCaDeviceComplianceAdminsExists',
+    'Test-MtCaDeviceComplianceExists', 'Test-MtCaEmergencyAccessExists',
+    'Test-MtCaEnforceNonPersistentBrowserSession',
+    'Test-MtCaEnforceSignInFrequency',
+    'Test-MtCaExclusionForDirectorySyncAccounts',
+    'Test-MtCaMfaForAdminManagement', 'Test-MtCaMfaForAdmins',
+    'Test-MtCaMfaForAllUsers', 'Test-MtCaMfaForGuests',
+    'Test-MtCaMfaForRiskySignIns',
+    'Test-MtCaRequirePasswordChangeForHighUserRisk',
+    'Test-MtCaSecureSecurityInfoRegistration'
 
-# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-CmdletsToExport = @()
+    # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
+    CmdletsToExport      = @()
 
-# Variables to export from this module
-# VariablesToExport = @()
+    # Variables to export from this module
+    # VariablesToExport = @()
 
-# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
-AliasesToExport = @()
+    # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
+    AliasesToExport      = @()
 
-# DSC resources to export from this module
-# DscResourcesToExport = @()
+    # DSC resources to export from this module
+    # DscResourcesToExport = @()
 
-# List of all modules packaged with this module
-# ModuleList = @()
+    # List of all modules packaged with this module
+    # ModuleList = @()
 
-# List of all files packaged with this module
-# FileList = @()
+    # List of all files packaged with this module
+    # FileList = @()
 
-# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
-PrivateData = @{
+    # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+    PrivateData          = @{
 
-    PSData = @{
+        PSData = @{
 
-        # Tags applied to this module. These help with module discovery in online galleries.
-        Tags = 'Microsoft','365','Cloud','Test','Pester','Entra','AzureAD','Automation','Regression','DevOps'
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags       = 'Microsoft', '365', 'Cloud', 'Test', 'Pester', 'Entra', 'AzureAD', 'Automation', 'Regression', 'DevOps'
 
-        # A URL to the license for this module.
-        LicenseUri = 'https://raw.githubusercontent.com/microsoft/maester/main/LICENSE'
+            # A URL to the license for this module.
+            LicenseUri = 'https://raw.githubusercontent.com/microsoft/maester/main/LICENSE'
 
-        # A URL to the main website for this project.
-        ProjectUri = 'https://github.com/microsoft/maester'
+            # A URL to the main website for this project.
+            ProjectUri = 'https://github.com/microsoft/maester'
 
-        # A URL to an icon representing this module.
-        # IconUri = ''
+            # A URL to an icon representing this module.
+            # IconUri = ''
 
-        # ReleaseNotes of this module
-        # ReleaseNotes = ''
+            # ReleaseNotes of this module
+            # ReleaseNotes = ''
 
-        # Prerelease string of this module
-        # Prerelease = ''
+            # Prerelease string of this module
+            # Prerelease = ''
 
-        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
-        # RequireLicenseAcceptance = $false
+            # Flag to indicate whether the module requires explicit user acceptance for install/update/save
+            # RequireLicenseAcceptance = $false
 
-        # External dependent modules of this module
-        # ExternalModuleDependencies = @()
+            # External dependent modules of this module
+            # ExternalModuleDependencies = @()
 
-    } # End of PSData hashtable
+        } # End of PSData hashtable
 
- } # End of PrivateData hashtable
+    } # End of PrivateData hashtable
 
-# HelpInfo URI of this module
-# HelpInfoURI = ''
+    # HelpInfo URI of this module
+    # HelpInfoURI = ''
 
-# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-# DefaultCommandPrefix = ''
+    # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+    # DefaultCommandPrefix = ''
 
 }
 
diff --git a/src/public/Connect-MtGraph.ps1 b/src/public/Connect-MtGraph.ps1
@@ -0,0 +1,19 @@
+<#
+ .Synopsis
+    Helper method to connect to Microsoft Graph using Connect-MgGraph with the required scopes.
+
+ .Description
+    Use this cmdlet to connect to Microsoft Graph using Connect-MgGraph.
+
+    This cmdlet is a short form for calling
+    ```
+    Connect-MgGraph -Scopes (Get-MtGraphScopes)
+    ```
+
+ .Example
+    Connect-MtGraph
+#>
+
+Function Connect-MtGraph {
+   Connect-MgGraph -Scopes (Get-MtGraphScopes) -NoWelcome
+}
diff --git a/src/public/Get-MtGraphScopes.ps1 b/src/public/Get-MtGraphScopes.ps1
@@ -0,0 +1,19 @@
+<#
+ .Synopsis
+    Returns the list of Graph scopes required to run Maester.
+
+ .Description
+    Use this cmdlet to connect to Microsoft Graph using Connect-MgGraph.
+
+ .Example
+    Connect-MgGraph -Scopes (Get-MtGraphScopes)
+#>
+
+Function Get-MtGraphScopes {
+
+    return @(
+        'Policy.Read.All'
+        'Directory.Read.All'
+        'Policy.ReadWrite.ConditionalAccess'
+    )
+}
diff --git a/src/public/Invoke-MtGraphRequest.ps1 b/src/public/Invoke-MtGraphRequest.ps1
@@ -60,8 +60,8 @@ Function Invoke-MtGraphRequest {
     )
 
     begin {
-        if (!$GraphBaseUri) {
-            if (!(Test-Path variable:global:GraphBaseUri)) {
+        if ([string]::IsNullOrEmpty($GraphBaseUri)) {
+            if ([string]::IsNullOrEmpty($global:GraphBaseUri)) {
                 $global:GraphBaseUri = $((Get-MgEnvironment -Name (Get-MgContext).Environment).GraphEndpoint)
             }
             $GraphBaseUri = $global:GraphBaseUri

diff --git a/tests/Custom/readme.md b/tests/Custom/readme.md
@@ -0,0 +1,11 @@
+# Custom Tests
+
+Place your custom Pester tests in this directory.
+
+If you need to customize the default tests, you can copy the tests from the `tests` directory add them here and modify to suit your needs.
+
+To make it easier to filter and run just your tests, add a 'Custom' tag to your tests and then run the tests with the `Invoke-Maester.ps1` script using the `-Tag` parameter.
+
+```powershell
+./tests/Invoke-Maester.ps1 -Tag Custom
+```