Test-Connection: Increase output detail when performing a tcp test by jackdcasey · Pull Request #11452 · PowerShell/PowerShell · GitHub

Test-Connection: Increase output detail when performing a tcp test

These changes provide more detail when using Test-Connection cmdlet with the -TCPPort option. This will provide functionality more in line with the ping test, and the classic Test-NetConnection cmdlet.

Currently, the returned value when performing this test is a boolean true / false. This provides some insight into if the connection was successful but not much else.

Here's the current output:

Test-Connection google.com -TCPPort 443

True

Here is an example of the same command, with the changes:

Test-Connection google.com -TCPPort 443

   Destination: google.com

Test Source           Destination      DestinationAddress    Port Latency Result
                                                                     (ms)
---- ------           -----------      ------------------    ---- ------- ------
   1 Jacks-MBP        google.com       172.217.3.174          443      15 Success

The -Count and -Repeat options are also implemented, as seen below:

Test-Connection google.com -TCPPort 443 -Count 4

   Destination: google.com

Test Source           Destination      DestinationAddress    Port Latency Result
                                                                     (ms)
---- ------           -----------      ------------------    ---- ------- ------
   1 Jacks-MBP        google.com       172.217.3.174          443      13 Success
   2 Jacks-MBP        google.com       172.217.3.174          443      10 Success
   3 Jacks-MBP        google.com       172.217.3.174          443      16 Success
   4 Jacks-MBP        google.com       172.217.3.174          443      16 Success

Test-Connection google.com -TCPPort 443 -Repeat 

   Destination: google.com

Test Source           Destination      DestinationAddress    Port Latency Result
                                                                     (ms)
---- ------           -----------      ------------------    ---- ------- ------
   1 Jacks-MBP        google.com       172.217.3.174          443      15 Success
   2 Jacks-MBP        google.com       172.217.3.174          443      15 Success
   3 Jacks-MBP        google.com       172.217.3.174          443      10 Success
   4 Jacks-MBP        google.com       172.217.3.174          443      16 Success
   5 Jacks-MBP        google.com       172.217.3.174          443      16 Success
   6 Jacks-MBP        google.com       172.217.3.174          443      15 Success
   7 Jacks-MBP        google.com       172.217.3.174          443      18 Success
   8 Jacks-MBP        google.com       172.217.3.174          443      16 Success
   9 Jacks-MBP        google.com       172.217.3.174          443      16 Success
  10 Jacks-MBP        google.com       172.217.3.174          443      17 Success
   ...

To provide a boolean output, the -Quiet option is used:

Test-Connection google.com -TCPPort 443 -Quiet

True

Most of the code changes are implementing a new TcpTestStatus class to facilitate the output. A few changes to existing code to implement the existing switches.

PR Context

This opens up a lot more functionality with Test-Connection when working with TCP. Often, while working on connectivity issues, we need more detail than just if the connection is established, or not.

These changes should provide much of the fundamental TCP functionality from the classic Test-NetConnection.

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed:
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

Fix: #11440

…o TestConnection-AddVerboseTcpTest

All CLA requirements met.

Great work here!

A few minor things I think we should address but on the whole this looks like a great improvement 😊

Couple smaller things I noticed on a re-read. 🙂

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

Steve Lee (@SteveL-MSFT) Thank you for the update!

I've made the changes to implement the parameter sets you've described. As mentioned, the default return with -TCPPort will be boolean, and will be an object if using -Detailed, -Repeat, and -Count.

Please let me know if these changes align with what's expected 😁

Commenting to bump, is there anything else required to merge these changes? I'm very excited to move things forward!

This PR has 144 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       : +126 -18
Percentile : 48.8%

Total files changed: 3

Change summary by file extension:
.cs : +98 -17
.ps1 : +28 -1

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.

/azp run PowerShell-CI-windows

Azure Pipelines successfully started running 1 pipeline(s).

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

Travis Plunk (@TravisEz13) The documentation for this cmdlet needs to be updated. Please file a docs issue.
cc: Steve Lee (@SteveL-MSFT)

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

Handy links:

Release Notes

…owerShell#11452) * Added verbose TCP test logic * Cleaned up output, removed source IP address * Consolidated detailed output logic into ProcessConnectionByTCPPort() * Updated existing tests with -Quiet switch * Improved output formatting, changed logic to match * Error handling and logic improvements * Updated tests to match new output * Updated logic, tcp tests now run once by default * Moved TcpConnectionTestResult enum into TcpTestStatus class * Removed unnecessary whitespace * Wrapped TcpClient() in Using statement * Appended missing period on comments * Change TcpTestStatus to TcpPortStatus for better clarity * Set default count back to 4 * Move stopwatch reset into finally block * Change TcpConnectionTestResult.New to TcpConnectionTestResult.None * Formatting fixes * Increase column size for Result output * Update logic for -quiet option * Change "TestNum" property to "Id" * Change Destination and DestinationAddress to Target and TargetAddress in TcpPortStatus * Implement new form of using declaration * Fix indentation * Update output, improve logic and update tests * Add CancellationToken to allow cancel before timeout * Assign testResult.Connected to client.Connected * Move TcpPortStatus object creation to after connection test * Remove delay from final connection test in loop * Move Count logic from ProcessConnectionByTCPPort into own function * Fix small formatting error * Add handling for TaskCanceledException * Remove redundant CancellationToken getter * Clean up handling of SocketException * Increase readability of final loop check * Remove unnecessary TimeSpan invocation * Rename cancellationTokenSource to match convention * Move SetCountForTcpTest() into BeginProcessing() * Added nameof to Count check * Removed explicit type declaration for TcpClient * Move delay and timeout evaluation out of the cycle * Remove redundant CancellationTokenSource * Initialize detailed SwitchParameter * Add check for Detailed parameter * Remove redundant tests for non-detailed output * Add return after first boolean output * Update tests with new detailed parameter set --------- Co-authored-by: Travis Plunk <travis.plunk@microsoft.com>

