🩹 [Patch]: Add tests for Meta + GitHubAPI fixes

examples/CallingAPIs.ps1

@@ -43,4 +43,5 @@ Invoke-GitHubAPI -ApiEndpoint /zen
 # Most complex example - output is the entire web response
 $context = Get-GitHubContext
 Invoke-WebRequest -Uri "https://api.$($context.HostName)/zen" -Token ($context.Token) -Authentication Bearer
+Invoke-RestMethod -Uri "https://api.$($context.HostName)/octocat" -Token ($context.Token) -Authentication Bearer
 #endregion

src/functions/private/Auth/Context/Resolve-GitHubContext.ps1

@@ -32,8 +32,7 @@
     begin {
         $commandName = $MyInvocation.MyCommand.Name
         Write-Verbose "[$commandName] - Start"
-        Write-Verbose 'Context:'
-        $Context | Format-Table | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
+        Initialize-GitHubConfig
     }
 
     process {
@@ -44,7 +43,7 @@
         }
 
         if (-not $Context) {
-            throw "Context [$contextName] not found. Please provide a valid context or log in using 'Connect-GitHub'."
+            throw "Please provide a valid context or log in using 'Connect-GitHub'."
         }
 
         # switch ($Context.Type) {
@@ -59,9 +58,6 @@
         #         }
         #     }
         # }
