Write an error if argument is a directory in Get-FileHash cmdlet by iSazonov · Pull Request #11114 · PowerShell/PowerShell · GitHub

PR Summary

If Get-FileHash gets a folder as argument we should write non-terminate error.

PR Context

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed:
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

Steve Lee (@SteveL-MSFT) If the new test uses $error[0]:

        It "Should write non-terminating error if argument is a folder" {
            $result = $pshome, "${pshome}\pwsh.dll" | Get-FileHash
            $result.Count | Should -Be 1
            $error[0].FullyQualifiedErrorId | Should -BeExactly "UnauthorizedAccessError,Microsoft.PowerShell.Commands.GetFileHashCommand"
        }

it unexpectedly fail with an ConciseView error

MethodInvocationException:
Line |
 127 |                                                     $remainingMessage = $remainingMessage.Substring($substring.Length - $prefix.Length).Trim()

     |                                                     ^ Exception calling "Substring" with "1" argument(s): "StartIndex cannot be less than zero. (Parameter 'startIndex')"

I cannot find simple repo steps.

…Hash.cs Co-Authored-By: Joel Sallow (/u/ta11ow) <32407840+vexx32@users.noreply.github.com>

Do you think it's worth doing a general catch or additional catches here as well? Looking at the exceptions that can be thrown from System.IO.File.OpenRead it seems likely we can run into the following exceptions somewhat commonly as well:

PathTooLongException
IOException

IOException combines FileNotFoundException, DirectoryNotFoundException, and PathTooLongException.

I guess PathTooLongException will be raised above at path resolving time.

So nothing to do. :-)

)

🎉v7.0.0-rc.2 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

It would be appreciated if this error could be changed from "Access Denied" to something more specific, i.e.: "SKIPPED: Invalid path: folder" or something.

I'm trying to recurse through my photo archive to try to find duplicates. For each file, I send FullName to get-filehash. I get a LOT of these errors, which implies a permissions issues, but after finding this pull request, I see that it is working as expected.
Error:
Get-FileHash: Access to the path 'E:\PHOTO\Lightroom CC Library\Lightroom CC\684f1da3ca494b3e854964d66fd6f341\originals\2011\2011-12-22' is denied.

Invocation:
Get-ChildItem -Recurse -path E:\PHOTO\ | Select-Object -ExpandProperty FullName | Get-FileHash | Export-Csv -Append h:\photo_hash_list3.csv

You can add the -File param to your Get-ChildItem call to avoid the issue entirely.

But yeah, that's a fair call. Would be a good idea to open a new issue for that. 🙂

…erShell#11114)

Ilya (iSazonov) added 2 commits November 19, 2019 11:51

Write an error if argument is a directory in Get-FileHash cmdlet

a9a6ec3

Add test

87f579a

Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Nov 19, 2019

Ilya (iSazonov) requested review from Steve Lee (SteveL-MSFT), Aditya Patwardhan (adityapatwardhan) and Dongbo Wang (daxian-dbw) November 19, 2019 07:41

Fix style issues

9680700

Ilya (iSazonov) self-assigned this Nov 19, 2019

Rain Sallow (/u/ta11ow) (vexx32) reviewed Nov 19, 2019

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetHash.cs Outdated

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetHash.cs Outdated

Ilya (iSazonov) and others added 2 commits November 19, 2019 18:21

Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Get…

08c29c6

…Hash.cs Co-Authored-By: Joel Sallow (/u/ta11ow) <32407840+vexx32@users.noreply.github.com>

Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Get…

56b5d57

…Hash.cs Co-Authored-By: Joel Sallow (/u/ta11ow) <32407840+vexx32@users.noreply.github.com>

Rain Sallow (/u/ta11ow) (vexx32) reviewed Nov 19, 2019

View reviewed changes

Steve Lee (SteveL-MSFT) approved these changes Nov 19, 2019

View reviewed changes

Ilya (iSazonov) merged commit 8d944fd into PowerShell:master Nov 21, 2019

