summaryrefslogtreecommitdiffstats
path: root/tests/distaf/distaf_libs/distaflibs-gluster/distaflibs/gluster/mount_ops.py
blob: 2ee5b815c53bfe4b0f98117cbc4592e599810480 (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
185
186
187
188
189
190
191
192
#  This file is part of DiSTAF
#  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.


from distaf.util import tc

class GlusterMount():
    """Gluster Mount class

    Args:
        mount (dict): Mount dict with 'mount_protocol', 'mountpoint',
            'server', 'client', 'volname', 'options' as keys

    Returns:
        Instance of GlusterMount class
   """
    client_register = 0

    def __init__(self, mount):
        if mount['protocol']:
            self.mounttype = mount['protocol']
        else:
            self.mounttype = "glusterfs"

        if mount['mountpoint']:
            self.mountpoint = mount['mountpoint']
        else:
            self.mountpoint = "/mnt/%s" % self.mounttype

        self.server_system = mount['server']
        self.client_system = mount['client']
        self.volname = mount['volname']
        self.options = mount['options']

    def mount(self):
        """Mounts the volume

        Args:
            uses instance args passed at init

        Returns:
            bool: True on success and False on failure.
        """
        (_retcode, _, _) = mount_volume(self.volname,
                                        mtype=self.mounttype,
                                        mpoint=self.mountpoint,
                                        mserver=self.server_system,
                                        mclient=self.client_system,
                                        options=self.options)

        if _retcode == 0:
            return True
        else:
            return False

    def is_mounted(self):
        """Tests for mount on client

        Args:
            uses instance args passed at init

        Returns:
            bool: True on success and False on failure.
        """
        _retcode = is_mounted(self.volname,
                              mpoint=self.mountpoint,
                              mserver=self.server_system,
                              mclient=self.client_system)

        if _retcode:
            return True
        else:
            return False

    def unmount(self):
        """Unmounts the volume

        Args:
            uses instance args passed at init

        Returns:
            bool: True on success and False on failure.
        """
        (_retcode, _, _) = umount_volume(self.client_system,
                                         self.mountpoint)

        if _retcode == 0:
            return True
        else:
            return False

def is_mounted(volname, mpoint, mserver, mclient):
    """Check if mount exist.

    Args:
        volname (str): Name of the volume
        mpoint (str): Mountpoint dir
        mserver (str): Server to which it is mounted to
        mclient (str): Client from which it is mounted.

    Returns:
        bool: True if mounted and False otherwise.
    """
    # python will error on missing arg, so just checking for empty args here
    if not volname or not mpoint or not mserver or not mclient:
        tc.logger.error("Missing arguments for mount.")
        return False

    ret, _, _ = tc.run(mclient, "mount | grep %s | grep %s | grep \"%s\""
                       % (volname, mpoint, mserver), verbose=False)
    if ret == 0:
        tc.logger.debug("Volume %s is mounted at %s:%s" % (volname,
                                                           mclient,
                                                           mpoint))
        return True
    else:
        tc.logger.error("Volume %s is not mounted at %s:%s" % (volname,
                                                               mclient,
                                                               mpoint))
        return False

def mount_volume(volname, mtype='glusterfs', mpoint='/mnt/glusterfs',
                 mserver='', mclient='', options=''):
    """Mount the gluster volume with specified options.

    Args:
        volname (str): Name of the volume to mount.

    Kwargs:
        mtype (str): Protocol to be used to mount.
        mpoint (str): Mountpoint dir.
        mserver (str): Server to mount.
        mclient (str): Client from which it has to be mounted.
        option (str): Options for the mount command.

    Returns:
        tuple: Tuple containing three elements (ret, out, err).
            (0, '', '') if already mounted.
            (ret, out, err) of mount commnd execution otherwise.
    """
    global tc
    if mserver == '':
        mserver = tc.servers[0]
    if mclient == '':
        mclient = tc.clients[0]
    if options != '':
        options = "-o %s" % options
    if mtype == 'nfs' and options != '':
        options = "%s" % options
    elif mtype == 'nfs' and options == '':
        options = '-o vers=3'

    if is_mounted(volname, mpoint, mserver, mclient):
        tc.logger.debug("Volume %s is already mounted at %s" %
                        (volname, mpoint))
        return (0, '', '')

    mcmd = ("mount -t %s %s %s:/%s %s" %
            (mtype, options, mserver, volname, mpoint))
    _, _, _ = tc.run(mclient, "test -d %s || mkdir -p %s" % (mpoint, mpoint),
                     verbose=False)
    return tc.run(mclient, mcmd)


def umount_volume(mclient, mpoint):
    """Unmounts the mountpoint.

    Args:
        mclient (str): Client from which it has to be mounted.
        mpoint (str): Mountpoint dir.

    Returns:
        tuple: Tuple containing three elements (ret, out, err) as returned by
            umount command execution.
    """
    cmd = ("umount %s || umount -f %s || umount -l %s" %
           (mpoint, mpoint, mpoint))
    return tc.run(mclient, cmd)