Unity 8
 All Classes Functions
dash.py
1 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
2 #
3 # Unity Autopilot Test Suite
4 # Copyright (C) 2012, 2013, 2014 Canonical
5 #
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #
19 
20 import logging
21 import ubuntuuitoolkit
22 
23 from unity8.shell import emulators
24 
25 from autopilot import logging as autopilot_logging
26 from autopilot.introspection import dbus
27 from ubuntuuitoolkit import emulators as toolkit_emulators
28 
29 
30 logger = logging.getLogger(__name__)
31 
32 
33 class DashApp(object):
34 
35  """Autopilot helper for the Dash app."""
36 
37  def __init__(self, app_proxy):
38  self.app_proxy = app_proxy
39  self.main_view = self.app_proxy.select_single(
40  toolkit_emulators.MainView)
41  self.dash = self.main_view.select_single(Dash)
42 
43 
45  """An emulator that understands the Dash."""
46 
47  def __init__(self, *args):
48  super(Dash, self).__init__(*args)
49  self.dash_content_list = self.wait_select_single(
50  'QQuickListView', objectName='dashContentList')
51 
52  def get_applications_grid(self):
53  get_grid = self.get_scope('clickscope').wait_select_single(
54  'CardGrid', objectName='local')
55  return get_grid
56 
57  def get_application_icon(self, text):
58  """Returns a 'Tile' icon that has the text 'text' from the application
59  grid.
60 
61  :param text: String containing the text of the icon to search for.
62 
63  """
64  app_grid = self.get_applications_grid()
65  resp_grid = app_grid.wait_select_single('ResponsiveGridView')
66  return resp_grid.select_single('Tile', text=text)
67 
68  def get_scope(self, scope_name='clickscope'):
69  return self.dash_content_list.wait_select_single(
70  'QQuickLoader', scopeId=scope_name)
71 
72  def get_scope_by_index(self, scope_index=0):
73  return self.dash_content_list.wait_select_single(
74  'QQuickLoader', objectName=("scopeLoader%i" % scope_index))
75 
76  @autopilot_logging.log_action(logger.info)
77  def open_scope(self, scope_id):
78  """Open a dash scope.
79 
80  :parameter scope_id: The id of the scope.
81  :return: The scope.
82 
83  """
84  scope_loader = self._get_scope_loader(scope_id)
85  if scope_loader.isCurrent:
86  logger.info('The scope is already open.')
87  return self._get_scope_from_loader(scope_loader)
88  else:
89  return self._open_scope_scrolling(scope_loader)
90 
91  def _get_scope_loader(self, scope_id):
92  try:
93  return self.dash_content_list.wait_select_single(
94  'QQuickLoader', scopeId=scope_id)
95  except dbus.StateNotFoundError:
97  'No scope found with id {0}'.format(scope_id))
98 
99  def _get_scope_from_loader(self, loader):
100  return loader.wait_select_single('GenericScopeView');
101 
102  def _open_scope_scrolling(self, scope_loader):
103  scroll = self._get_scroll_direction(scope_loader)
104 
105  while not scope_loader.isCurrent:
106  scroll()
107  self.dash_content_list.moving.wait_for(False)
108 
109  scope_loader.isCurrent.wait_for(True)
110  scope = self._get_scope_from_loader(scope_loader)
111  return scope
112 
113  def _get_scroll_direction(self, scope_loader):
114  current_scope_loader = self.dash_content_list.select_single(
115  'QQuickLoader', isCurrent=True)
116  if scope_loader.globalRect.x < current_scope_loader.globalRect.x:
117  return self._scroll_to_left_scope
118  elif scope_loader.globalRect.x > current_scope_loader.globalRect.x:
119  return self._scroll_to_right_scope
120  else:
121  raise emulators.UnityEmulatorException('The scope is already open')
122 
123  @autopilot_logging.log_action(logger.info)
124  def _scroll_to_left_scope(self):
125  original_index = self.dash_content_list.currentIndex
126  dash_content = self.select_single(objectName="dashContent")
127  x, y, width, height = dash_content.globalRect
128  start_x = x + width / 3
129  stop_x = x + width / 3 * 2
130  start_y = stop_y = y + 1
131  self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
132  self.dash_content_list.currentIndex.wait_for(original_index - 1)
133 
134  @autopilot_logging.log_action(logger.info)
135  def _scroll_to_right_scope(self):
136  original_index = self.dash_content_list.currentIndex
137  dash_content = self.select_single(objectName="dashContent")
138  x, y, width, height = dash_content.globalRect
139  start_x = x + width / 3 * 2
140  stop_x = x + width / 3
141  start_y = stop_y = y + 1
142  self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
143  self.dash_content_list.currentIndex.wait_for(original_index + 1)
144 
145  def enter_search_query(self, query):
146  current_header = self._get_current_page_header()
147  search_button = current_header.select_single(objectName="search_header_button")
148  self.pointing_device.move(search_button.globalRect.x + search_button.width / 2,
149  search_button.globalRect.y + search_button.height / 2)
150  self.pointing_device.click()
151  headerContainer = current_header.select_single(
152  objectName="headerContainer")
153  headerContainer.contentY.wait_for(0)
154  search_text_field = self._get_search_text_field()
155  search_text_field.write(query)
156  self.select_single(objectName="processingIndicator").visible.wait_for(False)
157 
158  def _get_search_text_field(self):
159  page_header = self._get_current_page_header()
160  return page_header.select_single(objectName='searchTextField')
161 
162  def _get_current_page_header(self):
163  dashContentList = self.select_single(objectName="dashContentList")
164  all_headers = dashContentList.select_many("QQuickLoader")
165  for i in all_headers:
166  if i.isCurrent:
167  return i.select_single(objectName="scopePageHeader")
168  return None
169 
170 
171 class ListViewWithPageHeader(ubuntuuitoolkit.QQuickFlickable):
172  pass
173 
174 
175 class GenericScopeView(emulators.UnityEmulatorBase):
176  """Autopilot emulator for generic scopes."""
177 
178  @autopilot_logging.log_action(logger.info)
179  def open_preview(self, category, app_name):
180  """Open the preview of an application.
181 
182  :parameter category: The name of the category where the application is.
183  :parameter app_name: The name of the application.
184  :return: The opened preview.
185 
186  """
187  # FIXME some categories need a long press in order to see the preview.
188  # Some categories do not show previews, like recent apps.
189  # --elopio - 2014-1-14
190  self.click_scope_item(category, app_name)
191  preview_list = self.wait_select_single(
192  'QQuickLoader', objectName='subPageLoader')
193  preview_list.subPageShown.wait_for(True)
194  preview_list.x.wait_for(0)
195  return preview_list.select_single(
196  Preview, objectName='preview{}'.format(preview_list.currentIndex))
197 
198  @autopilot_logging.log_action(logger.debug)
199  def click_scope_item(self, category, title):
200  """Click an item from the scope.
201 
202  :parameter category: The name of the category where the item is.
203  :parameter title: The title of the item.
204 
205  """
206  category_element = self._get_category_element(category)
207  icon = category_element.select_single('AbstractButton', title=title)
208  self.pointing_device.click_object(icon)
209 
210  def _get_category_element(self, category):
211  try:
212  return self.wait_select_single(
213  'DashCategoryBase', objectName='dashCategory{}'.format(category))
214  except dbus.StateNotFoundError:
216  'No category found with name {}'.format(category))
217 
218  def get_applications(self, category):
219  """Return the list of applications on a category.
220 
221  :parameter category: The name of the category.
222 
223  """
224  category_element = self._get_category_element(category)
225  see_all = category_element.select_single(objectName='seeAll')
226  application_cards = category_element.select_many('AbstractButton')
227 
228  application_cards = sorted(
229  (card for card in application_cards
230  if card.globalRect.y < see_all.globalRect.y),
231  key=lambda card: (card.globalRect.y, card.globalRect.x))
232 
233  result = []
234  for card in application_cards:
235  if card.objectName not in ('cardToolCard', 'seeAll'):
236  result.append(card.title)
237  return result
238 
239 
241  """Autopilot custom proxy object for generic previews."""