""" :codeauthor: Mike Place """ import copy import logging import os import salt.ext.tornado import salt.ext.tornado.testing import salt.minion import salt.syspaths import salt.utils.crypt import salt.utils.event as event import salt.utils.platform import salt.utils.process from salt._compat import ipaddress from salt.exceptions import SaltClientError, SaltMasterUnresolvableError, SaltSystemExit from salt.ext.six.moves import range from tests.support.helpers import skip_if_not_root, slowTest from tests.support.mixins import AdaptedConfigurationTestCaseMixin from tests.support.mock import MagicMock, patch from tests.support.unit import TestCase, skipIf log = logging.getLogger(__name__) class MinionTestCase(TestCase, AdaptedConfigurationTestCaseMixin): def setUp(self): self.opts = {} self.addCleanup(delattr, self, "opts") def test_invalid_master_address(self): with patch.dict( self.opts, { "ipv6": False, "master": float("127.0"), "master_port": "4555", "retry_dns": False, }, ): self.assertRaises(SaltSystemExit, salt.minion.resolve_dns, self.opts) def test_source_int_name_local(self): """ test when file_client local and source_interface_name is set """ interfaces = { "bond0.1234": { "hwaddr": "01:01:01:d0:d0:d0", "up": True, "inet": [ { "broadcast": "111.1.111.255", "netmask": "111.1.0.0", "label": "bond0", "address": "111.1.0.1", } ], } } with patch.dict( self.opts, { "ipv6": False, "master": "127.0.0.1", "master_port": "4555", "file_client": "local", "source_interface_name": "bond0.1234", "source_ret_port": 49017, "source_publish_port": 49018, }, ), patch("salt.utils.network.interfaces", MagicMock(return_value=interfaces)): assert salt.minion.resolve_dns(self.opts) == { "master_ip": "127.0.0.1", "source_ip": "111.1.0.1", "source_ret_port": 49017, "source_publish_port": 49018, "master_uri": "tcp://127.0.0.1:4555", } @slowTest def test_source_int_name_remote(self): """ test when file_client remote and source_interface_name is set and interface is down """ interfaces = { "bond0.1234": { "hwaddr": "01:01:01:d0:d0:d0", "up": False, "inet": [ { "broadcast": "111.1.111.255", "netmask": "111.1.0.0", "label": "bond0", "address": "111.1.0.1", } ], } } with patch.dict( self.opts, { "ipv6": False, "master": "127.0.0.1", "master_port": "4555", "file_client": "remote", "source_interface_name": "bond0.1234", "source_ret_port": 49017, "source_publish_port": 49018, }, ), patch("salt.utils.network.interfaces", MagicMock(return_value=interfaces)): assert salt.minion.resolve_dns(self.opts) == { "master_ip": "127.0.0.1", "source_ret_port": 49017, "source_publish_port": 49018, "master_uri": "tcp://127.0.0.1:4555", } @slowTest def test_source_address(self): """ test when source_address is set """ interfaces = { "bond0.1234": { "hwaddr": "01:01:01:d0:d0:d0", "up": False, "inet": [ { "broadcast": "111.1.111.255", "netmask": "111.1.0.0", "label": "bond0", "address": "111.1.0.1", } ], } } with patch.dict( self.opts, { "ipv6": False, "master": "127.0.0.1", "master_port": "4555", "file_client": "local", "source_interface_name": "", "source_address": "111.1.0.1", "source_ret_port": 49017, "source_publish_port": 49018, }, ), patch("salt.utils.network.interfaces", MagicMock(return_value=interfaces)): assert salt.minion.resolve_dns(self.opts) == { "source_publish_port": 49018, "source_ret_port": 49017, "master_uri": "tcp://127.0.0.1:4555", "source_ip": "111.1.0.1", "master_ip": "127.0.0.1", } # Tests for _handle_decoded_payload in the salt.minion.Minion() class: 3 @slowTest def test_handle_decoded_payload_jid_match_in_jid_queue(self): """ Tests that the _handle_decoded_payload function returns when a jid is given that is already present in the jid_queue. Note: This test doesn't contain all of the patch decorators above the function like the other tests for _handle_decoded_payload below. This is essential to this test as the call to the function must return None BEFORE any of the processes are spun up because we should be avoiding firing duplicate jobs. """ mock_opts = salt.config.DEFAULT_MINION_OPTS.copy() mock_data = {"fun": "foo.bar", "jid": 123} mock_jid_queue = [123] minion = salt.minion.Minion( mock_opts, jid_queue=copy.copy(mock_jid_queue), io_loop=salt.ext.tornado.ioloop.IOLoop(), ) try: ret = minion._handle_decoded_payload(mock_data).result() self.assertEqual(minion.jid_queue, mock_jid_queue) self.assertIsNone(ret) finally: minion.destroy() @slowTest def test_handle_decoded_payload_jid_queue_addition(self): """ Tests that the _handle_decoded_payload function adds a jid to the minion's jid_queue when the new jid isn't already present in the jid_queue. """ with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.utils.process.SignalHandlingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingProcess.join", MagicMock(return_value=True), ): mock_jid = 11111 mock_opts = salt.config.DEFAULT_MINION_OPTS.copy() mock_data = {"fun": "foo.bar", "jid": mock_jid} mock_jid_queue = [123, 456] minion = salt.minion.Minion( mock_opts, jid_queue=copy.copy(mock_jid_queue), io_loop=salt.ext.tornado.ioloop.IOLoop(), ) try: # Assert that the minion's jid_queue attribute matches the mock_jid_queue as a baseline # This can help debug any test failures if the _handle_decoded_payload call fails. self.assertEqual(minion.jid_queue, mock_jid_queue) # Call the _handle_decoded_payload function and update the mock_jid_queue to include the new # mock_jid. The mock_jid should have been added to the jid_queue since the mock_jid wasn't # previously included. The minion's jid_queue attribute and the mock_jid_queue should be equal. minion._handle_decoded_payload(mock_data).result() mock_jid_queue.append(mock_jid) self.assertEqual(minion.jid_queue, mock_jid_queue) finally: minion.destroy() @slowTest def test_handle_decoded_payload_jid_queue_reduced_minion_jid_queue_hwm(self): """ Tests that the _handle_decoded_payload function removes a jid from the minion's jid_queue when the minion's jid_queue high water mark (minion_jid_queue_hwm) is hit. """ with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.utils.process.SignalHandlingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingProcess.join", MagicMock(return_value=True), ): mock_opts = salt.config.DEFAULT_MINION_OPTS.copy() mock_opts["minion_jid_queue_hwm"] = 2 mock_data = {"fun": "foo.bar", "jid": 789} mock_jid_queue = [123, 456] minion = salt.minion.Minion( mock_opts, jid_queue=copy.copy(mock_jid_queue), io_loop=salt.ext.tornado.ioloop.IOLoop(), ) try: # Assert that the minion's jid_queue attribute matches the mock_jid_queue as a baseline # This can help debug any test failures if the _handle_decoded_payload call fails. self.assertEqual(minion.jid_queue, mock_jid_queue) # Call the _handle_decoded_payload function and check that the queue is smaller by one item # and contains the new jid minion._handle_decoded_payload(mock_data).result() self.assertEqual(len(minion.jid_queue), 2) self.assertEqual(minion.jid_queue, [456, 789]) finally: minion.destroy() @slowTest def test_process_count_max(self): """ Tests that the _handle_decoded_payload function does not spawn more than the configured amount of processes, as per process_count_max. """ with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.utils.process.SignalHandlingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingProcess.join", MagicMock(return_value=True), ), patch( "salt.utils.minion.running", MagicMock(return_value=[]) ), patch( "salt.ext.tornado.gen.sleep", MagicMock(return_value=salt.ext.tornado.concurrent.Future()), ): process_count_max = 10 mock_opts = salt.config.DEFAULT_MINION_OPTS.copy() mock_opts["__role"] = "minion" mock_opts["minion_jid_queue_hwm"] = 100 mock_opts["process_count_max"] = process_count_max io_loop = salt.ext.tornado.ioloop.IOLoop() minion = salt.minion.Minion(mock_opts, jid_queue=[], io_loop=io_loop) try: # mock gen.sleep to throw a special Exception when called, so that we detect it class SleepCalledException(Exception): """Thrown when sleep is called""" salt.ext.tornado.gen.sleep.return_value.set_exception( SleepCalledException() ) # up until process_count_max: gen.sleep does not get called, processes are started normally for i in range(process_count_max): mock_data = {"fun": "foo.bar", "jid": i} io_loop.run_sync( lambda data=mock_data: minion._handle_decoded_payload(data) ) self.assertEqual( salt.utils.process.SignalHandlingProcess.start.call_count, i + 1 ) self.assertEqual(len(minion.jid_queue), i + 1) salt.utils.minion.running.return_value += [i] # above process_count_max: gen.sleep does get called, JIDs are created but no new processes are started mock_data = {"fun": "foo.bar", "jid": process_count_max + 1} self.assertRaises( SleepCalledException, lambda: io_loop.run_sync( lambda: minion._handle_decoded_payload(mock_data) ), ) self.assertEqual( salt.utils.process.SignalHandlingProcess.start.call_count, process_count_max, ) self.assertEqual(len(minion.jid_queue), process_count_max + 1) finally: minion.destroy() @slowTest def test_beacons_before_connect(self): """ Tests that the 'beacons_before_connect' option causes the beacons to be initialized before connect. """ with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.minion.Minion.sync_connect_master", MagicMock(side_effect=RuntimeError("stop execution")), ), patch( "salt.utils.process.SignalHandlingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingProcess.join", MagicMock(return_value=True), ): mock_opts = self.get_config("minion", from_scratch=True) mock_opts["beacons_before_connect"] = True io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) try: try: minion.tune_in(start=True) except RuntimeError: pass # Make sure beacons are initialized but the sheduler is not self.assertTrue("beacons" in minion.periodic_callbacks) self.assertTrue("schedule" not in minion.periodic_callbacks) finally: minion.destroy() @slowTest def test_scheduler_before_connect(self): """ Tests that the 'scheduler_before_connect' option causes the scheduler to be initialized before connect. """ with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.minion.Minion.sync_connect_master", MagicMock(side_effect=RuntimeError("stop execution")), ), patch( "salt.utils.process.SignalHandlingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingProcess.join", MagicMock(return_value=True), ): mock_opts = self.get_config("minion", from_scratch=True) mock_opts["scheduler_before_connect"] = True io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) try: try: minion.tune_in(start=True) except RuntimeError: pass # Make sure the scheduler is initialized but the beacons are not self.assertTrue("schedule" in minion.periodic_callbacks) self.assertTrue("beacons" not in minion.periodic_callbacks) finally: minion.destroy() @slowTest def test_when_ping_interval_is_set_the_callback_should_be_added_to_periodic_callbacks( self, ): with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.minion.Minion.sync_connect_master", MagicMock(side_effect=RuntimeError("stop execution")), ), patch( "salt.utils.process.SignalHandlingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingProcess.join", MagicMock(return_value=True), ): mock_opts = self.get_config("minion", from_scratch=True) mock_opts["ping_interval"] = 10 io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) try: try: minion.connected = MagicMock(side_effect=(False, True)) minion._fire_master_minion_start = MagicMock() minion.tune_in(start=False) except RuntimeError: pass # Make sure the scheduler is initialized but the beacons are not self.assertTrue("ping" in minion.periodic_callbacks) finally: minion.destroy() @slowTest def test_when_passed_start_event_grains(self): mock_opts = self.get_config("minion", from_scratch=True) # provide mock opts an os grain since we'll look for it later. mock_opts["grains"]["os"] = "linux" mock_opts["start_event_grains"] = ["os"] io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) try: minion.tok = MagicMock() minion._send_req_sync = MagicMock() minion._fire_master( "Minion has started", "minion_start", include_startup_grains=True ) load = minion._send_req_sync.call_args[0][0] self.assertTrue("grains" in load) self.assertTrue("os" in load["grains"]) finally: minion.destroy() @slowTest def test_when_not_passed_start_event_grains(self): mock_opts = self.get_config("minion", from_scratch=True) io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) try: minion.tok = MagicMock() minion._send_req_sync = MagicMock() minion._fire_master("Minion has started", "minion_start") load = minion._send_req_sync.call_args[0][0] self.assertTrue("grains" not in load) finally: minion.destroy() @slowTest def test_when_other_events_fired_and_start_event_grains_are_set(self): mock_opts = self.get_config("minion", from_scratch=True) mock_opts["start_event_grains"] = ["os"] io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) try: minion.tok = MagicMock() minion._send_req_sync = MagicMock() minion._fire_master("Custm_event_fired", "custom_event") load = minion._send_req_sync.call_args[0][0] self.assertTrue("grains" not in load) finally: minion.destroy() @slowTest def test_minion_retry_dns_count(self): """ Tests that the resolve_dns will retry dns look ups for a maximum of 3 times before raising a SaltMasterUnresolvableError exception. """ with patch.dict( self.opts, { "ipv6": False, "master": "dummy", "master_port": "4555", "retry_dns": 1, "retry_dns_count": 3, }, ): self.assertRaises( SaltMasterUnresolvableError, salt.minion.resolve_dns, self.opts ) @slowTest def test_gen_modules_executors(self): """ Ensure gen_modules is called with the correct arguments #54429 """ mock_opts = self.get_config("minion", from_scratch=True) io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) class MockPillarCompiler: def compile_pillar(self): return {} try: with patch("salt.pillar.get_pillar", return_value=MockPillarCompiler()): with patch("salt.loader.executors") as execmock: minion.gen_modules() assert execmock.called_with(minion.opts, minion.functions) finally: minion.destroy() @patch("salt.utils.process.default_signals") @slowTest def test_reinit_crypto_on_fork(self, def_mock): """ Ensure salt.utils.crypt.reinit_crypto() is executed when forking for new job """ mock_opts = self.get_config("minion", from_scratch=True) mock_opts["multiprocessing"] = True io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() minion = salt.minion.Minion(mock_opts, io_loop=io_loop) job_data = {"jid": "test-jid", "fun": "test.ping"} def mock_start(self): # pylint: disable=comparison-with-callable assert ( len( [ x for x in self._after_fork_methods if x[0] == salt.utils.crypt.reinit_crypto ] ) == 1 ) # pylint: enable=comparison-with-callable with patch.object( salt.utils.process.SignalHandlingProcess, "start", mock_start ): io_loop.run_sync(lambda: minion._handle_decoded_payload(job_data)) def test_minion_manage_schedule(self): """ Tests that the manage_schedule will call the add function, adding schedule data into opts. """ with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.minion.Minion.sync_connect_master", MagicMock(side_effect=RuntimeError("stop execution")), ), patch( "salt.utils.process.SignalHandlingMultiprocessingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingMultiprocessingProcess.join", MagicMock(return_value=True), ): mock_opts = self.get_config("minion", from_scratch=True) io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() with patch( "salt.utils.schedule.clean_proc_dir", MagicMock(return_value=None) ): mock_functions = {"test.ping": None} minion = salt.minion.Minion(mock_opts, io_loop=io_loop) minion.schedule = salt.utils.schedule.Schedule( mock_opts, mock_functions, returners={} ) schedule_data = { "test_job": { "function": "test.ping", "return_job": False, "jid_include": True, "maxrunning": 2, "seconds": 10, } } data = {"name": "test-item", "schedule": schedule_data, "func": "add"} tag = "manage_schedule" minion.manage_schedule(tag, data) self.assertIn("test_job", minion.opts["schedule"]) def test_minion_manage_beacons(self): """ Tests that the manage_beacons will call the add function, adding beacon data into opts. """ with patch("salt.minion.Minion.ctx", MagicMock(return_value={})), patch( "salt.minion.Minion.sync_connect_master", MagicMock(side_effect=RuntimeError("stop execution")), ), patch( "salt.utils.process.SignalHandlingMultiprocessingProcess.start", MagicMock(return_value=True), ), patch( "salt.utils.process.SignalHandlingMultiprocessingProcess.join", MagicMock(return_value=True), ): mock_opts = self.get_config("minion", from_scratch=True) io_loop = salt.ext.tornado.ioloop.IOLoop() io_loop.make_current() mock_functions = {"test.ping": None} minion = salt.minion.Minion(mock_opts, io_loop=io_loop) minion.beacons = salt.beacons.Beacon(mock_opts, mock_functions) bdata = [{"salt-master": "stopped"}, {"apache2": "stopped"}] data = {"name": "ps", "beacon_data": bdata, "func": "add"} tag = "manage_beacons" minion.manage_beacons(tag, data) self.assertIn("ps", minion.opts["beacons"]) self.assertEqual(minion.opts["beacons"]["ps"], bdata) def test_prep_ip_port(self): _ip = ipaddress.ip_address opts = {"master": "10.10.0.3", "master_uri_format": "ip_only"} ret = salt.minion.prep_ip_port(opts) self.assertEqual(ret, {"master": _ip("10.10.0.3")}) opts = { "master": "10.10.0.3", "master_port": 1234, "master_uri_format": "default", } ret = salt.minion.prep_ip_port(opts) self.assertEqual(ret, {"master": "10.10.0.3"}) opts = {"master": "10.10.0.3:1234", "master_uri_format": "default"} ret = salt.minion.prep_ip_port(opts) self.assertEqual(ret, {"master": "10.10.0.3", "master_port": 1234}) opts = {"master": "host name", "master_uri_format": "default"} self.assertRaises(SaltClientError, salt.minion.prep_ip_port, opts) opts = {"master": "10.10.0.3:abcd", "master_uri_format": "default"} self.assertRaises(SaltClientError, salt.minion.prep_ip_port, opts) opts = {"master": "10.10.0.3::1234", "master_uri_format": "default"} self.assertRaises(SaltClientError, salt.minion.prep_ip_port, opts) class MinionAsyncTestCase( TestCase, AdaptedConfigurationTestCaseMixin, salt.ext.tornado.testing.AsyncTestCase ): def setUp(self): super().setUp() self.opts = {} self.addCleanup(delattr, self, "opts") @skip_if_not_root def test_sock_path_len(self): """ This tests whether or not a larger hash causes the sock path to exceed the system's max sock path length. See the below link for more information. https://github.com/saltstack/salt/issues/12172#issuecomment-43903643 """ opts = { "id": "salt-testing", "hash_type": "sha512", "sock_dir": os.path.join(salt.syspaths.SOCK_DIR, "minion"), "extension_modules": "", } with patch.dict(self.opts, opts): try: event_publisher = event.AsyncEventPublisher(self.opts) result = True except ValueError: # There are rare cases where we operate a closed socket, especially in containers. # In this case, don't fail the test because we'll catch it down the road. result = True except SaltSystemExit: result = False self.assertTrue(result) @salt.ext.tornado.testing.gen_test @skipIf( salt.utils.platform.is_windows(), "Skipping, no Salt master running on Windows." ) def test_master_type_failover(self): """ Tests master_type "failover" to not fall back to 127.0.0.1 address when master does not resolve in DNS """ mock_opts = salt.config.DEFAULT_MINION_OPTS.copy() mock_opts.update( { "master_type": "failover", "master": ["master1", "master2"], "__role": "", "retry_dns": 0, } ) class MockPubChannel: def connect(self): raise SaltClientError("MockedChannel") def close(self): return def mock_resolve_dns(opts, fallback=False): self.assertFalse(fallback) if opts["master"] == "master1": raise SaltClientError("Cannot resolve {}".format(opts["master"])) return { "master_ip": "192.168.2.1", "master_uri": "tcp://192.168.2.1:4505", } def mock_transport_factory(opts, **kwargs): self.assertEqual(opts["master"], "master2") return MockPubChannel() with patch("salt.minion.resolve_dns", mock_resolve_dns), patch( "salt.transport.client.AsyncPubChannel.factory", mock_transport_factory ), patch("salt.loader.grains", MagicMock(return_value=[])): with self.assertRaises(SaltClientError, msg="MockedChannel"): minion = salt.minion.Minion(mock_opts) yield minion.connect_master() @salt.ext.tornado.testing.gen_test def test_master_type_failover_no_masters(self): """ Tests master_type "failover" to not fall back to 127.0.0.1 address when no master can be resolved """ mock_opts = salt.config.DEFAULT_MINION_OPTS.copy() mock_opts.update( { "master_type": "failover", "master": ["master1", "master2"], "__role": "", "retry_dns": 0, } ) def mock_resolve_dns(opts, fallback=False): self.assertFalse(fallback) raise SaltClientError("Cannot resolve {}".format(opts["master"])) with patch("salt.minion.resolve_dns", mock_resolve_dns), patch( "salt.loader.grains", MagicMock(return_value=[]) ): with self.assertRaises(SaltClientError, msg="No master could be resolved"): minion = salt.minion.Minion(mock_opts) yield minion.connect_master()