Merge lp:~canonical-platform-qa/ubuntu-ui-toolkit/systemd into lp:ubuntu-ui-toolkit/staging

[Leo Arias]

[Vincent Ladeuil (vila)]

Wow, the duplication between upstart.py and systemd.py is worrying, can't you factor more ?

Using classes may help to at least define only the diverging methods in the daughter classes (you're more or less using modules as classes here with 'init = init_system.get_init_system_module()' so the transition shouldn't be too hard) ?

review: Needs Information

Unmerged revisions

1506. By Leo Arias on 2015-05-14

Removed pdb.

1505. By Leo Arias on 2015-05-14

Added support for systemd. environment variables.

=== modified file 'tests/autopilot/ubuntuuitoolkit/environment.py'
--- tests/autopilot/ubuntuuitoolkit/environment.py	2014-08-28 19:05:23 +0000
+++ tests/autopilot/ubuntuuitoolkit/environment.py	2015-05-15 08:59:52 +0000
@@ -1,6 +1,6 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
-# Copyright (C) 2014 Canonical Ltd.
+# Copyright (C) 2014, 2015 Canonical Ltd.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -14,13 +14,8 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
-import logging
-import subprocess
-
-from autopilot import logging as autopilot_logging
-
-
-logger = logging.getLogger(__name__)
+
+from ubuntuuitoolkit import init_system
 
 
 def is_initctl_env_var_set(variable, global_=False):
