BitTitan.Runbooks.MSOnline.Beta

0.2.12

Functions/Connect-MSOnlineAdminAccount.Tests.ps1

describe "BitTitan.Runbooks.MSOnline/Connect-MSOnlineAdminAccount" -Tag "module", "unit" {

    # Import the function to test
    . "$($PSScriptRoot)\Connect-MSOnlineAdminAccount.ps1"

    # Declare external functions and mocks
    function Connect-MsolService {
        param ([PSCredential]$Credential)
    }

    context "when there are no issues" {
        # Declare mocks
        mock Connect-MsolService {}

        it "connects to MS Online with the provided username and password" {
            # Call the function
            $output = Connect-MSOnlineAdminAccount -Username "username" -Password ("password" | ConvertTo-SecureString -AsPlainText -Force)

            # Verify the mocks
            Assert-MockCalled Connect-MsolService -Times 1 -Exactly -ParameterFilter {
                $Credential.Username -eq "username" -and $Credential.GetNetworkCredential().Password -eq "password"
            } -Scope it

            # Verify the output
            $output | Should Be $true
        }

        it "connects to MS Online with the provided endpoint" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Credential = [PSCredential]::new("username", ("password" | ConvertTo-SecureString -AsPlainText -Force))
            }

            # Call the function
            $output = Connect-MSOnlineAdminAccount -Endpoint $endpoint

            # Verify the mocks
            Assert-MockCalled Connect-MsolService -Times 1 -Exactly -ParameterFilter {
                $Credential.Username -eq "username" -and $Credential.GetNetworkCredential().Password -eq "password"
            } -Scope it

            # Verify the output
            $output | Should Be $true
        }
    }

    context "when there is an exception while connecting to MS Online" {
        # Mock Declare mocks
        mock Connect-MsolService {
            throw "throws exception"
        }

        it "fails to connect to MS Online and outputs an error message" {
            # Call the function
            $output = Connect-MSOnlineAdminAccount -Username "username" -Password ("password" | ConvertTo-SecureString -AsPlainText -Force) `
                -ErrorAction SilentlyContinue -ErrorVariable errorVariable

            # Verify the mocks
            Assert-MockCalled Connect-MsolService -Times 1 -Exactly -ParameterFilter {
                $Credential.Username -eq "username" -and $Credential.GetNetworkCredential().Password -eq "password"
            } -Scope it

            # Verify the output
            $errorVariable | Should Not BeNullOrEmpty
            $output | Should Be $false
        }
    }
}