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

jackdcasey · 2019-12-29T09:34:19Z

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

Fix: #11440

…o TestConnection-AddVerboseTcpTest

msftclas · 2019-12-29T09:34:32Z

All CLA requirements met.

vexx32

Great work here!

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

src/Microsoft.PowerShell.Commands.Management/commands/management/TestConnectionCommand.cs

vexx32

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

src/Microsoft.PowerShell.Commands.Management/commands/management/TestConnectionCommand.cs

sdwheeler · 2020-06-18T20:58:13Z

@vexx32 The difference between pings and TCP connections is that TCP connections continue to use system resources during the TIME_WAIT state after the connection is closed. So even if there is a throttle on how fast they are created, they will still exist for 4 minutes. See https://docs.microsoft.com/en-us/windows/client-management/troubleshoot-tcpip-port-exhaust

Troubleshoot port exhaustion issues - Windows Client Management
Learn how to troubleshoot port exhaustion issues.

TravisEz13 · 2020-06-18T21:22:32Z

sending back to the committee for #11452 (comment)

SteveL-MSFT · 2020-06-24T22:39:28Z

@PowerShell/powershell-committee reviewed this, we are concerned about a breaking change from 7.0 which is an LTS release.

Proposed parameter sets:

Test-Connection -TCPPort <port>
Test-Connection -TCPPort <port> -Detailed
Test-Connection -TCPPort <port> -Count <count>
Test-Connection -TCPPort <port> -Repeat

Therefore, Test-Connection -TCPPort <port> would continue to return a boolean and -Detailed must be specified to return an object.

-Count and -Repeat are likely used interactively so returning objects is fine and can still be handled by automation.

msftbot · 2020-07-07T02:00:18Z

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

jackdcasey · 2020-07-09T06:55:32Z

@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 😁

jackdcasey · 2020-09-10T18:55:12Z

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

pull-request-quantifier · 2022-05-12T20:54:48Z

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? 👍 👌 👎 (Email)
Customize PullRequestQuantifier for this repository.

TravisEz13 · 2022-05-13T22:54:53Z

/azp run PowerShell-CI-windows

azure-pipelines · 2022-05-13T22:55:04Z

Azure Pipelines successfully started running 1 pipeline(s).

msftbot · 2022-05-21T02:00:43Z

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

jackdcasey added 10 commits Dec 25, 2019

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

jackdcasey requested review from adityapatwardhan and daxian-dbw as code owners Dec 29, 2019

msftbot bot assigned TravisEz13 Dec 29, 2019

vexx32 suggested changes Dec 29, 2019

View changes

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

iSazonov reviewed Dec 29, 2019

View changes

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

jackdcasey added 5 commits Dec 29, 2019

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

vexx32 reviewed Dec 30, 2019

View changes

jackdcasey added 6 commits Dec 30, 2019

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

TravisEz13 added Review - Committee The PR/Issue needs a review from the PowerShell Committee and removed Committee-Reviewed PS-Committee has reviewed this and made a decision labels Jun 18, 2020

msftbot bot removed the Review - Needed The PR is being reviewed label Jun 18, 2020

SteveL-MSFT added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Jun 24, 2020

jackdcasey added 2 commits Jun 26, 2020

Merge branch 'master' into TestConnection-AddVerboseTcpTest

bb28039

Remove redundant CancellationTokenSource

ff24361

adityapatwardhan removed this from the 7.1.0-preview.4 milestone Jun 29, 2020

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

jackdcasey added 5 commits Jul 9, 2020

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

jackdcasey mentioned this pull request Nov 9, 2020

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

Open

Merge branch 'master' into TestConnection-AddVerboseTcpTest

22ca7a4

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

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

vexx32 mentioned this pull request May 20, 2022

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

Open

5 tasks

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

Oct	NOV	Dec
	28
2021	2022	2023

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

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

jackdcasey commented Dec 29, 2019 •

edited

msftclas commented Dec 29, 2019 •

edited

vexx32 left a comment

vexx32 left a comment

sdwheeler commented Jun 18, 2020 •

edited by unfurl-links bot

TravisEz13 commented Jun 18, 2020

SteveL-MSFT commented Jun 24, 2020 •

edited

msftbot bot commented Jul 7, 2020

jackdcasey commented Jul 9, 2020

jackdcasey commented Sep 10, 2020

pull-request-quantifier bot commented May 12, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

TravisEz13 commented May 13, 2022

azure-pipelines bot commented May 13, 2022

msftbot bot commented May 21, 2022

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

Are you sure you want to change the base?

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

Conversation

jackdcasey commented Dec 29, 2019 • edited

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

PR Context

PR Checklist

msftclas commented Dec 29, 2019 • edited

vexx32 left a comment

vexx32 left a comment

sdwheeler commented Jun 18, 2020 • edited by unfurl-links bot

TravisEz13 commented Jun 18, 2020

SteveL-MSFT commented Jun 24, 2020 • edited

msftbot bot commented Jul 7, 2020

jackdcasey commented Jul 9, 2020

jackdcasey commented Sep 10, 2020

pull-request-quantifier bot commented May 12, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

TravisEz13 commented May 13, 2022

azure-pipelines bot commented May 13, 2022

msftbot bot commented May 21, 2022

jackdcasey commented Dec 29, 2019 •

edited

msftclas commented Dec 29, 2019 •

edited

sdwheeler commented Jun 18, 2020 •

edited by unfurl-links bot

SteveL-MSFT commented Jun 24, 2020 •

edited