Jack Casey (jackdcasey) added 10 commits December 24, 2019 22:54

Added verbose TCP test logic

2cd4296

Cleaned up output, removed source IP address

1337193

Merge branch 'master' of https://github.com/PowerShell/PowerShell int…

d7b4368

…o TestConnection-AddVerboseTcpTest

Consolidated detailed output logic into ProcessConnectionByTCPPort()

9325584

Updated existing tests with -Quiet switch

c005933

Improved output formatting, changed logic to match

1698fc5

Error handling and logic improvements

34d56af

Updated tests to match new output

3896c98

Updated logic, tcp tests now run once by default

1b6c06d

Moved TcpConnectionTestResult enum into TcpTestStatus class

cdbcd07

Jack Casey (jackdcasey) requested review from Aditya Patwardhan (adityapatwardhan) and Dongbo Wang (daxian-dbw) as code owners December 29, 2019 09:34

ghost assigned Travis Plunk (TravisEz13) Dec 29, 2019

Rain Sallow (/u/ta11ow) (vexx32) suggested changes Dec 29, 2019

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 29, 2019

Ilya (iSazonov) reviewed Dec 29, 2019

View reviewed changes

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 29, 2019

Jack Casey (jackdcasey) added 5 commits December 29, 2019 11:14

Removed unnecessary whitespace

a5d3d6c

Wrapped TcpClient() in Using statement

8cddfbf

Appended missing period on comments

55f598e

Change TcpTestStatus to TcpPortStatus for better clarity

7cb7621

Set default count back to 4

c0960d8

Rain Sallow (/u/ta11ow) (vexx32) reviewed Dec 30, 2019

View reviewed changes

Jack Casey (jackdcasey) added 6 commits December 29, 2019 21:22

Move stopwatch reset into finally block

6edaa80

Change TcpConnectionTestResult.New to TcpConnectionTestResult.None

aa19612

Formatting fixes

dd904cc

Increase column size for Result output

24053d3

Update logic for -quiet option

6e6d9d2

Change "TestNum" property to "Id"

042ddba

Remove redundant CancellationTokenSource

ff24361

Aditya Patwardhan (adityapatwardhan) removed this from the 7.1.0-preview.4 milestone Jun 29, 2020

ghost added the Review - Needed The PR is being reviewed label Jul 7, 2020

Jack Casey (jackdcasey) added 5 commits July 8, 2020 23:16

Initialize detailed SwitchParameter

2a8aa2a

Add check for Detailed parameter

f92cde7

Remove redundant tests for non-detailed output

6816d02

Add return after first boolean output

629bb36

Update tests with new detailed parameter set

fd28410

Jack Casey (jackdcasey) mentioned this pull request Nov 9, 2020

Increase output detail of Test-Connection when performing a tcp connection test #11440

Closed

Merge branch 'master' into TestConnection-AddVerboseTcpTest

22ca7a4

pull-request-quantifier-deprecated Bot added the Medium label May 12, 2022

ghost removed the Review - Needed The PR is being reviewed label May 13, 2022

Rain Sallow (/u/ta11ow) (vexx32) mentioned this pull request May 20, 2022

Test-Connection with -TcpPort only tries IPv6 connection for localhost #17383

Closed

5 tasks

ghost added the Review - Needed The PR is being reviewed label May 21, 2022

Travis Plunk (TravisEz13) approved these changes May 1, 2023

View reviewed changes

Travis Plunk (TravisEz13) merged commit 698742e into PowerShell:master May 1, 2023

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

Travis Plunk (TravisEz13) mentioned this pull request May 1, 2023

Add new parameter set for Test-Connection MicrosoftDocs/PowerShell-Docs#10037

Closed

3 tasks

Sean Wheeler (sdwheeler) mentioned this pull request Jun 1, 2023

Add ParameterSetName for the Detailed parameter #19727

Merged

22 tasks

Sean Wheeler (sdwheeler) added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label Jun 1, 2023

Test-Connection: Increase output detail when performing a tcp test by jackdcasey · Pull Request #11452 · PowerShell/PowerShell · GitHub

Uh oh!

Test-Connection: Increase output detail when performing a tcp test - #11452

Conversation

Jack Casey (jackdcasey) commented Dec 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test-Connection: Increase output detail when performing a tcp test

PR Context

PR Checklist

Uh oh!

Microsoft Contribution License Agreements (msftclas) commented Dec 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Deleted user (ghost) commented Jul 7, 2020

Uh oh!

Jack Casey (jackdcasey) commented Jul 9, 2020

Uh oh!

Jack Casey (jackdcasey) commented Sep 10, 2020

Uh oh!

pull-request-quantifier-deprecated Bot commented May 12, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

Travis Plunk (TravisEz13) commented May 13, 2022

Uh oh!

azure-pipelines Bot commented May 13, 2022

Uh oh!

Deleted user (ghost) commented May 21, 2022

Uh oh!

Sean Wheeler (sdwheeler) commented May 1, 2023

Uh oh!

Deleted user (ghost) commented Jun 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

Jack Casey (jackdcasey) commented Dec 29, 2019 •
edited
Loading

Microsoft Contribution License Agreements (msftclas) commented Dec 29, 2019 •
edited
Loading