Merge lp:~unity-team/unity/unity.test-special-keys into lp:unity

[Brandon Schaefer]

[Thomi Richards (thomir)]

Hi,

These look great - two small things:

1) Please add "self.dash = Dash()" to AutopilotTest case - you'll see we already have self.launcher and self.switcher etc.

2) please put 'self.dash.ensure_hidden()' into your setup, and remove it from the tests.

3) I'm now being *really* picky, but your docstrings should ideally:
 a) Start with a captial letter and end with a '.'
 b) Describe the test in terms of given input and expected output, so this:

19 + def test_multi_key(self):
20 + """Tests that when the multi_key is pressed it will exepect a sequences"""

would be better written like this:

19 + def test_multi_key(self):
20 + """Pressing Multi_Key must not add add any characters to the search bar."""

and another example - before:

33 + def test_multi_key_o(self):
34 + """Tests the multi_key sequences ^ + o"""

after:

33 + def test_multi_key_o(self):
34 + """Pressing the Multi_Key followed by '^' and 'o' must produce ô."""

Number 3 is something that's good to aim for - I often don't remember to do this myself, but it helps produce tests that are easy to read and verify.

Otherwise, looks great!

[lp:~unity-team/unity/unity.test-special-keys]

2108. By Brandon Schaefer on 2012-03-13

* Fixed using ensure_dash in ALL test cases, now only in setUp and tearDown
* Fixed self.dash = Dash() being used everytime in setUp. Now in AutopilotTest

[Thomi Richards (thomir)]

Awesome tests, thanks!

review: Approve

=== modified file 'tests/autopilot/autopilot/tests/__init__.py'
--- tests/autopilot/autopilot/tests/__init__.py	2012-03-13 03:15:23 +0000
+++ tests/autopilot/autopilot/tests/__init__.py	2012-03-13 23:19:20 +0000
@@ -15,6 +15,7 @@
 import time
 
 from autopilot.emulators.bamf import Bamf
+from autopilot.emulators.unity.dash import Dash
 from autopilot.emulators.unity.launcher import LauncherController
 from autopilot.emulators.unity.switcher import Switcher
 from autopilot.emulators.unity.workspace import WorkspaceManager
@@ -169,6 +170,7 @@
         self.bamf = Bamf()
         self.keyboard = Keyboard()
         self.mouse = Mouse()
+        self.dash = Dash()
         self.switcher = Switcher()
         self.workspace = WorkspaceManager()
         self.launcher = self._get_launcher_controller()

=== modified file 'tests/autopilot/autopilot/tests/test_dash.py'
--- tests/autopilot/autopilot/tests/test_dash.py	2012-03-13 07:31:25 +0000
+++ tests/autopilot/autopilot/tests/test_dash.py	2012-03-13 23:19:20 +0000
@@ -9,7 +9,6 @@
 from gtk import Clipboard
 from time import sleep
 
-from autopilot.emulators.unity.dash import Dash
 from autopilot.emulators.X11 import Keyboard, Mouse
 from autopilot.tests import AutopilotTestCase
 
@@ -19,7 +18,7 @@
 
     def setUp(self):
         super(DashRevealTests, self).setUp()
-        self.dash = Dash()
+        self.dash.ensure_hidden()
 
     def tearDown(self):
         super(DashRevealTests, self).tearDown()
@@ -27,8 +26,6 @@
 
     def test_dash_reveal(self):
         """Ensure we can show and hide the dash."""
-        self.dash.ensure_hidden()
-
         self.assertFalse(self.dash.get_is_visible())
         self.dash.toggle_reveal()
         self.assertTrue(self.dash.get_is_visible())
@@ -46,28 +43,24 @@
 
     def test_application_lens_shortcut(self):
         """Application lense must reveal when Super+a is pressed."""
-        self.dash.ensure_hidden()
         self.dash.reveal_application_lens()
         lensbar = self.dash.view.get_lensbar()
         self.assertEqual(lensbar.active_lens, u'applications.lens')
 
     def test_music_lens_shortcut(self):
         """Music lense must reveal when Super+w is pressed."""
-        self.dash.ensure_hidden()
         self.dash.reveal_music_lens()
         lensbar = self.dash.view.get_lensbar()
         self.assertEqual(lensbar.active_lens, u'music.lens')
 
     def test_file_lens_shortcut(self):
         """File lense must reveal when Super+f is pressed."""
-        self.dash.ensure_hidden()
         self.dash.reveal_file_lens()
         lensbar = self.dash.view.get_lensbar()
         self.assertEqual(lensbar.active_lens, u'files.lens')
 
     def test_command_lens_shortcut(self):
         """Run Command lens must reveat on alt+F2."""
-        self.dash.ensure_hidden()
         self.dash.reveal_command_lens()
         lensbar = self.dash.view.get_lensbar()
         self.assertEqual(lensbar.active_lens, u'commands.lens')
@@ -85,7 +78,7 @@
 
     def setUp(self):
         super(DashKeyNavTests, self).setUp()
-        self.dash = Dash()
+        self.dash.ensure_hidden()
 
     def tearDown(self):
         super(DashKeyNavTests, self).tearDown()
@@ -137,7 +130,6 @@
         """Test that the dash autoscroll when a category header gets
         the focus.
         """
-        self.dash.ensure_hidden()
         self.dash.reveal_application_lens()
         app_lens = self.dash.get_current_lens()
 
@@ -185,7 +177,6 @@
         2. A category header stays highlight when it loses the focus
          and mouse is close to it (but not inside).
         """
-        self.dash.ensure_hidden()
         self.dash.reveal_application_lens()
 
         kb = Keyboard()
@@ -218,7 +209,6 @@
 
     def test_cltr_tab(self):
         """ This test makes sure that Ctlr + Tab works well."""
-        self.dash.ensure_hidden()
         self.dash.toggle_reveal()
 
         kb = Keyboard()
@@ -241,7 +231,6 @@
 
     def test_tab(self):
         """ This test makes sure that Tab works well."""
-        self.dash.ensure_hidden()
         self.dash.reveal_application_lens()
         app_lens = self.dash.get_current_lens()
 
@@ -277,7 +266,7 @@
 
     def setUp(self):
         super(DashClipboardTests, self).setUp()
-        self.dash = Dash()
+        self.dash.ensure_hidden()
 
     def tearDown(self):
         super(DashClipboardTests, self).tearDown()
@@ -285,7 +274,6 @@
 
     def test_ctrl_a(self):
         """ This test if ctrl+a selects all text """
-        self.dash.ensure_hidden()
         self.dash.toggle_reveal()
 
         kb = Keyboard();
@@ -300,7 +288,6 @@
 
     def test_ctrl_c(self):
         """ This test if ctrl+c copies text into the clipboard """
-        self.dash.ensure_hidden()
         self.dash.toggle_reveal()
 
         kb = Keyboard();
@@ -317,7 +304,6 @@
 
     def test_ctrl_x(self):
         """ This test if ctrl+x deletes all text and copys it """
-        self.dash.ensure_hidden()
         self.dash.toggle_reveal()
 
         kb = Keyboard();
@@ -336,7 +322,6 @@
 
     def test_ctrl_c_v(self):
         """ This test if ctrl+c and ctrl+v copies and pastes text"""
-        self.dash.ensure_hidden()
         self.dash.toggle_reveal()
 
         kb = Keyboard();
@@ -353,7 +338,6 @@
 
     def test_ctrl_x_v(self):
         """ This test if ctrl+x and ctrl+v cuts and pastes text"""
-        self.dash.ensure_hidden()
         self.dash.toggle_reveal()
 
         kb = Keyboard();
@@ -374,7 +358,7 @@
 
     def setUp(self):
         super(DashKeyboardFocusTests, self).setUp()
-        self.dash = Dash()
+        self.dash.ensure_hidden()
 
     def tearDown(self):
         super(DashKeyboardFocusTests, self).tearDown()
@@ -401,7 +385,7 @@
 
     def setUp(self):
         super(DashLensResultsTests, self).setUp()
-        self.dash = Dash()
+        self.dash.ensure_hidden()
 
     def tearDown(self):
         super(DashLensResultsTests, self).tearDown()
@@ -409,7 +393,6 @@
     
     def test_results_message_empty_search(self): 
         """ This tests a message is not shown when there is no text""" 
-        self.dash.ensure_hidden()
         self.dash.reveal_application_lens()
         lens = self.dash.get_current_lens()
 
@@ -418,7 +401,6 @@
 
     def test_results_message(self): 
         """ This test no mesage will be shown when results are there""" 
-        self.dash.ensure_hidden()
         self.dash.reveal_application_lens()
         lens = self.dash.get_current_lens()
 
@@ -431,7 +413,6 @@
 
     def test_no_results_message(self): 
         """ This test shows a message will appear in the lens""" 
-        self.dash.ensure_hidden()
         self.dash.reveal_application_lens()
         lens = self.dash.get_current_lens()
 
@@ -446,7 +427,7 @@
     """Tests that the dash visual is correct."""
     def setUp(self):
         super(DashVisualTests, self).setUp()
-        self.dash = Dash()
+        self.dash.ensure_hidden()
 
     def tearDown(self):
         super(DashVisualTests, self).tearDown()
@@ -465,3 +446,64 @@
             if (group.is_visible):
                 self.assertTrue(not group.expand_label_is_visible or
                                 (group.expand_label_y + group.expand_label_baseline == group.name_label_y + group.name_label_baseline))
+
+class DashSpecialKeysTests(AutopilotTestCase):
+    """Tests composition sequences, dead keys or any other special keys."""
+    def setUp(self):
+        super(DashSpecialKeysTests, self).setUp()
+        self.dash.ensure_hidden()
+
+    def tearDown(self):
+        super(DashSpecialKeysTests, self).tearDown()
+        self.dash.ensure_hidden()
+
+    def test_multi_key(self):
+        """Pressing 'Multi_key' must not add any characters to the search."""
+        self.dash.reveal_application_lens()
+      
+        kb = Keyboard();
+        kb.press_and_release('Multi_key')
+        kb.type("o")
+        sleep(1)
+
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual("", searchbar.search_string)
+
+    def test_multi_key_o(self):
+        """Pressing the sequences 'Multi_key' + '^' + 'o' must produce 'ô'."""
+        self.dash.reveal_application_lens()
+      
+        kb = Keyboard();
+        kb.press_and_release('Multi_key')
+        kb.type("^o")
+        sleep(1)
+
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual("ô", searchbar.search_string)
+
+    def test_multi_key_copyright(self):
+        """Pressing the sequences 'Multi_key' + 'c' + 'o' must produce '©'."""
+        self.dash.reveal_application_lens()
+      
+        kb = Keyboard();
+        kb.press_and_release('Multi_key')
+        kb.type("oc")
+        sleep(1)
+
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual("©", searchbar.search_string)
+
+    def test_multi_key_delete(self):
+        """Pressing 'Multi_key' must not get stuck looking for a sequence."""
+        self.dash.reveal_application_lens()
+
+        kb = Keyboard();
+        kb.type("dd")
+        sleep(1)
+        kb.press_and_release('Multi_key')
+        kb.press_and_release('BackSpace')
+        kb.press_and_release('BackSpace')
+        sleep(1)
+
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual("d", searchbar.search_string)