Ilya (iSazonov) deleted the get-filehash-dir-error branch November 21, 2019 10:15

Ilya (iSazonov) added this to the GA-consider milestone Dec 20, 2019

Aditya Patwardhan (adityapatwardhan) modified the milestones: GA-consider, GA-approved Jan 7, 2020

Dongbo Wang (daxian-dbw) pushed a commit that referenced this pull request Jan 10, 2020

Write an error if argument is a directory in Get-FileHash cmdlet (#11114

1d48608

)

Dongbo Wang (daxian-dbw) modified the milestones: GA-approved, 7.0.0-rc.2 Jan 11, 2020

ghost mentioned this pull request Jan 16, 2020

Get-FileHash access denied #11110

Closed

Travis Plunk (TravisEz13) mentioned this pull request Oct 12, 2022

Back-port to 7.0: Update list of PowerShell team members in release tools #18266

Merged

22 tasks

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026

Write an error if argument is a directory in Get-FileHash cmdlet (Pow…

f1a8466

…erShell#11114)

                               catch (FileNotFoundException ex)
                               {
-                                  ErrorRecord errorRecord = new ErrorRecord(ex,
+                                  var errorRecord = new ErrorRecord(
+                                      ex,
                                       "FileNotFound",
                                       ErrorCategory.ObjectNotFound,
                                       path);
                                   WriteError(errorRecord);
                               }
+                              catch (UnauthorizedAccessException ex)
+                              {
+                                  var errorRecord = new ErrorRecord(
+                                      ex,
+                                      "UnauthorizedAccessError",
+                                      ErrorCategory.InvalidData,
+                                      path);
+                                  WriteError(errorRecord);
+                              }

Write an error if argument is a directory in Get-FileHash cmdlet by iSazonov · Pull Request #11114 · PowerShell/PowerShell · GitHub

Uh oh!

Write an error if argument is a directory in Get-FileHash cmdlet - #11114

Write an error if argument is a directory in Get-FileHash cmdlet#11114
Ilya (iSazonov) merged 5 commits into
PowerShell:masterfrom
iSazonov:get-filehash-dir-error

Ilya (iSazonov) commented Nov 19, 2019 •
edited
Loading

Uh oh!

Uh oh!

Ilya (iSazonov) commented Nov 19, 2019

Uh oh!

Uh oh!

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) Nov 19, 2019

Uh oh!

Ilya (iSazonov) Nov 19, 2019

Uh oh!

Deleted user (ghost) commented Jan 16, 2020

Uh oh!

Jordan M. Nash (JordanNash) commented Jun 8, 2021 •
edited
Loading

Uh oh!

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) commented Jun 8, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Write an error if argument is a directory in Get-FileHash cmdlet by iSazonov · Pull Request #11114 · PowerShell/PowerShell · GitHub

Uh oh!

Write an error if argument is a directory in Get-FileHash cmdlet - #11114

Write an error if argument is a directory in Get-FileHash cmdlet#11114Ilya (iSazonov) merged 5 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom iSazonov:get-filehash-dir-erroriSazonov/PowerShell:get-filehash-dir-errorCopy head branch name to clipboard

Conversation

Ilya (iSazonov) commented Nov 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

Ilya (iSazonov) commented Nov 19, 2019

Uh oh!

Uh oh!

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) Nov 19, 2019

Choose a reason for hiding this comment

Uh oh!

Ilya (iSazonov) Nov 19, 2019

Choose a reason for hiding this comment

Uh oh!

Deleted user (ghost) commented Jan 16, 2020

Uh oh!

Jordan M. Nash (JordanNash) commented Jun 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) commented Jun 8, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Write an error if argument is a directory in Get-FileHash cmdlet#11114
Ilya (iSazonov) merged 5 commits into
PowerShell:masterfrom
iSazonov:get-filehash-dir-error

Ilya (iSazonov) commented Nov 19, 2019 •
edited
Loading

Jordan M. Nash (JordanNash) commented Jun 8, 2021 •
edited
Loading