🧪[Tests]: Refactor and enable source code tests

.github/workflows/Nightly-Run.yml

@@ -10,13 +10,15 @@ permissions:
   pull-requests: write
   statuses: write
 
-env:
-  TEST_APP_CLIENT_ID: ${{ secrets.TEST_APP_CLIENT_ID }}
-  TEST_APP_PRIVATE_KEY: ${{ secrets.TEST_APP_PRIVATE_KEY }}
-  TEST_FG_PAT: ${{ secrets.TEST_FG_PAT }}
-  TEST_PAT: ${{ secrets.TEST_PAT }}
-
 jobs:
   Process-PSModule:
     uses: PSModule/Process-PSModule/.github/workflows/CI.yml@v3
-    secrets: inherit
+    secrets:
+      APIKey: ${{ secrets.APIKey }}
+      TEST_APP_ENT_CLIENT_ID: ${{ secrets.TEST_APP_ENT_CLIENT_ID }}
+      TEST_APP_ENT_PRIVATE_KEY: ${{ secrets.TEST_APP_ENT_PRIVATE_KEY }}
+      TEST_APP_ORG_CLIENT_ID: ${{ secrets.TEST_APP_ORG_CLIENT_ID }}
+      TEST_APP_ORG_PRIVATE_KEY: ${{ secrets.TEST_APP_ORG_PRIVATE_KEY }}
+      TEST_USER_ORG_FG_PAT: ${{ secrets.TEST_USER_ORG_FG_PAT }}
+      TEST_USER_USER_FG_PAT: ${{ secrets.TEST_USER_USER_FG_PAT }}
+      TEST_USER_PAT: ${{ secrets.TEST_USER_PAT }}

.github/workflows/Process-PSModule.yml

@@ -24,17 +24,18 @@ permissions:
   pages: write
   id-token: write
 
-env:
-  TEST_APP_CLIENT_ID: ${{ secrets.TEST_APP_CLIENT_ID }}
-  TEST_APP_PRIVATE_KEY: ${{ secrets.TEST_APP_PRIVATE_KEY }}
-  TEST_FG_PAT: ${{ secrets.TEST_FG_PAT }}
-  TEST_PAT: ${{ secrets.TEST_PAT }}
-
 jobs:
   Process-PSModule:
     uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v3
-    secrets: inherit
+    secrets:
+      APIKey: ${{ secrets.APIKey }}
+      TEST_APP_ENT_CLIENT_ID: ${{ secrets.TEST_APP_ENT_CLIENT_ID }}
+      TEST_APP_ENT_PRIVATE_KEY: ${{ secrets.TEST_APP_ENT_PRIVATE_KEY }}
+      TEST_APP_ORG_CLIENT_ID: ${{ secrets.TEST_APP_ORG_CLIENT_ID }}
+      TEST_APP_ORG_PRIVATE_KEY: ${{ secrets.TEST_APP_ORG_PRIVATE_KEY }}
+      TEST_USER_ORG_FG_PAT: ${{ secrets.TEST_USER_ORG_FG_PAT }}
+      TEST_USER_USER_FG_PAT: ${{ secrets.TEST_USER_USER_FG_PAT }}
+      TEST_USER_PAT: ${{ secrets.TEST_USER_PAT }}
     with:
-      SkipTests: SourceCode
       Debug: true
       Verbose: true

src/functions/public/Auth/Update-GitHubUserAccessToken.ps1 → src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1

