aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/DMM/SetupDMMTest.py
blob: 7bb596546c37920bd3a6d1ec85fc86e992d1ec87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# Copyright (c) 2018 Huawei Technologies Co.,Ltd.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""This module exists to provide setup utilities for the framework on topology
nodes. All tasks required to be run before the actual tests are started is
supposed to end up here.
"""

from shlex import split
from subprocess import Popen, PIPE
from multiprocessing import Pool
from tempfile import NamedTemporaryFile
from os.path import basename

from robot.api import logger
from robot.libraries.BuiltIn import BuiltIn

from resources.libraries.python.ssh import SSH
from resources.libraries.python.DMM.DMMConstants import DMMConstants as con
from resources.libraries.python.topology import NodeType, Topology
from resources.libraries.python.TLDK.SetupTLDKTest import copy_tarball_to_node,\
     delete_local_tarball

__all__ = ["SetupDMMTest"]


def pack_framework_dir():
    """Pack the testing WS into temp file, return its name.
    :returns: file_name
    :rtype: str
    :raises RuntimeError: If pack the testing framework failed.
    """
    tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="DMM-testing-")
    file_name = tmpfile.name
    tmpfile.close()

    proc = Popen(
        split("tar --exclude-vcs --exclude=./tmp --exclude=dmm_depends.tar.gz"
              " -zcf {0} .".format(file_name)), stdout=PIPE, stderr=PIPE)
    (stdout, stderr) = proc.communicate()

    logger.debug(stdout)
    logger.debug(stderr)

    return_code = proc.wait()
    if return_code != 0:
        raise RuntimeError("Could not pack testing framework.")

    return file_name

def extract_tarball_at_node(tarball, node):
    """Extract tarball at given node.

    Extracts tarball using tar on given node to specific CSIT location.
    Raise runtime errors when failed.

    :param tarball: Path to tarball to upload.
    :param node: Dictionary created from topology.
    :type tarball: str
    :type node: dict
    :return: nothing
    :raises RuntimeError: If extract tarball failed.
    """
    logger.console('Extracting tarball to {0} on {1}'.format(
        con.REMOTE_FW_DIR, node['host']))
    ssh = SSH()
    ssh.connect(node)

    cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
          'rm -f {0};'.format(tarball, con.REMOTE_FW_DIR)
    (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
    if ret_code != 0:
        logger.error('Unpack error: {0}'.format(stderr))
        raise RuntimeError('Failed to unpack {0} at node {1}'.format(
            tarball, node['host']))

def install_dmm_test(node):
    """Prepare the DMM test envrionment.
    Raise errors when failed.

    :param node: Dictionary created from topology.
    :type node: dict
    :returns: nothing.
    :raises RuntimeError: If install dmm failed.
    """

    arch = Topology.get_node_arch(node)
    logger.console('Install the DMM on {0} ({1})'.format(node['host'], arch))

    ssh = SSH()
    ssh.connect(node)
    (ret_code, _, stderr) = ssh.exec_command(
        'cd {0}/{1} && ./install_prereq.sh {2} 2>&1 | tee '
        'log_install_prereq.txt'
        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS, arch), timeout=600)

    if ret_code != 0:
        logger.error('Install the DMM error: {0}'.format(stderr))
        raise RuntimeError('Install prereq failed')
    else:
        logger.console('Install prereq on {0} success!'.format(node['host']))

def setup_node(args):
    """Run all set-up methods for a node.

    This method is used as map_async parameter. It receives tuple with all
    parameters as passed to map_async function.

    :param args: All parameters needed to setup one node.
    :type args: tuple
    :returns: True - success, False - error
    :rtype: bool
    :raises RuntimeError: If node setup failed.
    """
    tarball, remote_tarball, node = args

    # if unset, arch defaults to x86_64
    Topology.get_node_arch(node)

    try:
        if node['type'] == NodeType.DUT:
            copy_tarball_to_node(tarball, node)
            extract_tarball_at_node(remote_tarball, node)
            install_dmm_test(node)
    except RuntimeError as exc:
        logger.error("Node setup failed, error:'{0}'".format(exc.message))
        return False
    else:
        logger.console('Setup of node {0} done'.format(node['host']))
        return True

class SetupDMMTest(object):
    """Setup suite run on topology nodes.

    Many VAT/CLI based tests need the scripts at remote hosts before executing
    them. This class packs the whole testing directory and copies it over
    to all nodes in topology under /tmp/
    """

    @staticmethod
    def setup_dmm_test(nodes):
        """Pack the whole directory and extract in temp on each node."""

        tarball = pack_framework_dir()
        msg = 'Framework packed to {0}'.format(tarball)
        logger.console(msg)
        logger.trace(msg)
        remote_tarball = "/tmp/{0}".format(basename(tarball))

        # Turn off logging since we use multiprocessing.
        log_level = BuiltIn().set_log_level('NONE')
        params = ((tarball, remote_tarball, node) for node in nodes.values())
        pool = Pool(processes=len(nodes))
        result = pool.map_async(setup_node, params)
        pool.close()
        pool.join()

        # Turn on logging.
        BuiltIn().set_log_level(log_level)

        logger.info(
            'Executed node setups in parallel, waiting for processes to end')
        result.wait()

        results = result.get()
        node_setup_success = all(results)
        logger.info('Results: {0}'.format(results))

        logger.trace('Test framework copied to all topology nodes')
        delete_local_tarball(tarball)
        if node_setup_success:
            logger.console('All nodes are ready')
        else:
            logger.console('Failed to setup dpdk on all the nodes')
pan class="o">= hash_create_string (0, sizeof (uword)); freg = fm->next_feature_by_arc[arc_index]; while (freg) { hash_set_mem (fm->next_feature_by_name[arc_index], freg->node_name, pointer_to_uword (freg)); freg = freg->next_in_arc; } /* next */ areg = areg->next; arc_index++; } return 0; } VLIB_INIT_FUNCTION (vnet_feature_init); u8 vnet_get_feature_arc_index (const char *s) { vnet_feature_main_t *fm = &feature_main; vnet_feature_arc_registration_t *reg; uword *p; p = hash_get_mem (fm->arc_index_by_name, s); if (p == 0) return ~0; reg = uword_to_pointer (p[0], vnet_feature_arc_registration_t *); return reg->feature_arc_index; } vnet_feature_registration_t * vnet_get_feature_reg (const char *arc_name, const char *node_name) { u8 arc_index; arc_index = vnet_get_feature_arc_index (arc_name); if (arc_index == (u8) ~ 0) return 0; vnet_feature_main_t *fm = &feature_main; vnet_feature_registration_t *reg; uword *p; p = hash_get_mem (fm->next_feature_by_name[arc_index], node_name); if (p == 0) return 0; reg = uword_to_pointer (p[0], vnet_feature_registration_t *); return reg; } u32 vnet_get_feature_index (u8 arc, const char *s) { vnet_feature_main_t *fm = &feature_main; vnet_feature_registration_t *reg; uword *p; if (s == 0) return ~0; p = hash_get_mem (fm->next_feature_by_name[arc], s); if (p == 0) return ~0; reg = uword_to_pointer (p[0], vnet_feature_registration_t *); return reg->feature_index; } int vnet_feature_enable_disable_with_index (u8 arc_index, u32 feature_index, u32 sw_if_index, int enable_disable, void *feature_config, u32 n_feature_config_bytes) { vnet_feature_main_t *fm = &feature_main; vnet_feature_config_main_t *cm; i16 feature_count; u32 ci; if (arc_index == (u8) ~ 0) return VNET_API_ERROR_INVALID_VALUE; if (feature_index == ~0) return VNET_API_ERROR_INVALID_VALUE_2; cm = &fm->feature_config_mains[arc_index]; vec_validate_init_empty (cm->config_index_by_sw_if_index, sw_if_index, ~0); ci = cm->config_index_by_sw_if_index[sw_if_index]; vec_validate (fm->feature_count_by_sw_if_index[arc_index], sw_if_index); feature_count = fm->feature_count_by_sw_if_index[arc_index][sw_if_index]; if (!enable_disable && feature_count < 1) return 0; ci = (enable_disable ? vnet_config_add_feature : vnet_config_del_feature) (vlib_get_main (), &cm->config_main, ci, feature_index, feature_config, n_feature_config_bytes); if (ci == ~0) { return 0; } cm->config_index_by_sw_if_index[sw_if_index] = ci; /* update feature count */ enable_disable = (enable_disable > 0); feature_count += enable_disable ? 1 : -1; ASSERT (feature_count >= 0); fm->sw_if_index_has_features[arc_index] = clib_bitmap_set (fm->sw_if_index_has_features[arc_index], sw_if_index, (feature_count > 0)); adj_feature_update (sw_if_index, arc_index, (feature_count > 0)); fm->feature_count_by_sw_if_index[arc_index][sw_if_index] = feature_count; return 0; } int vnet_feature_enable_disable (const char *arc_name, const char *node_name, u32 sw_if_index, int enable_disable, void *feature_config, u32 n_feature_config_bytes) { u32 feature_index; u8 arc_index; arc_index = vnet_get_feature_arc_index (arc_name); if (arc_index == (u8) ~ 0) return VNET_API_ERROR_INVALID_VALUE; feature_index = vnet_get_feature_index (arc_index, node_name); return vnet_feature_enable_disable_with_index (arc_index, feature_index, sw_if_index, enable_disable, feature_config, n_feature_config_bytes); } static int feature_cmp (void *a1, void *a2) { vnet_feature_registration_t *reg1 = a1; vnet_feature_registration_t *reg2 = a2; return (int) reg1->feature_index - reg2->feature_index; } /** Display the set of available driver features. Useful for verifying that expected features are present */ static clib_error_t * show_features_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { vnet_feature_main_t *fm = &feature_main; vnet_feature_arc_registration_t *areg; vnet_feature_registration_t *freg; vnet_feature_registration_t *feature_regs = 0; int verbose = 0; if (unformat (input, "verbose")) verbose = 1; vlib_cli_output (vm, "Available feature paths"); areg = fm->next_arc; while (areg) { if (verbose) vlib_cli_output (vm, "[%2d] %s:", areg->feature_arc_index, areg->arc_name); else vlib_cli_output (vm, "%s:", areg->arc_name); freg = fm->next_feature_by_arc[areg->feature_arc_index]; while (freg) { vec_add1 (feature_regs, freg[0]); freg = freg->next_in_arc; } vec_sort_with_function (feature_regs, feature_cmp); vec_foreach (freg, feature_regs) { if (verbose) vlib_cli_output (vm, " [%2d]: %s\n", freg->feature_index, freg->node_name); else vlib_cli_output (vm, " %s\n", freg->node_name); } vec_reset_length (feature_regs); /* next */ areg = areg->next; } vec_free (feature_regs); return 0; } /*? * Display the set of available driver features * * @cliexpar * Example: * @cliexcmd{show features [verbose]} * @cliexend * @endparblock ?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (show_features_command, static) = { .path = "show features", .short_help = "show features", .function = show_features_command_fn, }; /* *INDENT-ON* */ /** Display the set of driver features configured on a specific interface * Called by "show interface" handler */ void vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index, int verbose) { vnet_feature_main_t *fm = &feature_main; u32 node_index, current_config_index; u16 feature_arc; vnet_feature_config_main_t *cm = fm->feature_config_mains; vnet_feature_arc_registration_t *areg; vnet_config_main_t *vcm; vnet_config_t *cfg; u32 cfg_index; vnet_config_feature_t *feat; vlib_node_t *n; int i; vlib_cli_output (vm, "Feature paths configured on %U...", format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index); areg = fm->next_arc; while (areg) { feature_arc = areg->feature_arc_index; vcm = &(cm[feature_arc].config_main); vlib_cli_output (vm, "\n%s:", areg->arc_name); areg = areg->next; if (NULL == cm[feature_arc].config_index_by_sw_if_index || vec_len (cm[feature_arc].config_index_by_sw_if_index) <= sw_if_index) { vlib_cli_output (vm, " none configured"); continue; } current_config_index = vec_elt (cm[feature_arc].config_index_by_sw_if_index, sw_if_index); if (current_config_index == ~0) { vlib_cli_output (vm, " none configured"); continue; } ASSERT (current_config_index < vec_len (vcm->config_pool_index_by_user_index)); cfg_index = vcm->config_pool_index_by_user_index[current_config_index]; cfg = pool_elt_at_index (vcm->config_pool, cfg_index); for (i = 0; i < vec_len (cfg->features); i++) { feat = cfg->features + i; node_index = feat->node_index; n = vlib_get_node (vm, node_index); if (verbose) vlib_cli_output (vm, " [%2d] %v", feat->feature_index, n->name); else vlib_cli_output (vm, " %v", n->name); } } } static clib_error_t * set_interface_features_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { vnet_main_t *vnm = vnet_get_main (); unformat_input_t _line_input, *line_input = &_line_input; clib_error_t *error = 0; u8 *arc_name = 0; u8 *feature_name = 0; u32 sw_if_index = ~0; u8 enable = 1; /* Get a line of input. */ if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "%U %v", unformat_vnet_sw_interface, vnm, &sw_if_index, &feature_name)) ; else if (unformat (line_input, "arc %v", &arc_name)) ; else if (unformat (line_input, "disable")) enable = 0; else { if (feature_name && arc_name) break; error = unformat_parse_error (line_input); goto done; } } if (sw_if_index == ~0) { error = clib_error_return (0, "Interface not specified..."); goto done; } vec_add1 (arc_name, 0); vec_add1 (feature_name, 0); vnet_feature_registration_t *reg; reg = vnet_get_feature_reg ((const char *) arc_name, (const char *) feature_name); if (reg == 0) { error = clib_error_return (0, "Unknown feature..."); goto done; } if (reg->enable_disable_cb) error = reg->enable_disable_cb (sw_if_index, enable); if (!error) vnet_feature_enable_disable ((const char *) arc_name, (const char *) feature_name, sw_if_index, enable, 0, 0); done: vec_free (feature_name); vec_free (arc_name); unformat_free (line_input); return error; } /*? * Set feature for given interface * * @cliexpar * Example: * @cliexcmd{set interface feature GigabitEthernet2/0/0 ip4_flow_classify arc ip4_unicast} * @cliexend * @endparblock ?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (set_interface_feature_command, static) = { .path = "set interface feature", .short_help = "set interface feature <intfc> <feature_name> arc <arc_name> " "[disable]", .function = set_interface_features_command_fn, }; /* *INDENT-ON* */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */