WIP - Implement Get-Hash cmdlet #3395

iSazonov · 2017-03-22T13:36:17Z

It is first experimental implementation Get-Hash cmdlet for https://github.com/PowerShell/PowerShell-RFC/blob/master/2-Draft-Accepted/RFC0018-Get-StringHash.md

According to the RFC the type of Encoding parameter is FileSystemCmdletProviderEncoding but I had to use EncodingConversion class because the API contains useful methods and can be easily enhanced in future (to support full set of codepages). Now multiple Utility cmdlets uses it. In contrast, a code using FileSystemCmdletProviderEncoding type is distributed in FileProvider and it's hard to reuse it although it is designated as the preferred (?) in https://github.com/PowerShell/PowerShell-RFC/blob/master/1-Draft/RFC0020-DefaultFileEncoding.md We also talked about that we should rationalize the use of encoding so EncodingConversion class looks like the best option.
Added ValueFromPipelineByPropertyName to Path parameter that is skipped in the RFC 0018.
After the implementation we can really see that Path and InputString parameters have the same type and cannot be both ValueFromPipeline. Perhaps here we understand that it is better for UX to have both options and we should split on Get-FileHash and Get-StringHash still. Until concluding on this I haven't added pipeline tests. We follow Select-String pattern as suggested by @rkeithhill.
~~I wanted to implement ValidateEncoding attribute but was blocked so how to implement Tab Completion. I need help.~~ We should follow Unify file encoding when a cmdlet creates a file #4119.

rkeithhill · 2017-03-22T15:48:12Z

RE # 3, try changing the InputString type to PSObject[] and then convert each PSObject ToString before hashing. That should get you around the pipeline binding issue. This pattern in common for cmdlets that take both an InputObject and Path parameters like Select-String.

iSazonov · 2017-03-23T03:49:06Z

@rkeithhill Thanks for workaround! The code looks not pretty. But I am ready to try this if community votes for this.

Can we introduce new Path type to resolve such problems? (This can be a lot of work)

public class PSPath : PSObject
{
    string Path;
    public string ToString()
    {
        return Path;
    }
}

rkeithhill · 2017-03-23T04:27:12Z

If you look at the SelectStringCommand impl -

PowerShell/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs

Line 1009 in 02b5f35

[FileinfoToString]

it appears you use the FilenfoToString argument transform attribute on the Path/LiteralPath parameters.

iSazonov · 2017-03-23T13:20:04Z

How do the attribute help to resolve conflict of parameter bindings?

rkeithhill · 2017-03-23T15:37:57Z

Given that this attribute is private I've not had the chance to use it. However, it makes Select-String work so I'm assuming here it should make Get-Hash work as well. If you look at the parameter config for Select-String it is very similar to Get-Hash:

    Command: Microsoft.PowerShell.Utility/Select-String
    Set:    File *


Name                   Aliases      Position Mandatory Pipeline ByName Provider        Type
----                   -------      -------- --------- -------- ------ --------        ----
AllMatches             {A*}         Named    False     False    False  All             SwitchParameter
CaseSensitive          {Ca*}        Named    False     False    False  All             SwitchParameter
Context                {Co*}        Named    False     False    False  All             Int32[]
Encoding               {En*}        Named    False     False    False  All             String
Exclude                {Ex*}        Named    False     False    False  All             String[]
Include                {Inc*}       Named    False     False    False  All             String[]
List                   {Lis*}       Named    False     False    False  All             SwitchParameter
NotMatch               {N*}         Named    False     False    False  All             SwitchParameter
Path                   {}           1        True      False    True   All             String[]
Pattern                {Patt*}      0        True      False    False  All             String[]
Quiet                  {Q*}         Named    False     False    False  All             SwitchParameter
SimpleMatch            {S*}         Named    False     False    False  All             SwitchParameter


    Command: Microsoft.PowerShell.Utility/Select-String
    Set:    Object


Name                   Aliases      Position Mandatory Pipeline ByName Provider        Type
----                   -------      -------- --------- -------- ------ --------        ----
AllMatches             {A*}         Named    False     False    False  All             SwitchParameter
CaseSensitive          {Ca*}        Named    False     False    False  All             SwitchParameter
Context                {Co*}        Named    False     False    False  All             Int32[]
Encoding               {En*}        Named    False     False    False  All             String
Exclude                {Ex*}        Named    False     False    False  All             String[]
Include                {Inc*}       Named    False     False    False  All             String[]
InputObject            {Inp*}       Named    True      True     False  All             PSObject
List                   {Lis*}       Named    False     False    False  All             SwitchParameter
NotMatch               {N*}         Named    False     False    False  All             SwitchParameter
Pattern                {Patt*}      0        True      False    False  All             String[]
Quiet                  {Q*}         Named    False     False    False  All             SwitchParameter
SimpleMatch            {S*}         Named    False     False    False  All             SwitchParameter


    Command: Microsoft.PowerShell.Utility/Select-String
    Set:    LiteralFile


Name                   Aliases      Position Mandatory Pipeline ByName Provider        Type
----                   -------      -------- --------- -------- ------ --------        ----
AllMatches             {A*}         Named    False     False    False  All             SwitchParameter
CaseSensitive          {Ca*}        Named    False     False    False  All             SwitchParameter
Context                {Co*}        Named    False     False    False  All             Int32[]
Encoding               {En*}        Named    False     False    False  All             String
Exclude                {Ex*}        Named    False     False    False  All             String[]
Include                {Inc*}       Named    False     False    False  All             String[]
List                   {Lis*}       Named    False     False    False  All             SwitchParameter
LiteralPath            {PSPath, ... Named    True      False    True   All             String[]
NotMatch               {N*}         Named    False     False    False  All             SwitchParameter
Pattern                {Patt*}      0        True      False    False  All             String[]
Quiet                  {Q*}         Named    False     False    False  All             SwitchParameter
SimpleMatch            {S*}         Named    False     False    False  All             SwitchParameter

Path and LiteralPath are pipeline bound by property name and are of type string[]. InputObject is bound by value and is of type PSObject. Somehow Select-String takes both string input to search through (bound to InputObject) and FileInfo objects from Get-ChildItem/Item.

daxian-dbw · 2017-06-23T15:58:40Z

@TravisEz13 I have my hands full and thus re-assigned this PR to you. Could you please help drive it?

iSazonov · 2017-06-23T17:47:36Z

I'll continue on next week.

daxian-dbw · 2017-06-23T18:03:03Z

@iSazonov No rush at all 😄 I was the assignee previously but I have too much on my plate right now and thus I reassigned this PR to Travis. That comment is just to let Travis know.

TravisEz13 · 2017-07-21T17:30:42Z

@iSazonov We should close inactive PRs and reopen the PR when it's active. Any issues?

iSazonov · 2017-07-21T18:07:53Z

I'm going to give my time and finish my work.

iSazonov · 2017-07-24T13:55:36Z

Ready for a code review.
I corrected the PR desciption and cleaned up test.
We have a conflict with #4119 for Encoding parameter.

TravisEz13 · 2017-07-24T19:30:39Z

Please use the present tense, imperative style for commit messages and title per Contribution Guide

TravisEz13 · 2017-07-24T19:39:59Z

test/powershell/Modules/Microsoft.PowerShell.Utility/Get-Hash.Tests.ps1

Add a test for piping a file. The equivalent of dir * -File | Get-FileHash

To ensure compatibility

Added the test .

TravisEz13 · 2017-07-24T19:43:53Z

@BerheAbrha Can you review to ensure this won't cause issues for PowerShell DSC?

TravisEz13 · 2017-07-25T16:21:18Z

You have a test error in travis-ci

issues resolved

code has changed

TravisEz13 · 2017-12-15T23:53:52Z

@iSazonov merge conflicts need to be resolved

1. Replace GetFileHashCommand with GetHashCommand 2. Exclude an exception 3. Fix tests.

TravisEz13 · 2018-01-03T18:52:28Z

Tests are failing

iSazonov · 2018-01-04T18:02:31Z

This is too old code. I will update it.

stale · 2018-03-16T23:47:25Z

This PR has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed if no further activity occurs within 10 days. Thank you for your contributions.

stale · 2018-03-27T00:39:24Z

This PR has be automatically close because it is stale. If you wish to continue working on the PR, please first update the PR, then reopen it.
Thanks again for your contribution.
Community members are welcome to grab these works.

boernsen-development · 2025-12-16T12:44:33Z

Please reopen this :)

msftclas added the cla-already-signed label Mar 22, 2017

daxian-dbw self-assigned this Mar 22, 2017

iSazonov added the Review - Needed The PR is being reviewed label Mar 23, 2017

iSazonov mentioned this pull request May 25, 2017

No equivalent of Get-FileHash for text blobs, requires writing input to file to test output #3861

Closed

daxian-dbw assigned TravisEz13 and unassigned daxian-dbw Jun 23, 2017

iSazonov force-pushed the gethashrfc branch 4 times, most recently from 73a5efc to 8db565d Compare July 24, 2017 13:40

TravisEz13 added Breaking-Change breaking change that may affect users and removed Breaking-Change breaking change that may affect users labels Jul 24, 2017

TravisEz13 previously requested changes Jul 24, 2017

View reviewed changes

iSazonov changed the title ~~First experimental implementation Get-Hash cmdlet~~ Implement Get-Hash cmdlet Jul 25, 2017

iSazonov force-pushed the gethashrfc branch from 38c0e98 to b05e18f Compare July 25, 2017 10:05

iSazonov requested review from JamesWTruher, PaulHigin and vors as code owners August 17, 2017 07:56

iSazonov force-pushed the gethashrfc branch from cb1e91c to 3feeafa Compare August 17, 2017 14:16

msftgits removed the cla-already-signed label Sep 26, 2017

iSazonov force-pushed the gethashrfc branch from 3feeafa to bf47787 Compare December 19, 2017 18:00

iSazonov and others added 5 commits December 20, 2017 00:12

Implement Get-Hash cmdlet

fe11148

Cleanup tests

f09a80b

Add test for piping a path

94a4c98

Address code review

e9a5583

1. Replace GetFileHashCommand with GetHashCommand 2. Exclude an exception 3. Fix tests.

Tabs to spaces

59c9996

iSazonov force-pushed the gethashrfc branch from bf47787 to 59c9996 Compare December 19, 2017 19:17

TravisEz13 changed the title ~~Implement Get-Hash cmdlet~~ WIP - Implement Get-Hash cmdlet Jan 11, 2018

stale bot added the Stale label Mar 16, 2018

iSazonov mentioned this pull request Mar 21, 2018

Change Get-FileHash tests to use raw bytes #6430

Merged

11 tasks

stale bot closed this Mar 27, 2018

joeyaiello mentioned this pull request Oct 15, 2018

Docs needed for 'WIP - Implement Get-Hash cmdlet' MicrosoftDocs/PowerShell-Docs#3106

Closed

joeyaiello removed Documentation Needed in this repo Documentation is needed in this repo labels Oct 15, 2018

iSazonov deleted the gethashrfc branch May 15, 2020 13:26

iSazonov restored the gethashrfc branch May 15, 2020 13:27

iSazonov mentioned this pull request May 15, 2020

Get-StringHash (something like Get-FileHash but not file based) #12531

Closed

microsoft-github-policy-service bot removed the Stale label Dec 16, 2025

WIP - Implement Get-Hash cmdlet #3395

WIP - Implement Get-Hash cmdlet #3395

Uh oh!

Conversation

iSazonov commented Mar 22, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rkeithhill commented Mar 22, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Mar 23, 2017

Uh oh!

rkeithhill commented Mar 23, 2017

Uh oh!

iSazonov commented Mar 23, 2017

Uh oh!

rkeithhill commented Mar 23, 2017

Uh oh!

daxian-dbw commented Jun 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Jun 23, 2017

Uh oh!

daxian-dbw commented Jun 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TravisEz13 commented Jul 21, 2017

Uh oh!

iSazonov commented Jul 21, 2017

Uh oh!

iSazonov commented Jul 24, 2017

Uh oh!

TravisEz13 commented Jul 24, 2017

Uh oh!

TravisEz13 Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

TravisEz13 Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

iSazonov Jul 25, 2017

Choose a reason for hiding this comment

Uh oh!

TravisEz13 Jul 25, 2017

Choose a reason for hiding this comment

Uh oh!

TravisEz13 commented Jul 24, 2017

Uh oh!

TravisEz13 commented Jul 25, 2017

Uh oh!

TravisEz13 commented Dec 15, 2017

Uh oh!

TravisEz13 commented Jan 3, 2018

Uh oh!

iSazonov commented Jan 4, 2018

Uh oh!

stale bot commented Mar 16, 2018

Uh oh!

stale bot commented Mar 27, 2018

Uh oh!

boernsen-development commented Dec 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

iSazonov commented Mar 22, 2017 •

edited

Loading

rkeithhill commented Mar 22, 2017 •

edited

Loading

daxian-dbw commented Jun 23, 2017 •

edited

Loading

daxian-dbw commented Jun 23, 2017 •

edited

Loading