@@ -32,37 +27,23 @@
     :return: True if the variable is set. False otherwise.
 
     """
-    try:
-        get_initctl_env_var(variable, global_)
-        return True
-    except subprocess.CalledProcessError:
-        return False
+    init = init_system.get_init_system_module()
+    return init.is_initctl_env_var_set(variable, global_)
 
 
 def get_initctl_env_var(variable, global_=False):
     """Return the value of an initctl environment variable."""
-    command = ['/sbin/initctl', 'get-env', variable]
-    if global_:
-        command += ['--global']
-    output = subprocess.check_output(
-        command, stderr=subprocess.STDOUT, universal_newlines=True)
-    return output.rstrip()
-
-
-@autopilot_logging.log_action(logger.info)
+    init = init_system.get_init_system_module()
+    return init.get_initctl_env_var(variable, global_)
+
+
 def set_initctl_env_var(variable, value, global_=False):
     """Set the value of an initctl environment variable."""
-    command = ['/sbin/initctl', 'set-env', '%s=%s' % (variable, value)]
-    if global_:
-        command += ['--global']
-    subprocess.call(command, stderr=subprocess.STDOUT, universal_newlines=True)
-
-
-@autopilot_logging.log_action(logger.info)
+    init = init_system.get_init_system_module()
+    init.set_initctl_env_var(variable, value, global_)
+
+
 def unset_initctl_env_var(variable, global_=False):
     """Remove an initctl environment variable."""
-    command = ['/sbin/initctl', 'unset-env', variable]
-    if global_:
-        command += ['--global']
-    subprocess.call(
-        command, stderr=subprocess.STDOUT, universal_newlines=True)
+    init = init_system.get_init_system_module()
+    init.unset_initctl_env_var(variable, global_)

=== added directory 'tests/autopilot/ubuntuuitoolkit/init_system'
=== added file 'tests/autopilot/ubuntuuitoolkit/init_system/__init__.py'
--- tests/autopilot/ubuntuuitoolkit/init_system/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/init_system/__init__.py	2015-05-15 08:59:52 +0000
@@ -0,0 +1,42 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2015 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# This program 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import subprocess
+
+
+_init_system = None
+
+
+def get_init_system_module():
+    if get_init_system() == 'systemd':
+        from ubuntuuitoolkit.init_system import systemd
+        return systemd
+    else:
+        from ubuntuuitoolkit.init_system import upstart
+        return upstart
+
+
+def get_init_system():
+    global _init_system
+    if _init_system is None:
+        # Based on http://ur1.ca/lw3d0
+        p1_name = subprocess.check_output(
+            'ps -p1 -o comm=', shell=True, universal_newlines=True).strip()
+        if p1_name == 'systemd':
+            _init_system = p1_name
+        else:
+            _init_system = 'upstart'
+    return _init_system

=== added file 'tests/autopilot/ubuntuuitoolkit/init_system/systemd.py'
--- tests/autopilot/ubuntuuitoolkit/init_system/systemd.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/init_system/systemd.py	2015-05-15 08:59:52 +0000
@@ -0,0 +1,76 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2015 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# This program 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+import re
+import subprocess
+
+from autopilot import logging as autopilot_logging
+
+
+logger = logging.getLogger(__name__)
+
+
+def is_initctl_env_var_set(variable, global_=False):
+    """Check True if an initctl environment variable is set.
+
+    :param variable: The name of the variable to check.
+    :param global: if True, the method will operate on the global environment
+        table. Default is False.
+    :return: True if the variable is set. False otherwise.
+
+    """
+    variables = _get_initctl_env_vars_dictionary(global_)
+    return variable in variables
+
+
+def _get_initctl_env_vars_dictionary(global_):
+    command = ['systemctl', 'show-environment']
+    if not global_:
+        command += ['--user']
+    output = subprocess.check_output(
+        command, stderr=subprocess.STDOUT, universal_newlines=True).strip()
+    lines = output.split('\n')
+    dictionary = {}
+    for line in lines:
+        match = re.match('(?P<name>[^=]+)=(?P<value>.*)', line)
+        dictionary[match.group('name')] = match.group('value')
+    return dictionary
+
+
+def get_initctl_env_var(variable, global_=False):
+    """Return the value of an initctl environment variable."""
+    variables = _get_initctl_env_vars_dictionary(global_)
+    return variables[variable]
+
+
+@autopilot_logging.log_action(logger.info)
+def set_initctl_env_var(variable, value, global_=False):
+    """Set the value of an initctl environment variable."""
+    command = ['systemctl', 'set-environment', '%s=%s' % (variable, value)]
+    if not global_:
+        command += ['--user']
+    subprocess.call(command, stderr=subprocess.STDOUT, universal_newlines=True)
+
+
+@autopilot_logging.log_action(logger.info)
+def unset_initctl_env_var(variable, global_=False):
+    """Remove an initctl environment variable."""
+    command = ['systemctl', 'unset-environment', variable]
+    if not global_:
+        command += ['--user']
+    subprocess.call(
+        command, stderr=subprocess.STDOUT, universal_newlines=True)

=== added file 'tests/autopilot/ubuntuuitoolkit/init_system/upstart.py'
--- tests/autopilot/ubuntuuitoolkit/init_system/upstart.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/init_system/upstart.py	2015-05-15 08:59:52 +0000
@@ -0,0 +1,68 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014, 2015 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# This program 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+import subprocess
+
+from autopilot import logging as autopilot_logging
+
+
+logger = logging.getLogger(__name__)
+
+
+def is_initctl_env_var_set(variable, global_=False):
+    """Check True if an initctl environment variable is set.
+
+    :param variable: The name of the variable to check.
+    :param global: if True, the method will operate on the global environment
+        table. Default is False.
+    :return: True if the variable is set. False otherwise.
+
+    """
+    try:
+        get_initctl_env_var(variable, global_)
+        return True
+    except subprocess.CalledProcessError:
+        return False
+
+
+def get_initctl_env_var(variable, global_=False):
+    """Return the value of an initctl environment variable."""
+    command = ['/sbin/initctl', 'get-env', variable]
+    if global_:
+        command += ['--global']
+    output = subprocess.check_output(
+        command, stderr=subprocess.STDOUT, universal_newlines=True)
+    return output.rstrip()
+
+
+@autopilot_logging.log_action(logger.info)
+def set_initctl_env_var(variable, value, global_=False):
+    """Set the value of an initctl environment variable."""
+    command = ['/sbin/initctl', 'set-env', '%s=%s' % (variable, value)]
+    if global_:
+        command += ['--global']
+    subprocess.call(command, stderr=subprocess.STDOUT, universal_newlines=True)
+
+
+@autopilot_logging.log_action(logger.info)
+def unset_initctl_env_var(variable, global_=False):
+    """Remove an initctl environment variable."""
+    command = ['/sbin/initctl', 'unset-env', variable]
+    if global_:
+        command += ['--global']
+    subprocess.call(
+        command, stderr=subprocess.STDOUT, universal_newlines=True)

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/__init__.py'
--- tests/autopilot/ubuntuuitoolkit/tests/__init__.py	2015-04-14 21:02:06 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/__init__.py	2015-05-15 08:59:52 +0000
@@ -116,7 +116,7 @@
             'QML2_IMPORT_PATH',
             'UBUNTU_UI_TOOLKIT_THEMES_PATH'
         ]
-        kwargs = {'global_': True}
+        kwargs = {'global_': False}
         for env in env_vars:
             kwargs[env] = local_modules_path
         self.useFixture(fixture_setup.InitctlEnvironmentVariable(**kwargs))

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/test_environment.py'
--- tests/autopilot/ubuntuuitoolkit/tests/test_environment.py	2014-08-29 16:12:02 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/test_environment.py	2015-05-15 08:59:52 +0000
@@ -23,14 +23,18 @@
 
 class InitctlEnvironmentVariableTestCase(testtools.TestCase):
 
+    def get_unique_identifier(self):
+        return str(uuid.uuid1()).replace('-', '_')
+
     def test_is_environment_variable_set_with_unset_variable(self):
         """Test that is_initctl_env_var_set returns False for unset vars."""
-        variable = 'I do not exist {}'.format(uuid.uuid1())
+        variable = 'I_do_not_exist_{}'.format(self.get_unique_identifier())
         self.assertFalse(environment.is_initctl_env_var_set(variable))
 
     def test_is_environment_variable_set_with_set_variable(self):
         """Test that is_initctl_env_var_set returns True for existing vars."""
-        variable = 'Test variable to set {}'.format(uuid.uuid1())
+        variable = 'Test_variable_to_set_{}'.format(
+            self.get_unique_identifier())
         self.addCleanup(environment.unset_initctl_env_var, variable)
 
         environment.set_initctl_env_var(variable, 'dummy')
@@ -39,7 +43,8 @@
 
     def test_get_environment_variable(self):
         """Test that get_initctl_env_var returns the right value."""
-        variable = 'Test variable to get {}'.format(uuid.uuid1())
+        variable = 'Test_variable_to_get_{}'.format(
+            self.get_unique_identifier())
         self.addCleanup(environment.unset_initctl_env_var, variable)
         environment.set_initctl_env_var(variable, 'test value')
 
@@ -48,7 +53,8 @@
 
     def test_unset_environment_variable(self):
         """Test that unset_initctl_env_var removes the variable."""
-        variable = 'Test variable to unset {}'.format(uuid.uuid1())
+        variable = 'Test_variable_to_unset_{}'.format(
+            self.get_unique_identifier())
         environment.set_initctl_env_var(variable, 'dummy')
 
         environment.unset_initctl_env_var(variable)
@@ -57,7 +63,7 @@
 
     def test_unset_environment_variable_with_unset_variable(self):
         """Test that unset_initctl_env_var does nothing with unset var."""
-        variable = 'I do not exist {}'.format(uuid.uuid1())
+        variable = 'I_do_not_exist_{}'.format(self.get_unique_identifier())
 
         environment.unset_initctl_env_var(variable)
 
@@ -65,14 +71,16 @@
 
     def test_is_global_environment_variable_set_with_unset_variable(self):
         """Test is_initctl_env_var_set returns False for unset global vars."""
-        variable = 'I do not exist global {}'.format(uuid.uuid1())
+        variable = 'I_do_not_exist_global_{}'.format(
+            self.get_unique_identifier())
 
         self.assertFalse(environment.is_initctl_env_var_set(
             variable, global_=True))
 
     def test_get_global_environment_variable(self):
         """Test that get_initctl_env_var returns the right global value."""
-        variable = 'Test variable to get {}'.format(uuid.uuid1())
+        variable = 'Test_variable_to_get_{}'.format(
+            self.get_unique_identifier())
         self.addCleanup(
             environment.unset_initctl_env_var, variable, global_=True)
         environment.set_initctl_env_var(variable, 'test value', global_=True)
@@ -83,7 +91,8 @@
 
     def test_unset_global_environment_variable(self):
         """Test that unset_initctl_env_var removes the global variable."""
-        variable = 'Test variable to unset {}'.format(uuid.uuid1())
+        variable = 'Test_variable_to_unset_{}'.format(
+            self.get_unique_identifier())
 
         environment.set_initctl_env_var(variable, 'dummy', global_=True)
         environment.unset_initctl_env_var(variable, global_=True)