Modifies error messages of AvoidUsernameAndPasswordParams and UsePSCredentialType rules.

[kapilmb]

This change is

[KirkMunro]

Hi again, I have one suggestion regarding the text changes for this pull request. In PowerShell 3.0 and 4.0, the order is important. In PowerShell 5.0, the order is not important. However, in all versions, it is important that both a PSCredential type attribute and a Credential conversion attribute are used, and in the right way. With the text changed as is, I felt that last point might not be clear to an end user because it indicates it doesn't apply in PowerShell 5.0 or later. I haven't looked too deeply, so maybe this is ok, but I wanted to mention it to make sure that the text conveys (a) that the Credential conversion attribute should be used with parameters of type PSCredential, and (b) that the Credential conversion attribute must be placed after the PSCredential type attribute in PowerShell versions 4.0 and earlier.

[kapilmb]

In PowerShell 5.0, I found that the following 3 cases behave identically when a string is passed as an argument to the Credential parameter.

[PSCredential] 
$Credential

[System.Management.Automation.CredentialAttribute()] 
[PSCredential] 
$Credential

[PSCredential] 
[System.Management.Automation.CredentialAttribute()] 
$Credential

It appears that in PS 5.0 the interpreter converts a string to PSCredential type even when CredentialAttribute is not specified.

[KirkMunro]

That must be some magic done in the PowerShell interpreter then, because I'm using PowerShell 5.0.10586.122 and when I invoke Connect-MsolService -Credential foo (a compiled cmdlet), I receive the following error:

Connect-MsolService : Cannot bind parameter 'Credential'. Cannot convert the "foo" value of type "System.String" to type "System.Management.Automation.PSCredential".
At line:1 char:33
+ connect-msolservice -Credential foo
+                                 ~~~
    + CategoryInfo          : InvalidArgument: (:) [Connect-MsolService], ParameterBindingException
    + FullyQualifiedErrorId : CannotConvertArgumentNoMessage,Microsoft.Online.Administration.Automation.ConnectMsolService

Very cool to see this being addressed in native PowerShell. It would be great if this rule (or a similar one) would warn on binary module commands in the future as well.

[kapilmb]

@KirkMunro Thank you very much for the feedback on this issue.

Since PSScriptAnalyzer doesn't support binary module analysis , do we agree on the information provided in the error message?

[KirkMunro]

Checks if a parameter named Credential is of type PSCredential. For PowerShell 4 and earlier, also checks if there is a Credential transformation attribute defined after the PSCredential type attribute.

[KirkMunro]

I just added line comments for each of the messages showing what I think they should look like. The general statement "This is applicable only to PowerShell version less than 5.0" was too general IMHO. Only the Credential transformation attribute details aren't necessary in PowerShell 5.0+. The other details (about SecureString and about the PSCredential type attribute) apply to all versions. With that in mind, I provided updated messages that I think make that easier to understand. That's just my opinion though.

[kapilmb]

@KirkMunro Thanks for the detailed comments. The modifications that you suggest definitely make the error messages much clearer and easier to understand. I'll make the necessary changes and finalize the pull request. Thanks again.

[kapilmb]

Review status: 0 of 5 files reviewed at latest revision, 8 unresolved discussions.

---

Rules/Strings.resx, line 220 [r1] (raw file):
Done.

---

Rules/Strings.resx, line 226 [r1] (raw file):
Done.

---

Rules/Strings.resx, line 514 [r1] (raw file):
Done.

---

Rules/Strings.resx, line 517 [r1] (raw file):
Done.

---

Rules/UsePSCredentialType.cs, line 27 [r1] (raw file):
Done.

---

Rules/UsePSCredentialType.cs, line 33 [r1] (raw file):
Done.

---

Tests/Rules/AvoidUserNameAndPasswordParams.tests.ps1, line 3 [r1] (raw file):
Done.

---

Tests/Rules/PSCredentialType.tests.ps1, line 2 [r1] (raw file):
Done.

---

Comments from the review on Reviewable.io

[raghushantha]

:

---

Review status: 0 of 5 files reviewed at latest revision, 9 unresolved discussions.

---

Comments from the review on Reviewable.io

[raghushantha]

---

Comments from the review on Reviewable.io

[raghushantha]

Reviewed 5 of 5 files at r2.
Review status: all files reviewed at latest revision, 8 unresolved discussions.

---

Comments from the review on Reviewable.io

[KirkMunro]

---

Review status: 2 of 7 files reviewed at latest revision, 8 unresolved discussions.

---

Comments from the review on Reviewable.io

[KirkMunro]

Reviewed 2 of 5 files at r3.
Review status: 4 of 7 files reviewed at latest revision, 8 unresolved discussions.

---

Comments from the review on Reviewable.io

[kapilmb]

@KirkMunro and @raghushantha Thanks for reviewing!