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

Additional test hardening for tests which fail in release pass. #20093

Merged
merged 13 commits into from Aug 16, 2023

Conversation

JamesWTruher
Copy link
Member

PR Summary

PR Context

In our release pass testing a number of tests fail. This PR attempts to allow those tests to be skipped on the various platforms where they do not pass.

  • Start-UnixSocket is failing on some windows platforms as it is not supported on those platforms
  • there are platforms where remoting cannot be enabled (if enable-psremoting fails, those tests will be skipped)
  • being unable to remove a certificate is not a fatal error

PR Checklist

@JamesWTruher
Copy link
Member Author

before merging i want to run a release test to be sure that this addresses those issues

Add Test-IsWindows2016 to psd1 so it can be found.
Change some tests to use new default parameter value helper.
Skip test-connection on any suse release.
Ensure the write-verbose in the remote session test will have a non-null message.
fix typo in variable name.
This functionality was removed in PR 16044.
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Large
Size       : +274 -165
Percentile : 81.3%

Total files changed: 19

Change summary by file extension:
.ps1 : +216 -153
.psd1 : +7 -0
.psm1 : +48 -1
.yml : +3 -11

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.

@adityapatwardhan adityapatwardhan merged commit 046301b into PowerShell:master Aug 16, 2023
43 checks passed
@adityapatwardhan adityapatwardhan added the CL-Test Indicates that a PR should be marked as a test change in the Change Log label Aug 16, 2023
@JamesWTruher JamesWTruher deleted the ReleaseTestFix04 branch September 23, 2023 05:32
VindSkyggen pushed a commit to VindSkyggen/PowerShell that referenced this pull request Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-Test Indicates that a PR should be marked as a test change in the Change Log Extra Large
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants