🩹 [Patch]: Ensure that the vault is always present before using it (#69)

## Description

- Ensure that the vault is always present before using it.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

src/functions/private/Initialize-ContextVault.ps1 → src/functions/private/Set-ContextVault.ps1

@@ -1,13 +1,13 @@
 #Requires -Modules @{ ModuleName = 'Microsoft.PowerShell.SecretManagement'; RequiredVersion = '1.1.2' }
 #Requires -Modules @{ ModuleName = 'Microsoft.PowerShell.SecretStore'; RequiredVersion = '1.0.6' }
 
-function Initialize-ContextVault {
+function Set-ContextVault {
     <#
         .SYNOPSIS
-        Initialize a context vault.
+        Sets the context vault.
 
         .DESCRIPTION
-        Initialize a context vault. If the vault does not exist, it will be created and registered.
+        Sets the context vault. If the vault does not exist, it will be created and registered.
 
         The SecretStore is created with the following parameters:
         - Authentication: None
@@ -16,20 +16,34 @@ function Initialize-ContextVault {
         - Scope: CurrentUser
 
         .EXAMPLE
-        Initialize-ContextVault
+        Set-ContextVault
 
-        Initializes a context vault named 'ContextVault' using the 'Microsoft.PowerShell.SecretStore' module.
+        Sets a context vault named 'ContextVault' using the 'Microsoft.PowerShell.SecretStore' module.
+
+        .EXAMPLE
+        Set-ContextVault -Name 'MyVault' -Type 'MyModule'
+
+        Sets a context vault named 'MyVault' using the 'MyModule' module.
+
+        .EXAMPLE
+        Set-ContextVault -PassThru
+
+        Sets a context vault using the default values and returns the secret vault object.
     #>
     [OutputType([Microsoft.PowerShell.SecretManagement.SecretVaultInfo])]
-    [CmdletBinding()]
+    [CmdletBinding(SupportsShouldProcess)]
     param (
-        # The name of the secret vault.
+        # The name of the context vault.
         [Parameter()]
         [string] $Name = $script:Config.VaultName,
 
-        # The type of the secret vault.
+        # The type of the context vault.
         [Parameter()]
-        [string] $Type = $script:Config.VaultType
+        [string] $Type = $script:Config.VaultType,
+
+        # Pass the vault through the pipeline.
+        [Parameter()]
+        [switch] $PassThru
     )
 
     begin {
@@ -53,7 +67,9 @@ function Initialize-ContextVault {
                     Force           = $true
                     Verbose         = $false
                 }
-                Reset-SecretStore @vaultParameters
+                if ($PSCmdlet.ShouldProcess('SecretStore', 'Reset')) {
+                    Reset-SecretStore @vaultParameters
+                }
                 Write-Debug "[$Type] - Done"
                 Write-Debug "[$Name] - Registering vault"
                 $secretVault = @{
@@ -63,18 +79,20 @@ function Initialize-ContextVault {
                     Description  = 'SecretStore'
                     Verbose      = $false
                 }
-                Register-SecretVault @secretVault
+                if ($PSCmdlet.ShouldProcess('SecretVault', 'Register')) {
+                    $vault = Register-SecretVault @secretVault -PassThru
+                }
                 Write-Debug "[$Name] - Done"
             }
             $script:Config.VaultName = $vault.Name
-
-            Get-SecretVault -Verbose:$false | Where-Object { $_.ModuleName -eq $Type }
-            Write-Debug "[$Name] - Vault registered"
-            $script:Config.Initialized = $true
+            Write-Debug "Connected to context vault [$($script:Config.VaultName)]"
         } catch {
             Write-Error $_
             throw 'Failed to initialize context vault'
         }
+        if ($PassThru) {
+            $vault
+        }
     }
 
     end {

src/functions/public/Get-Context.ps1

@@ -31,7 +31,7 @@ filter Get-Context {
     begin {
         $commandName = $MyInvocation.MyCommand.Name
         Write-Debug "[$commandName] - Start"
-        $null = Get-ContextVault
+        Set-ContextVault
         $vaultName = $script:Config.VaultName
         $contextInfos = Get-ContextInfo
     }

src/functions/public/Get-ContextInfo.ps1

@@ -18,6 +18,7 @@
     begin {
         $commandName = $MyInvocation.MyCommand.Name
         Write-Debug "[$commandName] - Start"
+        Set-ContextVault
         $vaultName = $script:Config.VaultName
         $secretPrefix = $script:Config.SecretPrefix
     }

src/functions/public/Remove-Context.ps1

@@ -32,7 +32,7 @@ filter Remove-Context {
     begin {
         $commandName = $MyInvocation.MyCommand.Name
         Write-Debug "[$commandName] - Start"
-        $null = Get-ContextVault
+        Set-ContextVault
     }
 
     process {

src/functions/public/Rename-Context.ps1

@@ -30,6 +30,10 @@
     begin {
         $commandName = $MyInvocation.MyCommand.Name
         Write-Debug "[$commandName] - Start"
+        Set-ContextVault
+    }
+
+    process {
         $context = Get-Context -ID $ID
         if (-not $context) {
             throw "Context with ID '$ID' not found."
@@ -39,9 +43,7 @@
         if ($existingContext -and -not $Force) {
             throw "Context with ID '$NewID' already exists."
         }
-    }
 
-    process {
         if ($PSCmdlet.ShouldProcess("Renaming context '$ID' to '$NewID'")) {
             try {
                 Set-Context -ID $NewID -Context $context

src/functions/public/Set-Context.ps1

@@ -37,7 +37,7 @@ function Set-Context {
     begin {
         $commandName = $MyInvocation.MyCommand.Name
         Write-Debug "[$commandName] - Start"
-        $null = Get-ContextVault
+        Set-ContextVault
         $vaultName = $script:Config.VaultName
         $secretPrefix = $script:Config.SecretPrefix
     }

src/variables/private/Config.ps1

@@ -1,5 +1,4 @@
 $script:Config = [pscustomobject]@{
-    Initialized  = $false                             # $script:Config.Initialized
     SecretPrefix = 'Context:'                         # $script:Config.SecretPrefix
     VaultName    = 'ContextVault'                     # $script:Config.VaultName
     VaultType    = 'Microsoft.PowerShell.SecretStore' # $script:Config.VaultType

tests/Context.Tests.ps1

@@ -5,7 +5,14 @@
 param()
 
 BeforeAll {
-    Get-SecretInfo | Remove-Secret
+    $secrets = Get-SecretInfo -Verbose
+    Write-Verbose "Secrets: $($secrets.Count)" -Verbose
+    Write-Verbose ($secrets | Format-Table | Out-String) -Verbose
+    $secrets | Remove-Secret -Verbose
+    $vault = Get-SecretVault -Verbose
+    Write-Verbose "Vault: $($vault.Count)" -Verbose
+    Write-Verbose ($vault | Format-Table | Out-String) -Verbose
+    $vault | Unregister-SecretVault -Verbose
 }
 
 Describe 'Functions' {