Enable more tests to be run in a container. by JamesWTruher · Pull Request #17294 · PowerShell/PowerShell

JamesWTruher · 2022-05-09T20:22:19Z

Improve debugging output for online help test.

PR Summary

There are a number of tests which are disabled when run in a container. This PR re-enables all of them.
Notably, it removes the test which causes a browser to be launched in the shell as this is not available in a container (or server core). The functionality is still validated by verifying the URL that is opened, but does not launch the browser via a test hook.

This PR also improves a test for help failures by reporting the name of the topic that has been surprisingly found to aid in debugging.

PR Context

PR Checklist

PaulHigin · 2022-05-09T20:43:31Z

test/powershell/Modules/Microsoft.PowerShell.Management/Test-Connection.Tests.ps1

The test comment should be updated since we no longer skip the test.

PaulHigin · 2022-05-09T20:45:22Z

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

Suggested change

{ & $command $helpTopic -ErrorAction Stop } | Should -Throw -ErrorId "HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand" -Because "A help topic was found for $helpTopic"

{ & $command $helpTopic -ErrorAction Stop } | Should -Throw -ErrorId "HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand" -Because "A help topic was not found for $helpTopic"

@PaulHigin - actually in this case, it's an error if we find a help topic

Yes, but the test expectation is a thrown error because the topic is not found, and I feel the 'Because' text should make that clear.

TravisEz13 · 2022-05-10T17:54:19Z

/rebase

Improve debugging output for online help test.

…e of different types (on windows).

…nt between native and managed.

…ger.

pull-request-quantifier-deprecated · 2022-05-10T19:47:15Z

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

Quantification details

Label      : Small
Size       : +32 -38
Percentile : 28%

Total files changed: 7

Change summary by file extension:
.cs : +13 -6
.ps1 : +19 -32

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 detetcted.
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.

TravisEz13 · 2022-05-11T22:28:06Z

🎉

ghost · 2022-05-23T16:18:47Z

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

Handy links:

Release Notes

adityapatwardhan · 2022-05-24T20:37:42Z

/backport to release/v7.0.12

adityapatwardhan · 2022-05-24T20:37:54Z

/backport to release/v7.2.5

github-actions · 2022-05-24T20:37:55Z

Started backporting to release/v7.0.12: https://github.com/PowerShell/PowerShell/actions/runs/2380466643

GitHub
Enable more tests to be run in a container. · PowerShell/PowerShell@736cf3e
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

github-actions · 2022-05-24T20:38:09Z

Started backporting to release/v7.2.5: https://github.com/PowerShell/PowerShell/actions/runs/2380467497

GitHub
Enable more tests to be run in a container. · PowerShell/PowerShell@736cf3e
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

github-actions · 2022-05-24T20:38:11Z

@adityapatwardhan backporting to release/v7.0.12 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Enable more tests to be run in a container.
Using index info to reconstruct a base tree...
M	src/Microsoft.PowerShell.Commands.Utility/commands/utility/SetDateCommand.cs
M	src/System.Management.Automation/engine/Utils.cs
M	test/powershell/Modules/Microsoft.PowerShell.Management/Test-Connection.Tests.ps1
M	test/powershell/Modules/Microsoft.PowerShell.Utility/Set-Date.Tests.ps1
M	test/powershell/engine/Help/HelpSystem.OnlineHelp.Tests.ps1
M	test/powershell/engine/Help/HelpSystem.Tests.ps1
Falling back to patching base and 3-way merge...
Auto-merging test/powershell/engine/Help/HelpSystem.Tests.ps1
CONFLICT (content): Merge conflict in test/powershell/engine/Help/HelpSystem.Tests.ps1
Auto-merging test/powershell/engine/Help/HelpSystem.OnlineHelp.Tests.ps1
CONFLICT (content): Merge conflict in test/powershell/engine/Help/HelpSystem.OnlineHelp.Tests.ps1
Auto-merging test/powershell/Modules/Microsoft.PowerShell.Utility/Set-Date.Tests.ps1
Auto-merging test/powershell/Modules/Microsoft.PowerShell.Management/Test-Connection.Tests.ps1
CONFLICT (content): Merge conflict in test/powershell/Modules/Microsoft.PowerShell.Management/Test-Connection.Tests.ps1
Auto-merging src/System.Management.Automation/engine/Utils.cs
Auto-merging src/Microsoft.PowerShell.Commands.Utility/commands/utility/SetDateCommand.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Enable more tests to be run in a container.
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

github-actions · 2022-05-24T20:38:23Z

@adityapatwardhan backporting to release/v7.2.5 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Enable more tests to be run in a container.
Using index info to reconstruct a base tree...
M	test/powershell/Modules/Microsoft.PowerShell.Management/Test-Connection.Tests.ps1
M	test/powershell/engine/Help/HelpSystem.Tests.ps1
Falling back to patching base and 3-way merge...
Auto-merging test/powershell/engine/Help/HelpSystem.Tests.ps1
CONFLICT (content): Merge conflict in test/powershell/engine/Help/HelpSystem.Tests.ps1
Auto-merging test/powershell/Modules/Microsoft.PowerShell.Management/Test-Connection.Tests.ps1
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Enable more tests to be run in a container.
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

TravisEz13 · 2022-06-01T18:12:03Z

backported to 7.2 f1cb6d6

ghost · 2022-06-21T18:35:10Z

🎉v7.2.5 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

adityapatwardhan · 2022-08-10T17:14:50Z

/backport to release/v7.0.12

ghost · 2022-08-11T22:15:47Z

🎉v7.0.12 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

JamesWTruher requested a review from PaulHigin as a code owner May 9, 2022 20:22

pull-request-quantifier-deprecated bot added the Small label May 9, 2022

ghost assigned adityapatwardhan May 9, 2022

JamesWTruher requested review from TravisEz13 and adityapatwardhan May 9, 2022 20:23

PaulHigin suggested changes May 9, 2022

View reviewed changes

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 May 9, 2022

PaulHigin approved these changes May 9, 2022

View reviewed changes

JamesWTruher added 5 commits May 10, 2022 17:55

Enable more tests to be run in a container.

5e52d50

Improve debugging output for online help test.

improve message when test fails.

4e2d109

change test to validate individual properties since the objects may b…

0856b90

…e of different types (on windows).

remove validation of day of week since the number _should_ be differe…

cce8b48

…nt between native and managed.

Remove comments about skipped tests since they're not skipped any lon…

3f2c3a3

…ger.

github-actions bot force-pushed the containertests01 branch from 5f18fba to 3f2c3a3 Compare May 10, 2022 17:55

Add a .5 second wait before getting process list.

972d565

TravisEz13 approved these changes May 10, 2022

View reviewed changes

adityapatwardhan approved these changes May 11, 2022

View reviewed changes

adityapatwardhan added CL-Test Indicates that a PR should be marked as a test change in the Change Log BackPort-7.0.x-Consider labels May 11, 2022

adityapatwardhan merged commit 1a24540 into PowerShell:master May 11, 2022

adityapatwardhan added BackPort-7.0.x-Approved labels May 24, 2022

adityapatwardhan removed BackPort-7.0.x-Consider labels May 24, 2022

TravisEz13 pushed a commit that referenced this pull request Jun 1, 2022

Enable more tests to be run in a container. (#17294)

f1cb6d6

TravisEz13 added Backport-7.2.x-Done and removed Backport-7.2.x-Approved labels Jun 1, 2022

TravisEz13 mentioned this pull request Jun 7, 2022

Backport test fixes for 7.2 #17494

Merged

22 tasks

adityapatwardhan added Backport-7.0.x-Done and removed BackPort-7.0.x-Approved labels Aug 10, 2022

JamesWTruher deleted the containertests01 branch September 23, 2023 05:36

TravisEz13 mentioned this pull request Apr 16, 2024

WIP: add more detail to suspicious scriptblock logging #21475

Closed

TravisEz13 mentioned this pull request Jul 9, 2024

Add script to update SDK for release branches #24034

Merged

	{ & $command $helpTopic -ErrorAction Stop } \| Should -Throw -ErrorId "HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand" -Because "A help topic was found for $helpTopic"
	{ & $command $helpTopic -ErrorAction Stop } \| Should -Throw -ErrorId "HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand" -Because "A help topic was not found for $helpTopic"

Conversation

JamesWTruher commented May 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

PaulHigin May 9, 2022

Choose a reason for hiding this comment

Uh oh!

PaulHigin May 9, 2022

Choose a reason for hiding this comment

Uh oh!

JamesWTruher May 9, 2022

Choose a reason for hiding this comment

Uh oh!

PaulHigin May 9, 2022

Choose a reason for hiding this comment

Uh oh!

TravisEz13 commented May 10, 2022

Uh oh!

pull-request-quantifier-deprecated bot commented May 10, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

TravisEz13 commented May 11, 2022

Uh oh!

ghost commented May 23, 2022

Uh oh!

adityapatwardhan commented May 24, 2022

Uh oh!

adityapatwardhan commented May 24, 2022

Uh oh!

github-actions bot commented May 24, 2022 • edited by unfurl-links bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 24, 2022 • edited by unfurl-links bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 24, 2022

Uh oh!

github-actions bot commented May 24, 2022

Uh oh!

TravisEz13 commented Jun 1, 2022

Uh oh!

ghost commented Jun 21, 2022

Uh oh!

adityapatwardhan commented Aug 10, 2022

Uh oh!

ghost commented Aug 11, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

JamesWTruher commented May 9, 2022 •

edited

Loading

github-actions bot commented May 24, 2022 •

edited by unfurl-links bot

Loading

github-actions bot commented May 24, 2022 •

edited by unfurl-links bot

Loading