Skip to content

[show][warm_restart] add Multi-ASIC support for warm_restart command #98

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.

Sign up for GitHub

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

Closed
stepanblyschak wants to merge 1 commit into from
Closed

[show][warm_restart] add Multi-ASIC support for warm_restart command #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions show/warm_restart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import click
import utilities_common.cli as clicommon
import utilities_common.multi_asic as multi_asic_util
from swsscommon.swsscommon import SonicV2Connector, ConfigDBConnector
from tabulate import tabulate

Expand All @@ -11,14 +12,20 @@ def warm_restart():


@warm_restart.command()
@click.option('--namespace', '-n', 'namespace', default='', help='Namespace name')
@click.option('-s', '--redis-unix-socket-path', help='unix socket path for redis connection')
def state(redis_unix_socket_path):
def state(namespace, redis_unix_socket_path):
"""Show warm restart state"""
kwargs = {}

if redis_unix_socket_path:
kwargs['unix_socket_path'] = redis_unix_socket_path
click.secho(
"Warning: '-s|--redis-unix-socket-path' has no effect and is left for compatibility",
fg="red", err=True)

if namespace and namespace not in multi_asic_util.multi_asic_ns_choices():
raise click.UsageError("Invalid namespace: {}".format(namespace))

db = SonicV2Connector(host='127.0.0.1')
db = SonicV2Connector(namespace=namespace)
db.connect(db.STATE_DB, False) # Make one attempt only

TABLE_NAME_SEPARATOR = '|'
Expand Down Expand Up @@ -53,19 +60,27 @@ def remove_prefix(text, prefix):


@warm_restart.command()
@click.option('--namespace', '-n', 'namespace', default='', help='Namespace name')
@click.option('-s', '--redis-unix-socket-path', help='unix socket path for redis connection')
def config(redis_unix_socket_path):
def config(namespace, redis_unix_socket_path):
"""Show warm restart config"""
kwargs = {}
if redis_unix_socket_path:
kwargs['unix_socket_path'] = redis_unix_socket_path
config_db = ConfigDBConnector(**kwargs)

if namespace and redis_unix_socket_path:
raise click.UsageError("Cannot specify both namespace and redis unix socket path")

if namespace and namespace not in multi_asic_util.multi_asic_ns_choices():
raise click.UsageError("Invalid namespace: {}".format(namespace))

config_db = ConfigDBConnector(namespace=namespace, **kwargs)
config_db.connect(wait_for_init=False)
data = config_db.get_table('WARM_RESTART')
# Python dictionary keys() Method
keys = list(data.keys())

state_db = SonicV2Connector(host='127.0.0.1')
state_db = SonicV2Connector(namespace=namespace)
state_db.connect(state_db.STATE_DB, False) # Make one attempt only
TABLE_NAME_SEPARATOR = '|'
prefix = 'WARM_RESTART_ENABLE_TABLE' + TABLE_NAME_SEPARATOR
Expand Down
212 changes: 212 additions & 0 deletions tests/test_show_warm_restart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
import pytest
import fnmatch
import textwrap

from unittest.mock import patch, MagicMock
from show.main import cli
from click.testing import CliRunner


@pytest.fixture
def cfgdb():
class DB(MagicMock):
CONFIG_DB = "CONFIG_DB"

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.dbs = {
self.CONFIG_DB: {
"WARM_RESTART": {
"teamd": {
"teamsyncd_timer": "120",
},
},
},
}

def get_table(self, table):
return self.dbs[self.CONFIG_DB][table]

with patch("show.warm_restart.ConfigDBConnector", return_value=DB()) as db:
yield db


@pytest.fixture
def statedb():
class DB(MagicMock):
STATE_DB = "STATE_DB"

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.dbs = {
self.STATE_DB: {
"WARM_RESTART_TABLE|orchagent": {
"state": "restored",
"restore_count": "1"
},
"WARM_RESTART_TABLE|syncd": {
"state": "reconciled",
"restore_count": "1"
},
"WARM_RESTART_ENABLE_TABLE|system": {
"enable": "true",
},
},
}

def keys(self, db, hash):
return [key for key in self.dbs[db].keys() if fnmatch.fnmatch(key, hash)]

def get(self, db, key, field):
return self.dbs[db][key].get(field, None)

def get_all(self, db, key):
return self.dbs[db][key]

with patch("show.warm_restart.SonicV2Connector", return_value=DB()) as db:
yield db


@pytest.fixture
def multi_asic_mock():
with patch("show.warm_restart.multi_asic_util.multi_asic_ns_choices", return_value=["asic1"]) as mock:
yield mock


@pytest.mark.parametrize("namespace", [None, "asic1"])
def test_show_warm_restart(namespace, statedb, multi_asic_mock):
runner = CliRunner()
arguments = []
if namespace:
arguments += ["-n", namespace]
result = runner.invoke(
cli.commands["warm_restart"].commands["state"], arguments,
)
namespace = namespace or ""
statedb.assert_called_once_with(namespace=namespace)
expected_output = textwrap.dedent("""\
name restore_count state
--------- --------------- ----------
orchagent 1 restored
syncd 1 reconciled
""")
assert result.output == expected_output
assert result.exit_code == 0


def test_show_warm_restart_unix_sock_usage(statedb, multi_asic_mock):
runner = CliRunner()
arguments = ["-s", "/var/run/redis/redis.sock"]
result = runner.invoke(
cli.commands["warm_restart"].commands["state"], arguments,
)
expected_output = textwrap.dedent("""\
Warning: '-s|--redis-unix-socket-path' has no effect and is left for compatibility
name restore_count state
--------- --------------- ----------
orchagent 1 restored
syncd 1 reconciled
""")
assert result.output == expected_output
assert result.exit_code == 0


def test_show_warm_restart_unix_sock_usage(statedb, multi_asic_mock):
runner = CliRunner()
arguments = ["-s", "/var/run/redis/redis.sock"]
result = runner.invoke(
cli.commands["warm_restart"].commands["state"], arguments,
)
expected_output = textwrap.dedent("""\
Warning: '-s|--redis-unix-socket-path' has no effect and is left for compatibility
name restore_count state
--------- --------------- ----------
orchagent 1 restored
syncd 1 reconciled
""")
assert result.output == expected_output
assert result.exit_code == 0


def test_show_warm_restart_invalid_namespace(statedb, multi_asic_mock):
runner = CliRunner()
arguments = ["-n", "asicX"]
result = runner.invoke(
cli.commands["warm_restart"].commands["state"], arguments,
)
expected_output = textwrap.dedent("""\
Usage: state [OPTIONS]

Error: Invalid namespace: asicX
""")
assert result.output == expected_output
assert result.exit_code == 2


@pytest.mark.parametrize("namespace", [None, "asic1"])
def test_show_warm_restart_config(namespace, statedb, cfgdb, multi_asic_mock):
runner = CliRunner()
arguments = []
if namespace:
arguments += ["-n", namespace]
result = runner.invoke(
cli.commands["warm_restart"].commands["config"], arguments,
)
namespace = namespace or ""
statedb.assert_called_once_with(namespace=namespace)
cfgdb.assert_called_once_with(namespace=namespace)
expected_output = textwrap.dedent("""\
name enable timer_name timer_duration eoiu_enable
------ -------- --------------- ---------------- -------------
teamd false teamsyncd_timer 120 NULL
system true NULL NULL NULL
""")
assert result.output == expected_output
assert result.exit_code == 0


def test_show_warm_restart_config_invalid_namespace(statedb, cfgdb, multi_asic_mock):
runner = CliRunner()
arguments = ["-n", "asicX"]
result = runner.invoke(
cli.commands["warm_restart"].commands["config"], arguments,
)
expected_output = textwrap.dedent("""\
Usage: config [OPTIONS]

Error: Invalid namespace: asicX
""")
assert result.output == expected_output
assert result.exit_code == 2


def test_show_warm_restart_unix_sock_usage(statedb, cfgdb, multi_asic_mock):
runner = CliRunner()
arguments = ["-s", "/var/run/redis/redis.sock"]
result = runner.invoke(
cli.commands["warm_restart"].commands["config"], arguments,
)
cfgdb.assert_called_once_with(namespace="",unix_socket_path="/var/run/redis/redis.sock")
expected_output = textwrap.dedent("""\
name enable timer_name timer_duration eoiu_enable
------ -------- --------------- ---------------- -------------
teamd false teamsyncd_timer 120 NULL
system true NULL NULL NULL
""")
assert result.output == expected_output
assert result.exit_code == 0


def test_show_warm_restart_unix_sock_usage_and_namespace(statedb, cfgdb, multi_asic_mock):
runner = CliRunner()
arguments = ["-s", "/var/run/redis/redis.sock", "-n", "asic1"]
result = runner.invoke(
cli.commands["warm_restart"].commands["config"], arguments,
)
expected_output = textwrap.dedent("""\
Usage: config [OPTIONS]

Error: Cannot specify both namespace and redis unix socket path
""")
assert result.output == expected_output
assert result.exit_code == 2
Loading