Merge lp:~sil2100/unity/keybindings-migrations into lp:unity

[Łukasz Zemczak]

Initial version of keybinding convert files for unity

- Problem:
Currently, the migration script and .convert files for migrating GSettings files do not migrate keybindings for the unity profile.

- Fix:
Adding those keybinding changing .convert files to unity. Also, preparing another session-migration script that would run the gsettings-data-convert with the new files.

- Tests:
Attached a pymock script for testing the script functionality, based on the migrations tests script by Francis.

[Didier Roche (didrocks)]

Hum, I guess the compiz key migrations should be in compiz itself for people having compiz without unity installed and still having a good migration experience.

The hud one is needed in unity, indeed.

[Timo Jyrinki (timo-jyrinki)]

Didier: They are in compiz already, that's where these were copied from.

Łukasz: the exec needs to be changed to run-command-terminal (a fix now merged in lp:compiz as well)

review: Needs Fixing

[Didier Roche (didrocks)]

@Timo: where in unity?
I can see tools/convert-files/compiz-profile-active-unity.convert and tools/convert-files/compiz-profile-unity.convert which indeed convert all compiz keys *for the unity profile* and only for that one, which makes sense as the profile is shipped in unity.

Those convert keys though are not dependent of any profile (apart from the HUD key which is already converted into the unity profile), so tools/convert-files/keybindings-active-unity.convert and tools/convert-files/keybindings-unity.convert are useless as already in the previous mentionned files.

However, the rest of the keys are not linked to any profiles (default or unity) at all, and so, need to be in compiz, as told.

[Timo Jyrinki (timo-jyrinki)]

Ok, I thought you meant the key migrations needing to be in Compiz sources, since you mentioned "without unity installed". They've been in compiz under postinst/convert-files/ and are in the released packages since gsettings migration.

[Didier Roche (didrocks)]

But, that's exactly what I meant, on this merge proposal:
- remove the HUD transition, uneeded apparently
- put all the other migrations in compiz, as it's generic and doesn't depend on any profile, so we want this to happen even for people not having unity installed and it's the right place to put them anyway.

[Didier Roche (didrocks)]

Also @Lukasz: as the metacity keys won't exist anymore on a new profile, please check on the guest sessions that the keys are still populated with the default and not unsetted after this migration.

[Łukasz Zemczak (sil2100)]

Ok, I can move the global-keybinding bits to compiz. I would have to remove those from the profile .convert files in compiz though. I did it like this because I wanted to write one new migration script instead of two. Why is it so? Since the situation now looks like this:
- Compiz already has the keybinding conversions in its compiz Default profile .convert files (both active and non-active profile). So, essentially, when someone uses the Default profile, he already has the keybindings migrated. The migration only doesn't happen for Unity profile users, as Timo added those conversions to the default profiles only.
- The way it is now is that, since we already have the Default profiles covered by the default migration script, I only had to write one migration script for the unity case. If we decide to add the global keybindings in compiz executed for all profiles, we would have to have 2 additional migration scripts: one for migrating global keybindings (located in compiz) and one for migrating the hud key (located in unity).

Regarding the HUD key conversion - is it not required like this? Since, well, it needs to be converted from the unity active/non-active profile to the org.compiz.integrated schema - not sure if we have it covered anywhere else?

[Didier Roche (didrocks)]

for the compiz part, I checked with Mirv and the part in compiz was wrongly merged into existing file in a previous merge proposal per profile, even if those keys are not per profile (and this merge proposal is redundant with them). The goal is to avoid to write 4 times exactly the same convertion key list as we have with this merge proposal (2 in compiz and 2 in unity), in addition, 2 of them will be useless as you move exactly the same keys.

So one place instead of 4 seems a big win to me ;)

the HUD key is already covered by one of your script in unity, look at them :)

Unmerged revisions

2658. By Łukasz Zemczak on 2012-09-06

Initial version of keybinding convert files for unity

