Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/workflows/test_with_TestingHelper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ jobs:
shell: pwsh
run: |
$result = ./test.ps1 -ShowTestErrors
$result

Write-Output $result

# Allow Not Implemented and Skipped tests to pass
$passed = $result.Tests -eq $result.Pass + $result.NotImplemented + $result.Skipped
# $passed = $result.Tests -eq $result.Pass
import-module ./tools/Test_Helper/

$passed = Test-Result -Result $result

if($passed)
{ "All test passed" | Write-Verbose -verbose ; exit 0 }
Expand Down
6 changes: 5 additions & 1 deletion Test/mockfiles.log
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,10 @@
},
{
"FileName": "invoke-GitHubOrgProjectWithFields-octodemo-700-query-field-text.json",
"Command": "Invoke-GitHubOrgProjectWithFields -Owner octodemo -ProjectNumber 700 -afterFields \"\" -afterItems \"\" -query \"updated:<2025-03-15\""
"Command": "Invoke-GitHubOrgProjectWithFields -Owner octodemo -ProjectNumber 700 -afterFields \"\" -afterItems \"\" -query \"updated:>=2024-02-18\""
},
{
"FileName": "invoke-GitHubOrgProjectWithFields-octodemo-700-query-field-text.json",
"Command": "Invoke-GitHubOrgProjectWithFields -Owner octodemo -ProjectNumber 700 -afterFields \"\" -afterItems \"\" -query \"updated:>=2025-03-15\""
}
]
3 changes: 2 additions & 1 deletion Test/traceInvoke.log
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,5 @@ Invoke-GetUser -Handle rulasg
Invoke-UpdateProjectV2Collaborators -ProjectId PVT_kwDOAlIw4c4BCe3V -collaborators "MDQ6VXNlcjY4ODQ0MDg=" -Role "WRITER"
Invoke-GetUser -Handle rauldibildos
Invoke-UpdateProjectV2Collaborators -ProjectId PVT_kwDOAlIw4c4BCe3V -collaborators "MDQ6VXNlcjY4ODQ0MDg= U_kgDOC_E3gw" -Role "WRITER"
Invoke-GitHubOrgProjectWithFields -Owner octodemo -ProjectNumber 700 -afterFields "" -afterItems "" -query "updated:<2025-03-15"
Invoke-GitHubOrgProjectWithFields -Owner octodemo -ProjectNumber 700 -afterFields "" -afterItems "" -query "updated:>=2024-02-18"
Invoke-GitHubOrgProjectWithFields -Owner octodemo -ProjectNumber 700 -afterFields "" -afterItems "" -query "updated:>=2025-03-15"
63 changes: 25 additions & 38 deletions test.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -18,44 +18,6 @@
[Parameter()][string]$TestName
)

function Set-TestName{
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Scope='Function')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Scope='Function')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope='Function')]
[Alias("st")]
param (
[Parameter(Position=0,ValueFromPipeline)][string]$TestName
)

process{
$global:TestNameVar = $TestName
}
}

function Get-TestName{
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Scope='Function')]
[Alias("gt")]
param (
)

process{
$global:TestNameVar
}
}

function Clear-TestName{
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Scope='Function')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Scope='Function')]
[Alias("ct")]
param (
)

$global:TestNameVar = $null
}

function Import-RequiredModule{
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Scope='Function')]
Expand Down Expand Up @@ -108,6 +70,31 @@
}
}

function Test-TestingHelperResults{
Comment thread Fixed
[CmdletBinding()]
param(
[Parameter(ValueFromPipeline)][object]$result,
Comment thread Fixed
[Parameter()][switch]$SkippedNotAllowed,
[Parameter()][switch]$NotImplementedNotAllowed
)

# Chek results from last run
$result = $result ?? $Global:ResultTestingHelper
Comment thread Fixed

if($SkippedNotAllowed -and $result.Skipped -gt 0){
return $false
Comment thread Fixed
}

if($NotImplementedNotAllowed -and $result.NotImplemented -gt 0){
return $false
Comment thread Fixed
}

# Allow Not Implemented and Skipped tests to pass
$passed = $result.Tests -eq $result.Pass + $result.NotImplemented + $result.Skipped

return $passed
}

<#
. SYNOPSIS
Extracts the required modules from the module manifest
Expand Down
132 changes: 132 additions & 0 deletions tools/Test_Helper/Test_Helper.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
#
# Module manifest for module 'Test_Helper'
#
# Generated by: rulasg
#
# Generated on: 20/1/2026
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'Test_Helper.psm1'

# Version number of this module.
ModuleVersion = '0.0.1'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '0be904b3-72c4-4e02-882a-153fa558e074'

# Author of this module
Author = 'rulasg'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) rulasg. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# ClrVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = '*'

Check warning

Code scanning / PSScriptAnalyzer

Do not use wildcard or $null in this field. Explicitly specify a list for FunctionsToExport. Warning

