Tests/cOctopusServer.Tests.ps1
|
#requires -Version 4.0 [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')] # these are tests, not anything that needs to be secure param() $moduleName = Split-Path ($PSCommandPath -replace '\.Tests\.ps1$', '') -Leaf $modulePath = Split-Path $PSCommandPath -Parent $modulePath = Resolve-Path "$PSCommandPath/../../DSCResources/$moduleName/$moduleName.psm1" $module = $null try { $prefix = [guid]::NewGuid().Guid -replace '-' $module = Import-Module $modulePath -Prefix $prefix -PassThru -ErrorAction Stop InModuleScope $module.Name { # Get-Service is not available on mac/unix systems - fake it $getServiceCommand = Get-Command "Get-Service" -ErrorAction SilentlyContinue if ($null -eq $getServiceCommand) { function Get-Service {} } Describe 'cOctopusServer' { BeforeEach { $pass = ConvertTo-SecureString "S3cur3P4ssphraseHere!" -AsPlainText -Force $cred = New-Object System.Management.Automation.PSCredential ("Admin", $pass) [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] $desiredConfiguration = @{ Name = 'Stub' Ensure = 'Present' State = 'Started' WebListenPrefix = "http://localhost:80" SqlDbConnectionString = "conn-string" OctopusAdminCredential = $cred } [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] $mockConfig = [pscustomobject] @{ OctopusStorageExternalDatabaseConnectionString = 'StubConnectionString' OctopusWebPortalListenPrefixes = "https://octopus.example.com,http://localhost" } } Mock Import-ServerConfig { return $mockConfig } Context 'Get-TargetResource' { Mock Get-ItemProperty { return @{ InstallLocation = "c:\Octopus\Octopus" }} Mock Get-Service { return @{ Status = "Running" }} It 'Returns the proper data' { $config = Get-TargetResource @desiredConfiguration $config.GetType() | Should Be ([hashtable]) $config['Name'] | Should Be 'Stub' $config['Ensure'] | Should Be 'Present' $config['State'] | Should Be 'Started' } } Context 'Test-TargetResource' { $response = @{ Ensure="Absent"; State="Stopped" } Mock Get-TargetResource { return $response } It 'Returns True when Ensure is set to Absent and Instance does not exist' { $desiredConfiguration['Ensure'] = 'Absent' $desiredConfiguration['State'] = 'Stopped' $response['Ensure'] = 'Absent' $response['State'] = 'Stopped' Test-TargetResource @desiredConfiguration | Should Be $true } It 'Returns True when Ensure is set to Present and Instance exists' { $desiredConfiguration['Ensure'] = 'Present' $desiredConfiguration['State'] = 'Started' $response['Ensure'] = 'Present' $response['State'] = 'Started' Test-TargetResource @desiredConfiguration | Should Be $true } } Context 'Set-TargetResource' { #todo: more tests It 'Throws an exception if .net 4.5.1 or above is not installed (no .net reg key found)' { Mock Get-RegistryValue { return "" } { Set-TargetResource @desiredConfiguration } | Should throw "Octopus Server requires .NET 4.5.1. Please install it before attempting to install Octopus Server." } It 'Throws an exception if .net 4.5.1 or above is not installed (only .net 4.5.0 installed)' { Mock Get-RegistryValue { return "378389" } { Set-TargetResource @desiredConfiguration } | Should throw "Octopus Server requires .NET 4.5.1. Please install it before attempting to install Octopus Server." } } Context "Running HA" { It 'Should call expected commands on octopus.server.exe' { Mock Invoke-OctopusServerCommand Mock Get-TargetResource { return @{ Ensure="Absent"; State="Stopped" } } Mock Get-RegistryValue { return "478389" } # checking .net 4.5 Mock Install-MSI {} Mock Update-InstallState {} Mock Test-OctopusDeployServerResponding { return $true } Mock Test-OctopusVersionSupportsHomeDirectoryDuringCreateInstance { return $true } Mock Test-OctopusVersionRequiresDatabaseBeforeConfigure { return $true } Mock Test-OctopusVersionSupportsAutoLoginEnabled { return $true } Mock Test-OctopusVersionSupportsHsts { return $true } Mock Test-OctopusVersionSupportsShowConfiguration { return $true } Mock Test-OctopusVersionNewerThan { return $true } Mock ConvertFrom-SecureString { return "" } # mock this, as its not available on mac/linux $pass = ConvertTo-SecureString "S3cur3P4ssphraseHere!" -AsPlainText -Force $cred = New-Object System.Management.Automation.PSCredential ("Admin", $pass) $MasterKey = "Nc91+1kfZszMpe7DMne8wg==" $SecureMasterKey = ConvertTo-SecureString $MasterKey -AsPlainText -Force $MasterKeyCred = New-Object System.Management.Automation.PSCredential ("notused", $SecureMasterKey) $haparams = @{ Ensure = "Present"; State = "Started"; Name = "HANode"; WebListenPrefix = "http://localhost:82"; SqlDbConnectionString = "Server=(local);Database=Octopus;Trusted_Connection=True;"; OctopusMasterKey = $MasterKeyCred; OctopusAdminCredential = $cred; ListenPort = 10935; AllowCollectionOfUsageStatistics = $false; HomeDirectory = "C:\ChezOctopusSecondNode"; } Set-TargetResource @haparams Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 8 -Exactly Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq "create-instance --console --instance HANode --config $($env:SystemDrive)\Octopus\OctopusServer-HANode.config --home C:\ChezOctopusSecondNode" } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq "database --instance HANode --connectionstring $($haparams['SqlDbConnectionString']) --masterKey $MasterKey --grant NT AUTHORITY\SYSTEM" } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq "configure --console --instance HANode --upgradeCheck True --upgradeCheckWithStatistics False --webForceSSL False --webListenPrefixes $($haparams['WebListenPrefix']) --commsListenPort 10935 --autoLoginEnabled False --hstsEnabled False --hstsMaxAge 3600" } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'service --console --instance HANode --stop' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'admin --console --instance HANode --username Admin --password S3cur3P4ssphraseHere!' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'license --console --instance HANode --free' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'service --console --instance HANode --install --reconfigure --stop' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'service --start --console --instance HANode' } } } Context "Run-on-server user - new install" { It 'Should call expected commands on octopus.server.exe' { Mock Invoke-OctopusServerCommand #{ param ($arguments) write-host $arguments} Mock Get-TargetResource { return @{ Ensure="Absent"; State="Stopped" } } Mock Get-RegistryValue { return "478389" } # checking .net 4.5 Mock Install-MSI {} Mock Update-InstallState {} Mock Test-OctopusDeployServerResponding { return $true } Mock Test-OctopusVersionSupportsHomeDirectoryDuringCreateInstance { return $true } Mock Test-OctopusVersionRequiresDatabaseBeforeConfigure { return $true } Mock Test-OctopusVersionSupportsAutoLoginEnabled { return $true } Mock Test-OctopusVersionSupportsHsts { return $true } Mock Test-OctopusVersionSupportsShowConfiguration { return $true } Mock Test-OctopusVersionNewerThan { return $true } Mock Test-OctopusVersionSupportsRunAsCredential { return $true } Mock ConvertFrom-SecureString { return "" } # mock this, as its not available on mac/linux Mock Test-IsOctopusUpgrade { return $false } # we're installing new $pass = ConvertTo-SecureString "S3cur3P4ssphraseHere!" -AsPlainText -Force $cred = New-Object System.Management.Automation.PSCredential ("Admin", $pass) $pass = ConvertTo-SecureString "S4cretPassword!" -AsPlainText -Force $runAsCred = New-Object System.Management.Automation.PSCredential ("runasuser", $pass) $haparams = @{ Ensure = "Present"; State = "Started"; Name = "OctopusServer"; WebListenPrefix = "http://localhost:82"; SqlDbConnectionString = "Server=(local);Database=Octopus;Trusted_Connection=True;"; OctopusAdminCredential = $cred; ListenPort = 10935; AllowCollectionOfUsageStatistics = $false; HomeDirectory = "C:\Octopus"; OctopusBuiltInWorkerCredential = $runAsCred } Set-TargetResource @haparams Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 9 -Exactly Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq "create-instance --console --instance OctopusServer --config $($env:SystemDrive)\Octopus\OctopusServer-OctopusServer.config --home C:\Octopus" } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq "database --instance OctopusServer --connectionstring $($haparams['SqlDbConnectionString']) --create --grant NT AUTHORITY\SYSTEM" } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq "configure --console --instance OctopusServer --upgradeCheck True --upgradeCheckWithStatistics False --webForceSSL False --webListenPrefixes $($haparams['WebListenPrefix']) --commsListenPort 10935 --autoLoginEnabled False --hstsEnabled False --hstsMaxAge 3600" } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'service --console --instance OctopusServer --stop' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'admin --console --instance OctopusServer --username Admin --password S3cur3P4ssphraseHere!' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'license --console --instance OctopusServer --free' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'service --console --instance OctopusServer --install --reconfigure --stop' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'builtin-worker --instance OctopusServer --username runasuser --password S4cretPassword!' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'service --start --console --instance OctopusServer' } } } Context "Run-on-server user - existing install" { It 'Should call expected commands on octopus.server.exe' { Mock Invoke-OctopusServerCommand #{ param ($arguments) write-host $arguments} Mock Get-TargetResource { return @{ Ensure="Present"; State="Started"; DownloadUrl="https://octopus.com/downloads/latest/WindowsX64/OctopusServer" } } Mock Get-RegistryValue { return "478389" } # checking .net 4.5 Mock Update-InstallState {} Mock Test-OctopusDeployServerResponding { return $true } Mock Test-OctopusVersionSupportsHomeDirectoryDuringCreateInstance { return $true } Mock Test-OctopusVersionRequiresDatabaseBeforeConfigure { return $true } Mock Test-OctopusVersionSupportsAutoLoginEnabled { return $true } Mock Test-OctopusVersionSupportsHsts { return $true } Mock Test-OctopusVersionSupportsShowConfiguration { return $true } Mock Test-OctopusVersionNewerThan { return $true } Mock Test-OctopusVersionSupportsRunAsCredential { return $true } Mock ConvertFrom-SecureString { return "" } # mock this, as its not available on mac/linux $pass = ConvertTo-SecureString "S3cur3P4ssphraseHere!" -AsPlainText -Force $cred = New-Object System.Management.Automation.PSCredential ("Admin", $pass) $pass = ConvertTo-SecureString "S4cretPassword!" -AsPlainText -Force $runAsCred = New-Object System.Management.Automation.PSCredential ("runasuser", $pass) $haparams = @{ Ensure = "Present"; State = "Started"; Name = "OctopusServer"; WebListenPrefix = "http://localhost:82"; SqlDbConnectionString = "Server=(local);Database=Octopus;Trusted_Connection=True;"; OctopusAdminCredential = $cred; ListenPort = 10935; AllowCollectionOfUsageStatistics = $false; HomeDirectory = "C:\Octopus"; OctopusBuiltInWorkerCredential = $runAsCred } Set-TargetResource @haparams Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 4 -Exactly Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq "configure --console --instance OctopusServer --upgradeCheck True --upgradeCheckWithStatistics False --webForceSSL False --webListenPrefixes $($haparams['WebListenPrefix']) --commsListenPort 10935 --home C:\Octopus --autoLoginEnabled False --hstsEnabled False --hstsMaxAge 3600" } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'admin --console --instance OctopusServer --username Admin --password S3cur3P4ssphraseHere!' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'license --console --instance OctopusServer --free' } Assert-MockCalled -CommandName 'Invoke-OctopusServerCommand' -Times 1 -Exactly -ParameterFilter { ($arguments -join ' ') -eq 'builtin-worker --instance OctopusServer --username runasuser --password S4cretPassword!' } } } } } } finally { if ($module) { Remove-Module -ModuleInfo $module } } |