NetboxPS/Tests/Virtualization.Tests.ps1

<#	
	.NOTES
	===========================================================================
	 Created with: 	SAPIEN Technologies, Inc., PowerShell Studio 2018 v5.5.150
	 Created on:   	5/8/2018 4:01 PM
	 Created by:   	Ben Claussen
	 Organization: 	NEOnet
	 Filename:     	Virtualization.Tests.ps1
	===========================================================================
	.DESCRIPTION
		Virtualization Pester tests
#>

Import-Module Pester
Remove-Module NetboxPS -Force -ErrorAction SilentlyContinue

$ModulePath = "$PSScriptRoot\..\dist\NetboxPS.psd1"

if (Test-Path $ModulePath) {
    Import-Module $ModulePath -ErrorAction Stop
}

Describe -Name "Virtualization tests" -Tag 'Virtualization' -Fixture {
    Mock -CommandName 'CheckNetboxIsConnected' -Verifiable -ModuleName 'NetboxPS' -MockWith {
        return $true
    }
    
    Mock -CommandName 'Invoke-RestMethod' -Verifiable -ModuleName 'NetboxPS' -MockWith {
        # Return a hashtable of the items we would normally pass to Invoke-RestMethod
        return [ordered]@{
            'Method' = $Method
            'Uri' = $Uri
            'Headers' = $Headers
            'Timeout' = $Timeout
            'ContentType' = $ContentType
            'Body' = $Body
        }
    } 
    
    Mock -CommandName 'Get-NetboxCredential' -Verifiable -ModuleName 'NetboxPS' -MockWith {
        return [PSCredential]::new('notapplicable', (ConvertTo-SecureString -String "faketoken" -AsPlainText -Force))
    }
    
    Mock -CommandName 'Get-NetboxHostname' -Verifiable -ModuleName 'NetboxPS' -MockWith {
        return 'netbox.domain.com'
    }
    
    InModuleScope -ModuleName 'NetboxPS' -ScriptBlock {
        $script:NetboxConfig.Choices.Virtualization = (Get-Content "$PSScriptRoot\VirtualizationChoices.json" -ErrorAction Stop | ConvertFrom-Json)
        
        Context -Name "Get-NetboxVirtualMachine" -Fixture {
            It "Should request the default number of VMs" {
                $Result = Get-NetboxVirtualMachine
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with limit and offset" {
                $Result = Get-NetboxVirtualMachine -Limit 10 -Offset 12
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/?offset=12&limit=10'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a query" {
                $Result = Get-NetboxVirtualMachine -Query 'testvm'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/?q=testvm'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with an escaped query" {
                $Result = Get-NetboxVirtualMachine -Query 'test vm'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/?q=test+vm'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a name" {
                $Result = Get-NetboxVirtualMachine -Name 'testvm'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/?name=testvm'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a single ID" {
                $Result = Get-NetboxVirtualMachine -Id 10
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/10/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with multiple IDs" {
                $Result = Get-NetboxVirtualMachine -Id 10, 12, 15
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/?id__in=10,12,15'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request a status" {
                $Result = Get-NetboxVirtualMachine -Status 'Active'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/?status=1'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
        }
        
        Context -Name "Get-NetboxVirtualMachineInterface" -Fixture {
            It "Should request the default number of interfaces" {
                $Result = Get-NetboxVirtualMachineInterface
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a limit and offset" {
                $Result = Get-NetboxVirtualMachineInterface -Limit 10 -Offset 12
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/?offset=12&limit=10'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request a interface with a specific ID" {
                $Result = Get-NetboxVirtualMachineInterface -Id 10
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/10/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request a name" {
                $Result = Get-NetboxVirtualMachineInterface -Name 'Ethernet0'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/?name=Ethernet0'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a VM ID" {
                $Result = Get-NetboxVirtualMachineInterface -Virtual_Machine_Id 10
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/?virtual_machine_id=10'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with Enabled" {
                $Result = Get-NetboxVirtualMachineInterface -Enabled $true
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/?enabled=true'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
        }
        
        Context -Name "Get-NetboxVirtualMachineCluster" -Fixture {
            It "Should request the default number of clusters" {
                $Result = Get-NetboxVirtualizationCluster
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/clusters/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with limit and offset" {
                $Result = Get-NetboxVirtualizationCluster -Limit 10 -Offset 12
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/clusters/?offset=12&limit=10'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a query" {
                $Result = Get-NetboxVirtualizationCluster -Query 'testcluster'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/clusters/?q=testcluster'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with an escaped query" {
                $Result = Get-NetboxVirtualizationCluster -Query 'test cluster'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/clusters/?q=test+cluster'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a name" {
                $Result = Get-NetboxVirtualizationCluster -Name 'testcluster'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/clusters/?name=testcluster'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a single ID" {
                $Result = Get-NetboxVirtualizationCluster -Id 10
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/clusters/10/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with multiple IDs" {
                $Result = Get-NetboxVirtualizationCluster -Id 10, 12, 15
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/clusters/?id__in=10,12,15'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
        }
        
        Context -Name "Get-NetboxVirtualMachineClusterGroup" -Fixture {
            It "Should request the default number of cluster groups" {
                $Result = Get-NetboxVirtualizationClusterGroup
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/cluster-groups/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with limit and offset" {
                $Result = Get-NetboxVirtualizationClusterGroup -Limit 10 -Offset 12
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/cluster-groups/?offset=12&limit=10'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a name" {
                $Result = Get-NetboxVirtualizationClusterGroup -Name 'testclustergroup'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/cluster-groups/?name=testclustergroup'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
            
            It "Should request with a slug" {
                $Result = Get-NetboxVirtualizationClusterGroup -Slug 'test-cluster-group'
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'GET'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/cluster-groups/?slug=test-cluster-group'
                $Result.Headers.Keys.Count | Should -BeExactly 1
            }
        }
        
        Context -Name "Add-NetboxVirtualMachine" -Fixture {
            It "Should add a basic VM" {
                $Result = Add-NetboxVirtualMachine -Name 'testvm' -Cluster 1
                
                Assert-VerifiableMock

                $Result.Method | Should -Be 'POST'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"cluster":1,"name":"testvm","status":1}'
            }
            
            It "Should add a VM with CPUs, Memory, Disk, tenancy, and comments" {
                $Result = Add-NetboxVirtualMachine -Name 'testvm' -Cluster 1 -Status Active -vCPUs 4 -Memory 4096 -Tenant 11 -Disk 50 -Comments "these are comments"
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'POST'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"tenant":11,"comments":"these are comments","disk":50,"memory":4096,"name":"testvm","cluster":1,"status":1,"vcpus":4}'
            }
        }
        
        Context -Name "Add-NetboxVirtualInterface" -Fixture {
            It "Should add a basic interface" {
                $Result = Add-NetboxVirtualInterface -Name 'Ethernet0' -Virtual_Machine 10
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'POST'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"virtual_machine":10,"name":"Ethernet0","enabled":true}'
            }
            
            It "Should add an interface with a MAC, MTU, and Description" {
                $Result = Add-NetboxVirtualInterface -Name 'Ethernet0' -Virtual_Machine 10 -Mac_Address '11:22:33:44:55:66' -MTU 1500 -Description "Test description"
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'POST'
                $Result.Uri | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"mtu":1500,"description":"Test description","enabled":true,"virtual_machine":10,"name":"Ethernet0","mac_address":"11:22:33:44:55:66"}'
            }
        }
        
        Context -Name "Set-NetboxVirtualMachine" -Fixture {
            Mock -CommandName "Get-NetboxVirtualMachine" -ModuleName NetboxPS -MockWith {
                return @{
                    'Id' = 1234
                    'Name' = 'TestVM'
                }
            }
            
            It "Should set a VM to a new name" {
                $Result = Set-NetboxVirtualMachine -Id 1234 -Name 'newtestname' -Force
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'PATCH'
                $Result.URI | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/1234/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"name":"newtestname"}'
            }
            
            It "Should set a VM with a new name, cluster, platform, and status" {
                $Result = Set-NetboxVirtualMachine -Id 1234 -Name 'newtestname' -Cluster 10 -Platform 15 -Status 'Offline' -Force
                
                Assert-VerifiableMock
                
                $Result.Method | Should -Be 'PATCH'
                $Result.URI | Should -Be 'https://netbox.domain.com/api/virtualization/virtual-machines/1234/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"cluster":10,"platform":15,"name":"newtestname","status":0}'
            }
            
            It "Should throw because of an invalid status" {
                { Set-NetboxVirtualMachine -Id 1234 -Status 'Fake' -Force } | Should -Throw
                
                Assert-VerifiableMock
            }
        }
        
        Context -Name "Set-NetboxVirtualMachineInterface" -Fixture {
            Mock -CommandName "Get-NetboxVirtualMachineInterface" -ModuleName NetboxPS -MockWith {
                return @{
                    'Id' = 1234
                    'Name' = 'TestVM'
                }
            }
            
            It "Should set an interface to a new name" {
                $Result = Set-NetboxVirtualMachineInterface -Id 1234 -Name 'newtestname' -Force
                
                Assert-VerifiableMock
                Assert-MockCalled -CommandName Get-NetboxVirtualMachineInterface -Times 1 -Scope 'It' -Exactly
                
                $Result.Method | Should -Be 'PATCH'
                $Result.URI | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/1234/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"name":"newtestname"}'
            }
            
            It "Should set an interface to a new name, MTU, MAC address and description" {
                $paramSetNetboxVirtualMachineInterface = @{
                    Id = 1234
                    Name = 'newtestname'
                    MAC_Address = '11:22:33:44:55:66'
                    MTU = 9000
                    Description = "Test description"
                    Force = $true
                }
                
                $Result = Set-NetboxVirtualMachineInterface @paramSetNetboxVirtualMachineInterface
                
                Assert-VerifiableMock
                Assert-MockCalled -CommandName Get-NetboxVirtualMachineInterface -Times 1 -Scope 'It' -Exactly
                
                $Result.Method | Should -Be 'PATCH'
                $Result.URI | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/1234/'
                $Result.Headers.Keys.Count | Should -BeExactly 1
                $Result.Body | Should -Be '{"mac_address":"11:22:33:44:55:66","mtu":9000,"description":"Test description","name":"newtestname"}'
            }
            
            It "Should set multiple interfaces to a new name" {
                Mock -CommandName "Get-NetboxVirtualMachineInterface" -ModuleName NetboxPS -MockWith {
                    return @(
                        @{
                            'Id' = $Id
                            'Name' = 'TestVM'
                        }
                    )
                }
                
                $Result = Set-NetboxVirtualMachineInterface -Id 1234, 4321 -Name 'newtestname' -Force
                
                Assert-VerifiableMock
                Assert-MockCalled -CommandName Get-NetboxVirtualMachineInterface -Times 2 -Scope 'It' -Exactly
                
                $Result.Method | Should -Be 'PATCH', 'PATCH'
                $Result.URI | Should -Be 'https://netbox.domain.com/api/virtualization/interfaces/1234/', 'https://netbox.domain.com/api/virtualization/interfaces/4321/'
                $Result.Headers.Keys.Count | Should -BeExactly 2
                $Result.Body | Should -Be '{"name":"newtestname"}', '{"name":"newtestname"}'
            }
        }
    }
}