Pass -UserScope as required by RunUpdateHelpTests #13400

yecril71pl · 2020-08-11T09:57:12Z

PR Summary

The function RunUpdateHelpTests does not expect to get ~~Scope~~ but UserScope. I modified the calls accordingly.

PR Context

I am lost why passing a Scope to a function that accepts UserScope would have any good results. I think the current behaviour is that the tests are skipped because $userscope -eq $false, as evidenced by the following test log entry:

Validate Update-Help -SourcePath for all PowerShell modules for user scope..Validate Update-Help for module 'Microsoft.PowerShell.Core' with scope as 'False'

… and erroneously marked as passed.

PR Checklist

I am lost why passing a **Scope** to a function that accepts **UserScope** would have any good results. I think the current behaviour is that the tests are skipped because `-not $userscope`, as evidenced by the following test log entry: > Validate Update-Help -SourcePath for all PowerShell modules for user scope..Validate Update-Help for module 'Microsoft.PowerShell.Core' with scope as 'False'

iSazonov

We lost this tracking in #6352 (comment)

iSazonov · 2020-08-11T11:24:14Z

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1

        {

-            It "Validate Update-Help for module '$moduleName' with scope as '$userscope'" -Skip:(!(Test-CanWriteToPsHome) -and $userscope -eq $false) {
+            It "Validate Update-Help for module '$moduleName' with user scope as '$userscope'" -Skip:(!(Test-CanWriteToPsHome) -and $userscope -eq $false) {


It is not correct. Please try something like:

Suggested change

It "Validate Update-Help for module '$moduleName' with user scope as '$userscope'" -Skip:(!(Test-CanWriteToPsHome) -and $userscope -eq $false) {

It "Validate Update-Help for module '$moduleName' with $(if ($userscope) 'User' else 'AllScope') scope" -Skip:(!(Test-CanWriteToPsHome) -and $userscope -eq $false) {

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1

iSazonov · 2020-08-11T15:11:40Z

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1

-                    $params = @{Path = $testCases[$moduleName].HelpInstallationPath}
-                    $updateScope = @{Scope = 'AllUsers'}
-                }
+            It "Validate Update-Help for module '$moduleName' in '$updateScope'" -Skip:(!(Test-CanWriteToPsHome) -and $userscope -eq $false) {


'$updateScope' returns "System.Collections.Hashtable". Yes?

I am deeply ashamed of myself. I assumed it would be nicely expanded in a string. I am working on it.

We could simply add new variable for the test name.

I would rather be as deep to the metal as possible in a test log.

adityapatwardhan · 2020-08-11T17:15:16Z

@yecril71pl Thank you for your PR. Please have a look at the failures.

iSazonov

@yecril71pl 99% of the PR is unrelated changes. Please fix only UserScope issue and move rest of changes in follow PR.

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1

ghost · 2020-08-20T02:00:21Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

andyleejordan

I resolved the other requested changes as I don't think they're necessary and looked helpful for getting the tests to run again. However, spotted one real bug at the end that needs fixing (the test is no longer validating the correct function).

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1

pull-request-quantifier-deprecated · 2023-05-22T19:51:23Z

This PR has 142 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Medium
Size       : +66 -76
Percentile : 48.4%

Total files changed: 1

Change summary by file extension:
.ps1 : +66 -76

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

yecril71pl · 2023-05-22T22:04:47Z

Wow, long time no see 😄 Is there anything you want me to do about this? I sincerely hope it will move forward without me 😉

Feedback was addressed.

andyleejordan

It's all good @yecril71pl! CI passed with my bug-fix, approving. Thanks for your contribution!

ghost · 2023-06-29T22:03:43Z

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

ghost assigned anmenaga Aug 11, 2020

Improve the test message

b41e35e

iSazonov reviewed Aug 11, 2020

View reviewed changes

iSazonov added the CL-Test Indicates that a PR should be marked as a test change in the Change Log label Aug 11, 2020

iSazonov requested a review from adityapatwardhan August 11, 2020 11:27

yecril71pl added 2 commits August 11, 2020 13:37

Improve test message

61db29a

fix a mistake

ba00588

iSazonov reviewed Aug 11, 2020

View reviewed changes

yecril71pl added 2 commits August 11, 2020 17:38

Embed $updateScope as a custom object

3b28f99

standardise locale name

7d358d1

adityapatwardhan added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Aug 11, 2020

Fix paths

2ca7d8f

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Aug 11, 2020

yecril71pl added 15 commits August 11, 2020 19:46

explicit -AdditionalChildPath for %#$@ checker

58069e5

this checker guy is really a pest

90bc25d

Fix a typo

6ee093c

Fix a typo

0c34449

Fix an omission

edb0454

Fix a mistake

d827a1e

make the count test report something useful

0c8f463

Codacy be cool

ff7c3fe

expression in parentheses

4f587a2

Fix wrong type

ba7e21d

operator -join

99e96cb

change the clean action

1216e5f

Properly index into a hash table

7b64410

Add assertions

a9beade

Add assertions

67ba4d0

yecril71pl added 5 commits August 12, 2020 01:51

disable $params +=

f397c38

Remove-Item $path -Recurse

8c4a23b

revert to testing file count and improve name test

a5743a7

cast to [string[]]

58df1d9

clean up

6858a56

yecril71pl requested a review from iSazonov August 12, 2020 08:16

iSazonov previously requested changes Aug 12, 2020

View reviewed changes

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1 Show resolved Hide resolved

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1 Show resolved Hide resolved

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1 Show resolved Hide resolved

ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Aug 12, 2020

ghost added the Review - Needed The PR is being reviewed label Aug 20, 2020

daxian-dbw added the CommunityDay-Small A small PR that the PS team has identified to prioritize to review label May 15, 2023

daxian-dbw closed this May 22, 2023

daxian-dbw reopened this May 22, 2023

ghost removed the Review - Needed The PR is being reviewed label May 22, 2023

pull-request-quantifier-deprecated bot added the Medium label May 22, 2023

andyleejordan requested changes May 22, 2023

View reviewed changes

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1 Show resolved Hide resolved

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1 Show resolved Hide resolved

test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1 Outdated Show resolved Hide resolved

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 22, 2023

Update test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1

e774745

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 22, 2023

andyleejordan approved these changes May 22, 2023

View reviewed changes

daxian-dbw merged commit b69cae0 into PowerShell:master May 22, 2023

yecril71pl deleted the patch-6 branch May 23, 2023 09:55

	It "Validate Update-Help for module '$moduleName' with user scope as '$userscope'" -Skip:(!(Test-CanWriteToPsHome) -and $userscope -eq $false) {
	It "Validate Update-Help for module '$moduleName' with $(if ($userscope) 'User' else 'AllScope') scope" -Skip:(!(Test-CanWriteToPsHome) -and $userscope -eq $false) {

Pass -UserScope as required by RunUpdateHelpTests #13400

Pass -UserScope as required by RunUpdateHelpTests #13400

Uh oh!

Conversation

yecril71pl commented Aug 11, 2020

PR Summary

PR Context

PR Checklist

Uh oh!

iSazonov left a comment

Choose a reason for hiding this comment

Uh oh!

iSazonov Aug 11, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iSazonov Aug 11, 2020

Choose a reason for hiding this comment

Uh oh!

yecril71pl Aug 11, 2020

Choose a reason for hiding this comment

Uh oh!

iSazonov Aug 11, 2020

Choose a reason for hiding this comment

Uh oh!

yecril71pl Aug 11, 2020

Choose a reason for hiding this comment

Uh oh!

adityapatwardhan commented Aug 11, 2020

Uh oh!

iSazonov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ghost commented Aug 20, 2020

Uh oh!

andyleejordan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pull-request-quantifier-deprecated bot commented May 22, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

yecril71pl commented May 22, 2023

Uh oh!

andyleejordan left a comment

Choose a reason for hiding this comment

Uh oh!

ghost commented Jun 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants