def _setup_ntp(self, server):
"""
Change the ntp configuration file to use the server passed.
If no server is passed then use the existing setting and if there is no existing setting ask the user
which server they would like to use.
Enable NTPConfig to recognise legacy line marker used in previous IML manager NTP configurations routines by
passing it as a parameter to the get_configured_server method call
"""
ntp = NTPConfig(logger=log)
existing_server = ntp.get_configured_server(
markers=["# Added by chroma-manager\n"])
if not server:
if existing_server:
server = existing_server
log.info("Using existing (chroma configured) ntp server: %s" %
existing_server)
else:
# Only if you haven't already set it
server = self.get_input(msg="NTP Server", default="localhost")
log.info("Writing ntp configuration: %s " % server)
error = ntp.add(server)
if error:
log.error(
"Failed to write ntp server (%s) to config file (%s), %s" %
(server, ntp.CONFIG_FILE, error))
raise RuntimeError("Failure when writing ntp config: %s" % error)
if ServiceControl.create("firewalld").running:
error = firewall_control.add_rule("123", "udp", "ntpd")
if error:
log.error("firewall command failed:\n%s" % error)
raise RuntimeError(
"Failure when opening port in firewall for ntpd: %s" %
error)
log.info("Disabling chrony if active")
chrony_service = ServiceControl.create("chronyd")
chrony_service.stop(validate_time=0.5)
chrony_service.disable()
log.info("Restarting ntp")
ntp_service = ServiceControl.create("ntpd")
ntp_service.enable()
error = ntp_service.restart()
if error:
log.error(error)
raise RuntimeError(error)
def configure_ntp(ntp_server):
"""
Change the ntp configuration file to use the server passed
:return: Value using simple return protocol
"""
error = NTPConfig().add(ntp_server)
if error:
return error
else:
return agent_ok_or_error(ntp_service.restart())
def configure_ntp(ntp_server):
"""
Change the ntp configuration file to use the server passed
:return: Value using simple return protocol
"""
error = NTPConfig().add(ntp_server)
if error:
return error
else:
chrony_service.stop(validate_time=0.5)
chrony_service.disable()
ntp_service.enable()
return agent_ok_or_error(ntp_service.restart())
def setUp(self):
super(TestNTPConfig, self).setUp()
self.ntp = NTPConfig()
# Static assignments for use in tests
self.existing_server = "iml.ntp.com"
self.existing_directive = self._directive(self.existing_server)
# Constants for retrieving from legacy IML config files
self.existing_directive_old = "server " + self.existing_server
self.manager_marker = "# Added by chroma-manager\n"
self.manager_comment = "# Commented out by chroma-manager: "
# each time we run _reset_and_read_conf, config file edits are removed and config reset
self.mock_open = mock.mock_open()
self.mock_open.return_value.readlines.return_value = self._get_lines(
"IML")
mock.patch("__builtin__.open", self.mock_open, create=True).start()
mock.patch.object(self.ntp, "_write_conf", return_value=None).start()
self.addCleanup(mock.patch.stopall)
class TestNTPConfig(unittest.TestCase):
""" Test class for NTPConfig """
def setUp(self):
super(TestNTPConfig, self).setUp()
self.ntp = NTPConfig()
# Static assignments for use in tests
self.existing_server = "iml.ntp.com"
self.existing_directive = self._directive(self.existing_server)
# Constants for retrieving from legacy IML config files
self.existing_directive_old = "server " + self.existing_server
self.manager_marker = "# Added by chroma-manager\n"
self.manager_comment = "# Commented out by chroma-manager: "
# each time we run _reset_and_read_conf, config file edits are removed and config reset
self.mock_open = mock.mock_open()
self.mock_open.return_value.readlines.return_value = self._get_lines(
"IML")
mock.patch("__builtin__.open", self.mock_open, create=True).start()
mock.patch.object(self.ntp, "_write_conf", return_value=None).start()
self.addCleanup(mock.patch.stopall)
@staticmethod
def _directive(hostname):
""" helper method to return config file server directive """
return "server {0} iburst".format(hostname)
def _get_lines(self, variant):
lines = {
"no-servers": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
"#server 0.centos.pool.ntp.org iburst\n",
"#server 1.centos.pool.ntp.org iburst\n",
"#server 2.centos.pool.ntp.org iburst\n",
"#server 3.centos.pool.ntp.org iburst\n",
"\n",
],
"pre-IML": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
"server 0.centos.pool.ntp.org iburst\n",
"server 1.centos.pool.ntp.org iburst\n",
"server 2.centos.pool.ntp.org iburst\n",
"server 3.centos.pool.ntp.org iburst\n",
"\n",
],
"IML": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
"{0} {1} server 0.centos.pool.ntp.org iburst\n".format(
self.existing_directive, self.ntp.MARKER),
"{0} server 1.centos.pool.ntp.org iburst\n".format(
self.ntp.MARKER),
"{0} server 2.centos.pool.ntp.org iburst\n".format(
self.ntp.MARKER),
"{0} server 3.centos.pool.ntp.org iburst\n".format(
self.ntp.MARKER),
"\n",
],
"IML-append": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
"#server 0.centos.pool.ntp.org iburst\n",
"#server 1.centos.pool.ntp.org iburst\n",
"#server 2.centos.pool.ntp.org iburst\n",
"#server 3.centos.pool.ntp.org iburst\n",
"\n",
"{0} {1} \n".format(self.existing_directive, self.ntp.MARKER),
],
"local-ip-insert": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
"server 127.127.1.0 {0}\n".format(self.ntp.MARKER),
"fudge 127.127.1.0 stratum 10 {0} server 0.centos.pool.ntp.org iburst\n"
.format(self.ntp.MARKER),
"{0} server 1.centos.pool.ntp.org iburst\n".format(
self.ntp.MARKER),
"{0} server 2.centos.pool.ntp.org iburst\n".format(
self.ntp.MARKER),
"{0} server 3.centos.pool.ntp.org iburst\n".format(
self.ntp.MARKER),
"\n",
],
"local-ip-append": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
"#server 0.centos.pool.ntp.org iburst\n",
"#server 1.centos.pool.ntp.org iburst\n",
"#server 2.centos.pool.ntp.org iburst\n",
"#server 3.centos.pool.ntp.org iburst\n",
"\n",
"server 127.127.1.0 {0}\n".format(self.ntp.MARKER),
"fudge 127.127.1.0 stratum 10 {0} \n".format(
self.ntp.MARKER),
],
"IML-manager-old": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
self.manager_marker,
self.existing_directive_old,
self.manager_marker,
"{0}server 0.centos.pool.ntp.org iburst\n".format(
self.manager_comment),
"{0}server 1.centos.pool.ntp.org iburst\n".format(
self.manager_comment),
"{0}server 2.centos.pool.ntp.org iburst\n".format(
self.manager_comment),
"{0}server 3.centos.pool.ntp.org iburst\n".format(
self.manager_comment),
"\n",
],
"local-ip-insert-manager-old": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
"#server 0.centos.pool.ntp.org iburst\n",
"#server 1.centos.pool.ntp.org iburst\n",
"#server 2.centos.pool.ntp.org iburst\n",
"#server 3.centos.pool.ntp.org iburst\n",
"#fudge \n",
self.manager_marker,
"server 127.127.1.0 # local clock\n",
"fudge 127.127.1.0 stratum 10\n",
self.manager_marker,
"\n",
],
"local-ip-append-manager-old": [
"# Use public servers from the pool.ntp.org project.\n",
"# Please consider joining the pool (http://www.pool.ntp.org/join.html).\n",
self.manager_marker,
"server 127.127.1.0 # local clock\n",
"fudge 127.127.1.0 stratum 10\n",
self.manager_marker,
"# Enable public key cryptography.",
"\n",
],
}
return lines[variant]
def test_get_server(self):
"""
test fetching server hostname from ntp config,
test possible sentinel and comment strings in config for backward compatibility
because get_configured_server() doesn't use _{read|write}_conf as add() does,
we need to mock open explicitly and make the return file object return a specific
list of strings on readlines() call
"""
server = self.ntp.get_configured_server(markers=None)
self.assertEqual(server, self.existing_server)
# now test with config with appended server directive
self.mock_open.return_value.readlines.return_value = self._get_lines(
"IML-append")
server = self.ntp.get_configured_server(markers=None)
self.assertEqual(server, self.existing_server)
# now test with old style config syntax for compatibility with legacy IML config files
self.mock_open.return_value.readlines.return_value = self._get_lines(
"IML-manager-old")
server = self.ntp.get_configured_server(markers=[self.manager_marker])
self.assertEqual(server, self.existing_server)
def test_get_server_localhost(self):
"""
test fetching server when specified as localhost in ntp config
test possible sentinel and comment strings in config for backward compatibility
because get_configured_server() doesn't use _{read|write}_conf as add() does,
we need to mock open explicitly and make the return file object return a specific
list of strings on readlines() call
"""
self.mock_open.return_value.readlines.return_value = self._get_lines(
"local-ip-insert")
server = self.ntp.get_configured_server(markers=None)
self.assertEqual(server, "localhost")
self.mock_open.return_value.readlines.return_value = self._get_lines(
"local-ip-insert-manager-old")
server = self.ntp.get_configured_server(markers=[self.manager_marker])
self.assertEqual(server, "localhost")
self.mock_open.return_value.readlines.return_value = self._get_lines(
"local-ip-append")
server = self.ntp.get_configured_server(markers=None)
self.assertEqual(server, "localhost")
self.mock_open.return_value.readlines.return_value = self._get_lines(
"local-ip-append-manager-old")
server = self.ntp.get_configured_server(markers=[self.manager_marker])
self.assertEqual(server, "localhost")
def test_get_server_from_empty_config(self):
"""
test fetching server from ntp config with no active entry
test possible sentinel and comment strings in config for backward compatibility
because get_configured_server() doesn't use _{read|write}_conf as add() does,
we need to mock open explicitly and make the return file object return a specific
list of strings on readlines() call
"""
self.mock_open.return_value.readlines.return_value = self._get_lines(
"pre-IML")
server = self.ntp.get_configured_server(markers=None)
self.assertEqual(server, None)
server = self.ntp.get_configured_server(markers=[self.manager_marker])
self.assertEqual(server, None)
def test_add_remove_configured(self):
""" test adding to un-configured content and then removing IML configurations """
self.mock_open.return_value.readlines.return_value = self._get_lines(
"pre-IML")
# add desired line to config
error = self.ntp.add(self.existing_server)
self.assertEqual(error, None)
self.assertListEqual(self.ntp.lines, self._get_lines("IML"))
# remove any IML configuration
error = self.ntp.add(None)
self.assertEqual(error, None)
self.assertListEqual(self.ntp.lines, self._get_lines("pre-IML"))
def test_add_remove_append_configured(self):
"""
test adding and then removing IML configuration from ntp config content with commented server directives
by removing previous configuration
"""
self.mock_open.return_value.readlines.return_value = self._get_lines(
"no-servers")
# add desired line to config
error = self.ntp.add(self.existing_server)
self.assertEqual(error, None)
self.assertListEqual(self.ntp.lines, self._get_lines("IML-append"))
# remove any IML configuration
error = self.ntp.add(None)
self.assertEqual(error, None)
self.assertListEqual(self.ntp.lines, self._get_lines("no-servers"))
def test_add_localhost(self):
"""
test adding localhost to ntp config content
if server directives exist, replace the first one with local clock fudge,
if no server directives exist, append local clock fudge to end of file
"""
self.mock_open.return_value.readlines.return_value = self._get_lines(
"pre-IML")
self.ntp.add("localhost")
self.assertListEqual(self.ntp.lines,
self._get_lines("local-ip-insert"))
def test_add_localhost_empty_config(self):
"""
test adding localhost to ntp config content with no active server directives
IP address and local clock 'fudge' directives should be appended when applying localhost
"""
self.mock_open.return_value.readlines.return_value = self._get_lines(
"no-servers")
self.ntp.add("localhost")
self.assertListEqual(self.ntp.lines,
self._get_lines("local-ip-append"))
def test_add_and_reset_IML_edits(self):
"""
test resetting previous IML edits in config file contents then adding again
"""
for lines_out, lines_in, server in [
("IML", "pre-IML", self.existing_server),
("IML-append", "no-servers", self.existing_server),
("local-ip-insert", "pre-IML", "localhost"),
("local-ip-append", "no-servers", "localhost"),
]:
self.mock_open.return_value.readlines.return_value = self._get_lines(
lines_in)
self.ntp.add(server)
self.assertListEqual(self.ntp.lines, self._get_lines(lines_out))
self.mock_open.return_value.readlines.return_value = self._get_lines(
lines_out)
self.ntp.add(None)
self.assertListEqual(self.ntp.lines, self._get_lines(lines_in))
