summaryrefslogtreecommitdiffstats
path: root/compass-tasks/actions/health_check/utils.py
blob: 369c5b61a1571504107a55ba34362befbf9348d9 (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
# Copyright 2014 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.

"""Compass Health Check heavy-lifting utilities"""
import commands
import os
import platform
import re


def validate_setting(module, setting, param):
    """Checks if a Compass setting exists in the config file.

    :param module   : module name to be checked
    :type module    : string
    :param setting  : compass setting wrapper
    :type setting   : python module
    :param param    : settings defined in compass config file
    :type param     : string

    """
    if hasattr(setting, param):
        return True
    else:
        err_msg = "[%s]Error: no %s defined" % (module, param)
        return err_msg


def get_dist():
    """Returns the operating system related information."""

    os_version, version, release = platform.linux_distribution()
    return (os_version.lower().strip(), version, release.lower().strip())


def check_path(module_name, path):
    """Checks if a directory or file exisits.

    :param module_name   : module name to be checked
    :type module_name    : string
    :param path          : path of the directory of file
    :type path           : string

    """
    err_msg = ""
    if not os.path.exists(path):
        err_msg = (
            "[%s]Error: %s does not exist, "
            "please check your configurations.") % (module_name, path)
    return err_msg


def check_service_running(module_name, service_name):
    """Checks if a certain service is running.

    :param module_name  : module name to be checked
    :type module_name   : string
    :param service_name : service name to be checked
    :type service_name  : string

    """
    err_msg = ""
    if service_name not in commands.getoutput('ps -ef'):
        err_msg = "[%s]Error: %s is not running." % (
            module_name, service_name)

    return err_msg


def check_chkconfig(service_name):
    """Checks if a service is enabled at the start up.

    :param service_name  : service name to be checked
    :type service_name   : string

    """
    chk_on = False
    for service in os.listdir('/etc/rc3.d/'):
        if service_name in service and 'S' in service:
            chk_on = True
            break

    return chk_on


def strip_name(name):
    """Reformats names."""
    if not any([s in name for s in "(,),-,_".split(',')]):
        return name

    paren_regex = re.compile("(.*?)\s*\(")
    dash_regex = re.compile("(.*?)\s*\-")
    under_dash_regex = re.compile("(.*?)\s*\_")

    r1 = paren_regex.match(name)
    r2 = dash_regex.match(name)
    r3 = under_dash_regex.match(name)
    shortest = 'AVeryLongStringForDefualt'
    for r in [r1, r2, r3]:
        if r and len(r.group(1)) < len(shortest):
            shortest = r.group(1)

    return shortest