Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
30 changes: 27 additions & 3 deletions .github/workflows/deploy_module_on_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@ jobs:
run: |
echo $EVENT_CONTEXT

- name: Run test.ps1
shell: pwsh
run: |
$result = ./test.ps1 -ShowTestErrors

Write-Output $result

import-module ./tools/Test_Helper/

$passed = Test-Result -Result $result

if($passed)
{ "All test passed" | Write-Verbose -verbose ; exit 0 }
else
{ "Not all tests passed" | Write-Verbose -verbose ; exit 1 }

- name: deploy_ps1
shell: pwsh
env:
Expand All @@ -27,8 +43,16 @@ jobs:
RELEASE_TAG: ${{ github.event.release.tag_name }}
RELEASE_NAME: ${{ github.event.release.name }}
run: |
$env:EVENT_REF = $env:REF

# Import required modules for deployment
import-module ./tools/Test_Helper/

Get-RequiredModule -Verbose | Import-RequiredModule -AllowPrerelease

# GET TAG NAME

## Ref definition. Branch or Tag
$env:EVENT_REF = $env:REF
If ([string]::IsNullOrEmpty($env:EVENT_REF)) {
# Release published trigger
$tag = $env:RELEASE_TAG
Expand All @@ -41,9 +65,9 @@ jobs:

If([string]::IsNullorwhitespace($tag)) {
# Tag name is empty, exit
write-error "Tag name is empty"
exit 1
throw "Tag name is empty"
}

# DEPLOYMENT
./deploy.ps1 -VersionTag $tag -NugetApiKey $env:NUGETAPIKEY

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"
115 changes: 2 additions & 113 deletions test.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -18,121 +18,10 @@ param (
[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')]
param (
[Parameter(ParameterSetName = "HT", ValueFromPipeline)][hashtable]$RequiredModule,
[Parameter(ParameterSetName = "RM",Position = 0)][string]$ModuleName,
[Parameter(ParameterSetName = "RM")][string]$ModuleVersion,
[Parameter(ParameterSetName = "HT")]
[Parameter(ParameterSetName = "RM")]
[switch]$AllowPrerelease,
[Parameter(ParameterSetName = "HT")]
[Parameter(ParameterSetName = "RM")]
[switch]$PassThru
)

process{
# Powershell module manifest does not allow versions with prerelease tags on them.
# Powershell modle manifest does not allow to add a arbitrary field to specify prerelease versions.
# Valid value (ModuleName, ModuleVersion, RequiredVersion, GUID)
# There is no way to specify a prerelease required module.

if($RequiredModule){
$ModuleName = $RequiredModule.ModuleName
$ModuleVersion = [string]::IsNullOrWhiteSpace($RequiredModule.RequiredVersion) ? $RequiredModule.ModuleVersion : $RequiredModule.RequiredVersion
}

"Importing module Name[{0}] Version[{1}] AllowPrerelease[{2}]" -f $ModuleName, $ModuleVersion, $AllowPrerelease | Write-Verbose

# Following semVer we can manually specidy a taged version to specify that is prerelease
# Extract the semVer from it and set AllowPrerelease to true
if ($ModuleVersion) {
$V = $ModuleVersion.Split('-')
$semVer = $V[0]
$AllowPrerelease = ($AllowPrerelease -or ($null -ne $V[1]))
}

$module = Import-Module $ModuleName -PassThru -ErrorAction SilentlyContinue -MinimumVersion:$semVer

if ($null -eq $module) {
"Installing module Name[{0}] Version[{1}] AllowPrerelease[{2}]" -f $ModuleName, $ModuleVersion, $AllowPrerelease | Write-Host -ForegroundColor DarkGray
$installed = Install-Module -Name $ModuleName -Force -AllowPrerelease:$AllowPrerelease -passThru -RequiredVersion:$ModuleVersion
$module = $installed | ForEach-Object {Import-Module -Name $_.Name -RequiredVersion ($_.Version.Split('-')[0]) -Force -PassThru}
}

"Imported module Name[{0}] Version[{1}] PreRelease[{2}]" -f $module.Name, $module.Version, $module.privatedata.psdata.prerelease | Write-Host -ForegroundColor DarkGray

if ($PassThru) {
$module
}
}
}

<#
. SYNOPSIS
Extracts the required modules from the module manifest
#>
function Get-RequiredModule{
[CmdletBinding()]
[OutputType([Object[]])]
param()

# Required Modules
$localPath = $PSScriptRoot
$manifest = $localPath | Join-Path -child "*.psd1" | Get-Item | Import-PowerShellDataFile
$requiredModule = $null -eq $manifest.RequiredModules ? @() : $manifest.RequiredModules

# Convert to hashtable
$ret = @()
$requiredModule | ForEach-Object{
$ret += $_ -is [string] ? @{ ModuleName = $_ } : $_
}

return $ret
}
# Load Test_Helper module
Import-Module ./tools/Test_Helper

# Install and load TestingHelper
# Import-RequiredModule -Name TestingHelper -AllowPrerelease
Import-RequiredModule "TestingHelper" -AllowPrerelease

# Install and Load Module dependencies
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

Loading
Loading