=== added directory 'tests/migration-scripts'
=== added file 'tests/migration-scripts/test_keybinding_migration.py'
--- tests/migration-scripts/test_keybinding_migration.py	1970-01-01 00:00:00 +0000
+++ tests/migration-scripts/test_keybinding_migration.py	2012-09-06 16:12:21 +0000
@@ -0,0 +1,123 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (C) 2012 Canonical
+#
+# Authors:
+#  Francis 'fginther' Ginther <[e-mail]>
+#  Łukasz 'sil2100' Zemczak <[e-mail]>
+#
+# This program 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; version 3.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUTa
+# 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
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+
+import sys
+import unittest
+from mock import MagicMock, patch
+from StringIO import StringIO
+
+import gconf
+import glib
+import os.path
+import subprocess
+
+# Module Under Test (mut)
+try:
+    mut = __import__("03_migrate_keybindings_to_gsettings")
+except (ImportError):
+    sys.exit("Error! 03_migrate_keybindings_to_gsettings module-under-test not found - perhaps you missed including it in the PYTHONPATH environment variable? Add the migration module directory and re-run the script again.")
+
+class MigrateGconfToGsettingsTests(unittest.TestCase):
+    """Test suite for method migrate_keybindings_to_gsettings"""
+
+    def setUp(self):
+        """Redirects stdout so that tests can assert print statements"""
+        self.stdout = sys.stdout
+        self.out = StringIO()
+        sys.stdout = self.out
+
+    def tearDown(self):
+        """Restores stdout"""
+        sys.stdout = self.stdout
+        # Dump the content that was sent to stdout
+        # print(self.out.getvalue())
+
+    def testClientGetDefaultFalse(self):
+        """Test missing gconf client"""
+        gconf.client_get_default = MagicMock(return_value=False)
+        mut.migrate_keybindings_to_gsettings()
+        self.assertEqual(self.out.getvalue().strip(), "WARNING: no gconf client found.")
+
+    def testGetSchemaException(self):
+        """Test exception handling for get_schema"""
+        gconf_mock = MagicMock(name="gconf-Mock")
+        gconf.client_get_default = MagicMock(return_value=gconf_mock)
+        gconf_schema_mock = MagicMock(name="gconf.Schema-Mock")
+        gconf_mock.get_schema = MagicMock(return_value=gconf_schema_mock,
+                                 side_effect=glib.GError)
+        self.assertRaises(glib.GError, mut.migrate_keybindings_to_gsettings())
+
+    def testGetSchemaNone(self):
+        """Test missing schema"""
+        gconf_mock = MagicMock(name="gconf-Mock")
+        gconf.client_get_default = MagicMock(return_value=gconf_mock)
+        #gconf_schema_mock = MagicMock(name="gconf.Schema-Mock")
+        gconf_mock.get_schema = MagicMock(return_value=False)
+        mut.migrate_keybindings_to_gsettings()
+        self.assertEqual(self.out.getvalue().strip(), "No current profile set, no migration needed")
+
+    def setupGetSchema(self, profile):
+        """Set up mock objects for testing a valid schema"""
+        # gconf.client_get_default
+        gconf_mock = MagicMock(name="gconf-Mock")
+        gconf.client_get_default = MagicMock(return_value=gconf_mock)
+        # client.get_schema
+        gconf_schema_mock = MagicMock(name="gconf.Schema-Mock")
+        gconf_mock.get_schema = MagicMock(return_value=gconf_schema_mock)
+        # current_profile_schema.get_default_value
+        gconf_gconfvalue_mock = MagicMock(name="gconf.Schema.gconfvalue-Mock")
+        gconf_schema_mock.get_default_value = MagicMock(return_value=gconf_gconfvalue_mock)
+        # current_profile_gconfvalue.get_string
+        gconf_gconfvalue_mock.get_string = MagicMock(return_value=profile)
+
+        # Popen
+        subprocess_mock = MagicMock(name="subprocess-Mock")
+        popen_mock = MagicMock(name="popen-Mock", return_value=subprocess_mock)
+        subprocess.Popen = popen_mock
+        return popen_mock
+
+    def testGetSchemaUnity(self):
+        """Test the 'unity' schema"""
+        popen_mock = self.setupGetSchema("unity")
+        mut.migrate_keybindings_to_gsettings()
+        # 2 files should be converted: global and unity
+        self.assertEqual(len(popen_mock.call_args_list), 2)
+        self.assertEqual(popen_mock.call_args_list[0][0][0][1],
+                         '--file=/usr/lib/compiz/migration/global-unity-keybindings.convert')
+        self.assertEqual(popen_mock.call_args_list[1][0][0][1],
+                         '--file=/usr/lib/compiz/migration/keybindings-active-unity.convert')
+
+    def testGetSchemaDefault(self):
+        """Test the default schema"""
+        popen_mock = self.setupGetSchema("Default")
+        os.path.exists = MagicMock(return_value=False)
+        mut.migrate_keybindings_to_gsettings()
+        # 2 files should be converted: global and default
+        self.assertEqual(len(popen_mock.call_args_list), 2)
+        self.assertEqual(popen_mock.call_args_list[0][0][0][1],
+                         '--file=/usr/lib/compiz/migration/global-unity-keybindings.convert')
+        self.assertEqual(popen_mock.call_args_list[1][0][0][1],
+                         '--file=/usr/lib/compiz/migration/keybindings-unity.convert')
+
+if __name__ == '__main__':
+    unittest.main()
+

