[framework] Add DUT connection by console port by bingwang-ms · Pull Request #2204 · sonic-net/sonic-mgmt

bingwang-ms · 2020-09-11T07:08:51Z

Description of PR

Summary:
Fixes # (issue)

Type of change

Bug fix
Testbed and Framework(new/improvement)
Test case(new/improvement)

Approach

What is the motivation for this PR?

As we all know, Ansible run commands via SSH connection from mgmt port. However, the connection is not stable or not usable for some scenes, like vrf test, reboot test and etc. Therefore, we need a more robust way to connect and run command on DUT. This commit add enables framework to connect DUT by console port.

How did you do it?

The feature is implemented based on netmiko.
Cueerntly, two types of console connection in star lab are supported, that is console on Digi (digi_console) and console servers using telnet. Some interfaces are needed to be overwriten if more console types are to support.
The console type, address and port of console hub are defined in inventory file,

str-7260cx3-acs-1:
      ansible_host: 10.64.247.224
      hwsku: Arista-7260CX3-D108C8
      pdu_host: pdu-106
      console_type: telnet_console
      console_host: 10.3.146.16
      console_port: 2015

and console username and password are managed by Ansible secret vars.
3. Add a new fixture duthost_console for establishing connection to DUT by console port.
4. All public interfaces are inherited from netmiko. But only send_command is tested for now.
https://ktbyers.github.io/netmiko/docs/netmiko/index.html#netmiko.BaseConnection.send_command

How did you verify/test it?

I write a demo script to verify it

import pytest
import logging

pytestmark = [
    pytest.mark.topology('t0'),
]

def test_telnet(duthost_console):
    out = duthost_console.send_command("show version")
    logging.info(out)

Any platform specific information?

No.

Supported testbed topology if it's a new test case?

N/A.

Documentation

Please refer to Netmiko doc
https://ktbyers.github.io/netmiko/docs/netmiko/index.html

lgtm-com · 2020-09-11T07:23:40Z

This pull request introduces 7 alerts when merging 373675e19b9011dca73c87308234ac9c429f5189 into 647b57e - view on LGTM.com

new alerts:

6 for Unused import
1 for First argument to super() is not enclosing class

vaibhavhd · 2020-09-14T16:47:05Z

tests/common/connections/ssh_console_conn.py

How do we handle console connections that require Active Directory password. This is the case for most of the new DUTs (for eg. DX10s) that are onboarded and some Fanout switches. I think we will not want to have AD creds in secrets vars file.

Great question. The auth method used in Lab highly depends on Microsoft AD. Perhaps we could try to add a public account for test.

vaibhavhd · 2020-09-14T16:53:39Z

tests/common/connections/ssh_console_conn.py

This method seems to be returning return_msg

Thanks. I missed it. I will post an update to fix it.

vaibhavhd · 2020-09-14T16:58:29Z

tests/common/connections/ssh_console_conn.py

This condition is repeating in the line 74. Is there a reason to check twice?

Good catch. The check in ln68-71 is not necessary. But the check in ln74-77 must be kept to handle the case when password is not required to login.

tests/common/connections/telnet_console_conn.py

tests/common/connections/ssh_console_conn.py

wangxin · 2020-09-16T08:55:50Z

tests/conftest.py

This assumes that all the console servers use the same username/password?

Good catch. I need to come up with a better method to manage account info for various console server.

lguohan · 2020-10-29T10:10:06Z

most of the part looks good to me. maybe we can get it merged first and then iterate?

bingwang-ms · 2020-10-29T10:14:56Z

most of the part looks good to me. maybe we can get it merged first and then iterate?

Thanks. Now I'm waiting for this PR #2257 (Pdu and Console connection info in connection graph), which puts console meta data in connection graph. Currently, I put them in inventory file. But it shouldn't be too much work.

As we all know, Ansible run commands via SSH connection from mgmt port. However, the connection is not stable or not usable for some scenes, like vrf test, reboot test and etc. Therefore, we need a more robust way to connect and run command on DUT (or other hosts). This commit add enables framework to connect DUT by console port.

1. Support alt password for console and SNOiC 2. Support new console server 'menu_ports' Signed-off-by: bingwang <bingwang@microsoft.com>

bingwang-ms · 2020-12-31T05:22:51Z

@yxieca @vaibhavhd @wangxin Sorry for the late update. Please help to review again.
Major updates:

Support console login via menu ports
Support multi password for console server and SONiC

Please note that the current code reads console information from inventory file and reads creds from secret file. The next step is to put console information into connect_graph_facts. I will work with @sujinmkang to complete PR #2257

lgtm-com · 2020-12-31T05:42:56Z

This pull request introduces 1 alert when merging ba7cdb5 into 20d729d - view on LGTM.com

new alerts:

1 for Unused import

Signed-off-by: bingwang <bingwang@microsoft.com>

