Replace Format-Path function (#2084)

- SqlServerDsc.Common
  - Removed the function `Format-Path` in favor of the command
     with the same name in the module _DscResource.Common_.

Author: johlju

CHANGELOG.md

@@ -8,8 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 - SqlServerDsc.Common
-  - Removed the function `Get-RegistryPropertyValue` in favor of the command
-    with the same name in the module _DscResource.Common_.
+  - Removed the function `Get-RegistryPropertyValue` and `Format-Path` in
+    favor of the commands with the same names in the module _DscResource.Common_.
 
 ### Added
 

source/DSCResources/DSC_SqlRSSetup/DSC_SqlRSSetup.psm1

@@ -307,18 +307,18 @@ function Set-TargetResource
 
     $SourcePath = [Environment]::ExpandEnvironmentVariables($SourcePath)
 
-    $parametersToEvaluateTrailingSlash = @(
+    $parametersToEvaluateDirectorySeparator = @(
         'SourcePath',
         'InstallFolder'
     )
 
     # Making sure paths are correct.
-    foreach ($parameterName in $parametersToEvaluateTrailingSlash)
+    foreach ($parameterName in $parametersToEvaluateDirectorySeparator)
     {
         if ($PSBoundParameters.ContainsKey($parameterName))
         {
             $parameterValue = Get-Variable -Name $parameterName -ValueOnly
-            $formattedPath = Format-Path -Path $parameterValue -TrailingSlash
+            $formattedPath = Format-Path -Path $parameterValue -EnsureDriveLetterRoot -NoTrailingDirectorySeparator
             Set-Variable -Name $parameterName -Value $formattedPath
         }
     }

source/DSCResources/DSC_SqlSetup/DSC_SqlSetup.psm1

@@ -1034,7 +1034,7 @@ function Set-TargetResource
 
     $InstanceName = $InstanceName.ToUpper()
 
-    $parametersToEvaluateTrailingSlash = @(
+    $parametersToEvaluateDirectorySeparator = @(
         'InstanceDir',
         'InstallSharedDir',
         'InstallSharedWOWDir',
@@ -1053,12 +1053,12 @@ function Set-TargetResource
     )
 
     # Making sure paths are correct.
-    foreach ($parameterName in $parametersToEvaluateTrailingSlash)
+    foreach ($parameterName in $parametersToEvaluateDirectorySeparator)
     {
         if ($PSBoundParameters.ContainsKey($parameterName))
         {
             $parameterValue = Get-Variable -Name $parameterName -ValueOnly
-            $formattedPath = Format-Path -Path $parameterValue -TrailingSlash
+            $formattedPath = Format-Path -Path $parameterValue -EnsureDriveLetterRoot -NoTrailingDirectorySeparator
             Set-Variable -Name $parameterName -Value $formattedPath
         }
     }

source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psm1

@@ -4,57 +4,6 @@ Import-Module -Name $script:resourceHelperModulePath
 
 $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
-<#
-    .SYNOPSIS
-        Returns the value of the provided in the Name parameter, at the registry
-        location provided in the Path parameter.
-
-    .PARAMETER Path
-        String containing the path in the registry to the property name.
-
-    .PARAMETER PropertyName
-        String containing the name of the property for which the value is returned.
-#>
-function Format-Path
-{
-    [CmdletBinding()]
-    [OutputType([System.String])]
-    param
-    (
-        [Parameter(Mandatory = $true)]
-        [System.String]
-        $Path,
-
-        [Parameter()]
-        [System.Management.Automation.SwitchParameter]
-        $TrailingSlash
-    )
-
-    # Remove trailing slash ('\') from path.
-    if ($TrailingSlash.IsPresent)
-    {
-        <#
-            Trim backslash, but only if the path contains a full path and
-            not just a qualifier.
-        #>
-        if ($Path -notmatch '^[a-zA-Z]:\\$')
-        {
-            $Path = $Path.TrimEnd('\')
-        }
-
-        <#
-            If the path only contains a qualifier but no backslash ('M:'),
-            then a backslash is added ('M:\').
-        #>
-        if ($Path -match '^[a-zA-Z]:$')
-        {
-            $Path = '{0}\' -f $Path
-        }
-    }
-
-    return $Path
-}
-
 <#
     .SYNOPSIS
         Copy folder structure using Robocopy. Every file and folder, including empty ones are copied.

tests/Unit/SqlServerDsc.Common.Tests.ps1

@@ -83,43 +83,6 @@ AfterAll {
     Get-Module -Name 'CommonTestHelper' -All | Remove-Module -Force
 }
 
-Describe 'SqlServerDsc.Common\Format-Path' -Tag 'FormatPath' {
-    BeforeAll {
-        $mockCorrectPath = 'C:\Correct\Path'
-        $mockPathWithTrailingBackslash = 'C:\Correct\Path\'
-        $mockPathWithOnlyQualifier = 'M:'
-        $mockCorrectQualifierPath = 'M:\'
-    }
-
-    Context 'When there is a path that is wrongly formatted, but now formatting was requested' {
-        It 'Should return the same wrongly formatted path' {
-            $result = Format-Path -Path $mockPathWithTrailingBackslash
-            $result | Should -BeExactly $mockPathWithTrailingBackslash
-        }
-    }
-
-    Context 'When there is a path that is formatted correctly, and using TrailingSlash' {
-        It 'Should return the same path' {
-            $result = Format-Path -Path $mockCorrectPath -TrailingSlash
-            $result | Should -BeExactly $mockCorrectPath
-        }
-    }
-
-    Context 'When there is a path that has a trailing backslash, and using TrailingSlash' {
-        It 'Should return the path without trailing backslash' {
-            $result = Format-Path -Path $mockPathWithTrailingBackslash -TrailingSlash
-            $result | Should -BeExactly $mockCorrectPath
-        }
-    }
-
-    Context 'When there is a path that has only a qualifier, and using TrailingSlash' {
-        It 'Should return the path with trailing backslash after the qualifier' {
-            $result = Format-Path -Path $mockPathWithOnlyQualifier -TrailingSlash
-            $result | Should -BeExactly $mockCorrectQualifierPath
-        }
-    }
-}
-
 # Tests only the parts of the code that does not already get tested thru the other tests.
 Describe 'SqlServerDsc.Common\Copy-ItemWithRobocopy' -Tag 'CopyItemWithRobocopy' {
     BeforeAll {