Merge lp:~dpniel/ubuntu-autopilot-tests/evince-autopilot-1.3 into lp:ubuntu-autopilot-tests

[Dan Chapman ]

4 working tests
- Display pdf
- Changing pages
- Search document
- Side bar open and close

1 non-working test
- Fullscreen mode

One sleep has snuck its way in due to not being able to introspect the Yelp print dialog. Might be beacuse it introspecting a different application from within a different. Although vis shows Yelp and GtkPrintUnixDialog, the test didnt seem to like it. So have set the sleep to 10 seconds

[Nicholas Skaggs (nskaggs)]

Looks good.. Almost got out without needing to fallback because of issues. We'll look into the wmstate for the fullscreen test too. Thanks!

review: Approve

=== modified file 'ubuntu_autopilot_tests/evince/test_evince.py'
--- ubuntu_autopilot_tests/evince/test_evince.py	2013-01-17 20:27:58 +0000
+++ ubuntu_autopilot_tests/evince/test_evince.py	2013-06-04 15:36:31 +0000
@@ -1,182 +1,202 @@
 from autopilot.testcase import AutopilotTestCase
 from autopilot.matchers import Eventually
-from testtools.matchers import Equals, Contains
+from testtools.matchers import Equals, Contains, NotEquals
+
+from autopilot.input import Mouse, Touch, Pointer
 
 from time import sleep
 import tempfile
 import os
-
-#Register Evince as an application so we can call it
-AutopilotTestCase.register_known_application("Document Viewer", "evince.desktop", "evince")
-
-#http://packages.qa.ubuntu.com/qatracker/testcases/1417/info
+ 
+
+ 
+
 class EvinceTests(AutopilotTestCase):
-
+ 
     def setUp(self):
         super(EvinceTests, self).setUp()
-        self.app = self.start_app_window("Document Viewer")
-
-        #This will make sure evince window you launched is focused and ready to accept your keyboard input
-        self.app.set_focus()
-        self.assertTrue(self.app.is_focused)
-
+        self.app = self.launch_test_application('evince')
+        
+        self.windowTitle = self.app.select_single('EvWindow') 
+        self.prev_button = self.app.select_single('GtkButton', tooltip_text='Go to the previous page')
+        self.next_button = self.app.select_single('GtkButton', tooltip_text='Go to the next page')
+        self.page_num_box = self.app.select_single('GtkBox', tooltip_text='Select Page')
+        self.search_button = self.app.select_single('GtkToggleButton',
+                                                    tooltip_text='Find a word or phrase in the document')
+        self.entry = self.page_num_box.get_children_by_type('GtkEntry')[0]
+        self.pointing_device = Pointer(Mouse.create())
+        
     def test_display_pdf_file(self):
-        #Test-case name: evince/evn-001
-        #This test will check that Evince can display PDFs correctly
-        #Create pdf
+        '''test to view a pdf file'''
+        #Generate a temp file name, and split the path
         tempFile = _generateTempFileName()
-        self.createFile(tempFile)
-
-        #Open pdf
-        self.openFile(tempFile)
-        sleep(5)
-        #Verify Is the selected PDF displayed correctly?
         (dirName, fileName) = os.path.split(tempFile)
-        self.assertThat(lambda: self.app.name, Eventually(Contains(fileName)))
-
-        #Delete pdf
-        self.deleteFile(tempFile)
-
-    def test_enter_fullscreen_mode(self):
-        #Test-case name: evince/evn-002
-        #This test will check that Evince can enter fullscreen mode via F11
-
-        #Press F11
-        self.keyboard.press_and_release("F11")
-        sleep(5)
-
-        #Does Evince enter fullscreen mode?
-        windowState = self.app._get_window_states()
-        self.assertThat(windowState, Contains("_NET_WM_STATE_FULLSCREEN"))
-
-
-    def test_exit_fullscreen_mode(self):
-        #Test-case name: evince/evn-003
-        #This test will check that Evince can enter exit fullscreen mode via F11
-
-        #Press F11
-        self.keyboard.press_and_release("F11")
-        sleep(5)
-
-        #Make sure that Evince is in fullscreen mode
-        windowState = self.app._get_window_states()
-        self.assertThat(windowState, Contains("_NET_WM_STATE_FULLSCREEN"))
-
-        #Exit fullscreen mode
-        self.keyboard.press_and_release("F11")
-        sleep(5)
-
-        #Does Evince exit fullscreen mode and restore the window size and position correctly?
-        windowState = self.app._get_window_states()
-        self.assertNotIn(windowState, Contains("_NET_WM_STATE_FULLSCREEN"))
-
-
-    def test_hide_side_bar(self):
-        #Test-case name: evince/evn-004
-        #This test will check that Evince can hide sidebar
-        tempFile = _generateTempFileName()
-
-        #Create pdf
-        self.createFile(tempFile)
-        #Open pdf
-        self.openFile(tempFile)
-        sleep(5)
-
-        #Make sure sidebar is displayed
-        #TODO
-
-        #Press F9
-        self.keyboard.press_and_release("F9")
-        sleep(5)
-
-        #Did Evince hide the sidebar?
-
-        #Delete pdf
-        self.deleteFile(tempFile)
-
-    def test_show_side_bar(self):
-        #Test-case name: evince/evn-005
-        #This test will check that Evince can display sidebar
-        tempFile = _generateTempFileName()
-
-        #Create pdf
-        self.createFile(tempFile)
-        #Open pdf
-        self.openFile(tempFile)
-        sleep(5)
-        #Make sure sidebar is hidden
-
-        #Press F9
-        self.keyboard.press_and_release("F9")
-        sleep(5)
-
-        #Does Evince display a sidebar with page thumbnails or the document index?
-        #TODO
-
-        #Delete pdf
-        self.deleteFile(tempFile)
-
-    def test_rotate_document(self):
-        #Test-case name: evince/evn-006
-        #This test will check that Evince can rotate a document
-        tempFile = _generateTempFileName()
-
-        #Create pdf
-        self.createFile(tempFile)
-        #Open pdf
-        self.openFile(tempFile)
-        sleep(5)
-        #Press ctrl+left
-        self.keyboard.press_and_release("Ctrl+Left")
-        sleep(5)
-
-        #Verify The pdf is rotated left and Does Evince display the rotated document correctly?
-        #TODO
-
-        #Press ctrl+right
-        self.keyboard.press_and_release("Ctrl+Right")
-        sleep(5)
-
-        #Verify The pdf is rotated right and Does Evince display the rotated document correctly?
-        #TODO
-
-        #Delete pdf
-        self.deleteFile(tempFile)
-
-    def createFile(self, fileName):
+        #create the temp file
+        self.create_temp_file(tempFile)
+        #open the created temp file
+        self.open_temp_file(tempFile)
+        #Grab evince window       
+        
+        #test file name is in the window title bar
+        self.assertThat(self.windowTitle.title, Eventually(Contains(fileName)))
+        # delete the temp file
+        self.delete_temp_file(tempFile)
+      
+    #def test_enter_and_exit_fullscreen_mode(self):
+    #    ''' test to see that we can enter and exit fullscreen mode '''
+    #    self.keyboard.press_and_release('F11')
+    #    DOES NOT WORK!!--------------------------------------------
+    #    self.fullscreen_windowState = self.app.get_wm_state()
+    #    # find a way to assert the window state
+    #    
+    #    self.keyboard.press_and_release('F11')
+    #
+    #    # TODO: Currently unable to get the window state with get_wm_state.
+    #    # needs further investigation.
+        
+        
+    def test_changing_pages(self):
+        #Lets test we can go up and down the pages
+        tempFile = _generateTempFileName()
+        (dirPath, fileName) = os.path.split(tempFile)
+        self.create_temp_file(tempFile)
+        self.open_temp_file(tempFile)
+        self.assertThat(self.windowTitle.title, Eventually(Contains(fileName)))
+        # move to page 2
+        self.pointing_device.move_to_object(self.next_button)
+        self.pointing_device.click()
+        self.assertThat(self.entry.text, Eventually(Contains('2')))
+        # move to page 3
+        self.pointing_device.click()
+        self.assertThat(self.entry.text, Eventually(Contains('3')))
+        # go back to page 2
+        self.pointing_device.move_to_object(self.prev_button)
+        self.pointing_device.click()
+        self.assertThat(self.entry.text, Eventually(Contains('2')))
+        # and back to the first page
+        self.pointing_device.click()
+        self.assertThat(self.entry.text, Eventually(Contains('1')))
+        
+        self.delete_temp_file(tempFile)
+        
+    def test_sidebar_open_close(self):
+        #Lets test we can open and close the sidebar
+        tempFile = _generateTempFileName()
+        (dirPath, fileName) = os.path.split(tempFile)
+        self.create_temp_file(tempFile)
+        self.open_temp_file(tempFile)
+        self.assertThat(self.windowTitle.title, Eventually(Contains(fileName)))
+        # test opening and closing of sidebar
+        self.change_sidebar_state()
+        self.change_sidebar_state()
+                
+        self.delete_temp_file(tempFile)
+    
+    def test_search_document(self):
+        #lets test we can search a document
+        tempFile = _generateTempFileName()
+        (dirPath, fileName) = os.path.split(tempFile)
+        self.create_temp_file(tempFile)
+        self.open_temp_file(tempFile)
+        self.assertThat(self.windowTitle.title, Eventually(Contains(fileName)))
+        #click search toggle button
+        self.pointing_device.move_to_object(self.search_button)
+        self.pointing_device.click()
+        # Enter a search query
+        self.keyboard.type('Advanced')
+        # check it found the the search query
+        self.search_result_label = self.app.select_single('GtkLabel', label='1 found on this page')
+        self.assertThat(self.search_result_label.label, Eventually(Contains('1 found on this page')))
+        
+        self.delete_temp_file(tempFile)
+ 
+    def change_sidebar_state(self):
+        ''' changes the state of the sidebar and tests that it changed '''
+        # get value of Evsidebar.visible
+        self.side_bar = self.app.select_single('EvSidebar')
+        visible = self.side_bar.visible
+        # Test and change the side bar, 
+        if visible == 1:
+            self.keyboard.press_and_release('F9')
+            self.assertThat(self.side_bar.visible, Equals(0))
+        else:
+            self.keyboard.press_and_release('F9')
+            self.assertThat(self.side_bar.visible, Equals(1))
+    
+    def create_temp_file(self, fileName):
+        ''' create a temporary file for tests '''
         #Create a pdf file to use during tests
         self.keyboard.press_and_release("F1")
+        # TODO: would be good to check yelp window title
+        # but get NoneType error at the moment
+        #self.yelp_dialog = self.app.select_single('YelpWindow')
+        #self.assertThat(self.yelp_dialog.title, Eventually(Contains('Evince Document Viewer')))
+        #
+        
+        # Open the print dailog and check it loaded
         self.keyboard.press_and_release("Ctrl+p")
+        
+        # TODO: unable to introspect print dialog at moment
+        #self.print_dialog = self.app.select_single('GtkPrintUnixDialog')
+        #self.assertThat(self.print_dialog.title, Eventually(Equals(Print)))
+        
         self.keyboard.press_and_release("Tab")
-
+        
         #select print to file
         self.keyboard.press_and_release("p")
-
+        
         #select filename
+        ## TODO: try and select the file button with mouse
+        #self.file_name_button = self.app.select_single('GtkLabel', label='~/Documents/output.pdf')
+        #self.pointing_device.move_to_object(self.file_name_button)
+        #self.pointing_device.click()
+        
+        # Using keyboard to enter file for now
+        
+        
+                   
         self.keyboard.press_and_release("Tab")
         self.keyboard.press_and_release("Tab")
         self.keyboard.press_and_release("Space")
+        
         self.keyboard.press_and_release("Ctrl+a")
         self.keyboard.type(fileName + "\n")
-
-        sleep(5)
+        #TODO: lose this sleep when we can introspect print dialog
+        sleep(10)
 
         #make the file
         self.keyboard.press_and_release("Alt+p")
 
         #close window
         self.keyboard.press_and_release("Ctrl+w")
-
-    def openFile(self, fileName):
-        #Open a pdf by selecting file
-        self.keyboard.press_and_release("Ctrl+o")
+        
+    
+    def open_temp_file(self, fileName):
+        '''Opens the temporary file'''
+        # Click on the settings button
+        self.settings_button = self.app.select_single('GtkImage', icon_name='emblem-system-symbolic')
+        self.pointing_device.move_to_object(self.settings_button)
+        self.pointing_device.click()
+        # press 'O' to open the file dialog
+        self.keyboard.press_and_release("o")
+        # check the file dialog opened and contains 'Open Document' in the window title
+        self.open_file_dialog = self.app.select_single('GtkFileChooserDialog')
+        self.assertThat(self.open_file_dialog.title, Eventually(Equals('Open Document')))
+        # enter the temp file name
         self.keyboard.press_and_release("Ctrl+a")
-        self.keyboard.type(fileName + "\n")
-
-    def deleteFile(self, fileName):
-        #Delete pdf file created for test purposes
+        self.keyboard.type(fileName)
+        # click on the 'open' button
+        self.open_button = self.app.select_single('GtkLabel', label='_Open')
+        self.pointing_device.move_to_object(self.open_button)
+        self.pointing_device.click()
+        
+    def delete_temp_file(self, fileName):
+        #delete temp file
         self.addCleanup(os.remove, fileName)
 
+    
+    
+    
 def _generateTempFileName():
     #Create temporary file, then close it, so we can re-use the file name
     sFile = tempfile.NamedTemporaryFile()