Assert-ElevatedUser: Minor change to localization key name (#86)

dsccommunity · Dec 11, 2022 · 05e5294 · 05e5294
1 parent 47af45f
commit 05e5294
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- `Assert-ElevatedUser`
+  - Renamed the localized string key name and prepared the localized string
+    file to be able to distinguish which key belong to which command.
+
 ## [0.12.0] - 2022-12-10
 
 ### Added

diff --git a/source/Public/Assert-ElevatedUser.ps1 b/source/Public/Assert-ElevatedUser.ps1
@@ -35,7 +35,7 @@ function Assert-ElevatedUser
     {
         $PSCmdlet.ThrowTerminatingError(
             [System.Management.Automation.ErrorRecord]::new(
-                $script:localizedData.IsElevated_UserNotElevated,
+                $script:localizedData.ElevatedUser_UserNotElevated,
                 'UserNotElevated',
                 [System.Management.Automation.ErrorCategory]::InvalidOperation,
                 'Command parameters'

diff --git a/source/en-US/DscResource.Common.strings.psd1 b/source/en-US/DscResource.Common.strings.psd1
@@ -36,5 +36,7 @@ ConvertFrom-StringData @'
     PropertyNotInDesiredState = The parameter '{0}' is not in desired state. (DRC0040)
     PropertyNotInDesiredStateMessage = Property '{0}' is not in desired state. (DRC0041)
     NoMatchKeyMessage = NOTMATCH: Value (type '{0}') for property '{1}' does not match. Current state has the key(s) '{2}' and desired state has not. (DRC0042)
-    IsElevated_UserNotElevated = This command must run in an elevated PowerShell session. (DRC0043)
+
+    ## Assert-ElevatedUser
+    ElevatedUser_UserNotElevated = This command must run in an elevated PowerShell session. (DRC0043)
 '@
diff --git a/tests/Unit/Public/Assert-ElevatedUser.Tests.ps1 b/tests/Unit/Public/Assert-ElevatedUser.Tests.ps1
@@ -62,7 +62,7 @@ Describe 'Assert-ElevatedUser' -Tag 'Private' {
 
     It 'Should throw the correct error' -Skip:$mockIsElevated {
         InModuleScope -ScriptBlock {
-            $mockErrorMessage = $script:localizedData.IsElevated_UserNotElevated
+            $mockErrorMessage = $script:localizedData.ElevatedUser_UserNotElevated
 
             { Assert-ElevatedUser } | Should -Throw -ExpectedMessage $mockErrorMessage
         }