fuel-qa/fuelweb_test/helpers/ntp.py

246 lines
8.5 KiB
Python

# Copyright 2015 Mirantis, Inc.
#
# 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.
import time
from devops.error import TimeoutError
from devops.helpers.helpers import wait
from proboscis.asserts import assert_true
from fuelweb_test import logger
from fuelweb_test import logwrap
class GroupNtpSync(object):
"""Synchronize a group of nodes."""
def __init__(self, env=None, sync_admin_node=False, nailgun_nodes=None):
""" env - EnvironmentModel, to create remote connections
sync_admin_node - bool, should the Fuel admin node be synchronized?
nailgun_nodes - list of Nailgun node objects
"""
if not env:
raise Exception("'env' is not set, failed to initialize"
" connections to {0}".format(nailgun_nodes))
self.ntps = []
if sync_admin_node:
# Add a 'Ntp' instance with connection to Fuel admin node
self.ntps.append(
Ntp.get_ntp(env.d_env.get_admin_remote(), 'admin'))
if nailgun_nodes:
# 1. Create a list of 'Ntp' connections to the nodes
self.ntps.extend([
Ntp.get_ntp(env.d_env.get_ssh_to_remote(node['ip']),
'node-{0}'.format(node['id']),
env.get_admin_node_ip())
for node in nailgun_nodes])
def __enter__(self):
return self
def __exit__(self, exp_type, exp_value, traceback):
[ntp.remote.clear() for ntp in self.ntps]
@property
def is_synchronized(self):
return all([ntp.is_synchronized for ntp in self.ntps])
@property
def is_connected(self):
return all([ntp.is_connected for ntp in self.ntps])
def report_not_synchronized(self):
return [(ntp.node_name, ntp.date())
for ntp in self.ntps if not ntp.is_synchronized]
def report_not_connected(self):
return [(ntp.node_name, ntp.peers)
for ntp in self.ntps if not ntp.is_connected]
def do_sync_time(self, ntps=None):
# 0. 'ntps' can be filled by __init__() or outside the class
self.ntps = ntps or self.ntps
if not self.ntps:
raise ValueError("No servers were provided to synchronize "
"the time in self.ntps")
# 1. Set actual time on all nodes via 'ntpdate'
[ntp.set_actual_time() for ntp in self.ntps]
assert_true(self.is_synchronized, "Time on nodes was not set:"
" \n{0}".format(self.report_not_synchronized()))
# 2. Restart NTPD service
[ntp.stop() for ntp in self.ntps]
[ntp.start() for ntp in self.ntps]
# 3. Wait for established peers
[ntp.wait_peer() for ntp in self.ntps]
assert_true(self.is_connected, "Time on nodes was not synchronized:"
" \n{0}".format(self.report_not_connected()))
# 4. Report time on nodes
for ntp in self.ntps:
logger.info("Time on '{0}' = {1}".format(ntp.node_name,
ntp.date()[0].rstrip()))
class Ntp(object):
"""Common methods to work with ntpd service."""
def __repr__(self):
klass, obj_id = type(self), hex(id(self))
admin_ip = getattr(self, 'admin_ip', None)
node_name = getattr(self, 'node_name', None)
is_sync = getattr(self, 'is_synchronized', None)
is_conn = getattr(self, 'is_connected', None)
return ("[{klass}({obj_id}) admin_ip:{admin_ip}, "
"node_name:{node_name}, sync:{is_sync}, "
"conn:{is_conn}]").format(klass=klass,
obj_id=obj_id,
admin_ip=admin_ip,
node_name=node_name,
is_sync=is_sync,
is_conn=is_conn)
@staticmethod
@logwrap
def get_ntp(remote, node_name='node', admin_ip=None):
# Detect how NTPD is managed - by init script or by pacemaker.
cmd = "ps -C pacemakerd && crm_resource --resource p_ntp --locate"
if remote.execute(cmd)['exit_code'] == 0:
# Pacemaker service found
cls = NtpPacemaker()
else:
# Pacemaker not found, using native ntpd
cls = NtpInitscript()
cls.is_synchronized = False
cls.is_connected = False
cls.remote = remote
cls.node_name = node_name
cls.peers = []
# Get IP of a server from which the time will be syncronized.
cmd = "awk '/^server/ && $2 !~ /127.*/ {print $2}' /etc/ntp.conf"
cls.server = remote.execute(cmd)['stdout'][0]
cmd = "find /etc/init.d/ -regex '/etc/init.d/ntp.?'"
cls.service = remote.execute(cmd)['stdout'][0].strip()
# Speedup time synchronization for slaves that use admin node as a peer
if admin_ip:
cmd = ("sed -i 's/^server {0} .*/server {0} minpoll 3 maxpoll 5 "
"ibrust/' /etc/ntp.conf".format(admin_ip))
remote.execute(cmd)
return cls
@logwrap
def set_actual_time(self, timeout=600):
# Waiting for parent server until it starts providing the time
cmd = "ntpdate -p 4 -t 0.2 -bu {0}".format(self.server)
self.is_synchronized = False
try:
wait(lambda: not self.remote.execute(cmd)['exit_code'], timeout)
self.remote.execute('hwclock -w')
self.is_synchronized = True
except TimeoutError:
pass
return self.is_synchronized
@logwrap
def wait_peer(self, interval=8, timeout=600):
self.is_connected = False
start_time = time.time()
while start_time + timeout > time.time():
# peer = `ntpq -pn 127.0.0.1`
self.peers = self.get_peers()[2:] # skip the header
logger.debug("Node: {0}, ntpd peers: {1}".format(
self.node_name, self.peers))
for peer in self.peers:
p = peer.split()
remote = str(p[0])
reach = int(p[6], 8) # From octal to int
offset = float(p[8])
jitter = float(p[9])
# 1. offset and jitter should not be higher than 500
# Otherwise, time should be re-set.
if (abs(offset) > 500) or (abs(jitter) > 500):
return self.is_connected
# 2. remote should be marked whith tally '*'
if remote[0] != '*':
continue
# 3. reachability bit array should have '1' at least in
# two lower bits as the last two sussesful checks
if reach & 3 == 3:
self.is_connected = True
return self.is_connected
time.sleep(interval)
return self.is_connected
def date(self):
return self.remote.execute("date")['stdout']
class NtpInitscript(Ntp):
"""NtpInitscript.""" # TODO documentation
@logwrap
def start(self):
self.is_connected = False
self.remote.execute("{0} start".format(self.service))
@logwrap
def stop(self):
self.is_connected = False
self.remote.execute("{0} stop".format(self.service))
@logwrap
def get_peers(self):
return self.remote.execute('ntpq -pn 127.0.0.1')['stdout']
class NtpPacemaker(Ntp):
"""NtpPacemaker.""" # TODO documentation
@logwrap
def start(self):
self.is_connected = False
# Temporary workaround of the LP bug #1441121
self.remote.execute('ip netns exec vrouter ip l set dev lo up')
self.remote.execute('crm resource start p_ntp')
@logwrap
def stop(self):
self.is_connected = False
self.remote.execute('crm resource stop p_ntp; killall ntpd')
@logwrap
def get_peers(self):
return self.remote.execute(
'ip netns exec vrouter ntpq -pn 127.0.0.1')['stdout']