O365ServiceCommunications

1.2

O365ServiceCommunications.tests.ps1

$ModulePath = Split-Path -Parent $MyInvocation.MyCommand.Path
$ModuleName = (Split-Path -Leaf $MyInvocation.MyCommand.Path) -Replace ".Tests.ps1"

$ManifestPath   = "$ModulePath\$ModuleName.psd1"
if (Get-Module -Name $ModuleName) { Remove-Module $ModuleName -Force }
Import-Module $ManifestPath

# test the module manifest - exports the right functions, processes the right formats, and is generally correct
Describe "Manifest" {
    
    $ManifestHash = Invoke-Expression (Get-Content $ManifestPath -Raw)

    It "has a valid manifest" {
        {
            $null = Test-ModuleManifest -Path $ManifestPath -ErrorAction Stop -WarningAction SilentlyContinue
        } | Should Not Throw
    }

    It "has a valid root module" {
        $ManifestHash.RootModule | Should Be "$ModuleName.psm1"
    }

    It "has a valid Description" {
        $ManifestHash.Description | Should Not BeNullOrEmpty
    }

    It "has a valid guid" {
        $ManifestHash.Guid | Should Be 'bd4390dc-a8ad-4bce-8d69-f53ccf8e4163'
    }

    It "has a valid version" {
        $ManifestHash.ModuleVersion -as [Version] | Should Not BeNullOrEmpty
    }

    It "has a valid copyright" {
        $ManifestHash.CopyRight | Should Not BeNullOrEmpty
    }

    It 'processes all existing format files' {
        $FormatFiles = Get-ChildItem "$ModulePath\Formats\" -Filter *.ps1xml | Select-Object -ExpandProperty fullname
        $ExportedFormats = $ManifestHash.FormatsToProcess | foreach {"$ModulePath\$_"}
        $ExportedFormats | Should Be $FormatFiles
    }

    It 'exports all public functions' {
        $FunctionFiles = Get-ChildItem "$ModulePath\functions" -Filter *.ps1 | Select-Object -ExpandProperty basename
        $FunctionNames = $FunctionFiles
        $ManifestHash.FunctionsToExport | Should Be $FunctionNames
    }
}

# test the functions inside the module
Describe 'helper functions' {
    InModuleScope O365ServiceCommunications {
        Context 'New-CustomObject' {
            BeforeEach {
                $InputObject = [PSCustomObject]@{
                    Property1 = 1
                    Property2 = 'two'
                    Property3 = @{hash = 'table'}
                    Property4 = @(4,'four')
                }
                $TypeName = 'Custom'
            }
            
            It 'sets typename' {
                $Object = $InputObject | New-CustomObject -TypeName $TypeName
                $Object.PSObject.TypeNames[0] | Should be $TypeName
            }
            
            It 'adds properties' {
                $Properties = @{Property5 = 5; Property6 = 'six'}
                $Object = $InputObject | New-CustomObject -TypeName $TypeName -ExtraProperties $Properties
                $Object.PSObject.Properties.Name -contains 'Property5' | Should Be $true
                $Object.PSObject.Properties.Name -contains 'Property6' | Should Be $true
            }
            
            It 'excludes properties' {
                $Object = $InputObject | New-CustomObject -TypeName $TypeName -ExcludedProperties 'Property4','Property3'
                $Object.PSObject.Properties.Name -notcontains 'Property3' | Should Be $true
                $Object.PSObject.Properties.Name -notcontains 'Property4' | Should Be $true
            }
            
            It 'outputs all properties' {
                $Object = $InputObject | New-CustomObject -TypeName $TypeName
                $Object.PSObject.Properties.Name.Count | Should Be 4
            }
            
            It 'outputs correct property values' {
                $Object = $InputObject | New-CustomObject -TypeName $TypeName
                $Object.Property1 | Should Be 1
                $Object.Property2 | Should BeExactly 'two'
            }
            
            It 'outputs correct property value types' {
                $Object = $InputObject | New-CustomObject -TypeName $TypeName
                $Object.Property3.GetType().FullName | Should Be 'System.Collections.Hashtable'
                $Object.Property4.GetType().BaseType.FullName | Should Be 'System.Array'
            }
        }
    }
}

Describe 'public functions' {
    InModuleScope O365ServiceCommunications {
        $TestCred = New-Object System.Management.Automation.PSCredential ('testUser', (ConvertTo-SecureString '1234abcD' -AsPlainText -Force))
        
        Context 'New-SCSession'{
            BeforeEach {
                $CookieText = 'qwertyuiopasdfghjkl;'
            }

            It 'should output a session object' {
                Mock Invoke-RestMethod {[pscustomobject]@{RegistrationCookie = $CookieText}}
                $Result = New-SCSession -Credential $TestCred
                $Result.PsObject.TypeNames[0] | Should Be $SessionTypeName
            }
        }
        
        Context 'Get-SCServiceInfo' {
            BeforeEach {
                Mock New-SCSession { [pscustomobject]@{Cookie = 'qwertyuiopasdfghjkl;'; Locale = 'en-US'} | New-CustomObject -TypeName $SessionTypeName }
                Mock Invoke-RestMethod {[PSCustomObject]@{ ServiceInfo = 'ServiceInfoTest' }}
            }
        
            It 'outputs a service info object' {
                $Session = New-SCSession -Credential $TestCred
                $Result = Get-SCServiceInfo -SCSession $Session
                $Result.PSObject.TypeNames[0] | Should Be $ServiceInfoTypeName
            }
        }
        
        Context 'Get-SCEvent' {
            BeforeEach {
                Mock New-SCSession { [pscustomobject]@{Cookie = 'qwertyuiopasdfghjkl;'; Locale = 'en-US'} | New-CustomObject -TypeName $SessionTypeName }
                Mock Invoke-RestMethod {[PSCustomObject]@{ Events = 'EventTest' }}
            }
        
            It 'outputs an event object' {
                $Session = New-SCSession -Credential $TestCred
                $Result = Get-SCEvent -SCSession $Session
                $Result.PSObject.TypeNames[0] | Should Be $EventTypeName
            }
        }
        
        Context 'Get-SCTenantServiceInfo' {
            BeforeEach {
                Mock New-SCSession { [pscustomobject]@{Cookie = 'qwertyuiopasdfghjkl;'; Locale = 'en-US'} | New-CustomObject -TypeName $SessionTypeName }
                Mock Invoke-RestMethod {[PSCustomObject]@{ TenantServiceInfo = 'TenantServiceInfoTest' }}
            }
        
            It 'outputs an service info object' {
                $Session = New-SCSession -Credential $TestCred
                $Result = Get-SCTenantServiceInfo -SCSession $Session -Domains domain.com
                $Result.PSObject.TypeNames[0] | Should Be $TenantServiceInfoTypeName
            }
        }
        
        Context 'Get-SCTenantEvent' {
            BeforeEach {
                Mock New-SCSession { [pscustomobject]@{Cookie = 'qwertyuiopasdfghjkl;'; Locale = 'en-US'} | New-CustomObject -TypeName $SessionTypeName }
                Mock Invoke-RestMethod {[PSCustomObject]@{ Events = 'TenantEventTest' }}
            }
        
            It 'outputs a tenant event object' {
                $Session = New-SCSession -Credential $TestCred
                $Result = Get-SCTenantEvent -SCSession $Session -Domains domain.com
                $Result.PSObject.TypeNames[0] | Should Be $TenantEventTypeName
            }
        }
    }
}