@@ -1,6 +1,4 @@
-#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
-
-function Update-GitHubUserAccessToken {
+function Update-GitHubUserAccessToken {
     <#
         .SYNOPSIS
         Updates the GitHub access token.
@@ -21,12 +19,11 @@ function Update-GitHubUserAccessToken {
         .NOTES
         [Refreshing user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens)
     #>
+    [CmdletBinding(SupportsShouldProcess)]
     [OutputType([securestring])]
-    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidLongLines', '', Justification = 'Long links for documentation.')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'Is the CLI part of the module.')]
-    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '',
-        Justification = 'The tokens are recieved as clear text. Mitigating exposure by removing variables and performing garbage collection.')]
-    [CmdletBinding(SupportsShouldProcess)]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '', Justification = 'The tokens are recieved as clear text. Mitigating exposure by removing variables and performing garbage collection.')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidLongLines', '', Scope = 'Function', Justification = 'Reason for suppressing')]
     param(
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.

src/functions/private/License/Get-GitHubLicenseList.ps1

@@ -20,9 +20,10 @@
     [OutputType([string[]])]
     [CmdletBinding()]
     param(
-        # The context to run the command in.
+        # The context to run the command in. Used to get the details for the API call.
+        # Can be either a string or a GitHubContext object.
         [Parameter()]
-        [string] $Context
+        [object] $Context = (Get-GitHubContext)
     )
 
     begin {

src/functions/private/License/Get-GitHubRepositoryLicense.ps1

@@ -15,7 +15,7 @@
         Get the license for the Hello-World repository from the octocat account.
 
         .NOTES
-        https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
+        [Get the license for a repository](https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository)
 
     #>
     [CmdletBinding()]
@@ -28,6 +28,11 @@
         [Parameter()]
         [string] $Repo,
 
+        # The type of data to return. Can be either 'raw' or 'html'.
+        [Parameter()]
+        [ValidateSet('raw', 'html')]
+        [string] $Type = 'raw',
+
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
         [Parameter()]
@@ -49,14 +54,19 @@
             $Repo = $Context.Repo
         }
         Write-Debug "Repo: [$Repo]"
+
+        $contentType = switch ($Type) {
+            'raw' { 'application/vnd.github.raw+json' }
+            'html' { 'application/vnd.github.html+json' }
+        }
     }
 
     process {
         try {
             $inputObject = @{
                 Context     = $Context
                 APIEndpoint = "/repos/$Owner/$Repo/license"
-                Accept      = 'application/vnd.github+json'
+                ContentType = $contentType
                 Method      = 'GET'
             }
 

src/functions/private/Repositories/Repositories/Get-GitHubMyRepositories.ps1

@@ -123,21 +123,26 @@
     process {
         try {
             $body = @{
-                type      = $Type
                 sort      = $Sort
                 direction = $Direction
                 per_page  = $PerPage
             }
-
-            if ($PSBoundParameters.ContainsKey('Affiliation')) {
-                $body['affiliation'] = $Affiliation -join ','
-            }
             if ($PSBoundParameters.ContainsKey('Since')) {
                 $body['since'] = $Since.ToString('yyyy-MM-ddTHH:mm:ssZ')
             }
             if ($PSBoundParameters.ContainsKey('Before')) {
                 $body['before'] = $Before.ToString('yyyy-MM-ddTHH:mm:ssZ')
             }
+            Write-Debug "ParamSet: [$($PSCmdlet.ParameterSetName)]"
+            switch ($PSCmdlet.ParameterSetName) {
+                'Aff-Vis' {
+                    $body['affiliation'] = $Affiliation -join ','
+                    $body['visibility'] = $Visibility
+                }
+                'Type' {
+                    $body['type'] = $Type
+                }
+            }
 
             $inputObject = @{
                 Context     = $Context

src/functions/private/Teams/Get-GitHubRESTTeamByName.ps1

@@ -1,4 +1,4 @@
-function Get-GitHubTeamByName {
+function Get-GitHubRESTTeamByName {
     <#
         .SYNOPSIS
         Get a team by name
@@ -8,7 +8,7 @@
         and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name.
 
         .EXAMPLE
-        Get-GitHubTeamByName -Organization 'github' -Name 'my-team-name'
+        Get-GitHubRESTTeamByName -Organization 'github' -Name 'my-team-name'
     #>
     [OutputType([void])]
     [CmdletBinding()]

src/functions/private/Teams/Get-GitHubRESTTeamListByOrg.ps1

@@ -1,4 +1,4 @@
-function Get-GitHubTeamListByOrg {
+function Get-GitHubRESTTeamListByOrg {
     <#
         .SYNOPSIS
         List teams
@@ -7,7 +7,7 @@
         Lists all teams in an organization that are visible to the authenticated user.
 
         .EXAMPLE
-        Get-GitHubTeamListByOrg -Organization 'github'
+        Get-GitHubRESTTeamListByOrg -Organization 'github'
 
         .NOTES
         [List teams](https://docs.github.com/rest/teams/teams#list-teams)

src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1

@@ -13,7 +13,8 @@
         Get-PSCallStackPath
         First-Function\Second-Function\Third-Function
 
-        Shows the call stack of the last function called, Third-Function, with the first (<ScriptBlock>) and last (Get-PSCallStackPath) functions removed.
+        Shows the call stack of the last function called, Third-Function, with the first (<ScriptBlock>)
+        and last (Get-PSCallStackPath) functions removed.
 
         .EXAMPLE
         Get-PSCallStackPath -SkipFirst 0

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

@@ -95,12 +95,12 @@
 
     process {
         $Token = $Context.Token
-        Write-Debug "Token :      [$Token]"
+        Write-Debug "Token :     [$Token]"
 
         if ([string]::IsNullOrEmpty($TokenType)) {
             $TokenType = $Context.TokenType
         }
-        Write-Debug "TokenType :  [$($Context.TokenType)]"
+        Write-Debug "TokenType : [$($Context.TokenType)]"
 
         if ([string]::IsNullOrEmpty($ApiBaseUri)) {
             $ApiBaseUri = $Context.ApiBaseUri
@@ -194,6 +194,9 @@
                     'text/plain' {
                         $results = $response.Content
                     }
+                    'text/html' {
+                        $results = $response.Content
+                    }
                     'application/octocat-stream' {
                         [byte[]]$byteArray = $response.Content
                         $results = [System.Text.Encoding]::UTF8.GetString($byteArray)
@@ -227,6 +230,9 @@
             $headers = [pscustomobject]$headers
             $sortedProperties = $headers.PSObject.Properties.Name | Sort-Object
             $headers = $headers | Select-Object $sortedProperties
+            Write-Debug 'Response headers:'
+            $headers | Out-String -Stream | ForEach-Object { Write-Debug $_ }
+            Write-Debug '---------------------------'
 
             $errordetails = $failure.ErrorDetails | ConvertFrom-Json -AsHashtable
             $errorResult = [ordered]@{
@@ -239,13 +245,13 @@
             $APICall.Headers = $APICall.Headers | ConvertTo-Json
             $APICall.Method = $APICall.Method.ToString()
 
-            Write-Error '----------------------------------'
-            Write-Error 'Error details:'
-            $errorResult | Format-Table -AutoSize -HideTableHeaders | Out-String -Stream | ForEach-Object { Write-Error $_ }
-            Write-Error '----------------------------------'
-            Write-Debug 'Response headers:'
-            $headers | Out-String -Stream | ForEach-Object { Write-Debug $_ }
-            Write-Debug '---------------------------'
+            $errorResult = @"
+----------------------------------
+Error details:
+$($errorResult | Format-Table -AutoSize -HideTableHeaders | Out-String)
+----------------------------------
+"@
+            Write-Error $errorResult
             throw $failure.Exception.Message
         }
     }

src/functions/public/Actions/Disable-GitHubWorkflow.ps1

@@ -3,6 +3,7 @@
         .NOTES
         [Disable a workflow](https://docs.github.com/en/rest/actions/workflows#disable-a-workflow)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding()]
     param(
         # The account owner of the repository. The name is not case sensitive.

src/functions/public/Actions/Enable-GitHubWorkflow.ps1

@@ -3,6 +3,7 @@
         .NOTES
         [Enable a workflow](https://docs.github.com/en/rest/actions/workflows#enable-a-workflow)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding()]
     param(
         [Parameter()]

src/functions/public/Actions/Get-GitHubWorkflow.ps1

@@ -21,6 +21,7 @@
         .NOTES
         [List repository workflows](https://docs.github.com/rest/actions/workflows?apiVersion=2022-11-28#list-repository-workflows)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding(DefaultParameterSetName = 'ByName')]
     param(
         [Parameter()]

src/functions/public/Actions/Get-GitHubWorkflowRun.ps1

@@ -36,6 +36,7 @@
         [List workflow runs for a workflow](https://docs.github.com/rest/actions/workflow-runs?apiVersion=2022-11-28#list-workflow-runs-for-a-workflow)
         [List workflow runs for a repository](https://docs.github.com/rest/actions/workflow-runs?apiVersion=2022-11-28#list-workflow-runs-for-a-repository)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding(DefaultParameterSetName = '__AllParameterSets')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidLongLines', '', Justification = 'Contains a long link.')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidAssignmentToAutomaticVariable', 'Event',

src/functions/public/Actions/Get-GitHubWorkflowUsage.ps1

@@ -12,6 +12,7 @@
         .NOTES
         [Get workflow usage](https://docs.github.com/en/rest/actions/workflows#get-workflow-usage)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding(
         DefaultParameterSetName = 'ByName'
     )]

src/functions/public/Actions/Remove-GitHubWorkflowRun.ps1

@@ -16,6 +16,7 @@
         .NOTES
         [Delete a workflow run](https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding(SupportsShouldProcess)]
     param(
         # The account owner of the repository. The name is not case sensitive.

src/functions/public/Actions/Start-GitHubWorkflow.ps1

@@ -17,6 +17,7 @@
         .NOTES
         [Create a workflow dispatch event](https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding(SupportsShouldProcess)]
     param(
         # The account owner of the repository. The name is not case sensitive.

src/functions/public/Actions/Start-GitHubWorkflowReRun.ps1

@@ -12,6 +12,7 @@
         .NOTES
         [Re-run a workflow](https://docs.github.com/en/rest/actions/workflow-runs#re-run-a-workflow)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding(SupportsShouldProcess)]
     param(
         # The account owner of the repository. The name is not case sensitive.

src/functions/public/Actions/Stop-GitHubWorkflowRun.ps1

@@ -14,6 +14,7 @@
         .NOTES
         [Cancel a workflow run](https://docs.github.com/en/rest/actions/workflow-runs#cancel-a-workflow-run)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding(SupportsShouldProcess)]
     [alias('Cancel-GitHubWorkflowRun')]
     param(

src/functions/public/Apps/GitHub Apps/New-GitHubAppInstallationAccessToken.ps1

@@ -33,7 +33,7 @@
         Creates an installation access token for the installation with the ID `12345678`.
 
         .EXAMPLE
-        Connect-GitHub -ClientID $ClientID -PrivateKey $PrivateKey -Verbose
+        Connect-GitHub -ClientID $ClientID -PrivateKey $PrivateKey
         Get-GitHubAppInstallation | New-GitHubAppInstallationAccessToken
 
         Gets the GitHub App installations and creates an installation access token for each installation.

src/functions/public/Apps/Webhooks/Update-GitHubAppWebhookConfiguration.ps1

@@ -58,8 +58,9 @@
                 url          = $URL
                 content_type = $ContentType
                 secret       = $Secret
-                insecure_ssl = $InsecureSSL ? 1 : 0
+                insecure_ssl = $PSBoundParameters.ContainsKey($InsecureSSL) ? ($InsecureSSL ? 1 : 0) : $null
             }
+            $body | Remove-HashtableEntry -NullOrEmptyValues
 
             $inputObject = @{
                 Context     = $Context

src/functions/public/Auth/Connect-GitHubApp.ps1

@@ -1,4 +1,4 @@
-function Connect-GitHubApp {
+function Connect-GitHubApp {
     <#
         .SYNOPSIS
         Connects to GitHub as a installation using a GitHub App.

src/functions/public/Branches/Get-GitHubRepoBranch.ps1

@@ -14,6 +14,7 @@
         .NOTES
         [List branches](https://docs.github.com/rest/branches/branches#list-branches)
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding()]
     param(
         # The account owner of the repository. The name is not case sensitive.

src/functions/public/Commands/Set-GitHubOutput.ps1

@@ -60,7 +60,8 @@
 
             Write-Verbose "Output: [$Name] = [$Value]"
 
-            # If the script is running in a GitHub composite action, accumulate the output under the 'result' key, else append the key-value pair directly.
+            # If the script is running in a GitHub composite action, accumulate the output under the 'result' key,
+            # else append the key-value pair directly.
             if ($env:PSMODULE_GITHUB_SCRIPT) {
                 if (-not $outputs.result) {
                     $outputs.result = @{

src/functions/public/Enterprise/Get-GitHubEnterpriseInstallableOrganization.ps1

@@ -12,6 +12,7 @@
         .EXAMPLE
         Get-GitHubEnterpriseInstallableOrganization -Enterprise 'msx'
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding()]
     param(
         # The enterprise slug or ID.

src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1

@@ -9,6 +9,7 @@
         .EXAMPLE
         Get-GitHubEnterpriseOrganization -Enterprise 'msx'
     #>
+    #SkipTest:FunctionTest:Will add a test for this function in a future PR
     [CmdletBinding()]
     param(
         [Parameter()]