…ance submodule head (sonic-net#14029) utilities: * a4f141f1 2023-01-10 | [sfputil] Firmware download/upgrade CLI support for QSFP-DD (sonic-net#1947) (sonic-net#2349) (HEAD -> 202205) [CliveNi] swss-common: * 41fcad8 2023-01-30 | Increase the netlink buffer size from 3MB to 16MB. (sonic-net#739) (HEAD -> 202205) [KISHORE KUNAL] sairedis: * 5ce9990 2023-02-27 | [Dual-ToR] update sai.profile with SAI_ADDITIONAL_MAC_ENABLED attribute if corresponding arg passed to syncd (sonic-net#1201) (HEAD -> 202205) [Andriy Yurkiv] * 3c2e0c5 2023-02-23 | Use new value of STATE_DB FAST_REBOOT entry (sonic-net#1196) [Aryeh Feigin] * fe7756f 2023-02-28 | [submodule][SAI]Advance SAI head (sonic-net#1210) (github/202205) [Richard.Yu] platform-common: * 321a8e7 2022-09-23 | Cdb fw upgrade (sonic-net#308) (HEAD -> 202205) [CliveNi] swss: * ceea558 2023-02-28 | [orchagent]: Get bridge port ID from orchagent cache instead of SAI API (sonic-net#2657) (HEAD -> 202205) [Lawrence Lee] * bd04e24 2023-03-01 | [dualtor] Fix neighbor miss when mux is not ready (sonic-net#2676) (HEAD -> 202205) [Longxiang Lyu] * 7d87a90 2023-02-28 | [ci] Fix pipeline error about team5 not found. (sonic-net#2684) [Liu Shilong] * 93a924c 2023-02-27 | [aclorch] Fixed issue sonic-net#2204.Support IN_PORTS qualifer in MIRRORV6 table. (sonic-net#2668) [Rajkumar-Marvell] * 9d87ec4 2023-02-23 | swss: Fix Invalid port oid messages generated because of voq counters. (sonic-net#2653) [Sambath Kumar Balasubramanian] Signed-off-by: Ying Xie <ying.xie@microsoft.com>

swss: * 143cd44 2023-03-04 | Revert "[aclorch] Fixed issue sonic-net#2204.Support IN_PORTS qualifer in MIRRORV6 table. (sonic-net#2668)" (sonic-net#2687) (HEAD -> 202205, github/202205) [StormLiangMS] * 25812f8 2023-02-06 | [test_mux] add sleep in test_NH (sonic-net#2648) [Nikola Dancejic] Signed-off-by: Ying Xie <ying.xie@microsoft.com>

bingwang-ms force-pushed the add_connection_by_console branch from eed9eab to 373675e Compare September 11, 2020 07:10

bingwang-ms added Enhancement Design Review Needed labels Sep 11, 2020

bingwang-ms requested a review from a team September 11, 2020 07:48

vaibhavhd reviewed Sep 14, 2020

View reviewed changes

tests/common/connections/telnet_console_conn.py Outdated Show resolved Hide resolved

vaibhavhd reviewed Sep 14, 2020

View reviewed changes

tests/common/connections/ssh_console_conn.py Outdated Show resolved Hide resolved

wangxin reviewed Sep 16, 2020

View reviewed changes

lguohan approved these changes Oct 29, 2020

View reviewed changes

yxieca force-pushed the master branch from 885053e to 8f9cb56 Compare October 31, 2020 02:57

bingwang-ms force-pushed the add_connection_by_console branch from 78c597d to dff6cb1 Compare December 31, 2020 05:00

Update console connection

d401bdc

1. Support alt password for console and SNOiC 2. Support new console server 'menu_ports' Signed-off-by: bingwang <bingwang@microsoft.com>

bingwang-ms force-pushed the add_connection_by_console branch from 0859016 to d401bdc Compare December 31, 2020 05:13

Merge branch 'master' into add_connection_by_console

ba7cdb5

bingwang-ms added 2 commits December 30, 2020 22:54

Fix LGTM.

170ff4d

Signed-off-by: bingwang <bingwang@microsoft.com>

Fix exception in conftests.

4539557

Signed-off-by: bingwang <bingwang@microsoft.com>

wangxin approved these changes Jan 4, 2021

View reviewed changes

bingwang-ms merged commit ad4fb76 into sonic-net:master Jan 5, 2021

Conversation

bingwang-ms commented Sep 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of PR

Type of change

Approach

What is the motivation for this PR?

How did you do it?

How did you verify/test it?

Any platform specific information?

Supported testbed topology if it's a new test case?

Documentation

Uh oh!

lgtm-com bot commented Sep 11, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lguohan commented Oct 29, 2020

Uh oh!

bingwang-ms commented Oct 29, 2020

Uh oh!

bingwang-ms commented Dec 31, 2020

Uh oh!

lgtm-com bot commented Dec 31, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bingwang-ms commented Sep 11, 2020 •

edited

Loading