SecretManagement.ExtensionTemplate

1.0.0

SecretManagement.ExtensionTemplate.psm1

                                $script:ModuleRoot = $PSScriptRoot

$script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\SecretManagement.ExtensionTemplate.psd1").ModuleVersion

# Detect whether at some level dotsourcing was enforced

$script:doDotSource = Get-PSFConfigValue -FullName SecretManagement.ExtensionTemplate.Import.DoDotSource -Fallback $false

if ($SecretManagement.ExtensionTemplate_dotsourcemodule) { $script:doDotSource = $true }

<#

Note on Resolve-Path:

All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator.

This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS.

Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist.

This is important when testing for paths.

#>

# Detect whether at some level loading individual module files, rather than the compiled module was enforced

$importIndividualFiles = Get-PSFConfigValue -FullName SecretManagement.ExtensionTemplate.Import.IndividualFiles -Fallback $false

if ($SecretManagement.ExtensionTemplate_importIndividualFiles) { $importIndividualFiles = $true }

if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true }

if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true }

function Import-ModuleFile

{

    <#

        .SYNOPSIS

            Loads files into the module on module import.

        .DESCRIPTION

            This helper function is used during module initialization.

            It should always be dotsourced itself, in order to proper function.

            This provides a central location to react to files being imported, if later desired

        .PARAMETER Path

            The path to the file to load

        .EXAMPLE

            PS C:\> . Import-ModuleFile -File $function.FullName

            Imports the file stored in $function according to import policy

    #>

    [CmdletBinding()]

    Param (

        [string]

        $Path

    )

    $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($Path).ProviderPath

    if ($doDotSource) { . $resolvedPath }

    else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($resolvedPath))), $null, $null) }

}

#region Load individual files

if ($importIndividualFiles)

{

    # Execute Preimport actions

    foreach ($path in (& "$ModuleRoot\internal\scripts\preimport.ps1")) {

        . Import-ModuleFile -Path $path

    }

    # Import all internal functions

    foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore))

    {

        . Import-ModuleFile -Path $function.FullName

    }

    # Import all public functions

    foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore))

    {

        . Import-ModuleFile -Path $function.FullName

    }

    # Execute Postimport actions

    foreach ($path in (& "$ModuleRoot\internal\scripts\postimport.ps1")) {

        . Import-ModuleFile -Path $path

    }

    # End it here, do not load compiled code below

    return

}

#endregion Load individual files

#region Load compiled code

<#

This file loads the strings documents from the respective language folders.

This allows localizing messages and errors.

Load psd1 language files for each language you wish to support.

Partial translations are acceptable - when missing a current language message,

it will fallback to English or another available language.

#>

Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'SecretManagement.ExtensionTemplate' -Language 'en-US'

function Invoke-SMETemplate {

    <#

    .SYNOPSIS

    Helper for creating a SecretManagement Extension module.

    .DESCRIPTION

    Helper for creating a SecretManagement Extension module.

    .PARAMETER NewExtensionName

    The name of the extension. Will result in a module names 'SecretManagement.$NewExtensionName'

    .PARAMETER FunctionPrefix

    Prefix for functions exported from the main module.

    'MySecret' will e.g. create a 'Register-MySecretVault.ps1'.

    .PARAMETER OutPath

    Where should the new module be saved? A subfolder named '' will be created.

    .PARAMETER CompileTemplates

    Should the templates be compiled before usage? Needed for development.

    .EXAMPLE

    Invoke-SMETemplate -NewExtensionName MyWarden -FunctionPrefix MV

    Will create a complete module structure SecretManagement.MyWarden

    .NOTES

    General notes

    #>

    [CmdletBinding()]

    param (

        [parameter(Mandatory)]

        [String]$NewExtensionName,

        [parameter(Mandatory)]

        [string]$FunctionPrefix,

        $OutPath = (Get-Location).Path,

        [switch]$CompileTemplates

    )

    if ($CompileTemplates) {

        $templateSource = Join-Path $moduleRoot 'internal\template'

        $templateDestination = Join-Path $moduleRoot 'compiledTemplates'

        $manifest = Join-Path $moduleRoot "SecretManagement.ExtensionTemplate.psd1"

        $manifestData = Import-PowerShellDataFile $manifest

        $moduleVersion = $manifestData.ModuleVersion

        Write-PSFMessage -Level Important "Using moduleRoot '$moduleRoot'"

        Write-PSFMessage -Level Important "Using templateSource '$templateSource'"

        Write-PSFMessage -Level Important "Using templateDestination '$templateDestination'"

        Write-PSFMessage -Level Important "Using moduleVersion '$moduleVersion'"

        Remove-Item -Path "$templateDestination\*.xml" -Verbose

        New-PSMDTemplate -TemplateName SecretManagement.Extension -OutPath $templateDestination -ReferencePath $templateSource -Force -Debug # -Version $moduleVersion

    }

    Invoke-PSMDTemplate SecretManagement.Extension -Parameters @{

        name           = $NewExtensionName

        Description    = "SecretManagement module for accessing $NewExtensionName vaults"

        functionPrefix = $FunctionPrefix

    } -OutPath $OutPath -NoFolder

}

<#

This is an example configuration file

By default, it is enough to have a single one of them,

however if you have enough configuration settings to justify having multiple copies of it,

feel totally free to split them into multiple files.

#>

<#

# Example Configuration

Set-PSFConfig -Module 'SecretManagement.ExtensionTemplate' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'"

#>

Set-PSFConfig -Module 'SecretManagement.ExtensionTemplate' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging."

Set-PSFConfig -Module 'SecretManagement.ExtensionTemplate' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments."

Set-PSFConfig -Module 'PSModuleDevelopment' -Name 'Template.Store.SecretManagement' -Value "$script:ModuleRoot/compiledTemplates" -Initialize -Validation "string" -Description "Path to the templates shipped in OdinSelfServiceModule"

<#

Stored scriptblocks are available in [PsfValidateScript()] attributes.

This makes it easier to centrally provide the same scriptblock multiple times,

without having to maintain it in separate locations.

It also prevents lengthy validation scriptblocks from making your parameter block

hard to read.

Set-PSFScriptblock -Name 'SecretManagement.ExtensionTemplate.ScriptBlockName' -Scriptblock {

}

#>

<#

# Example:

Register-PSFTeppScriptblock -Name "SecretManagement.ExtensionTemplate.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' }

#>

<#

# Example:

Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name SecretManagement.ExtensionTemplate.alcohol

#>

New-PSFLicense -Product 'SecretManagement.ExtensionTemplate' -Manufacturer 'Sascha Spiekermann' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2023-02-28") -Text @"

Copyright (c) 2023 Sascha Spiekermann

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

"@

#endregion Load compiled code