Bypass check_host_reachable check for self

[Eric MacDonald]

Brief Description
-----------------
Observed collect tool failure mode on the check_host_unreachable call that prevented log collection of local host.

An ssh to self failed with host unreachable due to host configuration error.

   [sysadmin@controller-0 ~(keystone_admin)]$ ssh sysadmin@controller-0
   ssh: connect to host controller-0 port 22: Network is unreachable

Since this check is not needed for local host this bug report calls for it to be bypassed for local host cases to increase the likelyhood of being able to collect from self in some error modes.

Severity
--------
Minor - requires particular failure mode to occur

Steps to Reproduce
------------------
Cause error that prevents ssh to self

Expected Behavior
------------------
collect current host should succeed

Actual Behavior
----------------
collect current host fails

Reproducibility
---------------
100% when prerequisite issue is present

System Configuration
--------------------
Any

Branch/Pull Time/Commit
-----------------------
Nov 18, 2021

Last Pass
---------
N/A

Test Activity
-------------
Regression Testing

Workaround
----------
Fix networking issue that prevents ssh to self

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/utilities/+/818697

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/utilities/+/818698

[OpenStack Infra (hudson-openstack)]

Change abandoned by "Eric MacDonald <email address hidden>" on branch: master
Review: https://review.opendev.org/c/starlingx/utilities/+/818697
Reason: Accidentally uploaded duplicate review with one small change. Keeping the second upload.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/utilities/+/818698
Committed: https://opendev.org/starlingx/utilities/commit/467b03c1cad4a6bc9a158733a4e9dcbf63877c3e
Submitter: "Zuul (22348)"
Branch: master

commit 467b03c1cad4a6bc9a158733a4e9dcbf63877c3e
Author: Eric MacDonald <email address hidden>
Date: Fri Nov 19 16:35:57 2021 -0500

    Bypass check_host_reachable check for local host

    Call to check_host_reachable on local host can prevent
    collection of the local host in the presence if certain
    networking config failures that error out on ssh to self.

    There is no need to check_host_reachable for the local host.
    To make collect for local host more fault tolerant this
    update modifies the check_host_reachable function to
    return pass when executed on the local host.
    It's just not needed in that case.

    This update also adds three additional ssh connection
    failure strings to better handle expect timeouts seen
    for some unreachable host test cases scenarios.

    This update also adds the check_host_reachable test
    prior to subcloud clean operation after finding undesirable
    handling in the unreachaable case during update testing.

    Test Plan:

    PASS: Verify check_host_reachable bypasses check for the local host.
    PASS: Verify check_host_reachable for remote hosts and subclouds.

    Regression:

    PASS: Verify collect all hosts
    PASS: Verify collect all subclouds
    PASS: Verify collect local host
    PASS: Verify collect single and subcloud group
    PASS: Verify collect single and host group
    PASS: Verify collect clean single, group and all
          hosts and subclouds with some unreachable

    Change-Id: I8dc6b0a5f021f38a623fcdd6235b545d2671b7ed
    Closes-Bug: 1951641
    Signed-off-by: Eric MacDonald <email address hidden>

[Ghada Khalil (gkhalil)]

screening: Adding stx.6.0 since the fix will be available for that release