feat: Adds helm chart name functions

steveblackduck · steveblackduck · commit 0da24a3ab003 · 2024-11-08T11:34:47.000-05:00
- Replaces Synopsys references with Black Duck
diff --git a/LICENSE b/LICENSE
@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2017 Code Dx, Inc
+   Copyright 2024 Black Duck Software, Inc. All rights reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
diff --git a/functions/docker.ps1 b/functions/docker.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.0.0
 .GUID fc6ce9ac-58ac-4e50-befb-754f063752f0
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes Docker-related helpers
 #>
 
diff --git a/functions/helm.ps1 b/functions/helm.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.3.1
 .GUID 04273f72-e001-415b-add0-e5e95e378355
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes Helm-related helpers
 #>
 
@@ -150,6 +151,19 @@ function Get-HelmVersionMajorMinor() {
 }
 
 function Get-HelmChartFullname([string] $releaseName, [string] $chartName) {
+	Get-HelmChartFullnameEquals $releaseName $chartName
+}
+
+function Get-HelmChartFullnameContains([string] $releaseName, [string] $chartName) {
+
+	$fullname = $releaseName
+	if (-not ($releaseName.Contains($chartName))) {
+		$fullname = "$releaseName-$chartName"
+	}
+	Get-CommonName $fullname
+}
+
+function Get-HelmChartFullnameEquals([string] $releaseName, [string] $chartName) {
 
 	$fullname = $releaseName
 	if ($releaseName -cne $chartName) {
@@ -158,6 +172,10 @@ function Get-HelmChartFullname([string] $releaseName, [string] $chartName) {
 	Get-CommonName $fullname
 }
 
+function Get-HelmChartFullnameConcat([string] $releaseName, [string] $chartName) {
+	Get-CommonName "$releaseName-$chartName"
+}
+
 function Get-CommonName([string] $name) {
 
 	# note: matches chart "sanitize" helper
@@ -166,3 +184,12 @@ function Get-CommonName([string] $name) {
 	}
 	$name.TrimEnd('-')
 }
+
+function Get-AllHelmValues([string] $namespace, [string] $releaseName) {
+
+	$values = helm -n $namespace get values $releaseName -a -o json
+	if ($LASTEXITCODE -ne 0) {
+		throw "Unable to get release values, helm exited with code $LASTEXITCODE."
+	}
+	ConvertFrom-Json $values
+}
diff --git a/functions/input.ps1 b/functions/input.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.0.0
 .GUID b9a28367-a806-4d33-936c-73f8dc9e522a
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes input-related helpers
 #>
 
diff --git a/functions/k8s.ps1 b/functions/k8s.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.1.0
 .GUID bfaf255e-8e7b-4354-824f-46ac9625cab5
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes Kubernetes-related helpers
 #>
 
@@ -883,6 +884,17 @@ function Get-ServiceAccountName([string] $namespace,
 	$name
 }
 
+function Get-PodLog([string] $namespace,
+	[string] $containerName,
+	[string] $podName) {
+
+	$log = kubectl -n $namespace logs -c $containerName $podName
+	if (0 -ne $LASTEXITCODE) {
+		throw "Unable to get logs for container $containerName and pod $podName, kubectl exited with code $LASTEXITCODE."
+	}
+	$log
+}
+
 function Set-DeploymentReplicas([string] $namespace,
 	[string] $resourceName,
 	[int]    $replicaCount,
diff --git a/functions/keytool.ps1 b/functions/keytool.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.1.0
 .GUID d73b9c33-1ca5-40c2-bbce-ff18efd062ab
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes keytool-related helpers
 #>
 
diff --git a/functions/mariadb.ps1 b/functions/mariadb.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.1.0
 .GUID 0bccb44c-14f1-44c0-b41b-3fa02f5bb412
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes MariaDB-related helpers
 #>
 
diff --git a/functions/resource.ps1 b/functions/resource.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.3.0
 .GUID 7eadb850-7e43-4308-a9fa-0119a0a883a3
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes resource-related helpers
 #>
 
diff --git a/functions/step.ps1 b/functions/step.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.2.0
 .GUID 30b223d9-c262-4631-9e29-c6ee8191dc26
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes graph-related helpers.
 #>
 
diff --git a/functions/utils.ps1 b/functions/utils.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.1.0
 .GUID 6d09dd8f-2f19-4e91-9c1a-dfd848e50884
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes utility-related helpers.
 #>
 
diff --git a/functions/velero.ps1 b/functions/velero.ps1
@@ -1,7 +1,8 @@
 <#PSScriptInfo
 .VERSION 1.0.0
 .GUID d59ec807-d430-4d6a-ae7b-6e0ad9e8f9b5
-.AUTHOR Code Dx
+.AUTHOR Black Duck
+.COPYRIGHT Copyright 2024 Black Duck Software, Inc. All rights reserved.
 .DESCRIPTION Includes Velero-related helpers.
 #>
 
diff --git a/guided-setup.psd1 b/guided-setup.psd1
@@ -1,7 +1,7 @@
 #
 # Module manifest for module 'guided-setup'
 #
-# Generated by: Code Dx
+# Generated by: Black Duck
 #
 # Generated on: 7/21/2022
 #
@@ -12,7 +12,7 @@
 RootModule = 'guided-setup'
 
 # Version number of this module.
-ModuleVersion = '1.16.0'
+ModuleVersion = '1.17.0'
 
 # Supported PSEditions
 CompatiblePSEditions = @('Core')
@@ -21,13 +21,13 @@ CompatiblePSEditions = @('Core')
 GUID = '26bcb7a5-2ec2-4d3e-bd19-b80a96dacd6b'
 
 # Author of this module
-Author = 'Code Dx'
+Author = 'Black Duck'
 
 # Company or vendor of this module
-CompanyName = 'Synopsys'
+CompanyName = 'Black Duck Software'
 
 # Copyright statement for this module
-Copyright = '(c) 2022 Code Dx. All rights reserved.'
+Copyright = 'Copyright 2024 Black Duck Software, Inc. All rights reserved.'
 
 # Description of the functionality provided by this module
 Description = 'This module includes a framework for installing an application on a Kubernetes cluster using a setup wizard based on a directed graph.'
@@ -74,7 +74,7 @@ PowerShellVersion = '7.0.0'
 #   $files = (Get-ChildItem -LiteralPath './functions' -Recurse -Include '*.ps1','*.psm1') + (Get-ChildItem './guided-setup.psm1')
 #   [string]::join(',',($files | ForEach-Object { Select-String -input $_ -pattern '^function\s([^(]+)(?:\s|\()' -allmatches | ForEach-Object { "'$($_.matches.groups[1].value)'" } } | Sort-Object))
 #
-FunctionsToExport = @('Add-HelmRepo','Add-KeystoreAlias','Add-ResourceLabel','Add-Step','Add-StepTransition','Add-StepTransitions','Clear-HostStep','Convert-Base64','ConvertTo-Map','ConvertTo-PsonMap','ConvertTo-PsonStringArray','ConvertTo-YamlIntArray','ConvertTo-YamlMap','ConvertTo-YamlMap','ConvertTo-YamlStringArray','Copy-DBBackupFiles','Copy-K8sItem','Edit-ResourceJsonPath','Edit-ResourceStrategicPatch','Format-KeyValueAssignment','Format-NodeSelector','Format-PodTolerationNoScheduleNoExecute','Format-ResourceLimitRequest','Get-AppCommandPath','Get-CertificateFromCsr','Get-CommonName','Get-CsrSignerNameLegacyUnknown','Get-DatabaseUrl','Get-DockerImageParts','Get-HelmChartFullname','Get-HelmReleaseAppVersion','Get-HelmReleaseHistory','Get-HelmValues','Get-HelmVersionMajorMinor','Get-IPv4AddressList','Get-KeystorePasswordEscaped','Get-KeytoolJavaSettings','Get-KeytoolJavaSpec','Get-KubectlClientVersion','Get-KubectlContext','Get-KubectlContexts','Get-KubectlDryRunParam','Get-KubectlServerSemanticVersion','Get-KubectlServerVersion','Get-KubectlServerVersionMajor','Get-KubectlServerVersionMinor','Get-KubectlServerVersionNumber','Get-KubectlVersion','Get-KubernetesEndpointsPort','Get-KubernetesPort','Get-MasterFilePosAfterReset','Get-ResourceDirectoryPath','Get-SecretFieldValue','Get-SemanticVersionComponents','Get-ServiceAccountName','Get-TrustedCaCertAlias','Get-VirtualCpuCountFromReservation','Import-TrustedCaCert','Import-TrustedCaCerts','Invoke-GitClone','Invoke-GuidedSetup','Invoke-HelmCommand','New-Certificate','New-CertificateConfigMap','New-CertificateConfigMapResource','New-CertificateSecret','New-CertificateSecretResource','New-ConfigMap','New-ConfigMapResource','New-Csr','New-CsrApproval','New-CsrResource','New-Database','New-DockerImagePullSecretResource','New-GenericSecret','New-GenericSecretResource','New-GitRepository','New-HelmCommand','New-HelmControllerChartSource','New-HelmControllerConfigMapValues','New-HelmControllerGitSource','New-HelmOperatorChartSource','New-HelmOperatorConfigMapValues','New-HelmOperatorGitSource','New-HelmRelease','New-HelmRepository','New-ImagePullSecret','New-Namespace','New-NamespacedResource','New-NamespacedResourceFromYaml','New-NamespaceResource','New-PriorityClass','New-PriorityClassResource','New-ResourceFile','New-SealedSecret','New-SealedSecretFile','New-SecretResourceFile','Read-HostChoice','Read-HostEnter','Read-HostSecureText','Read-HostText','Remove-ConfigMap','Remove-CsrResource','Remove-Database','Remove-KeystoreAlias','Remove-KubernetesJob','Remove-KubernetesPvc','Remove-NamespacedResource','Remove-Pod','Remove-PriorityClass','Remove-ResourceLabel','Remove-Secret','Remove-VeleroBackupSchedule','Set-CustomResourceDefinitionResource','Set-DeploymentReplicas','Set-GuidedSetupModulePreferences','Set-K8sResource','Set-KeystorePassword','Set-KubectlContext','Set-KubectlFromFilePath','Set-NamespaceLabel','Set-NonNamespacedResource','Set-Replicas','Set-ResourceDirectory','Set-StatefulSetReplicas','Split-DockerName','Split-DockerRepo','Start-SlaveDB','Stop-SlaveDB','Test-CertificateSigningRequestV1Beta1','Test-CertificateSigningRequestV1Beta1','Test-ClusterInfo','Test-ConfigMap','Test-CsrResource','Test-CurrentKubeContext','Test-Database','Test-Deployment','Test-DeploymentLabel','Test-EmailAddress','Test-HelmRelease','Test-IsBlacklisted','Test-IsCore','Test-IsElevated','Test-IsValidParameterValue','Test-KeystoreAlias','Test-KeystorePassword','Test-KeyToolCertificate','Test-KubernetesJob','Test-MinPsMajorVersion','Test-Namespace','Test-NamespacedResource','Test-NonNamespacedResource','Test-Pod','Test-PriorityClass','Test-ResourceApiVersion','Test-Secret','Test-Service','Test-SetupKubernetesVersion','Test-StatefulSet','Test-VeleroBackupSchedule','Wait-AllRunningPods','Wait-Deployment','Wait-JobSuccess','Wait-ReplicasReady','Wait-RunningPod','Wait-StatefulSet','Write-ErrorMessageAndExit','Write-HostSection','Write-ImportantNote','Write-StepGraph')
+FunctionsToExport = @('Add-HelmRepo','Add-KeystoreAlias','Add-ResourceLabel','Add-Step','Add-StepTransition','Add-StepTransitions','Clear-HostStep','Convert-Base64','ConvertTo-Map','ConvertTo-PsonMap','ConvertTo-PsonStringArray','ConvertTo-YamlIntArray','ConvertTo-YamlMap','ConvertTo-YamlMap','ConvertTo-YamlStringArray','Copy-DBBackupFiles','Copy-K8sItem','Edit-ResourceJsonPath','Edit-ResourceStrategicPatch','Format-KeyValueAssignment','Format-NodeSelector','Format-PodTolerationNoScheduleNoExecute','Format-ResourceLimitRequest','Get-AllHelmValues','Get-AppCommandPath','Get-CertificateFromCsr','Get-CommonName','Get-CsrSignerNameLegacyUnknown','Get-DatabaseUrl','Get-DockerImageParts','Get-HelmChartFullname','Get-HelmChartFullnameConcat','Get-HelmChartFullnameContains','Get-HelmChartFullnameEquals','Get-HelmReleaseAppVersion','Get-HelmReleaseHistory','Get-HelmValues','Get-HelmVersionMajorMinor','Get-IPv4AddressList','Get-KeystorePasswordEscaped','Get-KeytoolJavaSettings','Get-KeytoolJavaSpec','Get-KubectlClientVersion','Get-KubectlContext','Get-KubectlContexts','Get-KubectlDryRunParam','Get-KubectlServerSemanticVersion','Get-KubectlServerVersion','Get-KubectlServerVersionMajor','Get-KubectlServerVersionMinor','Get-KubectlServerVersionNumber','Get-KubectlVersion','Get-KubernetesEndpointsPort','Get-KubernetesPort','Get-MasterFilePosAfterReset','Get-PodLog','Get-ResourceDirectoryPath','Get-SecretFieldValue','Get-SemanticVersionComponents','Get-ServiceAccountName','Get-TrustedCaCertAlias','Get-VirtualCpuCountFromReservation','Import-TrustedCaCert','Import-TrustedCaCerts','Invoke-GitClone','Invoke-GuidedSetup','Invoke-HelmCommand','New-Certificate','New-CertificateConfigMap','New-CertificateConfigMapResource','New-CertificateSecret','New-CertificateSecretResource','New-ConfigMap','New-ConfigMapResource','New-Csr','New-CsrApproval','New-CsrResource','New-Database','New-DockerImagePullSecretResource','New-GenericSecret','New-GenericSecretResource','New-GitRepository','New-HelmCommand','New-HelmControllerChartSource','New-HelmControllerConfigMapValues','New-HelmControllerGitSource','New-HelmOperatorChartSource','New-HelmOperatorConfigMapValues','New-HelmOperatorGitSource','New-HelmRelease','New-HelmRepository','New-ImagePullSecret','New-Namespace','New-NamespacedResource','New-NamespacedResourceFromYaml','New-NamespaceResource','New-PriorityClass','New-PriorityClassResource','New-ResourceFile','New-SealedSecret','New-SealedSecretFile','New-SecretResourceFile','Read-HostChoice','Read-HostEnter','Read-HostSecureText','Read-HostText','Remove-ConfigMap','Remove-CsrResource','Remove-Database','Remove-KeystoreAlias','Remove-KubernetesJob','Remove-KubernetesPvc','Remove-NamespacedResource','Remove-Pod','Remove-PriorityClass','Remove-ResourceLabel','Remove-Secret','Remove-VeleroBackupSchedule','Set-CustomResourceDefinitionResource','Set-DeploymentReplicas','Set-GuidedSetupModulePreferences','Set-K8sResource','Set-KeystorePassword','Set-KubectlContext','Set-KubectlFromFilePath','Set-NamespaceLabel','Set-NonNamespacedResource','Set-Replicas','Set-ResourceDirectory','Set-StatefulSetReplicas','Split-DockerName','Split-DockerRepo','Start-SlaveDB','Stop-SlaveDB','Test-CertificateSigningRequestV1Beta1','Test-CertificateSigningRequestV1Beta1','Test-ClusterInfo','Test-ConfigMap','Test-CsrResource','Test-CurrentKubeContext','Test-Database','Test-Deployment','Test-DeploymentLabel','Test-EmailAddress','Test-HelmRelease','Test-IsBlacklisted','Test-IsCore','Test-IsElevated','Test-IsValidParameterValue','Test-KeystoreAlias','Test-KeystorePassword','Test-KeyToolCertificate','Test-KubernetesJob','Test-MinPsMajorVersion','Test-Namespace','Test-NamespacedResource','Test-NonNamespacedResource','Test-Pod','Test-PriorityClass','Test-ResourceApiVersion','Test-Secret','Test-Service','Test-SetupKubernetesVersion','Test-StatefulSet','Test-VeleroBackupSchedule','Wait-AllRunningPods','Wait-Deployment','Wait-JobSuccess','Wait-ReplicasReady','Wait-RunningPod','Wait-StatefulSet','Write-ErrorMessageAndExit','Write-HostSection','Write-ImportantNote','Write-StepGraph')
 
 # 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 = @()