=== added file 'tools/convert-files/global-unity-keybindings.convert'
--- tools/convert-files/global-unity-keybindings.convert	1970-01-01 00:00:00 +0000
+++ tools/convert-files/global-unity-keybindings.convert	2012-09-06 16:12:21 +0000
@@ -0,0 +1,59 @@
+[org.compiz.integrated]
+exec = /apps/metacity/global_keybindings/run_command_terminal
+run-command-screenshot = /apps/metacity/global_keybindings/run_command_screenshot
+run-command-window-screenshot = /apps/metacity/global_keybindings/run_command_window_screenshot
+panel-run-dialog = /apps/metacity/global_keybindings/panel_run_dialog
+panel-main-menu = /apps/metacity/global_keybindings/panel_main_menu
+
+
+[org.gnome.desktop.wm.keybindings]
+move-to-workspace-1 = /apps/metacity/window_keybindings/move_to_workspace_1
+move-to-workspace-2 = /apps/metacity/window_keybindings/move_to_workspace_2
+move-to-workspace-3 = /apps/metacity/window_keybindings/move_to_workspace_3
+move-to-workspace-4 = /apps/metacity/window_keybindings/move_to_workspace_4
+move-to-workspace-5 = /apps/metacity/window_keybindings/move_to_workspace_5
+move-to-workspace-6 = /apps/metacity/window_keybindings/move_to_workspace_6
+move-to-workspace-7 = /apps/metacity/window_keybindings/move_to_workspace_7
+move-to-workspace-8 = /apps/metacity/window_keybindings/move_to_workspace_8
+move-to-workspace-9 = /apps/metacity/window_keybindings/move_to_workspace_9
+move-to-workspace-10 = /apps/metacity/window_keybindings/move_to_workspace_10
+move-to-workspace-11 = /apps/metacity/window_keybindings/move_to_workspace_11
+move-to-workspace-12 = /apps/metacity/window_keybindings/move_to_workspace_12
+move-to-workspace-left = /apps/metacity/window_keybindings/move_to_workspace_left
+move-to-workspace-right = /apps/metacity/window_keybindings/move_to_workspace_right
+move-to-workspace-up = /apps/metacity/window_keybindings/move_to_workspace_up
+move-to-workspace-down = /apps/metacity/window_keybindings/move_to_workspace_down
+switch-windows = /apps/metacity/global_keybindings/switch_windows
+switch-group = /apps/metacity/global_keybindings/switch_group
+show-desktop = /apps/metacity/global_keybindings/show_desktop
+switch-to-workspace-1 = /apps/metacity/global_keybindings/switch_to_workspace_1
+switch-to-workspace-2 = /apps/metacity/global_keybindings/switch_to_workspace_2
+switch-to-workspace-3 = /apps/metacity/global_keybindings/switch_to_workspace_3
+switch-to-workspace-4 = /apps/metacity/global_keybindings/switch_to_workspace_4
+switch-to-workspace-5 = /apps/metacity/global_keybindings/switch_to_workspace_5
+switch-to-workspace-6 = /apps/metacity/global_keybindings/switch_to_workspace_6
+switch-to-workspace-7 = /apps/metacity/global_keybindings/switch_to_workspace_7
+switch-to-workspace-8 = /apps/metacity/global_keybindings/switch_to_workspace_8
+switch-to-workspace-9 = /apps/metacity/global_keybindings/switch_to_workspace_9
+switch-to-workspace-10 = /apps/metacity/global_keybindings/switch_to_workspace_10
+switch-to-workspace-11 = /apps/metacity/global_keybindings/switch_to_workspace_11
+switch-to-workspace-12 = /apps/metacity/global_keybindings/switch_to_workspace_12
+switch-to-workspace-left = /apps/metacity/global_keybindings/switch_to_workspace_left
+switch-to-workspace-right = /apps/metacity/global_keybindings/switch_to_workspace_right
+switch-to-workspace-up = /apps/metacity/global_keybindings/switch_to_workspace_up
+switch-to-workspace-down = /apps/metacity/global_keybindings/switch_to_workspace_down
+activate-window-menu = /apps/metacity/window_keybindings/activate_window_menu
+toggle-fullscreen = /apps/metacity/window_keybindings/toggle_fullscreen
+toggle-maximized = /apps/metacity/window_keybindings/toggle_maximized
+maximize = /apps/metacity/window_keybindings/maximize
+unmaximize = /apps/metacity/window_keybindings/unmaximize
+toggle-shaded = /apps/metacity/window_keybindings/toggle_shaded
+close = /apps/metacity/window_keybindings/close
+minimize = /apps/metacity/window_keybindings/minimize
+begin-move = /apps/metacity/window_keybindings/begin_move
+begin-resize = /apps/metacity/window_keybindings/begin_resize
+raise = /apps/metacity/window_keybindings/raise
+lower = /apps/metacity/window_keybindings/lower
+maximize-vertically = /apps/metacity/window_keybindings/maximize_vertically
+maximize-horizontally = /apps/metacity/window_keybindings/maximize_horizontally
+

