Back to index

unity  6.0.0
Public Member Functions | Private Member Functions | Private Attributes
unity.tests.UnityTestCase Class Reference
Inheritance diagram for unity.tests.UnityTestCase:
Inheritance graph
[legend]
Collaboration diagram for unity.tests.UnityTestCase:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def setUp
def check_test_behavior
def dash
def hud
def launcher
def panels
def switcher
def window_manager
def workspace
def set_unity_log_level
def assertNumberWinsIsEventually

Private Member Functions

def _get_launcher_controller
def _get_panel_controller
def _get_window_manager
def _setUpUnityLogging
def _tearDownUnityLogging

Private Attributes

 _initial_workspace_num
 __dash
 __hud
 __launcher
 __panels
 __switcher
 __window_manager
 __workspace
 _unity_log_file_name

Detailed Description

Unity test case base class, with improvments specific to Unity tests.

Definition at line 40 of file __init__.py.


Constructor & Destructor Documentation

def unity.tests.UnityTestCase.__init__ (   self,
  args 
)

Definition at line 43 of file __init__.py.

00043 
00044     def __init__(self, *args):
00045         super(UnityTestCase, self).__init__(*args)


Member Function Documentation

Definition at line 151 of file __init__.py.

00151 
00152     def _get_launcher_controller(self):
00153         controllers = LauncherController.get_all_instances()
00154         self.assertThat(len(controllers), Equals(1))
00155         return controllers[0]

Definition at line 156 of file __init__.py.

00156 
00157     def _get_panel_controller(self):
00158         controllers = PanelController.get_all_instances()
00159         self.assertThat(len(controllers), Equals(1))
00160         return controllers[0]

Definition at line 161 of file __init__.py.

00161 
00162     def _get_window_manager(self):
00163         managers = WindowManager.get_all_instances()
00164         self.assertThat(len(managers), Equals(1))
00165         return managers[0]

Definition at line 166 of file __init__.py.

00166 
00167     def _setUpUnityLogging(self):
00168         self._unity_log_file_name = mktemp(prefix=self.shortDescription())
00169         start_log_to_file(self._unity_log_file_name)
00170         self.addCleanup(self._tearDownUnityLogging)

Here is the caller graph for this function:

Definition at line 171 of file __init__.py.

00171 
00172     def _tearDownUnityLogging(self):
00173         # If unity dies, our dbus interface has gone, and reset_logging will fail
00174         # but we still want our log, so we ignore any errors.
00175         try:
00176             reset_logging()
00177         except DBusException:
00178             pass
00179         with open(self._unity_log_file_name) as unity_log:
00180             self.addDetail('unity-log', text_content(unity_log.read()))
00181         os.remove(self._unity_log_file_name)
00182         self._unity_log_file_name = ""

Here is the call graph for this function:

def unity.tests.UnityTestCase.assertNumberWinsIsEventually (   self,
  app,
  num 
)
Asserts that 'app' eventually has 'num' wins. Waits up to 10 seconds.

Definition at line 196 of file __init__.py.

00196 
00197     def assertNumberWinsIsEventually(self, app, num):
00198         """Asserts that 'app' eventually has 'num' wins. Waits up to 10 seconds."""
00199 
00200         self.assertThat(lambda: len(app.get_windows()), Eventually(Equals(num)))

Here is the caller graph for this function:

Fail the test if it did something naughty.

This includes leaving the dash or the hud open, changing the current
workspace, or leaving the system in show_desktop mode.

Definition at line 56 of file __init__.py.

00056 
00057     def check_test_behavior(self):
00058         """Fail the test if it did something naughty.
00059 
00060         This includes leaving the dash or the hud open, changing the current
00061         workspace, or leaving the system in show_desktop mode.
00062 
00063         """
00064         well_behaved = True
00065         reasons = []
00066         log.info("Checking system state for badly behaving test...")
00067 
00068         # Have we switched workspace?
00069         if self.workspace.current_workspace != self._initial_workspace_num:
00070             well_behaved = False
00071             reasons.append("The test changed the active workspace from %d to %d." \
00072                 % (self._initial_workspace_num, self.workspace.current_workspace))
00073             log.warning("Test changed the active workspace, changing it back...")
00074             self.workspace.switch_to(self._initial_workspace_num)
00075         # Have we left the dash open?
00076         if self.dash.visible:
00077             well_behaved = False
00078             reasons.append("The test left the dash open.")
00079             log.warning("Test left the dash open, closing it...")
00080             self.dash.ensure_hidden()
00081         # ... or the hud?
00082         if self.hud.visible:
00083             well_behaved = False
00084             reasons.append("The test left the hud open.")
00085             log.warning("Test left the hud open, closing it...")
00086             self.hud.ensure_hidden()
00087         # Are we in show desktop mode?
00088         if self.window_manager.showdesktop_active:
00089             well_behaved = False
00090             reasons.append("The test left the system in show_desktop mode.")
00091             log.warning("Test left the system in show desktop mode, exiting it...")
00092             self.window_manager.leave_show_desktop()
00093         for launcher in self.launcher.get_launchers():
00094             if launcher.in_keynav_mode:
00095                 well_behaved = False
00096                 reasons.append("The test left the launcher keynav mode enabled.")
00097                 log.warning("Test left the launcher in keynav mode, exiting it...")
00098                 launcher.key_nav_cancel()
00099             if launcher.in_switcher_mode:
00100                 well_behaved = False
00101                 reasons.append("The test left the launcher in switcher mode.")
00102                 log.warning("Test left the launcher in switcher mode, exiting it...")
00103                 launcher.switcher_cancel()
00104 
00105         if not well_behaved:
00106             self.fail("/n".join(reasons))
00107         else:
00108             log.info("Test was well behaved.")

Definition at line 110 of file __init__.py.

00110 
00111     def dash(self):
00112         if not getattr(self, '__dash', None):
00113             self.__dash = Dash()
00114         return self.__dash

Definition at line 116 of file __init__.py.

00116 
00117     def hud(self):
00118         if not getattr(self, '__hud', None):
00119             self.__hud = Hud();
00120         return self.__hud

Definition at line 122 of file __init__.py.

00122 
00123     def launcher(self):
00124         if not getattr(self, '__launcher', None):
00125             self.__launcher = self._get_launcher_controller()
00126         return self.__launcher

Definition at line 128 of file __init__.py.

00128 
00129     def panels(self):
00130         if not getattr(self, '__panels', None):
00131             self.__panels = self._get_panel_controller()
00132         return self.__panels

def unity.tests.UnityTestCase.set_unity_log_level (   self,
  component,
  level 
)
Set the unity log level for 'component' to 'level'.

Valid levels are: TRACE, DEBUG, INFO, WARNING and ERROR.

Components are dotted unity component names. The empty string specifies
the root logging component.

Definition at line 183 of file __init__.py.

00183 
00184     def set_unity_log_level(self, component, level):
00185         """Set the unity log level for 'component' to 'level'.
00186 
00187         Valid levels are: TRACE, DEBUG, INFO, WARNING and ERROR.
00188 
00189         Components are dotted unity component names. The empty string specifies
00190         the root logging component.
00191         """
00192         valid_levels = ('TRACE', 'DEBUG', 'INFO', 'WARN', 'WARNING', 'ERROR')
00193         if level not in valid_levels:
00194             raise ValueError("Log level '%s' must be one of: %r" % (level, valid_levels))
00195         set_log_severity(component, level)

Here is the call graph for this function:

Here is the caller graph for this function:

Reimplemented in unity.tests.test_panel.PanelCrossMonitorsTests, unity.tests.test_dash.DashBorderTests, unity.tests.test_dash.DashLensBarTests, unity.tests.test_hud.HudVisualTests, unity.tests.test_hud.HudLockedLauncherInteractionsTests, unity.tests.test_hud.HudLauncherInteractionsTests, unity.tests.test_switcher.SwitcherDetailsTests, unity.tests.test_panel.PanelWindowButtonsTests, unity.tests.test_ibus.IBusTestsAnthyIgnore, unity.tests.test_ibus.IBusTestsPinyinIgnore, unity.tests.test_ibus.IBusTestsAnthy, unity.tests.test_quicklist.QuicklistKeyNavigationTests, unity.tests.test_ibus.IBusTestsHangul, unity.tests.test_dash.DashMultiKeyTests, unity.tests.test_ibus.IBusTestsPinyin, unity.tests.test_hud.HudBehaviorTests, unity.tests.test_hud.HudTestsBase, unity.tests.test_panel.PanelTestsBase, unity.tests.launcher.LauncherTestCase, unity.tests.test_switcher.SwitcherTests, unity.tests.launcher.test_capture.LauncherCaptureTests, unity.tests.test_ibus.IBusTests, unity.tests.launcher.test_icon_behavior.LauncherIconsTests, unity.tests.launcher.test_reveal.LauncherRevealTests, unity.tests.launcher.test_shortcut.LauncherShortcutTests, unity.tests.test_shortcut_hint.BaseShortcutHintTests, unity.tests.test_command_lens.CommandLensSearchTests, unity.tests.test_dash.DashTestCase, unity.tests.test_home_lens.HomeLensSearchTests, and unity.tests.test_showdesktop.ShowDesktopTests.

Definition at line 46 of file __init__.py.

00046 
00047     def setUp(self):
00048         super(UnityTestCase, self).setUp()
00049         self._setUpUnityLogging()
00050         self._initial_workspace_num = self.workspace.current_workspace
00051         self.addCleanup(self.check_test_behavior)
00052         #
00053         # Setting this here since the show desktop feature seems to be a bit
00054         # ropey. Once it's been proven to work reliably we can remove this line:
00055         self.set_unity_log_level("unity.plugin", "DEBUG")

Here is the call graph for this function:

Definition at line 134 of file __init__.py.

00134 
00135     def switcher(self):
00136         if not getattr(self, '__switcher', None):
00137             self.__switcher = Switcher()
00138         return self.__switcher

Definition at line 140 of file __init__.py.

00140 
00141     def window_manager(self):
00142         if not getattr(self, '__window_manager', None):
00143             self.__window_manager = self._get_window_manager()
00144         return self.__window_manager

Definition at line 146 of file __init__.py.

00146 
00147     def workspace(self):
00148         if not getattr(self, '__workspace', None):
00149             self.__workspace = WorkspaceManager()
00150         return self.__workspace


Member Data Documentation

Definition at line 112 of file __init__.py.

Definition at line 118 of file __init__.py.

Definition at line 124 of file __init__.py.

Definition at line 130 of file __init__.py.

Definition at line 136 of file __init__.py.

Definition at line 142 of file __init__.py.

Definition at line 148 of file __init__.py.

Definition at line 49 of file __init__.py.

Definition at line 167 of file __init__.py.


The documentation for this class was generated from the following file: