From ba9f26cf00b0a767b7b25f156553a9e783aa895d Mon Sep 17 00:00:00 2001 From: Michele Bologna Date: Thu, 14 Dec 2017 18:20:02 +0100 Subject: [PATCH] Feat: add grain for all FQDNs This PR adds a grain named fqdns to the grains. fqdns represents all the FQDNs known for the system on all available interfaces (excluding lo). Note: hostname != FQDN hostname is the UNIX name of the machine. A machine can have one and only one hostname. FQDN is host.domain that resolves to an IP address that the machines is answering to. A machine can have 1+ FQDNs. Upstream PR: https://github.com/saltstack/salt/pull/45060 --- salt/grains/core.py | 27 +++++++++++++++++++++++++++ tests/integration/modules/test_grains.py | 1 + tests/unit/grains/test_core.py | 28 ++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+) diff --git a/salt/grains/core.py b/salt/grains/core.py index a7e1a22d2a..04b73f9120 100644 --- a/salt/grains/core.py +++ b/salt/grains/core.py @@ -1756,6 +1756,33 @@ def append_domain(): return grain +def fqdns(): + ''' + Return all known FQDNs for the system by enumerating all interfaces and + then trying to reverse resolve them (excluding 'lo' interface). + ''' + # Provides: + # fqdns + + grains = {} + fqdns = set() + + addresses = salt.utils.network.ip_addrs(include_loopback=False, + interface_data=_INTERFACES) + addresses.extend(salt.utils.network.ip_addrs6(include_loopback=False, + interface_data=_INTERFACES)) + + for ip in addresses: + try: + fqdns.add(socket.gethostbyaddr(ip)[0]) + except (socket.error, socket.herror, + socket.gaierror, socket.timeout) as e: + log.error("Exception during resolving address: " + str(e)) + + grains['fqdns'] = list(fqdns) + return grains + + def ip_fqdn(): ''' Return ip address and FQDN grains diff --git a/tests/integration/modules/test_grains.py b/tests/integration/modules/test_grains.py index 7d46315e42..1db90ab532 100644 --- a/tests/integration/modules/test_grains.py +++ b/tests/integration/modules/test_grains.py @@ -51,6 +51,7 @@ class TestModulesGrains(ModuleCase): 'cpuarch', 'domain', 'fqdn', + 'fqdns', 'gid', 'groupname', 'host', diff --git a/tests/unit/grains/test_core.py b/tests/unit/grains/test_core.py index 6ee4257863..4f1412de76 100644 --- a/tests/unit/grains/test_core.py +++ b/tests/unit/grains/test_core.py @@ -6,6 +6,7 @@ # Import Python libs from __future__ import absolute_import import os +import socket # Import Salt Testing Libs from tests.support.mixins import LoaderModuleMockMixin @@ -462,3 +463,30 @@ PATCHLEVEL = 3 self.assertEqual(os_grains.get('osrelease'), os_release_map['osrelease']) self.assertListEqual(list(os_grains.get('osrelease_info')), os_release_map['osrelease_info']) self.assertEqual(os_grains.get('osmajorrelease'), os_release_map['osmajorrelease']) + + @skipIf(not salt.utils.is_linux(), 'System is not Linux') + def test_fqdns_return(self): + ''' + test the return for a dns grain. test for issue: + https://github.com/saltstack/salt/issues/41230 + ''' + reverse_resolv_mock = [('foo.bar.baz', [], ['1.2.3.4']), + ('rinzler.evil-corp.com', [], ['5.6.7.8']), + ('foo.bar.baz', [], ['fe80::a8b2:93ff:fe00:0']), + ('bluesniff.foo.bar', [], ['fe80::a8b2:93ff:dead:beef'])] + ret = {'fqdns': ['rinzler.evil-corp.com', 'foo.bar.baz', 'bluesniff.foo.bar']} + self._run_fqdns_test(reverse_resolv_mock, ret) + + def _run_fqdns_test(self, reverse_resolv_mock, ret): + with patch.object(salt.utils, 'is_windows', MagicMock(return_value=False)): + with patch('salt.utils.network.ip_addrs', + MagicMock(return_value=['1.2.3.4', '5.6.7.8'])),\ + patch('salt.utils.network.ip_addrs6', + MagicMock(return_value=['fe80::a8b2:93ff:fe00:0', 'fe80::a8b2:93ff:dead:beef'])): + with patch.object(socket, 'gethostbyaddr', side_effect=reverse_resolv_mock): + fqdns = core.fqdns() + self.assertEqual(fqdns, ret) + +if __name__ == '__main__': + from integration import run_tests + run_tests(CoreGrainsTestCase, needs_daemon=False) -- 2.13.6