Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from May 11, 2022

Conversation

JamesWTruher
Copy link
Member

@JamesWTruher JamesWTruher commented May 9, 2022

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

@@ -257,7 +257,7 @@ Describe "Test-Connection" -tags "CI", "RequireSudoOnUnix" {
# We skip the MtuSize detection tests when in containers, as the environments throw raw exceptions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@@ -578,7 +578,7 @@ Describe "Help failure cases" -Tags Feature {

# under some conditions this does not throw, so include what we actually got
$helpTopic = [guid]::NewGuid().ToString("N")
{ & $command $helpTopic -ErrorAction Stop } | Should -Throw -ErrorId "HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand" -Because "$(& $command $helpTopic -ea Ignore)"
{ & $command $helpTopic -ErrorAction Stop } | Should -Throw -ErrorId "HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand" -Because "A help topic was found for $helpTopic"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@msftbot msftbot bot 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
@TravisEz13
Copy link
Member

/rebase

@pull-request-quantifier-deprecated

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.

@adityapatwardhan adityapatwardhan added CL-Test Indicates that a PR should be marked as a test change in the Change Log BackPort-7.0.x-Consider Backport-7.2.x-Consider labels May 11, 2022
@adityapatwardhan adityapatwardhan merged commit 1a24540 into PowerShell:master May 11, 2022
@TravisEz13
Copy link
Member

🎉

@msftbot
Copy link

msftbot bot commented May 23, 2022

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

Handy links:

@adityapatwardhan
Copy link
Member

/backport to release/v7.0.12

@adityapatwardhan
Copy link
Member

/backport to release/v7.2.5

@github-actions
Copy link
Contributor

github-actions bot commented May 24, 2022

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

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@github-actions
Copy link
Contributor

github-actions bot commented May 24, 2022

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

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@github-actions
Copy link
Contributor

@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
Copy link
Contributor

@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
Copy link
Member

backported to 7.2 f1cb6d6

@msftbot
Copy link

msftbot bot commented Jun 21, 2022

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

Handy links:

@adityapatwardhan
Copy link
Member

/backport to release/v7.0.12

@msftbot
Copy link

msftbot bot commented Aug 11, 2022

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

Handy links:

@JamesWTruher JamesWTruher deleted the containertests01 branch September 23, 2023 05:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport-7.0.x-Done Backport-7.2.x-Done CL-Test Indicates that a PR should be marked as a test change in the Change Log Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants