Changed hostname recognition from dhclient to nmcli

Author: Andrea Bettich

.gitignore

@@ -2,3 +2,4 @@
 *.swp
 site/
 .python-version
+.cache/

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+# Python Version
+python:
+  - "2.7"
+# Ignore submodules
+git:
+  submodules: false
+# Install requirements
+install: "pip install -r requirements.txt"
+# Run pytests
+script: pytest

requirements.txt

@@ -0,0 +1 @@
+pytest-mock

virtesk-tc-connectspice/conftest.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+# vim: autoindent expandtab tabstop=4 sw=4 sts=4 filetype=python
+
+# Copyright (c) 2013-2016, Adfinis SyGroup AG
+#
+# This file is part of Virtesk VDI.
+#
+# Virtesk VDI 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 3 of the License, or
+# (at your option) any later version.
+#
+# Virtesk VDI 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 Virtesk VDI.  If not, see <http://www.gnu.org/licenses/>.
+
+# System Imports
+import pytest
+import os.path
+
+
+MOCK_DATA_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'test_mock_data')
+
+
+@pytest.yield_fixture(scope='module')
+def active_connection():
+    yield readfile('active_connection')
+
+
+@pytest.yield_fixture(scope='module')
+def nmcli_con_show_empty():
+    yield readfile('nmcli_con_show_adsy_eap_empty')
+
+
+@pytest.yield_fixture(scope='module')
+def nmcli_con_show():
+    yield readfile('nmcli_con_show_adsy_eap')
+
+
+@pytest.yield_fixture(scope='module')
+def nmcli_device_show_single_line():
+    yield readfile('nmcli_device_show_single_line')
+
+
+@pytest.yield_fixture(scope='module')
+def nmcli_device_show():
+    yield readfile('nmcli_device_show')
+
+
+def readfile(filename):
+    with open(os.path.join(MOCK_DATA_PATH, filename), 'r') as f:
+        return f.read()

virtesk-tc-connectspice/connect_spice_client.py

@@ -39,6 +39,7 @@
 # Project Imports
 import spice_xpi_controller
 import find_thinclient_identifier
+import find_thinclient_identifier_nmcli
 import ovirtsdk.api
 
 
@@ -632,16 +633,15 @@ def raise_exception_again_in_main_action_sequence(self):
             self.raise_again = None
             raise ex
 
-    def wait_for_dhcp_lease(self):
-        logging.info("waiting for dhcp lease file...")
-        for iteration in range(1, 5 + 1):
-            leasefiles = find_thinclient_identifier.find_dhclient_leasefiles()
-            if len(leasefiles) > 0:
-                logging.info("waiting for dhcp lease file... done")
+    def wait_for_active_connection(self):
+        logging.info("waiting for active connection")
+        for iteration in range(0, 5):
+            active_connections = find_thinclient_identifier_nmcli.get_active_connections()
+            if active_connections > 0:
+                logging.info("found an active connection")
                 return
             self.notify_waiting_for_dhcplease()
             time.sleep(4)
-
         # TRANSLATE:
         # "Network error. Please contact the system administrator."
         raise NetworkError(
@@ -657,7 +657,7 @@ def main_action_sequence(self):
 
         self.adjust_logging()
 
-        self.wait_for_dhcp_lease()
+        self.wait_for_active_connection()
 
         self.connect_to_rest_api()
 
@@ -683,7 +683,7 @@ def shutdown_vm_action_sequence(self):
 
             logging.info("Auto-Shutdown program started...")
 
-            self.wait_for_dhcp_lease()
+            self.wait_for_active_connection()
 
             self.connect_to_rest_api()
 

virtesk-tc-connectspice/find_thinclient_identifier.py

@@ -24,6 +24,7 @@
 import re
 import logging
 import subprocess
+from find_thinclient_identifier_nmcli import extract_identifiers_from_nmcli
 
 
 def get_dmidecode_sysuuid():
@@ -37,94 +38,14 @@ def get_dmidecode_sysuuid():
     return result
 
 
-def find_dhclient_leasefiles():
-    # Finds dhclient lease files.
-    # More or less the same as:
-    #  ps ax | grep dhclient
-    #  and then looking at the -lf parameter.
-
-    procdir = os.listdir('/proc')
-
-    leasefiles = []
-    for procfile in procdir:
-        try:
-            if procfile.isdigit():
-                cmdfile_path = '/proc/%s/cmdline' % procfile
-                with open(cmdfile_path, 'r') as cmdline_file:
-                    cmdline_nullseperated = cmdline_file.read()
-                cmdline = cmdline_nullseperated.split('\0')[0:-1]
-                if len(cmdline) is 0:
-                    continue
-                if re.search('dhclient', cmdline[0]) is None:
-                    continue
-
-                i = cmdline.index('-lf')
-                if i < len(cmdline):
-                    leasefiles.append(cmdline[i + 1])
-        except:
-            continue
-
-    return leasefiles
-
-
-def extract_identifiers_from_leasefiles(leasefilepaths):
-    hostnames = []
-    fixedips = []
-    for leasefilepath in leasefilepaths:
-        if leasefilepath is None:
-            return None
-        logging.debug("reading dhclient-leasefile %s", leasefilepath)
-        with open(leasefilepath, 'r') as leasefile:
-            leasefilecontent = leasefile.read()
-
-        leases = re.split("lease\s*\{([^\}]*)\}", leasefilecontent)
-
-        for lease in leases:
-            if lease is None:
-                continue
-            if re.match("\s*\Z", lease):
-                continue
-
-            match_fixedip = re.search(
-                'fixed-address\s*(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})', lease)
-            if match_fixedip:
-                fixedip = match_fixedip.group(1)
-                logging.debug("found fixed ip address in dhclient lease " +
-                              "file: %s", fixedip)
-                if fixedip not in fixedips:
-                    fixedips.append(fixedip)
-
-            match_hostname = re.search(
-                'option\s*host-name\s*"([\w\-.]+)"', lease)
-            if match_hostname:
-                hostname = match_hostname.group(1)
-                logging.debug("found hostname in dhclient lease file: %s",
-                              hostname)
-
-                # some dhcp servers serve FQDNs, some only short hostnames.
-                # here, we do want short hostnames.
-                match_fqdn = re.search('([\w\-]+)\..*', hostname)
-                if match_fqdn:
-                    hostname_fqdn = hostname
-                    hostname = match_fqdn.group(1)
-                    logging.debug(
-                        "hostname: %s fqdn: %s" % (hostname_fqdn, hostname))
-
-                if hostname not in hostnames:
-                    hostnames.append(hostname)
-
-    return (hostnames, fixedips)
-
-
 def process_ip(ip):
     # RHEV-tags cannot contain dots in their names.
     # so we replace dots by hyphens.
     return ip.replace('.', '-')
 
 
 def get_thinclient_identifiers():
-    leasefilepaths = find_dhclient_leasefiles()
-    (hostnames, fixedips) = extract_identifiers_from_leasefiles(leasefilepaths)
+    (hostnames, fixedips) = extract_identifiers_from_nmcli()
     identifiers = (["thinclient-hostname-%s" % x for x in hostnames] +
                    ["thinc*ient-hostname-%s" % x for x in hostnames] +
                    ["thinclient-ip-%s" % process_ip(x) for x in fixedips] +
@@ -135,8 +56,7 @@ def get_thinclient_identifiers():
 
 
 def get_dhcp_hostnames():
-    leasefilepaths = find_dhclient_leasefiles()
-    (hostnames, fixedips) = extract_identifiers_from_leasefiles(leasefilepaths)
+    hostnames, _ = extract_identifiers_from_nmcli()
     return hostnames
 
 

virtesk-tc-connectspice/find_thinclient_identifier_nmcli.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+# vim: autoindent expandtab tabstop=4 sw=4 sts=4 filetype=python
+
+# Copyright (c) 2013-2016, Adfinis SyGroup AG
+#
+# This file is part of Virtesk VDI.
+#
+# Virtesk VDI 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 3 of the License, or
+# (at your option) any later version.
+#
+# Virtesk VDI 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 Virtesk VDI.  If not, see <http://www.gnu.org/licenses/>.
+
+# System Imports
+import subprocess
+import re
+
+
+def extract_identifiers_from_nmcli():
+    fixedips = []
+    hostnames = []
+    nmcli_output = subprocess.check_output(['nmcli', 'device', 'show'], env={'LC_ALL': 'C'})
+    for line in nmcli_output.splitlines():
+        if re.match('^IP4\.ADDRESS.', line):
+            key, value = get_line_key_value(line)
+            value = value[:value.index("/")].strip()
+            fixedips.append(value)
+        elif re.match('^GENERAL\.CONNECTION.', line):
+            key, value = get_line_key_value(line)
+            dhcp_hostname = get_dhcp_hostname_from_connection(value)
+            if dhcp_hostname:
+                hostnames.append(dhcp_hostname)
+    return (hostnames, fixedips)
+
+
+def get_dhcp_hostname_from_connection(name):
+    if name and name != '--':
+        nmcli_output = subprocess.check_output(['nmcli', 'con', 'show', name], env={'LC_ALL': 'C'})
+        for line in nmcli_output.splitlines():
+            if re.match('^ipv4\.dhcp-hostname.', line):
+                key, value = get_line_key_value(line)
+                if value != '--':
+                    return value
+
+
+def get_line_key_value(line):
+    if line:
+        values = str(line).split(':')
+        if len(values) == 2:
+            key, value = values
+            value = value.strip()
+            return (key, value)
+
+
+def get_active_connections():
+    nmcli_output = subprocess.check_output(['nmcli', '-t', '-f', 'state', 'con', 'show', '--active'], env={'LC_ALL': 'C'})
+    return len(nmcli_output.splitlines())
+
+def main():
+    print(extract_identifiers_from_nmcli())
+
+
+if __name__ == "__main__":
+    main()

virtesk-tc-connectspice/test_find_thinclient_identifier_nmcli.py

@@ -0,0 +1,48 @@
+import find_thinclient_identifier_nmcli as find_nmcli
+
+
+def test_extract_identifiers_from_nmcli(mock, nmcli_device_show, nmcli_con_show, nmcli_con_show_empty):
+    def my_check_output(cmd, **kwargs):
+        if cmd[:4] == ['nmcli', 'con', 'show', 'ADSY-EAP']:
+            return nmcli_con_show
+        elif cmd[:3] == ['nmcli', 'con', 'show']:
+            return nmcli_con_show_empty
+        elif cmd[:3] == ['nmcli', 'device', 'show']:
+            return nmcli_device_show
+    mock.patch('find_thinclient_identifier_nmcli.subprocess.check_output', my_check_output)
+    return_value = find_nmcli.extract_identifiers_from_nmcli()
+
+    assert return_value == (['a-hostname-appeared'], ['172.17.0.1', '10.9.5.185', '127.0.0.1'])
+
+
+def test_get_dhcp_hostname_from_connection(mock, nmcli_con_show):
+    patched_check_output = mock.patch('find_thinclient_identifier_nmcli.subprocess.check_output')
+    patched_check_output.return_value = nmcli_con_show
+    return_value = find_nmcli.get_dhcp_hostname_from_connection('SOME-NAME')
+    assert return_value == 'a-hostname-appeared'
+
+
+def test_get_dhcp_hostname_from_connection_empty(mock, nmcli_con_show_empty):
+    patched_check_output = mock.patch('find_thinclient_identifier_nmcli.subprocess.check_output')
+    patched_check_output.return_value = nmcli_con_show_empty
+    return_value = find_nmcli.get_dhcp_hostname_from_connection('SOME-NAME')
+    assert return_value is None
+
+
+def test_get_line_key_value(nmcli_device_show_single_line):
+    return_value = find_nmcli.get_line_key_value(nmcli_device_show_single_line)
+    key, value = return_value
+    assert key == 'IP4.ADDRESS[1]'
+    assert value == '10.9.5.185/16'
+
+
+def test_get_line_key_value_none():
+    return_value = find_nmcli.get_line_key_value('')
+    assert return_value is None
+
+
+def test_get_active_connections(mock, active_connection):
+    patched_check_output = mock.patch('find_thinclient_identifier_nmcli.subprocess.check_output')
+    patched_check_output.return_value = active_connection
+    return_value = find_nmcli.get_active_connections()
+    assert return_value == 2

virtesk-tc-connectspice/test_mock_data/active_connection

@@ -0,0 +1,2 @@
+activated
+activated