Merge lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser into lp:ubuntu-autopilot-tests

[Prabhendu V Senan]

[Dan Chapman  (dpniel)]

First off this is a great start :-) Well Done. Its always the trickiest part learning what you can and can't do with autopilot.

So my first thoughts are (and keeping in mind the near release of autopilot 1.4),

1) the test window title failed on my box. Due to having a different locale where analyzer is actually analyser. So to make this work you would probably be better testing the title with something like Contains('Disk Usage'). Then we miss the strange locale issues.

Note that if you wanted the test to pass on any locale you could assertThat(title, NotEquals(None)) and then assertIsInstance(title, unicode). This will test that the title contains text (we don't know what the title text will be, but we can test the title is there and that its unicode.

2) the other 3 tests are very similar so you could probably break them up a little. My first point with this is you are finishing each test outside of the test function with the self.disk_usage_display_common() call. Ideally you should be finishing each test with asserts as the last lines inside your test function. This way you can see the intended end result of the test i.e "the treeviewmap and ringmap should display a 'x' directory/folder" try and do the setup type parts to get you to the point you need outside the test function and then come back once setup to test the thing you are actually testing

another thing when entering /home in the file chooser dialog you should use the provided function in the keyboard class 'focused_type' so for example once you have clicked the toggle button and the entry is visible you could use something like this

entry = self.app.select_single('GtkFileChooserEntry')
with self.keyboard.focused_type(entry) as kb:
    kb.type('/home')
    self.assertThat(entry.text, Equals('/home'))
    kb.press_and_release('Enter')

This will get the entries focus and type the text see http://unity.ubuntu.com/autopilot/api/input.html#autopilot.input.Keyboard.focused_type

There is also some changes needed to be made for 1.4 if you check this link about boolean properties are now represented correctly and not 1/0. http://unity.ubuntu.com/autopilot/porting/porting.html#gtk-tests-and-boolean-parameters

I'll leave it there for now and see how we fair once these changes are made.

Feel free to ping myself or balloons if your are getting stuck :-)

[Dan Chapman  (dpniel)]

Senan hey,

So what i was trying to say in IRC is that you are repeating code in a few of your tests. So lets use the test_scan_local_folder for this example and you will be able to use it in the other test just as easy

lets start with this part of the test

def test_scan_local_folder(self):
    self.gear_menu_option_button = self.app.select_single(BuilderName='menu-button')
    self.pointing_device.move_to_object(self.gear_menu_option_button)
    self.pointing_device.click()
    self.create_scan_folder_menu_item = self.app.select_single('GtkModelMenuItem',action_name= 'win.scan-folder')
    self.pointing_device.move_to_object(self.create_scan_folder_menu_item)
    self.pointing_device.click()

you use this same process in two tests but selecting a different GtkModelMenuItem for each test, so this can be broken out into its own function and you pass in the name of the GtkModelMenuItem you need for each test

you should use more descriptive names than this, i'm just showing examples

def test_scan_local_folder(self):
    self.open_folder_dialog('win.scan-folder')
    # .. Rest of test ..

def open_folder_dialog(self, item_name):
    gear_menu_option_button = self.app.select_single(BuilderName='menu-button')
    self.pointing_device.click_object(self.gear_menu_option_button)
    #now select the passed in menu item
    create_scan_folder_menu_item = self.app.select_single('GtkModelMenuItem',action_name=item_name)
    self.pointing_device.click_object(create_scan_folder_menu_item)

so now for your tests you can reuse this and just pass in the action_name of the menu item
i.e
self.open_folder_dialog('win.scan-folder')
self.open_folder_dialog('win.scan-remote')

Thats an example of what i mean by breaking up the tests a bit and re-using code makes it easier to maintain.

Regarding my comments on finishing the tests inside the test function, currently on some of the tests you call self.disk_usage_display_common() as the last call of your test, this in effect takes us out of the test function and we have to go looking elswhere to see what the intent of the test function is trying to assert. Each test method should work like

def Test
    1) setup the test (this is the setup function which starts baobab)
    2) get the test into the required state for this test. ( so using functions outside the test function )
    3) once in the required state for the test, assert what we want to test. as the last part of the test function

take a look at the gedit test as an example the test are only testing one thing only then move on to the next test.

so as an example you could break tests up like

1) test we can open home folder ( but we do not check the folder is being displayed properly thats another test)
2) test that the tree map diplays the home folder
3) test trying to open a folder that doesn't exist.

Each test should not depend on any other test. So create functions of common code that you can use to get a test to its 'required state'

I hope this is of some help

[lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser]

61. By Prabhendu V Senan on 2013-11-07

