diff options
Diffstat (limited to 'glustolibs-gluster/glustolibs/gluster/peer_ops.py')
| -rw-r--r-- | glustolibs-gluster/glustolibs/gluster/peer_ops.py | 424 |
1 files changed, 424 insertions, 0 deletions
diff --git a/glustolibs-gluster/glustolibs/gluster/peer_ops.py b/glustolibs-gluster/glustolibs/gluster/peer_ops.py new file mode 100644 index 000000000..9f74bb7c7 --- /dev/null +++ b/glustolibs-gluster/glustolibs/gluster/peer_ops.py @@ -0,0 +1,424 @@ +#!/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: Library for gluster peer operations. +""" + + +from glusto.core import Glusto as g +import re +import time +import socket +try: + import xml.etree.cElementTree as etree +except ImportError: + import xml.etree.ElementTree as etree + + +def peer_probe(mnode, server): + """Probe the specified server. + + Args: + mnode (str): Node on which command has to be executed. + server (str): Server to be peer probed. + + 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 peer probe %s" % server + return g.run(mnode, cmd) + + +def peer_detach(mnode, server, force=False): + """Detach the specified server. + + Args: + mnode (str): Node on which command has to be executed. + server (str): Server to be peer detached. + + Kwargs: + force (bool): option to detach peer. Defaults to False. + + 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. + """ + if force: + cmd = "gluster peer detach %s force" % server + else: + cmd = "gluster peer detach %s" % server + return g.run(mnode, cmd) + + +def peer_status(mnode): + """Runs 'gluster peer status' on specified node. + + Args: + mnode (str): Node on which command has 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 = "gluster peer status" + return g.run(mnode, cmd) + + +def pool_list(mnode): + """Runs 'gluster pool list' command on the specified node. + + Args: + mnode (str): Node on which command has 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 = "gluster pool list" + return g.run(mnode, cmd) + + +def peer_probe_servers(mnode, servers, validate=True, time_delay=10): + """Probe specified servers and validate whether probed servers + are in cluster and connected state if validate is set to True. + + Args: + mnode (str): Node on which command has to be executed. + servers (list): List of servers to be peer probed. + + Kwargs: + validate (bool): True to validate if probed peer is in cluster and + connected state. False otherwise. Defaults to True. + time_delay (int): time delay before validating peer status. + Defaults to 10 seconds. + + Returns: + bool: True on success and False on failure. + """ + if not isinstance(servers, list): + servers = [servers] + else: + servers = servers[:] + + if mnode in servers: + servers.remove(mnode) + + # Get list of nodes from 'gluster pool list' + nodes_in_pool_list = nodes_from_pool_list(mnode) + if nodes_in_pool_list is None: + g.log.error("Unable to get nodes from gluster pool list. " + "Failing peer probe.") + return False + + for server in servers: + if server not in nodes_in_pool_list: + ret, out, _ = peer_probe(mnode, server) + if (ret != 0 or + re.search(r'^peer\sprobe\:\ssuccess(.*)', out) is None): + g.log.error("Failed to peer probe the node '%s'.", server) + return False + else: + g.log.info("Successfully peer probed the node '%s'.", server) + + # Validating whether peer is in connected state after peer probe + if validate: + time.sleep(time_delay) + if not is_peer_connected(mnode, servers): + g.log.error("Validation after peer probe failed.") + return False + else: + g.log.info("Validation after peer probe is successful.") + + return True + + +def peer_detach_servers(mnode, servers, force=False, validate=True, + time_delay=10): + """Detach peers and validate status of peer if validate is set to True. + + Args: + mnode (str): Node on which command has to be executed. + servers (list): List of servers to be peer probed. + + Kwargs: + force (bool): option to detach peer. + Defaults to False. + validate (bool): True if status of the peer needs to be validated, + False otherwise. Defaults to True. + time_delay (int): time delay before executing validating peer. + status. Defaults to 10 seconds. + + Returns: + bool: True on success and False on failure. + """ + if not isinstance(servers, list): + servers = [servers] + else: + servers = servers[:] + + if mnode in servers: + servers.remove(mnode) + + for server in servers: + ret, out, _ = peer_detach(mnode, server, force) + if (ret != 0 or + re.search(r'^peer\sdetach\:\ssuccess(.*)', out) is None): + g.log.error("Failed to peer detach the node '%s'.", server) + return False + + # Validating whether peer detach is successful + if validate: + time.sleep(time_delay) + nodes_in_pool = nodes_from_pool_list(mnode) + rc = True + for server in servers: + if server in nodes_in_pool: + g.log.error("Peer '%s' still in pool" % server) + rc = False + if not rc: + g.log.error("Validation after peer detach failed.") + else: + g.log.info("Validation after peer detach is successful") + + return True + + +def nodes_from_pool_list(mnode): + """Return list of nodes from the 'gluster pool list'. + + Args: + mnode (str): Node on which command has to be executed. + + Returns: + NoneType: None if command execution fails. + list: List of nodes in pool on Success, Empty list on failure. + """ + pool_list_data = get_pool_list(mnode) + if pool_list_data is None: + g.log.error("Unable to get Nodes from the pool list command.") + return None + + nodes = [] + for item in pool_list_data: + nodes.append(item['hostname']) + return nodes + + +def get_peer_status(mnode): + """Parse the output of command 'gluster peer status'. + + Aargs: + mnode (str): Node on which command has to be executed. + + Returns: + NoneType: None if command execution fails or parse errors. + list: list of dicts on success. + + Examples: + >>> get_peer_status(mnode = 'abc.lab.eng.xyz.com') + [{'uuid': '77dc299a-32f7-43d8-9977-7345a344c398', + 'hostname': 'ijk.lab.eng.xyz.com', + 'state': '3', + 'hostnames' : ['ijk.lab.eng.xyz.com'], + 'connected': '1', + 'stateStr': 'Peer in Cluster'}, + + {'uuid': 'b15b8337-9f8e-4ec3-8bdb-200d6a67ae12', + 'hostname': 'def.lab.eng.xyz.com', + 'state': '3', + 'hostnames': ['def.lab.eng.xyz.com'], + 'connected': '1', + 'stateStr': 'Peer in Cluster'} + ] + """ + ret, out, _ = g.run(mnode, "gluster peer status --xml") + if ret != 0: + g.log.error("Failed to execute peer status command on node '%s'. " + "Hence failed to parse the peer status.", mnode) + return None + + try: + root = etree.XML(out) + except etree.ParseError: + g.log.error("Failed to parse the gluster peer status xml output.") + return None + + peer_status_list = [] + for peer in root.findall("peerStatus/peer"): + peer_dict = {} + for element in peer.getchildren(): + if element.tag == "hostnames": + hostnames_list = [] + for hostname in element.getchildren(): + hostnames_list.append(hostname.text) + element.text = hostnames_list + peer_dict[element.tag] = element.text + peer_status_list.append(peer_dict) + return peer_status_list + + +def get_pool_list(mnode): + """Parse the output of 'gluster pool list' command. + + Args: + mnode (str): Node on which command has to be executed. + + Returns: + NoneType: None if command execution fails, parse errors. + list: list of dicts on success. + + Examples: + >>> get_pool_list(mnode = 'abc.lab.eng.xyz.com') + [{'uuid': 'a2b88b10-eba2-4f97-add2-8dc37df08b27', + 'hostname': 'abc.lab.eng.xyz.com', + 'state': '3', + 'connected': '1', + 'stateStr': 'Peer in Cluster'}, + + {'uuid': 'b15b8337-9f8e-4ec3-8bdb-200d6a67ae12', + 'hostname': 'def.lab.eng.xyz.com', + 'state': '3', + 'hostnames': ['def.lab.eng.xyz.com'], + 'connected': '1', + 'stateStr': 'Peer in Cluster'} + ] + """ + ret, out, _ = g.run(mnode, "gluster pool list --xml") + if ret != 0: + g.log.error("Failed to execute 'pool list' on node %s. " + "Hence failed to parse the pool list.", mnode) + return None + + try: + root = etree.XML(out) + except etree.ParseError: + g.log.error("Failed to parse the gluster pool list xml output.") + return None + + pool_list_list = [] + for peer in root.findall("peerStatus/peer"): + peer_dict = {} + for element in peer.getchildren(): + if element.tag == "hostname" and element.text == 'localhost': + element.text = mnode + if element.tag == "hostnames": + hostnames_list = [] + for hostname in element.getchildren(): + hostnames_list.append(hostname.text) + element.text = hostnames_list + peer_dict[element.tag] = element.text + + pool_list_list.append(peer_dict) + return pool_list_list + + +def is_peer_connected(mnode, servers): + """Checks whether specified peers are in cluster and 'Connected' state. + + Args: + mnode (str): Node from which peer probe has to be executed. + servers (list): List of servers to be validated. + + Returns + bool : True on success (peer in cluster and connected), False on + failure. + """ + if not isinstance(servers, list): + servers = [servers] + else: + servers = servers[:] + + if mnode in servers: + servers.remove(mnode) + + peer_connected = True + peer_status_list = get_peer_status(mnode) + if peer_status_list is None: + g.log.error("Failed to parse the peer status. Hence failed to " + "validate the peer connected state.") + return False + if peer_status_list == []: + g.log.error("No peers present in the pool. Servers are not yet " + "connected.") + return False + + # Convert all hostnames to ip's + server_ips = [] + for server in servers: + server_ips.append(socket.gethostbyname(server)) + + is_connected = True + for peer_stat in peer_status_list: + if socket.gethostbyname(peer_stat['hostname']) in server_ips: + if (re.match(r'([0-9a-f]{8})(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}', + peer_stat['uuid'], re.I) is None): + g.log.error("Invalid UUID for the node '%s'", + peer_stat['hostname']) + is_connected = False + if (peer_stat['stateStr'] != "Peer in Cluster" or + peer_stat['connected'] != '1'): + g.log.error("Peer '%s' not in connected state", + peer_stat['hostname']) + is_connected = False + + if not is_connected: + return False + + peer_ips = [socket.gethostbyname(peer_stat['hostname']) for + peer_stat in peer_status_list] + if not (set(server_ips).issubset(peer_ips)): + servers_not_in_pool = list(set(server_ips).difference(peer_ips)) + for index, server in enumerate(servers_not_in_pool): + if not (server in servers): + servers_not_in_pool[index] = socket.gethostbyaddr(server)[0] + g.log.error("Servers: '%s' not yet added to the pool.", + servers_not_in_pool) + return False + + g.log.info("Servers: '%s' are all 'Peer in Cluster' and 'Connected' " + "state.", servers) + return True |