summaryrefslogtreecommitdiffstats
path: root/glustolibs-gluster/glustolibs/gluster/uss_ops.py
blob: a6f9b8f98d5bc32868fb1c0bafadc505551bad6d (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
#!/usr/bin/env python
#  Copyright (C) 2015-2016  Red Hat, Inc. <http://www.redhat.com>
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License along
#  with this program; if not, write to the Free Software Foundation, Inc.,
#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

"""
    Description: Module for gluster uss operations
"""

from glusto.core import Glusto as g
from glustolibs.gluster.volume_ops import get_volume_status


def enable_uss(mnode, volname):
    """Enables uss on the specified volume

    Args:
        mnode (str): Node on which cmd has to be executed.
        volname (str): volume name

    Returns:
        tuple: Tuple containing three elements (ret, out, err).
            The first element 'ret' is of type 'int' and is the return value
            of command execution.

            The second element 'out' is of type 'str' and is the stdout value
            of the command execution.

            The third element 'err' is of type 'str' and is the stderr value
            of the command execution.
    """
    cmd = "gluster volume set %s features.uss enable" % volname
    return g.run(mnode, cmd)


def disable_uss(mnode, volname):
    """Disables uss on the specified volume

    Args:
        mnode (str): Node on which cmd has to be executed.
        volname (str): volume name

    Returns:
        tuple: Tuple containing three elements (ret, out, err).
            The first element 'ret' is of type 'int' and is the return value
            of command execution.

            The second element 'out' is of type 'str' and is the stdout value
            of the command execution.

            The third element 'err' is of type 'str' and is the stderr value
            of the command execution.
    """
    cmd = "gluster volume set %s features.uss disable" % volname
    return g.run(mnode, cmd)


def is_uss_enabled(mnode, volname):
    """Check if uss is Enabled on the specified volume

    Args:
        mnode (str): Node on which cmd has to be executed.
        volname (str): volume name

    Returns:
        bool : True if successfully enabled uss on the volume. False otherwise.
    """
    from glustolibs.gluster.volume_ops import get_volume_options
    option_dict = get_volume_options(mnode=mnode, volname=volname,
                                     option="uss")
    if option_dict is None:
        g.log.error("USS is not set on the volume %s" % volname)
        return False

    if ('features.uss' in option_dict and
            option_dict['features.uss'] == 'enable'):
        return True
    else:
        return False


def is_uss_disabled(mnode, volname):
    """Check if uss is disabled on the specified volume

    Args:
        mnode (str): Node on which cmd has to be executed.
        volname (str): volume name

    Returns:
        bool : True if successfully disabled uss on the volume.
            False otherwise.
    """
    from glustolibs.gluster.volume_ops import get_volume_options
    option_dict = get_volume_options(mnode=mnode, volname=volname,
                                     option="uss")
    if option_dict is None:
        g.log.error("USS is not set on the volume %s" % volname)
        return False

    if ('features.uss' in option_dict and
            option_dict['features.uss'] == 'disable'):
        return True
    else:
        return False


def is_snapd_running(mnode, volname):
    """Checks if snapd is running on the given node

        Args:
            mnode (str): Node on which cmd has to be executed.
            volname (str): volume name

        Returns:
            True on success, False otherwise

        Example:
            is_snapd_running("abc.com", "testvol")
            """
    vol_status = get_volume_status(mnode, volname=volname)

    if vol_status is None:
        g.log.error("Failed to get volume status in is_snapd_running()")
        return False

    if 'Snapshot Daemon' not in vol_status[volname][mnode]:
        g.log.error("uss is not enabled in volume %s"
                    % volname)
        return False

    snapd_status = vol_status[volname][mnode]['Snapshot Daemon']['status']
    if snapd_status != '1':
        g.log.error("Snapshot Daemon is not running in node %s"
                    % mnode)
        return False
    return True


def uss_list_snaps(client, mount):

    """List snapshots under .snaps directory
    Args:
        client(str):client on which commands has to be executed
        mount(str): Mount points to be executed
    Returns:
        tuple: Tuple containing three elements (ret, out, err).
            The first element 'ret' is of type 'int' and is the return value
            of command execution.

            The second element 'out' is of type 'str' and is the stdout value
            of the command execution.

            The third element 'err' is of type 'str' and is the stderr value
            of the command execution.
    """
    cmd = "ls -R %s/.snaps" % (mount)
    return g.run(client, cmd)