Get-SqlDscPreferredModule: Using command Get-PSModulePath (#1905)

- `Get-SqlDscPreferredModule` - Re-using the command `Get-PSModulePath` from the module DscResource.Common.
dsccommunity · Apr 10, 2023 · b12e5bb · b12e5bb
1 parent 501bfe1
commit b12e5bb
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - New public command:
     - `Get-SqlDscPreferredModule` - Returns the name of the first available
       preferred module ([issue #1879](https://github.com/dsccommunity/SqlServerDsc/issues/1879)).
+      - Re-using the command `Get-PSModulePath` from the module DscResource.Common.
 - SqlSecureConnection
   - Added new parameter `ServerName` that will be used as the host name when
     restarting the SQL Server instance. The specified value should be the same

diff --git a/source/Public/Get-SqlDscPreferredModule.ps1 b/source/Public/Get-SqlDscPreferredModule.ps1
@@ -70,28 +70,7 @@ function Get-SqlDscPreferredModule
                 contains all paths.
             #>
 
-            <#
-                TODO: This should be replaced by Get-PSModulePath that is in
-                PR https://github.com/dsccommunity/DscResource.Common/pull/104.
-            #>
-
-            <#
-                Get the environment variables from all targets session, user and machine.
-                Casts the value to System.String to convert $null values to empty string.
-            #>
-            $modulePathSession = [System.String] [System.Environment]::GetEnvironmentVariable('PSModulePath')
-            $modulePathUser = [System.String] [System.Environment]::GetEnvironmentVariable('PSModulePath', 'User')
-            $modulePathMachine = [System.String] [System.Environment]::GetEnvironmentVariable('PSModulePath', 'Machine')
-
-            $modulePath = $modulePathSession, $modulePathUser, $modulePathMachine -join ';'
-
-            $modulePathArray = $modulePath -split ';' |
-                Where-Object -FilterScript {
-                    -not [System.String]::IsNullOrEmpty($_)
-                } |
-                Sort-Object -Unique
-
-            $modulePath = $modulePathArray -join ';'
+            $modulePath = Get-PSModulePath -FromTarget 'Session', 'User', 'Machine'
 
             Set-PSModulePath -Path $modulePath
         }

diff --git a/tests/Unit/Public/Get-SqlDscPreferredModule.Tests.ps1 b/tests/Unit/Public/Get-SqlDscPreferredModule.Tests.ps1
@@ -406,6 +406,10 @@ Describe 'Get-SqlDscPreferredModule' -Tag 'Public' {
     Context 'When specifying the parameter Refresh' {
         BeforeAll {
             Mock -CommandName Set-PSModulePath
+            Mock -CommandName Get-PSModulePath -MockWith {
+                return 'MockPath'
+            }
+
             Mock -CommandName Get-Module -MockWith {
                 return @{
                     Name = 'SqlServer'