Reset now applies to registered values

Author: nvarscar

functions/Reset-DBODefaultSetting.ps1

@@ -2,17 +2,28 @@ function Reset-DBODefaultSetting {
     <#
         .SYNOPSIS
             Resets configuration entries back to default values.
-    
+
         .DESCRIPTION
             This function creates or changes configuration values.
             These can be used to provide dynamic configuration information outside the PowerShell variable system.
-    
+
         .PARAMETER Name
             Name of the configuration entry.
 
         .PARAMETER All
             Specify if you want to reset all configuration values to their defaults.
 
+        .PARAMETER Temporary
+            The setting is not persisted outside the current session.
+            By default, settings will be remembered across all powershell sessions.
+
+        .PARAMETER Scope
+            Choose if the setting should be stored in current user's registry or will be shared between all users.
+            Allowed values: CurrentUser, AllUsers.
+            AllUsers will require administrative access to the computer (elevated session).
+
+            Default: CurrentUser.
+
         .PARAMETER Confirm
             Prompts to confirm certain actions
 
@@ -21,42 +32,51 @@ function Reset-DBODefaultSetting {
 
         .EXAMPLE
             Reset-DBODefaultSetting -Name ConnectionTimeout
-        
+
             Reset connection timeout setting back to default value.
-        
+
         .EXAMPLE
             Reset-DBODefaultSetting -All
-        
+
             Reset all settings.
     #>
     [CmdletBinding(DefaultParameterSetName = "Named", SupportsShouldProcess)]
     param (
         [parameter(Mandatory, ParameterSetName = 'Named')]
         [string[]]$Name,
         [parameter(Mandatory, ParameterSetName = 'All')]
-        [switch]$All
+        [switch]$All,
+        [switch]$Temporary,
+        [ValidateSet('CurrentUser', 'AllUsers')]
+        [string]$Scope = 'CurrentUser'
     )
 
     process {
         if ($Name) {
+            $settings = @()
             foreach ($n in $Name) {
-                if ($PSCmdlet.ShouldProcess($Name, "Resetting the setting back to its default value")) {
-                    $config = Get-PSFConfig -FullName dbops.$n
-                    if ($config) { $config.ResetValue() }
-                    else {
-                        Stop-PSFFunction -Message "Unable to find setting $n" -EnableException $true
-                    }
-                }
+                $config = Get-PSFConfig -FullName dbops.$n
+                if ($config) { $settings += $config }
+                else { Stop-PSFFunction -Message "Unable to find setting $n" -EnableException $true }
             }
         }
-        elseif ($All) {
-            foreach ($config in Get-PSFConfig -Module dbops ) {
-                if ($PSCmdlet.ShouldProcess($config, "Resetting the setting back to its default value")) {
-                    if ($config.Initialized) {
-                        $config.ResetValue()
-                    }
-                    else {
-                        Write-PSFMessage -Level Warning -Message "Setting $($config.fullName -replace '^dbops\.','')) was not initialized and has no default value as such"
+        elseif ($All) { $settings = Get-PSFConfig -Module dbops }
+        $newScope = switch ($Scope) {
+            'CurrentUser' { 'UserDefault' }
+            'AllUsers' { 'SystemDefault' }
+        }
+        foreach ($config in $settings) {
+            $sName = $config.fullName -replace '^dbops\.', ''
+            if ($PSCmdlet.ShouldProcess($config, "Resetting the setting $sName back to its default value")) {
+                if ($config.Initialized) {
+                    $config.ResetValue()
+                }
+                else {
+                    Write-PSFMessage -Level Warning -Message "Setting $sName was not initialized and has no default value as such"
+                }
+                if (!$Temporary) {
+                    if ($PSCmdlet.ShouldProcess($Name, "Unregistering $sName in the $newScope scope")) {
+                        $config | Unregister-PSFConfig -Scope $newScope
                     }
                 }
             }

tests/Reset-DBODefaultSetting.Tests.ps1

@@ -25,7 +25,7 @@ Describe "Reset-DBODefaultSetting tests" -Tag $commandName, UnitTests {
     AfterAll {
         Unregister-PSFConfig -Module dbops -Name tc1
         Unregister-PSFConfig -Module dbops -Name tc2
-        Unregister-PSFConfig -Module dbops -Name tc3
+        Unregister-PSFConfig -Module dbops -Name tc3 -Scope SystemDefault
         Unregister-PSFConfig -Module dbops -Name secret
     }
     Context "Resetting various configs" {
@@ -41,6 +41,12 @@ Describe "Reset-DBODefaultSetting tests" -Tag $commandName, UnitTests {
             $testResult | Should -BeNullOrEmpty
             Get-PSFConfigValue -FullName dbops.tc1 | Should -Be 1
         }
+        It "resets temporary config" {
+            Get-PSFConfigValue -FullName dbops.tc1 | Should -Be 2
+            $testResult = Reset-DBODefaultSetting -Name tc1 -Temporary
+            $testResult | Should -BeNullOrEmpty
+            Get-PSFConfigValue -FullName dbops.tc1 | Should -Be 1
+        }
         It "resets two configs" {
             Get-PSFConfigValue -FullName dbops.tc1 | Should -Be 2
             Get-PSFConfigValue -FullName dbops.tc2 | Should -Be 'string2'
@@ -54,17 +60,28 @@ Describe "Reset-DBODefaultSetting tests" -Tag $commandName, UnitTests {
             Get-PSFConfigValue -FullName dbops.tc2 | Should -Be 'string2'
             Get-PSFConfigValue -FullName dbops.tc3 | Should -Be 'another2'
             $testResult = Get-PSFConfigValue -FullName dbops.secret
-            $cred = [pscredential]::new('test',$testResult)
+            $cred = [pscredential]::new('test', $testResult)
             $cred.GetNetworkCredential().Password | Should Be 'bar'
             $testResult = Reset-DBODefaultSetting -All
             $testResult | Should -BeNullOrEmpty
             Get-PSFConfigValue -FullName dbops.tc1 | Should -Be 1
             Get-PSFConfigValue -FullName dbops.tc2 | Should -Be 'string'
             Get-PSFConfigValue -FullName dbops.tc3 | Should -Be 'another'
             $testResult = Get-PSFConfigValue -FullName dbops.secret
-            $cred = [pscredential]::new('test',$testResult)
+            $cred = [pscredential]::new('test', $testResult)
             $cred.GetNetworkCredential().Password | Should Be 'foo'
         }
+        It "resets an AllUsers-scoped value" {
+            try {
+                Register-PSFConfig -FullName dbops.tc3 -Scope SystemDefault
+                $testResult = Reset-DBODefaultSetting -Name tc3 -Scope AllUsers
+                $testResult | Should -BeNullOrEmpty
+                Get-PSFConfigValue -FullName dbops.tc3 | Should Be 'another'
+            }
+            catch {
+                $_.Exception.Message | Should BeLike '*access*'
+            }
+        }
     }
     Context "Negative tests" {
         It "should throw when setting does not exist" {