Merge pull request #6 from cloudyspells/feature/testoutput

Feature/testoutput

Author: webtonize

.github/workflows/qa.yml

@@ -39,14 +39,42 @@ jobs:
           Set-PSRepository PSGallery -InstallationPolicy Trusted
           Install-Module Az.Resources
           Import-Module Az.Resources
-          Invoke-Pester ./tests/PSWattTime.Tests/PSWattTime.Tests.ps1 `
-            -PassThru `
-            -CodeCoverage ./src/PSWattTime/PSWattTime.psm1 `
-            -CodeCoverageOutputFile ./tests/coverage.xml `
-            -CodeCoverageOutputFileFormat JaCoCo `
-            -OutputFile ./tests/junit.xml `
-            -OutputFormat JUnitXml `
-            -EnableExit
+          Import-Module Pester
+          $pConfig = New-PesterConfiguration
+          $pConfig.Run.Path = './tests/PSWattTime.Tests/PSWattTime.Tests.ps1'
+          $pConfig.Run.PassThru = $true
+          $pConfig.Output.CIFormat = 'GithubActions'
+          $pConfig.Output.Verbosity = 'Detailed'
+          $pConfig.TestResult.OutputFormat = 'JunitXml'
+          $pConfig.TestResult.OutputPath ='./tests/junit.xml'
+          $pConfig.TestResult.Enabled = $true
+          $pConfig.CodeCoverage.Enabled = $true
+          $pConfig.CodeCoverage.OutputFormat = 'JaCoCo'
+          $pConfig.CodeCoverage.OutputPath = './tests/coverage.xml'
+          $pConfig.CodeCoverage.Path = './src/PSWattTime/PSWattTime.psm1'
+          $p = Invoke-Pester -Configuration $pConfig
+          Write-Output "## Pester Test Results" >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "" >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "- Code coverage: **$($p.CodeCoverage.CoveragePercent)**" >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "- Commands Executed: **$($p.CodeCoverage.CommandsExecutedCount)**" >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "- Commands Missed: **$($p.CodeCoverage.CommandsMissedCount)**" >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "" >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "|Block|Test|Duration|Result|" >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "|---|---|---|---|" >> $env:GITHUB_STEP_SUMMARY
+          $p.Tests | ForEach-Object {
+            $mdTestResult = ""
+            If($_.Result -eq 'Failed') {
+              $mdTestResult = ":boom: Failed"
+            }
+            ElseIf($_.Result -eq 'Passed') {
+              $mdTestResult = ":green_heart: Passed"
+            }
+            Else {
+              $mdTestResult = ":nerd_face: $($_.Result)"
+            }
+            Write-Output "|$($_.Block)|$($_.Name)|$($_.Duration)|$($mdTestResult)|"
+          } >> $env:GITHUB_STEP_SUMMARY
+          Write-Output "" >> $env:GITHUB_STEP_SUMMARY
 
       - name: Test the Module Manifest
         shell: pwsh
@@ -70,4 +98,4 @@ jobs:
         with:
           name: unit-tests
           path: ./tests/*.xml
-        if: ${{ always() }}
+        if: ${{ always() }}

.gitignore

@@ -0,0 +1,3 @@
+**/coverage.xml
+**/junit.xml
+**/coverage.xml

PSScriptAnalyzerSettings.psd1

@@ -0,0 +1,3 @@
+@{
+    ExcludeRules = @('PSAvoidUsingPlainTextForPassword')
+}

tests/PSWattTime.Tests/PSWattTime.Tests.ps1

@@ -5,6 +5,45 @@ Describe "PSWattTimeTests" {
         $env:WATTTIMEUSERNAME | Should -Not -BeNullOrEmpty
         $env:WATTTIMEPASSWORD | Should -Not -BeNullOrEmpty
     }
+
+    Context "When we have imported the module" {
+        It "Should have a ConvertFrom-AzureRegion command" {
+            $test = Get-Command -Module PSWattTime -Name 'ConvertFrom-AzureRegion'
+            $test | Should -Not -BeNullOrEmpty
+            $test.CommandType | Should -Be 'Function'
+        }
+
+        It "Should have a Get-AzureRegionWithLowestWattTime command" {
+            $test = Get-Command -Module PSWattTime -Name 'Get-AzureRegionWithLowestWattTime'
+            $test | Should -Not -BeNullOrEmpty
+            $test.CommandType | Should -Be 'Function'
+        }
+
+        It "Should have a Get-WattTime command" {
+            $test = Get-Command -Module PSWattTime -Name 'Get-WattTime'
+            $test | Should -Not -BeNullOrEmpty
+            $test.CommandType | Should -Be 'Function'
+        }
+
+        It "Should have a Get-WattTimeAuthToken command" {
+            $test = Get-Command -Module PSWattTime -Name 'Get-WattTimeAuthToken'
+            $test | Should -Not -BeNullOrEmpty
+            $test.CommandType | Should -Be 'Function'
+        }
+
+        It "Should have a Get-WattTimeForAzureRegion command" {
+            $test = Get-Command -Module PSWattTime -Name 'Get-WattTimeForAzureRegion'
+            $test | Should -Not -BeNullOrEmpty
+            $test.CommandType | Should -Be 'Function'
+        }
+
+        It "Should have a New-WattTimeAccount command" {
+            $test = Get-Command -Module PSWattTime -Name 'New-WattTimeAccount'
+            $test | Should -Not -BeNullOrEmpty
+            $test.CommandType | Should -Be 'Function'
+        }
+
+    }
 
     Context "When we login" {
         It "Should return a token" {
@@ -105,4 +144,22 @@ Describe "PSWattTimeTests" {
             $wattTime.percent | Should -BeOfType 'string'
         }
     }
+    Context "When we register an account" {
+        BeforeAll {
+            Mock -ModuleName PSWattTime -CommandName Invoke-RestMethod { return (New-Object PSObject -Property @{'user' = 'freddo';'ok' = 'User created'})}
+            $newAccount = New-WattTimeAccount `
+                -Username 'freddo' `
+                -Password 'P@ssvvordsAr3St00p1d' `
+                -Organization 'CloudySpells' `
+                -Email 'freddo@example.com'
+        }
+        
+        It "Should return a PSObject" {
+            $newAccount | Should -BeOfType 'PSObject'
+        }
+
+        It "Should return an ok field with a user created value" {
+            $newAccount.ok | Should -Be 'User created'
+        }
+    }
 }