-
-        Write-Verbose 'Resolved Context:'
-        $Context | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
     }
 
     end {

src/functions/private/Config/Initialize-GitHubConfig.ps1

@@ -29,21 +29,24 @@
     }
 
     process {
-        Write-Verbose "GitHubConfig initialized: [$($script:GitHub.Initialized)]"
-        Write-Verbose "Force:                    [$Force]"
-        if (-not $script:GitHub.Initialized -or $Force) {
+        Write-Verbose "GitHubConfig ID: [$($script:GitHub.Config.ID)]"
+        Write-Verbose "Force:           [$Force]"
+        if (-not $script:GitHub.Config.ID -or $Force) {
             try {
+                Write-Verbose 'Attempt to load the stored GitHubConfig from ContextVault'
                 $context = [GitHubConfig](Get-Context -ID $script:GitHub.Config.ID)
                 if (-not $context -or $Force) {
-                    Write-Verbose "Loading GitHubConfig from defaults"
+                    Write-Verbose 'No stored config found. Loading GitHubConfig from defaults'
                     $context = Set-Context -ID $script:GitHub.DefaultConfig.ID -Context $script:GitHub.DefaultConfig -PassThru
                 }
+                Write-Verbose 'GitHubConfig loaded into memory.'
                 $script:GitHub.Config = [GitHubConfig]$context
-                $script:GitHub.Initialized = $true
             } catch {
                 Write-Error $_
                 throw 'Failed to initialize GitHub config'
             }
+        } else {
+            Write-Verbose 'GitHubConfig already initialized and available in memory.'
         }
     }
 

src/functions/public/API/Invoke-GitHubAPI.ps1

@@ -179,7 +179,31 @@
                 Write-Debug 'Response headers:'
                 $headers | Out-String -Stream | ForEach-Object { Write-Debug $_ }
                 Write-Debug '---------------------------'
-                $results = $response.Content | ConvertFrom-Json
+                Write-Debug 'Response:'
+                $response | Out-String -Stream | ForEach-Object { Write-Debug $_ }
+                Write-Debug '---------------------------'
+                Write-Debug $headers.'Content-Type'
+                switch -Regex ($headers.'Content-Type') {
+                    'application/json' {
+                        $results = $response.Content | ConvertFrom-Json
+                    }
+                    'application/vnd.github.v3+json' {
+                        $results = $response.Content | ConvertFrom-Json
+                    }
+                    'text/plain' {
+                        $results = $response.Content
+                    }
+                    'application/octocat-stream' {
+                        [byte[]]$byteArray = $response.Content
+                        $results = [System.Text.Encoding]::UTF8.GetString($byteArray)
+                    }
+                    default {
+                        Write-Warning "Unknown content type: $($headers.'Content-Type')"
+                        Write-Warning 'Please report this issue!'
+                        [byte[]]$byteArray = $response.Content
+                        $results = [System.Text.Encoding]::UTF8.GetString($byteArray)
+                    }
+                }
                 [pscustomobject]@{
                     Request           = $APICall
                     Response          = $results

src/functions/public/Meta/Get-GitHubApiVersion.ps1

@@ -23,16 +23,25 @@
         [object] $Context = (Get-GitHubContext)
     )
 
-    $Context = Resolve-GitHubContext -Context $Context
-
-    $inputObject = @{
-        Context     = $Context
-        ApiEndpoint = '/versions'
-        Method      = 'GET'
+    begin {
+        $commandName = $MyInvocation.MyCommand.Name
+        Write-Verbose "[$commandName] - Start"
+        $Context = Resolve-GitHubContext -Context $Context
     }
 
-    Invoke-GitHubAPI @inputObject | ForEach-Object {
-        Write-Output $_.Response
+    process {
+        $inputObject = @{
+            Context     = $Context
+            ApiEndpoint = '/versions'
+            Method      = 'GET'
+        }
+
+        Invoke-GitHubAPI @inputObject | ForEach-Object {
+            Write-Output $_.Response
+        }
     }
 
+    end {
+        Write-Verbose "[$commandName] - End"
+    }
 }

src/functions/public/Meta/Get-GitHubMeta.ps1

@@ -31,15 +31,25 @@
         [object] $Context = (Get-GitHubContext)
     )
 
-    $Context = Resolve-GitHubContext -Context $Context
+    begin {
+        $commandName = $MyInvocation.MyCommand.Name
+        Write-Verbose "[$commandName] - Start"
+        $Context = Resolve-GitHubContext -Context $Context
+    }
+
+    process {
+        $inputObject = @{
+            Context     = $Context
+            ApiEndpoint = '/meta'
+            Method      = 'GET'
+        }
 
-    $inputObject = @{
-        Context     = $Context
-        ApiEndpoint = '/meta'
-        Method      = 'GET'
+        Invoke-GitHubAPI @inputObject | ForEach-Object {
+            Write-Output $_.Response
+        }
     }
 
-    Invoke-GitHubAPI @inputObject | ForEach-Object {
-        Write-Output $_.Response
+    end {
+        Write-Verbose "[$commandName] - End"
     }
 }

src/functions/public/Meta/Get-GitHubOctocat.ps1

@@ -34,20 +34,30 @@
         [object] $Context = (Get-GitHubContext)
     )
 
-    $Context = Resolve-GitHubContext -Context $Context
-
-    $body = @{
-        s = $S
+    begin {
+        $commandName = $MyInvocation.MyCommand.Name
+        Write-Verbose "[$commandName] - Start"
+        $Context = Resolve-GitHubContext -Context $Context
     }
 
-    $inputObject = @{
-        Context     = $Context
-        APIEndpoint = '/octocat'
-        Method      = 'GET'
-        Body        = $body
+    process {
+        $body = @{
+            s = $S
+        }
+
+        $inputObject = @{
+            Context     = $Context
+            APIEndpoint = '/octocat'
+            Method      = 'GET'
+            Body        = $body
+        }
+
+        Invoke-GitHubAPI @inputObject | ForEach-Object {
+            Write-Output $_.Response
+        }
     }
 
-    Invoke-GitHubAPI @inputObject | ForEach-Object {
-        Write-Output $_.Response
+    end {
+        Write-Verbose "[$commandName] - End"
     }
 }

src/functions/public/Meta/Get-GitHubRoot.ps1

@@ -22,16 +22,25 @@
         [object] $Context = (Get-GitHubContext)
     )
 
-    $Context = Resolve-GitHubContext -Context $Context
-
-    $inputObject = @{
-        Context     = $Context
-        APIEndpoint = '/'
-        Method      = 'GET'
+    begin {
+        $commandName = $MyInvocation.MyCommand.Name
+        Write-Verbose "[$commandName] - Start"
+        $Context = Resolve-GitHubContext -Context $Context
     }
 
-    Invoke-GitHubAPI @inputObject | ForEach-Object {
-        Write-Output $_.Response
+    process {
+        $inputObject = @{
+            Context     = $Context
+            APIEndpoint = '/'
+            Method      = 'GET'
+        }
+
+        Invoke-GitHubAPI @inputObject | ForEach-Object {
+            Write-Output $_.Response
+        }
     }
 
+    end {
+        Write-Verbose "[$commandName] - End"
+    }
 }

src/functions/public/Meta/Get-GitHubZen.ps1

@@ -22,15 +22,25 @@
         [object] $Context = (Get-GitHubContext)
     )
 
-    $Context = Resolve-GitHubContext -Context $Context
+    begin {
+        $commandName = $MyInvocation.MyCommand.Name
+        Write-Verbose "[$commandName] - Start"
+        $Context = Resolve-GitHubContext -Context $Context
+    }
+
+    process {
+        $inputObject = @{
+            Context     = $Context
+            APIEndpoint = '/zen'
+            Method      = 'GET'
+        }
 
-    $inputObject = @{
-        Context     = $Context
-        APIEndpoint = '/zen'
-        Method      = 'GET'
+        Invoke-GitHubAPI @inputObject | ForEach-Object {
+            Write-Output $_.Response
+        }
     }
 
-    Invoke-GitHubAPI @inputObject | ForEach-Object {
-        Write-Output $_.Response
+    end {
+        Write-Verbose "[$commandName] - End"
     }
 }

src/variables/private/Config.ps1

@@ -1,5 +1,4 @@
 $script:GitHub = [pscustomobject]@{
-    Initialized        = $false
     TokenPrefixPattern = '(?<=^(ghu|gho|ghs|github_pat|ghp)).*'
     EnvironmentType    = if ($env:GITHUB_ACTIONS -eq 'true') {
         'GHA'

tests/GitHub.Tests.ps1

@@ -81,7 +81,7 @@ Describe 'GitHub' {
 
         It 'Can connect to all GitHub App Installations' {
             { Connect-GitHubApp } | Should -Not -Throw
-            Write-Verbose "Default context:" -Verbose
+            Write-Verbose 'Default context:' -Verbose
             Write-Verbose (Get-GitHubContext | Out-String) -Verbose
             Write-Verbose 'All contexts:' -Verbose
             Write-Verbose (Get-GitHubContext -ListAvailable | Out-String) -Verbose
@@ -111,6 +111,33 @@ Describe 'GitHub' {
             $config.ID | Should -Be 'PSModule.GitHub'
         }
     }
+    Context 'Meta' {
+        It 'Get-GitHubRoot' {
+            $root = Get-GitHubRoot
+            Write-Verbose ($root | Format-Table | Out-String) -Verbose
+            $root | Should -Not -BeNullOrEmpty
+        }
+        It 'Get-GitHubApiVersion' {
+            $apiVersion = Get-GitHubApiVersion
+            Write-Verbose ($apiVersion | Format-Table | Out-String) -Verbose
+            $apiVersion | Should -Not -BeNullOrEmpty
+        }
+        It 'Get-GitHubMeta' {
+            $meta = Get-GitHubMeta
+            Write-Verbose ($meta | Format-Table | Out-String) -Verbose
+            $meta | Should -Not -BeNullOrEmpty
+        }
+        It 'Get-GitHubOctocat' {
+            $octocat = Get-GitHubOctocat
+            Write-Verbose ($octocat | Format-Table | Out-String) -Verbose
+            $octocat | Should -Not -BeNullOrEmpty
+        }
+        It 'Get-GitHubZen' {
+            $zen = Get-GitHubZen
+            Write-Verbose ($zen | Format-Table | Out-String) -Verbose
+            $zen | Should -Not -BeNullOrEmpty
+        }
+    }
     Context 'Git' {
         It 'Set-GitHubGitConfig sets the Git configuration' {
             { Set-GitHubGitConfig } | Should -Not -Throw