Tests/Unit/psgithub.tests.ps1
|
# # This is a PowerShell Unit Test file. # You need a unit test framework such as Pester to run PowerShell Unit tests. # You can download Pester from http://go.microsoft.com/fwlink/?LinkID=534084 # $ModuleRoot = "$($Script:MyInvocation.MyCommand.Path)\..\..\.." Push-Location ` -Path $ModuleRoot Get-Module ` -Name PSGitHub ` -All | Remove-Module Import-Module ` -Name "$ModuleRoot\PSGitHub.psd1" ` -Force ` -DisableNameChecking $Global:ArtifactPath = "$ModuleRoot\Artifacts" $null = New-Item ` -Path $ArtifactPath ` -ItemType Directory ` -Force ` -ErrorAction SilentlyContinue if (-not (Get-Module -Name PSScriptAnalyzer -ListAvailable)) { # Perform PS Script Analyzer tests on module code only $null = Set-PackageSource ` -Name PSGallery ` -Trusted ` -Force $null = Install-Module ` -Name PSScriptAnalyzer ` -Confirm:$False Import-Module ` -Name PSScriptAnalyzer } Describe 'PSScriptAnalyzer' { Context 'PSGitHub Module, Functions and TabCompleters' { It 'Passes Invoke-ScriptAnalyzer' { # Perform PSScriptAnalyzer scan. $PSScriptAnalyzerResult = Invoke-ScriptAnalyzer ` -Path "$ModuleRoot\PSGitHub.psm1" ` -Severity Warning ` -ErrorAction SilentlyContinue $PSScriptAnalyzerResult += Invoke-ScriptAnalyzer ` -Path "$ModuleRoot\Functions\Public\*.ps1" ` -Severity Warning ` -ErrorAction SilentlyContinue $PSScriptAnalyzerResult += Invoke-ScriptAnalyzer ` -Path "$ModuleRoot\Functions\Private\*.ps1" ` -Severity Warning ` -ErrorAction SilentlyContinue $PSScriptAnalyzerResult += Invoke-ScriptAnalyzer ` -Path "$ModuleRoot\TabCompleters\*.ps1" ` -Severity Warning ` -ErrorAction SilentlyContinue $PSScriptAnalyzerErrors = $PSScriptAnalyzerResult ` | Where-Object { $_.Severity -eq 'Error' } $PSScriptAnalyzerWarnings = $PSScriptAnalyzerResult ` | Where-Object { $_.Severity -eq 'Warning' } if ($PSScriptAnalyzerErrors -ne $null) { Write-Warning ` -Message 'There are PSScriptAnalyzer errors that need to be fixed:' @($PSScriptAnalyzerErrors).Foreach( { Write-Warning -Message "$($_.Scriptname) (Line $($_.Line)): $($_.Message)" } ) Write-Warning ` -Message 'For instructions on how to run PSScriptAnalyzer on your own machine, please go to https://github.com/powershell/psscriptAnalyzer/' $PSScriptAnalyzerErrors.Count | Should Be $null } if ($PSScriptAnalyzerWarnings -ne $null) { Write-Warning ` -Message 'There are PSScriptAnalyzer warnings that should be fixed if possible:' @($PSScriptAnalyzerWarnings).Foreach( { Write-Warning -Message "$($_.Scriptname) (Line $($_.Line)): $($_.Message)" } ) } } } } InModuleScope PSGitHub { #region *-GitHubLabel Describe 'Get-GitHubLabel' { BeforeAll { Mock -CommandName Invoke-GitHubApi $mockOwnerName = 'Mary' $mockRepositoryName = 'WebApps' $mockLabelName = 'Label1' $mockExpectedDefaultRestMethod = 'repos/{0}/{1}/labels' -f $mockOwnerName, $mockRepositoryName } Context 'When getting first page of all labels in a repository' { It 'Should call the mock with the correct arguments' { { Get-GitHubLabel -Owner $mockOwnerName -Repository $mockRepositoryName } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Get' -and $RestMethod -eq $mockExpectedDefaultRestMethod } } } Context 'When getting second page of all labels in a repository' { It 'Should call the mock with the correct arguments' { { Get-GitHubLabel -Owner $mockOwnerName -Repository $mockRepositoryName -Page 2 } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Get' -and $RestMethod -eq ('{0}?page=2' -f $mockExpectedDefaultRestMethod) } } } Context 'When getting a specific label in a repository' { It 'Should call the mock with the correct arguments' { { Get-GitHubLabel -Owner $mockOwnerName -Repository $mockRepositoryName -Name $mockLabelName } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Get' -and $RestMethod -eq ('{0}/{1}' -f $mockExpectedDefaultRestMethod, $mockLabelName) } } } } Describe 'New-GitHubLabel' { BeforeAll { Mock -CommandName Invoke-GitHubApi $mockOwnerName = 'Mary' $mockRepositoryName = 'WebApps' $mockLabelName = 'Label1' $mockLabelColor = 'ffffff' $mockLabelDescription = 'Label description' $newGitHubLabelParameters = @{ Owner = $mockOwnerName Repository = $mockRepositoryName Name = $mockLabelName Color = $mockLabelColor } $mockExpectedDefaultRestMethod = 'repos/{0}/{1}/labels' -f $mockOwnerName, $mockRepositoryName $mockExpectedDefaultRequestBody = @{ name = $mockLabelName color = $mockLabelColor } } Context 'When adding a new label without description' { It 'Should call the mock with the correct arguments' { { New-GitHubLabel @newGitHubLabelParameters -Confirm:$false } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Post' -and $RestMethod -eq $mockExpectedDefaultRestMethod -and $Body -eq ($mockExpectedDefaultRequestBody | ConvertTo-Json) } } } Context 'When adding a new label without description' { It 'Should call the mock with the correct arguments' { $mockTestParameters = $newGitHubLabelParameters.Clone() $mockTestParameters['Description'] = $mockLabelDescription { New-GitHubLabel @mockTestParameters -Confirm:$false } | Should -Not -Throw $mockExpectedRequestBody = $mockExpectedDefaultRequestBody.Clone() $mockExpectedRequestBody['description'] = $mockLabelDescription Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Post' -and $RestMethod -eq $mockExpectedDefaultRestMethod -and $Body -eq ($mockExpectedRequestBody | ConvertTo-Json) } } } Context 'When adding a new label and requesting explicit validation' { It 'Should not not call any mock' { { New-GitHubLabel @newGitHubLabelParameters -WhatIf } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 0 } } Context 'When adding a new label and requesting to forcibly execute' { It 'Should call the correct mock' { { $ConfirmPreference = 'Medium' New-GitHubLabel @newGitHubLabelParameters -Force } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 } } } Describe 'Set-GitHubLabel' { BeforeAll { Mock -CommandName Invoke-GitHubApi $mockOwnerName = 'Mary' $mockRepositoryName = 'WebApps' $mockLabelName = 'Label1' $mockNewLabelName = 'NewName' $mockLabelColor = 'ffffff' $mockLabelDescription = 'Label description' $newGitHubLabelParameters = @{ Owner = $mockOwnerName Repository = $mockRepositoryName Name = $mockLabelName } $mockExpectedDefaultRestMethod = 'repos/{0}/{1}/labels/{2}' -f $mockOwnerName, $mockRepositoryName, $mockLabelName } Context 'When updating a label with a new name' { It 'Should call the mock with the correct arguments' { $mockTestParameters = $newGitHubLabelParameters.Clone() $mockTestParameters['NewName'] = $mockNewLabelName { Set-GitHubLabel @mockTestParameters -Confirm:$false } | Should -Not -Throw $mockExpectedRequestBody = @{ name = $mockNewLabelName } Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Patch' -and $RestMethod -eq $mockExpectedDefaultRestMethod -and $Body -eq ($mockExpectedRequestBody | ConvertTo-Json) } } } Context 'When updating a label with a new color' { It 'Should call the mock with the correct arguments' { $mockTestParameters = $newGitHubLabelParameters.Clone() $mockTestParameters['Color'] = $mockLabelColor { Set-GitHubLabel @mockTestParameters -Confirm:$false } | Should -Not -Throw $mockExpectedRequestBody = @{ color = $mockLabelColor } Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Patch' -and $RestMethod -eq $mockExpectedDefaultRestMethod -and $Body -eq ($mockExpectedRequestBody | ConvertTo-Json) } } } Context 'When updating a label with a new description' { It 'Should call the mock with the correct arguments' { $mockTestParameters = $newGitHubLabelParameters.Clone() $mockTestParameters['Description'] = $mockLabelDescription { Set-GitHubLabel @mockTestParameters -Confirm:$false } | Should -Not -Throw $mockExpectedRequestBody = @{ description = $mockLabelDescription } Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Patch' -and $RestMethod -eq $mockExpectedDefaultRestMethod -and $Body -eq ($mockExpectedRequestBody | ConvertTo-Json) } } } Context 'When updating a label with a new name, color and description' { It 'Should call the mock with the correct arguments' { $mockTestParameters = $newGitHubLabelParameters.Clone() $mockTestParameters['NewName'] = $mockNewLabelName $mockTestParameters['Color'] = $mockLabelColor $mockTestParameters['Description'] = $mockLabelDescription { Set-GitHubLabel @mockTestParameters -Confirm:$false } | Should -Not -Throw $mockExpectedRequestBody = @{ name = $mockNewLabelName color = $mockLabelColor description = $mockLabelDescription } Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Patch' -and $RestMethod -eq $mockExpectedDefaultRestMethod -and $Body -eq ($mockExpectedRequestBody | ConvertTo-Json) } } } Context 'When adding a new label and requesting explicit validation' { It 'Should not not call any mock' { { Set-GitHubLabel @newGitHubLabelParameters -WhatIf } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 0 } } Context 'When adding a new label and requesting to forcibly execute' { It 'Should call the correct mock' { { $ConfirmPreference = 'Medium' Set-GitHubLabel @newGitHubLabelParameters -Force } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 } } } Describe 'Remove-GitHubLabel' { BeforeAll { Mock -CommandName Invoke-GitHubApi $mockOwnerName = 'Mary' $mockRepositoryName = 'WebApps' $mockLabelName = 'Label1' $newGitHubLabelParameters = @{ Owner = $mockOwnerName Repository = $mockRepositoryName Name = $mockLabelName } $mockExpectedDefaultRestMethod = 'repos/{0}/{1}/labels/{2}' -f $mockOwnerName, $mockRepositoryName, $mockLabelName } Context 'When removing a label' { It 'Should call the mock with the correct arguments' { { Remove-GitHubLabel @newGitHubLabelParameters -Confirm:$false } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 -ParameterFilter { $Method -eq 'Delete' -and $RestMethod -eq $mockExpectedDefaultRestMethod -and $null -eq $Body } } } Context 'When removing a label and requesting explicit validation' { It 'Should not not call any mock' { { Remove-GitHubLabel @newGitHubLabelParameters -WhatIf } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 0 } } Context 'When removing a label and requesting to forcibly execute' { It 'Should call the correct mock' { { $ConfirmPreference = 'Medium' Remove-GitHubLabel @newGitHubLabelParameters -Force } | Should -Not -Throw Assert-MockCalled -CommandName Invoke-GitHubApi -Exactly -Times 1 } } } #endregion } Pop-Location |