Do not use wildcard or $null in this field. Explicitly specify a list for FunctionsToExport.

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = '*'

Check warning

Code scanning / PSScriptAnalyzer

Do not use wildcard or $null in this field. Explicitly specify a list for CmdletsToExport. Warning

Do not use wildcard or $null in this field. Explicitly specify a list for CmdletsToExport.

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = '*'

Check warning

Code scanning / PSScriptAnalyzer

Do not use wildcard or $null in this field. Explicitly specify a list for AliasesToExport. Warning

Do not use wildcard or $null in this field. Explicitly specify a list for AliasesToExport.

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
# Tags = @()

# A URL to the license for this module.
# LicenseUri = ''

# A URL to the main website for this project.
# ProjectUri = ''

# A URL to an icon representing this module.
# IconUri = ''

# ReleaseNotes of this module
# ReleaseNotes = ''

# Prerelease string of this module
Prerelease = 'dev'

# Flag to indicate whether the module requires explicit user acceptance for install/update/save
# RequireLicenseAcceptance = $false

# External dependent modules of this module
# ExternalModuleDependencies = @()

} # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

27 changes: 27 additions & 0 deletions tools/Test_Helper/Test_Helper.psm1
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Write-Information -Message ("Loading {0} ..." -f ($PSCommandPath | Split-Path -LeafBase)) -InformationAction continue

Check warning

Code scanning / PSScriptAnalyzer

Cmdlet 'Write-Information' may be used incorrectly. Please check that all mandatory parameters are supplied. Warning

Cmdlet 'Write-Information' may be used incorrectly. Please check that all mandatory parameters are supplied.

#Module path is where resides the RootModule file. This file. :)
$MODULE_PATH = $PSScriptRoot

#Get public and private function definition files.
$Public = @( Get-ChildItem -Path $MODULE_PATH\public\*.ps1 -ErrorAction SilentlyContinue )
$Private = @( Get-ChildItem -Path $MODULE_PATH\private\*.ps1 -ErrorAction SilentlyContinue )

#Dot source the files
Foreach($import in @($Public + $Private))
{
Try
{
. $import.fullname
}
Catch
{
Write-Error -Message "Failed to import function $($import.fullname): $_"
}
}

# Here I might...
# Read in or create an initial config file and variable
# Export Public functions ($Public.BaseName) for WIP modules
# Set variables visible to the module and its functions only

24 changes: 24 additions & 0 deletions tools/Test_Helper/public/testResults.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
function Test-Result{
Comment thread Fixed

Check notice

Code scanning / PSScriptAnalyzer

The cmdlet 'Test-Result' does not have a help comment. Note test

The cmdlet 'Test-Result' does not have a help comment.
[CmdletBinding()]
param(
[Parameter(ValueFromPipeline)][object]$Result,
Comment thread Fixed
[Parameter()][switch]$SkippedNotAllowed,
[Parameter()][switch]$NotImplementedNotAllowed
)

# Chek results from last run
$Result = $Result ?? $Global:ResultTestingHelper
Comment thread Fixed

if($SkippedNotAllowed -and $Result.Skipped -gt 0){
return $false
Comment thread Fixed
}

if($NotImplementedNotAllowed -and $Result.NotImplemented -gt 0){
return $false
Comment thread Fixed
}

# Allow Not Implemented and Skipped tests to pass
$passed = $Result.Tests -eq $Result.Pass + $Result.NotImplemented + $Result.Skipped

return $passed
} Export-ModuleMember -Function Test-Result
37 changes: 37 additions & 0 deletions tools/Test_Helper/public/testname.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
function Set-TestName{

Check notice

Code scanning / PSScriptAnalyzer

The cmdlet 'Set-TestName' does not have a help comment. Note test

The cmdlet 'Set-TestName' does not have a help comment.
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Scope='Function')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Scope='Function')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope='Function')]
[Alias("st")]
param (
[Parameter(Position=0,ValueFromPipeline)][string]$TestName
)

process{
$global:TestNameVar = $TestName
}
} Export-ModuleMember -Function Set-TestName -Alias st

function Get-TestName{

Check notice

Code scanning / PSScriptAnalyzer

The cmdlet 'Get-TestName' does not have a help comment. Note test

The cmdlet 'Get-TestName' does not have a help comment.
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Scope='Function')]
[Alias("gt")]
param (
)

process{
$global:TestNameVar
}
} Export-ModuleMember -Function Get-TestName -Alias gt

function Clear-TestName{

Check notice

Code scanning / PSScriptAnalyzer

The cmdlet 'Clear-TestName' does not have a help comment. Note test

The cmdlet 'Clear-TestName' does not have a help comment.
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Scope='Function')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Scope='Function')]
[Alias("ct")]
param (
)

$global:TestNameVar = $null
} Export-ModuleMember -Function Clear-TestName -Alias ct
Loading