20221011A

Author: hugoalh

hugoalh.GitHubActionsToolkit/module/artifact.psm1

@@ -11,32 +11,32 @@ Import-Module -Name (
 .SYNOPSIS
 GitHub Actions - Export Artifact
 .DESCRIPTION
-Export artifact to persist data and/or share with another job in the same workflow.
+Export artifact to persist data and/or share with future job in the same workflow.
 .PARAMETER Name
-Artifact name.
+Name of the artifact.
 .PARAMETER Path
-Absolute and/or relative path to the file that need to export as artifact.
+Paths to the files that need to export as artifact.
 .PARAMETER LiteralPath
-Absolute and/or relative literal path to the file that need to export as artifact.
+Literal paths to the files that need to export as artifact.
 .PARAMETER BaseRoot
-A (literal) path that denote the base root directory of the files for control files structure.
+Absolute literal path of the base root directory of the files for control files structure.
 .PARAMETER ContinueOnIssue
 Whether the export should continue in the event of files fail to export; If not set and issue is encountered, export will stop and queued files will not export; The partial artifact availables which include files up until the issue; If set and issue is encountered, the issue file will ignore and skip, and queued files will still export; The partial artifact availables which include everything but exclude issue files.
 .PARAMETER RetentionTime
-Duration of artifact expire, by days.
+Duration of the artifact become expire, by days.
 .OUTPUTS
-[PSCustomObject] Exported artifact's metadata.
+[PSCustomObject] Metadata of the exported artifact.
 #>
 Function Export-Artifact {
 	[CmdletBinding(DefaultParameterSetName = 'Path', HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_export-githubactionsartifact#Export-GitHubActionsArtifact')]
 	[OutputType([PSCustomObject])]
 	Param (
-		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][ValidateScript({ Test-ArtifactName -InputObject $_ }, ErrorMessage = '`{0}` is not a valid GitHub Actions artifact name!')][String]$Name,
-		[Parameter(Mandatory = $True, ParameterSetName = 'Path', Position = 1, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][SupportsWildcards()][Alias('File', 'Files', 'Paths')][String[]]$Path,
-		[Parameter(Mandatory = $True, ParameterSetName = 'LiteralPath', ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][Alias('LiteralFile', 'LiteralFiles', 'LiteralPaths', 'LP', 'PSPath', 'PSPaths')][String[]]$LiteralPath,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateScript({ [System.IO.Path]::IsPathRooted($_) -and (Test-Path -LiteralPath $_ -PathType 'Container') }, ErrorMessage = '`{0}` is not an exist and valid GitHub Actions artifact base root!')][Alias('Root')][String]$BaseRoot = $Env:GITHUB_WORKSPACE,
+		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][String]$Name,
+		[Parameter(Mandatory = $True, ParameterSetName = 'Path', Position = 1, ValueFromPipelineByPropertyName = $True)][SupportsWildcards()][Alias('File', 'Files', 'Paths')][String[]]$Path,
+		[Parameter(Mandatory = $True, ParameterSetName = 'LiteralPath', ValueFromPipelineByPropertyName = $True)][Alias('LiteralFile', 'LiteralFiles', 'LiteralPaths', 'LP', 'PSPath', 'PSPaths')][String[]]$LiteralPath,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Root')][String]$BaseRoot = $Env:GITHUB_WORKSPACE,
 		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('ContinueOnError')][Switch]$ContinueOnIssue,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, 90)][Alias('RetentionDay')][Byte]$RetentionTime
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('RetentionDay')][Byte]$RetentionTime
 	)
 	Begin {
 		[Boolean]$NoOperation = !(Test-GitHubActionsEnvironment -Artifact)# When the requirements are not fulfill, only stop this function but not others.
@@ -48,26 +48,12 @@ Function Export-Artifact {
 		If ($NoOperation) {
 			Return
 		}
-		Switch ($PSCmdlet.ParameterSetName) {
-			'LiteralPath' {
-				[String[]]$PathsProceed = $LiteralPath |
-					ForEach-Object -Process { [System.IO.Path]::IsPathRooted($_) ? $_ : (Join-Path -Path $BaseRoot -ChildPath $_) }
-			}
-			'Path' {
-				[String[]]$PathsProceed = @()
-				ForEach ($Item In $Path) {
-					Try {
-						$PathsProceed += Resolve-Path -Path ([System.IO.Path]::IsPathRooted($Item) ? $Item : (Join-Path -Path $BaseRoot -ChildPath $Item))
-					}
-					Catch {
-						$PathsProceed += $Item
-					}
-				}
-			}
-		}
 		[Hashtable]$InputObject = @{
 			Name = $Name
-			Path = $PathsProceed
+			Path = ($PSCmdlet.ParameterSetName -ieq 'LiteralPath') ? (
+				$LiteralPath |
+					ForEach-Object -Process { [WildcardPattern]::Escape($_) }
+			) : $Path
 			BaseRoot = $BaseRoot
 			ContinueOnIssue = $ContinueOnIssue.IsPresent
 		}
@@ -83,25 +69,25 @@ Set-Alias -Name 'Save-Artifact' -Value 'Export-Artifact' -Option 'ReadOnly' -Sco
 .SYNOPSIS
 GitHub Actions - Import Artifact
 .DESCRIPTION
-Import artifact that shared data from previous job in the same workflow.
+Import artifact that shared data from past job in the same workflow.
 .PARAMETER Name
-Artifact name.
+Name of the artifact.
 .PARAMETER CreateSubfolder
-Create a subfolder with artifact name and put data into here.
+Whether to create a subfolder with artifact name and put data into here.
 .PARAMETER All
-Import all artifacts that shared data from previous job in the same workflow; Always create subfolder.
+Import all of the artifacts that shared data from past job in the same workflow; Always create subfolders.
 .PARAMETER Destination
-Artifact destination.
+Absolute literal path(s) of the destination of the artifact(s).
 .OUTPUTS
-[PSCustomObject] Imported artifact's metadata.
-[PSCustomObject[]] Imported artifacts' metadata.
+[PSCustomObject] Metadata of the imported artifact.
+[PSCustomObject[]] Metadata of the imported artifacts.
 #>
 Function Import-Artifact {
 	[CmdletBinding(DefaultParameterSetName = 'Single', HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_import-githubactionsartifact#Import-GitHubActionsArtifact')]
 	[OutputType([PSCustomObject[]], ParameterSetName = 'All')]
 	[OutputType([PSCustomObject], ParameterSetName = 'Single')]
 	Param (
-		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][ValidateScript({ Test-ArtifactName -InputObject $_ }, ErrorMessage = '`{0}` is not a valid GitHub Actions artifact name!')][String]$Name,
+		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][String]$Name,
 		[Parameter(ParameterSetName = 'Single', ValueFromPipelineByPropertyName = $True)][Switch]$CreateSubfolder,
 		[Parameter(Mandatory = $True, ParameterSetName = 'All')][Switch]$All,
 		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Dest', 'Target')][String]$Destination = $Env:GITHUB_WORKSPACE
@@ -135,48 +121,6 @@ Function Import-Artifact {
 	}
 }
 Set-Alias -Name 'Restore-Artifact' -Value 'Import-Artifact' -Option 'ReadOnly' -Scope 'Local'
-<#
-.SYNOPSIS
-GitHub Actions (Private) - Test Artifact Name
-.DESCRIPTION
-Test GitHub Actions artifact name whether is valid.
-.PARAMETER InputObject
-GitHub Actions artifact name that need to test.
-.OUTPUTS
-[Boolean] Test result.
-#>
-Function Test-ArtifactName {
-	[CmdletBinding()]
-	[OutputType([Boolean])]
-	Param (
-		[Parameter(Mandatory = $True, Position = 0, ValueFromPipeline = $True)][Alias('Input', 'Object')][String]$InputObject
-	)
-	Process {
-		(Test-ArtifactPath -InputObject $InputObject) -and $InputObject -imatch '^[^\\/]+$' |
-			Write-Output
-	}
-}
-<#
-.SYNOPSIS
-GitHub Actions (Private) - Test Artifact Path
-.DESCRIPTION
-Test GitHub Actions artifact path whether is valid.
-.PARAMETER InputObject
-GitHub Actions artifact path that need to test.
-.OUTPUTS
-[Boolean] Test result.
-#>
-Function Test-ArtifactPath {
-	[CmdletBinding()]
-	[OutputType([Boolean])]
-	Param (
-		[Parameter(Mandatory = $True, Position = 0, ValueFromPipeline = $True)][Alias('Input', 'Object')][String]$InputObject
-	)
-	Process {
-		$InputObject -imatch '^[^":<>|*?\n\r\t]+$' |
-			Write-Output
-	}
-}
 Export-ModuleMember -Function @(
 	'Export-Artifact',
 	'Import-Artifact'

hugoalh.GitHubActionsToolkit/module/cache.psm1

@@ -11,15 +11,15 @@ Import-Module -Name (
 .SYNOPSIS
 GitHub Actions - Restore Cache
 .DESCRIPTION
-Restore cache that shared data from previous job in the same workflow.
+Restore cache that shared data from past job in the same workflow.
 .PARAMETER Key
-Cache key.
+Key of the cache.
 .PARAMETER Path
-Cache destination path.
+Path of the destination of the cache.
 .PARAMETER LiteralPath
-Cache destination literal path.
+Absolute literal path of the destination of the cache.
 .PARAMETER NotUseAzureSdk
-Do not use Azure Blob SDK to download caches that are stored on Azure Blob Storage, this maybe affect reliability and performance.
+Whether to not use Azure Blob SDK to download caches that are stored on the Azure Blob Storage, this maybe affect the reliability and performance.
 .PARAMETER DownloadConcurrency
 Number of parallel downloads (only for Azure SDK).
 .PARAMETER Timeout
@@ -84,11 +84,11 @@ Set-Alias -Name 'Import-Cache' -Value 'Restore-Cache' -Option 'ReadOnly' -Scope
 .SYNOPSIS
 GitHub Actions - Save cache
 .DESCRIPTION
-Save cache to persist data and/or share with another job in the same workflow.
+Save cache to persist data and/or share with future job in the same workflow.
 .PARAMETER Key
-Cache key.
+Key of the cache.
 .PARAMETER Path
-Cache path.
+Paths of the cache.
 .PARAMETER LiteralPath
 Cache literal path.
 .PARAMETER UploadChunkSizes

hugoalh.GitHubActionsToolkit/module/internal/token.psm1

@@ -11,7 +11,7 @@ Generate a new random token.
 .PARAMETER Length
 Length of the token.
 .PARAMETER WithUpperCase
-Contain upper case letters in the token.
+Whether to contain upper case letters in the token.
 .OUTPUTS
 [String] A new random token.
 #>
@@ -22,7 +22,8 @@ Function New-RandomToken {
 		[Parameter(Position = 0)][ValidateRange(1, [UInt32]::MaxValue)][UInt32]$Length = 8,
 		[Alias('UpperCase')][Switch]$WithUpperCase
 	)
-	[Char[]]$Pool = $PoolLowerCase + $PoolNumber + ($WithUpperCase.IsPresent ? $PoolUpperCase : @())
+	[Char[]]$Pool = $PoolLowerCase + $PoolNumber + ($WithUpperCase.IsPresent ? $PoolUpperCase : @()) |
+		Get-Random -Shuffle
 	@(1..$Length) |
 		ForEach-Object -Process {
 			$Pool |

hugoalh.GitHubActionsToolkit/module/nodejs-wrapper/artifact/download-all.js

@@ -1,11 +1,10 @@
+import { argumentHandle, errorHandle } from "../handle.js";
 import { create as ghactionsArtifact } from "@actions/artifact";
-const [inputs, delimiter] = process.argv.slice(2);
-const { Destination } = JSON.parse(inputs);
-const result = await ghactionsArtifact().downloadAllArtifacts(Destination)
-	.catch((reason) => {
-		console.error(reason);
-		return process.exit(1);
-	});
+const {
+	delimiter,
+	Destination
+} = argumentHandle();
+const result = await ghactionsArtifact().downloadAllArtifacts(Destination).catch(errorHandle);
 console.log(delimiter);
 console.log(JSON.stringify(result.map((value) => {
 	return {

hugoalh.GitHubActionsToolkit/module/nodejs-wrapper/artifact/download.js

@@ -1,15 +1,12 @@
+import { argumentHandle, errorHandle } from "../handle.js";
 import { create as ghactionsArtifact } from "@actions/artifact";
-const [inputs, delimiter] = process.argv.slice(2);
 const {
+	delimiter,
 	CreateSubfolder,
 	Destination,
 	Name
-} = JSON.parse(inputs);
-const result = await ghactionsArtifact().downloadArtifact(Name, Destination, { createArtifactFolder: CreateSubfolder })
-	.catch((reason) => {
-		console.error(reason);
-		return process.exit(1);
-	});
+} = argumentHandle();
+const result = await ghactionsArtifact().downloadArtifact(Name, Destination, { createArtifactFolder: CreateSubfolder }).catch(errorHandle);
 console.log(delimiter);
 console.log(JSON.stringify({
 	Name: result.artifactName,

hugoalh.GitHubActionsToolkit/module/nodejs-wrapper/artifact/upload.js

@@ -1,20 +1,17 @@
+import { argumentHandle, errorHandle } from "../handle.js";
 import { create as ghactionsArtifact } from "@actions/artifact";
-const [inputs, delimiter] = process.argv.slice(2);
 const {
+	delimiter,
 	BaseRoot,
 	ContinueOnIssue,
 	Name,
 	Path,
 	RetentionTime
-} = JSON.parse(inputs);
+} = argumentHandle();
 const result = await ghactionsArtifact().uploadArtifact(Name, Path, BaseRoot, {
 	continueOnError: ContinueOnIssue,
 	retentionDays: RetentionTime
-})
-	.catch((reason) => {
-		console.error(reason);
-		return process.exit(1);
-	});
+}).catch(errorHandle);
 console.log(delimiter);
 console.log(JSON.stringify({
 	FailedItem: result.failedItems,

hugoalh.GitHubActionsToolkit/module/nodejs-wrapper/cache/restore.js

@@ -1,21 +1,18 @@
+import { argumentHandle, errorHandle } from "../handle.js";
 import { restoreCache as ghactionsCacheRestoreCache } from "@actions/cache";
-const [inputs, delimiter] = process.argv.slice(2);
 const {
+	delimiter,
 	DownloadConcurrency,
 	Path,
 	PrimaryKey,
 	RestoreKey,
 	Timeout,
 	UseAzureSdk
-} = JSON.parse(inputs);
+} = argumentHandle();
 const result = await ghactionsCacheRestoreCache(Path, PrimaryKey, RestoreKey, {
 	downloadConcurrency: DownloadConcurrency,
 	timeoutInMs: Timeout,
 	useAzureSdk: UseAzureSdk
-})
-	.catch((reason) => {
-		console.error(reason);
-		return process.exit(1);
-	});
+}).catch(errorHandle);
 console.log(delimiter);
 console.log(JSON.stringify({ CacheKey: result }));

hugoalh.GitHubActionsToolkit/module/nodejs-wrapper/cache/save.js

@@ -1,18 +1,15 @@
+import { argumentHandle, errorHandle } from "../handle.js";
 import { saveCache as ghactionsCacheSaveCache } from "@actions/cache";
-const [inputs, delimiter] = process.argv.slice(2);
 const {
+	delimiter,
 	Key,
 	Path,
 	UploadChunkSizes,
 	UploadConcurrency
-} = JSON.parse(inputs);
+} = argumentHandle();
 const result = await ghactionsCacheSaveCache(Path, Key, {
 	uploadChunkSize: UploadChunkSizes,
 	uploadConcurrency: UploadConcurrency
-})
-	.catch((reason) => {
-		console.error(reason);
-		return process.exit(1);
-	});
+}).catch(errorHandle);
 console.log(delimiter);
 console.log(JSON.stringify({ CacheId: result }));

hugoalh.GitHubActionsToolkit/module/nodejs-wrapper/handle.js

@@ -0,0 +1,15 @@
+function argumentHandle() {
+	const [inputs, delimiter] = process.argv.slice(2);
+	return {
+		...JSON.parse(inputs),
+		delimiter
+	};
+}
+function errorHandle(reason) {
+	console.error(reason);
+	return process.exit(1);
+}
+export {
+	argumentHandle,
+	errorHandle
+};

hugoalh.GitHubActionsToolkit/module/nodejs-wrapper/open-id-connect/get-token.js

@@ -1,10 +1,9 @@
+import { argumentHandle, errorHandle } from "../handle.js";
 import { getIDToken as ghactionsGetOpenIDConnectToken } from "@actions/core";
-const [inputs, delimiter] = process.argv.slice(2);
-const { Audience } = JSON.parse(inputs);
-const result = await ghactionsGetOpenIDConnectToken(Audience)
-	.catch((reason) => {
-		console.error(reason);
-		return process.exit(1);
-	});
+const {
+	delimiter,
+	Audience
+} = argumentHandle();
+const result = await ghactionsGetOpenIDConnectToken(Audience).catch(errorHandle);
 console.log(delimiter);
 console.log(JSON.stringify({ Token: result }));