=== added file 'tools/convert-files/keybindings-active-unity.convert'
--- tools/convert-files/keybindings-active-unity.convert	1970-01-01 00:00:00 +0000
+++ tools/convert-files/keybindings-active-unity.convert	2012-09-06 16:12:21 +0000
@@ -0,0 +1,2 @@
+[org.compiz.integrated]
+show-hud = /apps/compiz-1/plugins/unityshell/screen0/options/show_hud

=== added file 'tools/convert-files/keybindings-unity.convert'
--- tools/convert-files/keybindings-unity.convert	1970-01-01 00:00:00 +0000
+++ tools/convert-files/keybindings-unity.convert	2012-09-06 16:12:21 +0000
@@ -0,0 +1,2 @@
+[org.compiz.integrated]
+show-hud = /apps/compizconfig-1/profiles/unity/plugins/unityshell/screen0/options/show_hud

=== added file 'tools/migration-scripts/03_migrate_keybindings_to_gsettings.py'
--- tools/migration-scripts/03_migrate_keybindings_to_gsettings.py	1970-01-01 00:00:00 +0000
+++ tools/migration-scripts/03_migrate_keybindings_to_gsettings.py	2012-09-06 16:12:21 +0000
@@ -0,0 +1,67 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (C) 2012 Canonical
+#
+# Authors:
+#  Łukasz 'sil2100' Zemczak <[e-mail]>
+#
+# This program 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; version 3.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUTa
+# 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
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+import gconf
+import glib
+import subprocess
+import os.path
+
+# this should point to the directory where all the .convert files are stored
+CONVERT_PATH = "/usr/lib/compiz/migration/"
+
+def migrate_file(convert_file):
+    subprocess.Popen(["gsettings-data-convert", "--file={}{}".format(CONVERT_PATH, convert_file)]).communicate()
+
+def migrate_keybindings_to_gsettings():
+    # first, we actually convert the global keybindings, since no knowledge
+    # of the active profile is needed here
+    migrate_file("global-unity-keybindings.convert")
+
+    # now get the default profile and migrate profile specific keybindings
+
+    client = gconf.client_get_default()
+
+    if not client:
+        print "WARNING: no gconf client found."
+        return
+
+    try:
+        current_profile_schema = client.get_schema("/apps/compizconfig-1/current_profile")
+    except (glib.GError, AttributeError):
+        print "No current profile set, no migration needed"
+        return
+
+    if current_profile_schema:
+        current_profile_gconfvalue = current_profile_schema.get_default_value()
+        current_profile_str = current_profile_gconfvalue.get_string()
+    else:
+        print "No current profile set, no migration needed"
+        return
+
+    # depending what current profile is set, migrate using specific .convert files
+    if current_profile_str == 'unity':
+        print "Will migrate keybindings for unity as the active profile"
+        migrate_file('keybindings-active-unity.convert')
+    else:
+        print "Will migrate keybindings for unity as the active profile"
+        migrate_file('keybindings-unity.convert')
+
+if __name__ == '__main__':
+    migrate_keybindings_to_gsettings ()