Title: ModuleSpecification/FullyQualifiedName usage does not handle paths well · Issue #8261 · PowerShell/PowerShell · GitHub
Open Graph Title: ModuleSpecification/FullyQualifiedName usage does not handle paths well · Issue #8261 · PowerShell/PowerShell
X Title: ModuleSpecification/FullyQualifiedName usage does not handle paths well · Issue #8261 · PowerShell/PowerShell
Description: Opened out of #8218. We do very little santisation/normalisation on paths passed in as module names in ModuleSpecification types to various cmdlets. Not many users rely directly on this functionality, but things like RequiredModules in m...
Open Graph Description: Opened out of #8218. We do very little santisation/normalisation on paths passed in as module names in ModuleSpecification types to various cmdlets. Not many users rely directly on this functionali...
X Description: Opened out of #8218. We do very little santisation/normalisation on paths passed in as module names in ModuleSpecification types to various cmdlets. Not many users rely directly on this functionali...
Opengraph URL: https://github.com/PowerShell/PowerShell/issues/8261
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"ModuleSpecification/FullyQualifiedName usage does not handle paths well","articleBody":"Opened out of https://github.com/PowerShell/PowerShell/pull/8218.\r\n\r\nWe do very little santisation/normalisation on paths passed in as module names in `ModuleSpecification` types to various cmdlets.\r\n\r\nNot many users rely directly on this functionality, but things like `RequiredModules` in module manifests do.\r\n\r\nWe currently don't have any layering or type API (that I know of) to reflect that a path passed in has been converted by PowerShell to one that's safe for .NET to operate on, and the ideal scenario would be for us to change that. Otherwise we are doomed to repeat the same path checks/resolutions at every layer in the code, either hurting perf or causing serious bugs.\r\n\r\n## Steps to reproduce\r\n\r\nSome examples of this problem:\r\n- Remove module using a path in a qualified name doesn't work:\r\n ```powershell\r\n Describe \"Remove-Module works with FullyQualifiedName using a path for the name\" {\r\n BeforeAll {\r\n $moduleName = 'rmomod'\r\n $moduleVersion = '1.2'\r\n $modulePath = Join-Path $TestDrive $moduleName\r\n $manifestPath = Join-Path $modulePath \"$moduleName.psd1\"\r\n \r\n New-Item -ItemType Directory -Path $modulePath\r\n \r\n New-ModuleManifest -Path $manifestPath -ModuleVersion $moduleVersion\r\n \r\n if ($IsWindows)\r\n {\r\n $sep = '\\'\r\n $altSep = '/'\r\n }\r\n else\r\n { \r\n $sep = '/'\r\n $altSep = '\\'\r\n }\r\n \r\n $absoluteTestCases = @(\r\n @{ ModuleName = $moduleName; Case = 'module name' }\r\n @{ ModuleName = $modulePath; Case = 'absolute module dir path' }\r\n @{ ModuleName = \"$TestDrive${altSep}$moduleName\"; Case = 'absolute module dir path with alt dir separators' }\r\n @{ ModuleName = $manifestPath; Case = 'absolute manifest path' }\r\n @{ ModuleName = \"$TestDrive${altSep}$moduleName${sep}$moduleName.psd1\"; Case = 'absolute manifest path with alt dir separators' }\r\n )\r\n\r\n $relativeTestCases = @(\r\n @{ Case = 'relative path to module dir'; Location = $TestDrive; ModuleName = \"./$moduleName\" }\r\n @{ Case = 'relative path to module dir with alt sep'; Location = \"$TestDrive/duck\"; ModuleName = \"..${altSep}moduleName\" }\r\n @{ Case = 'relative path to manifest with alt sep'; Location = \"$TestDrive/$moduleName\"; ModuleName = \"./$moduleName.psd1\" }\r\n @{ Case = 'relative path to manifest with alt sep'; Location = $TestDrive; ModuleName = \".${sep}$moduleName{$altSep}$moduleName.psd1\" }\r\n @{ Case = 'current dir being module dir'; Location = \"$TestDrive/$moduleName\"; ModuleName = \".\" }\r\n )\r\n }\r\n \r\n BeforeEach {\r\n Import-Module $modulePath\r\n }\r\n \r\n AfterEach {\r\n Remove-Module $moduleName -ErrorAction SilentlyContinue\r\n }\r\n \r\n It \"Removes the module by \u003cCase>\" -TestCases $absoluteTestCases {\r\n param([string]$ModuleName, [string]$Case)\r\n \r\n $fqn = @{\r\n ModuleName = $ModuleName\r\n ModuleVersion = $moduleVersion\r\n }\r\n \r\n Remove-Module -FullyQualifiedName $fqn -ErrorAction Stop\r\n Get-Module $moduleName | Should -HaveCount 0\r\n }\r\n\r\n It \"Removes the module by \u003cCase>\" -TestCases $relativeTestCases {\r\n param([string]$Location, [string]$ModuleName, [string]$Case)\r\n\r\n $fqn = @{\r\n ModuleName = $ModuleName\r\n ModuleVersion = $moduleVersion\r\n }\r\n\r\n if (-not (Test-Path $Location))\r\n {\r\n New-Item -ItemType Directory -Path $Location\r\n }\r\n\r\n Push-Location $Location\r\n try\r\n {\r\n Remove-Module -FullyQualifiedName $fqn -ErrorAction Stop\r\n Get-Module $moduleName | Should -HaveCount 0\r\n }\r\n finally\r\n {\r\n Pop-Location\r\n }\r\n }\r\n }\r\n ```\r\n- Required modules in a script:\r\n ```powershell\r\n Describe \"Requiring modules by absolute path\" {\r\n BeforeAll {\r\n $scriptPath = Join-Path $TestDrive \"script.ps1\"\r\n $success = 'SUCCESS'\r\n\r\n $moduleName = 'reqmod'\r\n $modulePath = Join-Path $TestDrive $moduleName\r\n $manifestPath = Join-Path $modulePath \"$moduleName.psd1\"\r\n\r\n New-Item -ItemType Directory $modulePath -Force\r\n\r\n New-ModuleManifest -Path $manifestPath -ModuleVersion '3.2.4'\r\n\r\n if ($IsWindows)\r\n {\r\n $sep = '\\'\r\n $altSep = '/'\r\n }\r\n else\r\n {\r\n $sep = '/'\r\n $altSep = '\\'\r\n }\r\n\r\n $oldModulePath = $env:PSModulePath\r\n $env:PSModulePath += [System.IO.Path]::PathSeparator + $TestDrive\r\n\r\n $testCases = @(\r\n @{ Case = 'module name, with module on path'; ModuleName = $moduleName }\r\n @{ Case = 'absolute path to module dir'; ModuleName = $modulePath }\r\n @{ Case = 'absolute path to module dir with alt sep'; ModuleName = \"$TestDrive${altSep}$moduleName\" }\r\n @{ Case = 'absolute path to manifest'; ModuleName = $manifestPath }\r\n @{ Case = 'absolute path to manifest with alt sep'; ModuleName = \"$TestDrive${sep}$moduleName${altSep}$moduleName.psd1\" }\r\n )\r\n }\r\n\r\n AfterAll {\r\n $env:PSModulePath = $oldModulePath\r\n }\r\n\r\n Context \"Autoload unloaded required module\" {\r\n AfterEach {\r\n Remove-Module $moduleName -ErrorAction SilentlyContinue\r\n }\r\n\r\n It \"Autoloads the required module by \u003cCase>\" -TestCases $testCases {\r\n param([string]$ModuleName, [string]$Case)\r\n\r\n $script = @\"\r\n #requires -Modules @{ ModuleName = '$ModuleName'; ModuleVersion = '$moduleVersion' }\r\n '$success'\r\n \"@\r\n\r\n New-Item -Path $scriptPath -Value $script -Force\r\n & $scriptPath | Should -BeExactly $success\r\n }\r\n }\r\n\r\n Context \"Verify required module is already loaded\" {\r\n BeforeAll {\r\n Import-Module $modulePath\r\n }\r\n\r\n AfterAll {\r\n Remove-Module $moduleName -ErrorAction SilentlyContinue\r\n }\r\n\r\n It \"Verifies that the required module is loaded by \u003cCase>\" -TestCases $testCases {\r\n param([string]$ModuleName, [string]$Case)\r\n\r\n $script = @\"\r\n #requires -Modules @{ ModuleName = '$ModuleName'; ModuleVersion = '$moduleVersion' }\r\n '$success'\r\n \"@\r\n\r\n New-Item -Path $scriptPath -Value $script -Force\r\n & $scriptPath | Should -BeExactly $success\r\n }\r\n }\r\n }\r\n ```\r\n (This second case actually supports alt separators, which I didn't expect. But still no module dir. And no relative paths either)","author":{"url":"https://github.com/rjmholt","@type":"Person","name":"rjmholt"},"datePublished":"2018-11-13T23:52:45Z","url":"https://github.com/PowerShell/PowerShell/issues/8261"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:b107a29d-6227-ec52-2f97-0cd8e97554e6 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D89E:9905:8D220:C728D:6AFD4A1A |
| html-safe-nonce | f2e3b74d899b98600622d66fa91e314a4b2c1c30b32d20914a9c5cfc7dbc4af8 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEODlFOjk5MDU6OEQyMjA6QzcyOEQ6NkFGRDRBMUEiLCJ2aXNpdG9yX2lkIjoiODcwNTcxNjQ4MzkxNDU0OTc4NiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 49fdb129f899ac3c34f0ec0c16ae5b224fb0ae61a5a8a37920cae910bf407da8 |
| hovercard-subject-tag | issue:380475831 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PowerShell/8261/issue_layout |
| twitter:image | https://opengraph.githubassets.com/652a6fb50064425d492ff3c7f06fee166591153f9fa80dad771bc72b64d973e0/PowerShell/PowerShell/issues/8261 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/652a6fb50064425d492ff3c7f06fee166591153f9fa80dad771bc72b64d973e0/PowerShell/PowerShell/issues/8261 |
| og:image:alt | Opened out of #8218. We do very little santisation/normalisation on paths passed in as module names in ModuleSpecification types to various cmdlets. Not many users rely directly on this functionali... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | rjmholt |
| hostname | github.com |
| expected-hostname | github.com |
| None | 66653c2e55a6fff2930be1bdf07ee4f8aa137e3956d056c822563be6f878755e |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PowerShell git https://github.com/PowerShell/PowerShell.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 49609581 |
| octolytics-dimension-repository_nwo | PowerShell/PowerShell |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 49609581 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PowerShell |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | b6f01f7cb9f35f8c09949773241a3d49dd04b340 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width