1#!/usr/bin/env python3
2
3r"""
4This file contains functions which are useful for processing BMC dumps.
5"""
6
7import gen_print as gp
8import gen_misc as gm
9import gen_robot_keyword as grk
10import bmc_ssh_utils as bsu
11import var_funcs as vf
12import os
13import sys
14import os
15import imp
16import variables as var
17
18from robot.libraries.BuiltIn import BuiltIn
19
20base_path = os.path.dirname(os.path.dirname(
21                            imp.find_module("gen_robot_print")[1])) + os.sep
22sys.path.append(base_path + "data/")
23
24
25def get_dump_dict(quiet=None):
26    r"""
27    Get dump information and return as an ordered dictionary where the keys
28    are the dump IDs and the values are the full path names of the dumps.
29
30    Example robot program call:
31
32    ${dump_dict}=  Get Dump Dict
33    Rprint Vars  dump_dict
34
35    Example output:
36
37    dump_dict:
38      [1]:
39      /var/lib/phosphor-debug-collector/dumps/1/obmcdump_1_1508255216.tar.xz
40      [2]:
41      /var/lib/phosphor-debug-collector/dumps/2/obmcdump_2_1508255245.tar.xz
42      [3]:
43      /var/lib/phosphor-debug-collector/dumps/3/obmcdump_3_1508255267.tar.xz
44      [4]:
45      /var/lib/phosphor-debug-collector/dumps/4/obmcdump_4_1508255283.tar.xz
46
47    Description of argument(s):
48    quiet                           If quiet is set to 1, this function will
49                                    NOT write status messages to stdout.
50    """
51
52    quiet = int(gp.get_var_value(quiet, 1))
53    cmd_buf = "find /var/lib/phosphor-debug-collector/ -maxdepth 4 -type f"
54    output, stderr, rc = bsu.bmc_execute_command(cmd_buf, quiet=quiet)
55
56    BuiltIn().log_to_console(output)
57    return output.split("\n")
58
59
60def valid_dump(dump_id,
61               dump_dict=None,
62               quiet=None):
63    r"""
64    Verify that dump_id is a valid.  If it is not valid, issue robot failure
65    message.
66
67    A dump is valid if the indicated dump_id refers to an existing dump with a
68    valid associated dump file.
69
70    Description of argument(s):
71    dump_id                         A dump ID (e.g. "1", "2", etc.)
72    dump_dict                       A dump dictionary such as the one returned
73                                    by get_dump_dict.  If this value is None,
74                                    this function will call get_dump_dict on
75                                    the caller's behalf.
76    quiet                           If quiet is set to 1, this function will
77                                    NOT write status messages to stdout.
78    """
79
80    if dump_dict is None:
81        dump_dict = get_dump_dict(quiet=quiet)
82
83    if dump_id not in dump_dict:
84        message = "The specified dump ID was not found among the existing" \
85            + " dumps:\n"
86        message += gp.sprint_var(dump_id)
87        message += gp.sprint_var(dump_dict)
88        BuiltIn().fail(gp.sprint_error(message))
89
90    if not dump_dict[dump_id].endswith("tar.xz"):
91        message = "There is no \"tar.xz\" file associated with the given" \
92            + " dump_id:\n"
93        message += gp.sprint_var(dump_id)
94        dump_file_path = dump_dict[dump_id]
95        message += gp.sprint_var(dump_file_path)
96        BuiltIn().fail(gp.sprint_error(message))
97
98
99def scp_dumps(targ_dir_path,
100              targ_file_prefix="",
101              dump_dict=None,
102              quiet=None):
103    r"""
104    SCP all dumps from the BMC to the indicated directory on the local system
105    and return a list of the new files.
106
107    Description of argument(s):
108    targ_dir_path                   The path of the directory to receive the
109                                    dump files.
110    targ_file_prefix                Prefix which will be pre-pended to each
111                                    target file's name.
112    dump_dict                       A dump dictionary such as the one returned
113                                    by get_dump_dict.  If this value is None,
114                                    this function will call get_dump_dict on
115                                    the caller's behalf.
116    quiet                           If quiet is set to 1, this function will
117                                    NOT write status messages to stdout.
118    """
119
120    targ_dir_path = gm.add_trailing_slash(targ_dir_path)
121
122    if dump_dict is None:
123        dump_list = get_dump_dict(quiet=quiet)
124
125    status, ret_values = grk.run_key("Open Connection for SCP", quiet=quiet)
126
127    dump_file_list = []
128    for file_path in dump_list:
129        targ_file_path = targ_dir_path + targ_file_prefix \
130            + os.path.basename(file_path)
131        status, ret_values = grk.run_key("scp.Get File  " + file_path
132                                         + "  " + targ_file_path, quiet=quiet)
133        dump_file_list.append(targ_file_path)
134
135    return dump_file_list
136