Renamed DiskUsageAnalyser to DiskUsageAnalyzer

62. By Prabhendu V Senan on 2013-11-11

split tests into small tests

63. By Prabhendu V Senan on 2013-11-11

Recommiting

[Dan Chapman  (dpniel)]

Senan

so the test_window_title is still failing for me due to the locale issue with the spelling of analyser so i would just remove that and assert 'Disk Usage '.

Also when entering text you need explicitly make sure you get the text entry focus, by either clicking on it assert entry.is_focus = True and then type or you can use the focused_type context manager. e.g currenlty you have this

111 + self.create_toggle_button = self.app.select_single('GtkToggleButton',tooltip_text=u'Type a file name')
112 + self.pointing_device.move_to_object(self.create_toggle_button)
113 + self.pointing_device.click()
114 + self.keyboard.type(key_input)

Which once you have clicked the toggle button we do not actually know if the entry is now visable and has focus before typing. So after the clicking the toggle button you need to

1) assert entry.visible == True

2) either click on the entry and assert entry.is_focus == True before typing
or use the focused_type context manager (which i prefer) which looks something like

entry = self.app.select_single('GtkFileChooserEntry')
 with self.keyboard.focused_type(entry) as kb:
     kb.type(key_input)
     self.assertThat(entry.text, Equals(key_input)) (after typing assert it type correctly)
     kb.press_and_release('Enter')

3) test you have ended where you expected :-)

So anywhere in your tests you are entering text you need to do one of the above so we know the entry has focus if we can't get focus then we have a bug :-)

One last thing all boolean values your test that are using ints need to be changed for autopilot 1.4 i.e

self.assertThat(window.visible, Equals(1)) will become self.assertThat(window.visible, Equals(True)) and all 0 values become False. If you are on saucy install autopilot from the ppa:autopilot/ppa and you will get autopilot 1.4
We need to make our tests compliant with 1.4 as soon as possible.

THank you for iterating over these tests, your doing a great job and soon you will get into the swing of it, just hang in there :-)

Dan

[lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser]

64. By Prabhendu V Senan on 2013-11-19

added new assertion

[Dan Chapman  (dpniel)]

Hey senan, i'm still looking into the problems we were having last night. I am waiting on a reply from someone who may no more so as soon as hear anything we will move onwards with this. Sorry about the delay, sometimes these little niggles need sorting first :-)

Hope you are well

Dan

[Prabhendu V Senan (senan)]

Thanks Dan
On 22 Nov 2013 16:36, "Dan Chapman" <email address hidden> wrote:

> Hey senan, i'm still looking into the problems we were having last night.
> I am waiting on a reply from someone who may no more so as soon as hear
> anything we will move onwards with this. Sorry about the delay, sometimes
> these little niggles need sorting first :-)
>
> Hope you are well
>
> Dan
> --
>
> https://code.launchpad.net/~senan/ubuntu-autopilot-tests/DiskUsageAnalyser/+merge/193087
> You are the owner of lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser.
>

[Dan Chapman  (dpniel)]

Senan hey you left too soon, ok ive been having a play and added something ive been working on for a little while (some helpful emulators :-) ), ive adapted your branch slightly here https://code.launchpad.net/~dpniel/+junk/baobab and it uses emulators for selecting items in tree so feel free to branch it have a play and see what you can come up with, take a while to look through emulators.py and see whats happening :-)

Hope this helps in the mean time till we can figure out what the difference is between desktop and sandbox

Dan

[lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser]

65. By Prabhendu V Senan on 2013-12-17

Fixed mouse issue

[Prabhendu V Senan (senan)]

Hi Dan,

I've made some changes to the code in order to address the
filechooserdialog treeview click issue. http://paste.ubuntu.com/6612284/ .
But I am sure its not the best way to resolve the issue. But I am still not
able to identify the treeview. Looking forward to your review comments.

On Tue, Oct 29, 2013 at 10:01 PM, Prabhendu V Senan <<email address hidden>
> wrote:

> Prabhendu V Senan has proposed merging
> lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser into
> lp:ubuntu-autopilot-tests.
>
> Requested reviews:
> Ubuntu Testcase Admins (ubuntu-testcase)
>
> For more details, see:
>
> https://code.launchpad.net/~senan/ubuntu-autopilot-tests/DiskUsageAnalyser/+merge/193087
> --
>
> https://code.launchpad.net/~senan/ubuntu-autopilot-tests/DiskUsageAnalyser/+merge/193087
> You are the owner of lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser.
>
> === added directory 'ubuntu_autopilot_tests/DiskUsageAnalyser'
> === added file 'ubuntu_autopilot_tests/DiskUsageAnalyser/__init__.py'
> === added file
> 'ubuntu_autopilot_tests/DiskUsageAnalyser/test_diskUsageAnalyser.py'
> --- ubuntu_autopilot_tests/DiskUsageAnalyser/test_diskUsageAnalyser.py
> 1970-01-01 00:00:00 +0000
> +++ ubuntu_autopilot_tests/DiskUsageAnalyser/test_diskUsageAnalyser.py
> 2013-10-29 16:26:36 +0000
> @@ -0,0 +1,95 @@
> +from autopilot.testcase import AutopilotTestCase
> +from autopilot.matchers import Eventually
> +from testtools.matchers import Equals, Contains, NotEquals
> +
> +from autopilot.input import Mouse, Pointer
> +
> +import os
> +from time import sleep
> +
> +class DiskUsageAnalyserTests(AutopilotTestCase):
> +
> + def setUp(self):
> + super(DiskUsageAnalyserTests,self).setUp()
> + self.app = self.launch_test_application('baobab')
> + self.mainWindowTitle = self.app.select_single('BaobabWindow')
> + self.pointing_device = Pointer(Mouse.create())
> +
> + def test_window_title(self):
> + # Verify the Disk Usage Analyzer application Title
> +
> self.assertThat(self.mainWindowTitle.title,Eventually(Contains('Disk Usage
> Analyzer')))
> +
> + def test_scan_local_folder(self):
> + self.gear_menu_option_button =
> self.app.select_single(BuilderName='menu-button')
> +
> self.pointing_device.move_to_object(self.gear_menu_option_button)
> + self.pointing_device.click()
> + self.create_scan_folder_menu_item =
> self.app.select_single('GtkModelMenuItem',action_name= 'win.scan-folder')
> +
> self.pointing_device.move_to_object(self.create_scan_folder_menu_item)
> + self.pointing_device.click()
> + self.assertThat(lambda:
> self.app.select_single('GtkFileChooserDialog').visible,Eventually(Equals(1)))
> + dialog = self.app.select_single('GtkFileChooserDialog')
> + self.assertThat(dialog.title,Eventually(Equals('Select
> Folder')))
> + tree_view = dialog.select_many('GtkTreeView')[0]
> + self.pointing_device.click_object(tree_view)
> +
> + self.create_toggle_button =
> self.app.select_single('GtkToggleButton',tooltip_text=u'Type a file name')
> +
> self.po...

[lp:~senan/ubuntu-autopilot-tests/DiskUsageAnalyser]

66. By Prabhendu V Senan on 2013-12-27

Fixed bug

67. By Prabhendu V Senan on 2014-01-17

fixed tree clicking

68. By senan<email address hidden> on 2014-01-25

added scan remote folder check

69. By senan<email address hidden> on 2014-01-25

refactored code

70. By senan<email address hidden> on 2014-02-16

addeded new assesrion and validations

71. By senan<email address hidden> on 2014-02-21

used index instead of menu names. fixed remote folder dialog

72. By senan<email address hidden> on 2014-02-24

removed sleep from test

73. By senan<email address hidden> on 2014-02-27

broken asserions into simple ones

74. By senan<email address hidden> on 2014-03-04

added bug number to the file

75. By senan<email address hidden> on 2014-03-07

renamed file

76. By senan<email address hidden> on 2014-03-07

added renamed file

77. By senan<email address hidden> on 2014-03-07

renamed file and folder for consistancy

78. By senan<email address hidden> on 2014-03-07

Formatted the code

79. By senan<email address hidden> on 2014-03-07

Formatted Code

80. By senan<email address hidden> on 2014-03-15

added mock

81. By senan<email address hidden> on 2014-03-15

added mock

82. By senan<email address hidden> on 2014-03-16

Added mock to create fake home directory

83. By senan<email address hidden> on 2014-03-18

added mock py2 py3 compatibility

84. By senan<email address hidden> on 2014-03-18

fixed scan_remote_folder input field issue

85. By senan<email address hidden> on 2014-03-18

added comments

86. By senan<email address hidden> on 2014-03-18

added comment for gear menu deselection

Unmerged revisions

=== added file '__init__.py'
=== added directory 'ubuntu_autopilot_tests/DiskUsageAnalyser'
=== added file 'ubuntu_autopilot_tests/DiskUsageAnalyser/__init__.py'
=== added file 'ubuntu_autopilot_tests/DiskUsageAnalyser/test_diskUsageAnalyser.py'
--- ubuntu_autopilot_tests/DiskUsageAnalyser/test_diskUsageAnalyser.py	1970-01-01 00:00:00 +0000
+++ ubuntu_autopilot_tests/DiskUsageAnalyser/test_diskUsageAnalyser.py	2014-01-25 13:59:32 +0000
@@ -0,0 +1,149 @@
+from autopilot.testcase import AutopilotTestCase
+from autopilot.matchers import Eventually
+from testtools.matchers import Equals, Contains, NotEquals
+from autopilot.introspection import get_proxy_object_for_existing_process
+
+from autopilot.input import Mouse, Pointer
+
+import os
+from time import sleep
+import subprocess
+
+class DiskUsageAnalyzerTests(AutopilotTestCase):
+
+	def setUp(self):		
+	    super(DiskUsageAnalyzerTests,self).setUp()
+	    self.app = self.launch_test_application('baobab')
+	    self.mainWindowTitle = self.app.select_single('BaobabWindow')
+	    self.pointing_device = Pointer(Mouse.create())
+	    
+	def test_window_title(self):
+		# Verify the Disk Usage Analyzer application Title
+	    self.assertThat(self.mainWindowTitle.title,Eventually(Contains('Disk Usage')))
+		
+	def test_scan_local_folder(self):
+		self.open_scan_folder_dialog(u'Scan Folder\u2026')
+		self.assertThat(lambda: self.app.select_single('GtkFileChooserDialog').visible,Eventually(Equals(True)))
+		self.open_file_chooser_dialog('/home/')
+		self.assertThat(lambda:self.app.select_single('GdHeaderBar',BuilderName='result-header-bar').title,Eventually(Contains('home')))
+		
+	def test_scan_remote_folder(self):
+		#Scan remote folder--check only the UI components
+		self.open_scan_folder_dialog(u'Scan Remote Folder\u2026')
+		self.pointing_device.move_to_object(self.gear_menu_option_button)
+		self.pointing_device.click()
+		cmd_output = subprocess.Popen("ps -ef | pgrep nautilus-connect*",stdout=subprocess.PIPE, shell=True)
+		self.connect_server_dlg_pid,error  = cmd_output.communicate()
+		self.connect_server_dlg_pid = int(self.connect_server_dlg_pid.rstrip('\n'))
+		self.assertNotEqual(self.connect_server_dlg_pid,None)
+		self.connect_server_dlg_proxy_object = get_proxy_object_for_existing_process(pid=self.connect_server_dlg_pid)
+		input_server_name = self.connect_server_dlg_proxy_object.select_single('GtkEntry')
+		with self.keyboard.focused_type(input_server_name) as kb:
+			self.assertThat(input_server_name.is_focus,Equals(True))
+			kb.type('smb://foo.example.org')
+			kb.press_and_release('Delete')
+			self.assertThat(input_server_name.text,Equals('smb://foo.example.org'))
+		self.btn_connect = self.connect_server_dlg_proxy_object.select_single('GtkButton',label='C_onnect')
+		self.btn_cancel = self.connect_server_dlg_proxy_object.select_single('GtkButton',label='gtk-cancel')
+		self.assertThat(self.btn_connect.sensitive,Equals(True))
+		self.assertThat(self.btn_cancel.sensitive,Equals(True))
+		self.pointing_device.move_to_object(self.btn_cancel)
+		self.pointing_device.click()
+		
+	def test_home_list(self):
+		#scan home folder listed in the applocations start page
+		self.create_button_scan_home_folder = self.app.select_single('GtkLabel',label=u'<b>Home folder</b>')
+		self.pointing_device.move_to_object(self.create_button_scan_home_folder)
+		self.pointing_device.click()	
+		self.assertThat(lambda: self.app.select_single('GtkSpinner',BuilderName='spinner').sensitive,Eventually(Equals(True)))
+		self.show_tree_map()
+		self.assertThat(lambda: self.app.select_single('BaobabTreemap',BuilderName='treemap-chart').visible,Eventually(Equals(True)))
+		self.show_ring_chart()
+		self.assertThat(lambda: self.app.select_single('BaobabRingschart',BuilderName='rings-chart').visible,Eventually(Equals(True)))		
+	
+	def test_scan_folder_tree_map(self):
+		self.open_scan_folder_dialog(u'Scan Folder\u2026')
+		self.assertThat(lambda: self.app.select_single('GtkFileChooserDialog').visible,Eventually(Equals(True)))
+		self.open_file_chooser_dialog('/home/')
+		self.assertThat(lambda:self.app.select_single('GdHeaderBar',BuilderName='result-header-bar').title,Eventually(Contains('home')))
+		self.show_tree_map()
+		self.assertThat(lambda: self.app.select_single('BaobabTreemap',BuilderName='treemap-chart').visible,Eventually(Equals(1)))
+	
+	def test_scan_folder_ring_chart(self):
+		self.open_scan_folder_dialog(u'Scan Folder\u2026')
+		self.assertThat(lambda: self.app.select_single('GtkFileChooserDialog').visible,Eventually(Equals(1)))
+		self.open_file_chooser_dialog('/home/')
+		self.assertThat(lambda:self.app.select_single('GdHeaderBar',BuilderName='result-header-bar').title,Eventually(Contains('home')))
+		self.show_ring_chart()
+		self.assertThat(lambda: self.app.select_single('BaobabRingschart',BuilderName='rings-chart').visible,Eventually(Equals(True)))
+		
+	def show_tree_map(self):	
+		#Toggle treemap and ring chart
+		self.assertThat(lambda: self.app.select_single('GtkSpinner',BuilderName='spinner').sensitive,Eventually(Equals(True)))
+		self.tree_map_button = self.app.select_single('GtkRadioButton',BuilderName='treemap-button')
+		self.assertThat(self.tree_map_button.sensitive,Eventually(Equals(True)))
+		sleep(1)
+		self.pointing_device.move_to_object(self.tree_map_button)
+		self.pointing_device.click()
+	
+	def show_ring_chart(self):	
+		self.assertThat(lambda: self.app.select_single('GtkSpinner',BuilderName='spinner').sensitive,Eventually(Equals(True)))
+		self.ring_button = self.app.select_single('GtkRadioButton',BuilderName='rings-button')
+		self.assertThat(self.ring_button.sensitive,Eventually(Equals(True)))
+		sleep(1)
+		self.pointing_device.move_to_object(self.ring_button)
+		self.pointing_device.click()
+
+	def open_scan_folder_dialog(self,menu_item_name):
+		self.gear_menu_option_button = self.app.select_single(BuilderName='menu-button')
+		self.pointing_device.move_to_object(self.gear_menu_option_button)
+		self.pointing_device.click()
+		sleep(2)
+		window = self.app.select_many('GtkWindowAccessible')[1]
+		self.create_scan_folder_sub_menu_item = window.select_single('GtkCheckMenuItemAccessible', accessible_name=menu_item_name)
+		self.assertThat(self.create_scan_folder_sub_menu_item, NotEquals(None))
+		self.pointing_device.move_to_object(self.create_scan_folder_sub_menu_item)
+		self.pointing_device.click()
+		
+	def open_file_chooser_dialog(self,key_input):
+		dialog = self.app.select_single('GtkFileChooserDialog') 
+		self.assertThat(dialog.title,Eventually(Equals('Select Folder')))
+		places_sidebar = self.app.select_single('GtkPlacesSidebar',BuilderName=u'places_sidebar')
+		tree_view = places_sidebar.select_single('GtkTreeView')
+		tree_item = self.get_tree_item(tree_view,'Home')
+		self.pointing_device.move_to_object(tree_item)
+		self.pointing_device.click_object(tree_item)
+
+		self.create_toggle_button = self.app.select_single('GtkToggleButton',tooltip_text=u'Type a file name')
+		
+		if not self.create_toggle_button.active:
+			self.pointing_device.move_to_object(self.create_toggle_button)		
+			self.pointing_device.click()	
+		editBox = self.app.select_single('GtkFileChooserEntry')
+		#self.keyboard.focused_type(editBox)
+		self.assertThat(editBox.is_focus,Equals(True))
+		self.keyboard.type(key_input)
+		self.keyboard.press_and_release('Delete')
+		self.assertThat(editBox.text,Equals(key_input))
+		
+		#Open the scan directory
+		self.open_scan_dir = self.app.select_single('GtkLabel',label='_Open')
+		self.pointing_device.move_to_object(self.open_scan_dir)
+		self.pointing_device.click()	
+		
+	def get_tree_item(self, treeview_object, item_label):
+		""" Gets an item from a gtktreeview
+		param treeview_object: a selected GtkTreeView object
+		param item_label: Visual label value of the tree item i.e 'Documents'
+		returns treeview item object"""
+		#get all accessible treeviews
+		accessible_treeviews = self.app.select_many('GtkTreeViewAccessible')
+		# find the one that has the same globalRect as treeview_object
+		for treeview_accessible in accessible_treeviews:
+			if treeview_accessible.globalRect == treeview_object.globalRect:
+				#select our item from here
+				tree_item = treeview_accessible.select_many('GtkTextCellAccessible',accessible_name=item_label)
+				return tree_item[1]
+		    
+	   
+