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

[Dan Chapman ]

Have removed the delete_all_test_files method and made each test selfcontained. :) All tests run independently on my machine. Should be good to go :)

[Nicholas Skaggs (nskaggs)]

Despite the hack to get the path going, this looks good!

A couple minor tweaks; If you could remove the delete_all_test_files function and incorporate that into teardown or the end of each needed test. Please also make sure each test is self-contained.

review: Needs Fixing

[Nicholas Skaggs (nskaggs)]

One more tweak: Could we move the hardcoded filename to a generated temporary filename instead? In addition, this would make files in /tmp instead of /home, which is nicer. I see you also cleanup after yourself anyway, so don't forget that step :)

With those fixes, this should be ready for prod.

review: Needs Fixing

[lp:~dpniel/ubuntu-autopilot-tests/fileroller-autopilot-1.3]

49. By DanChapman <email address hidden> on 2013-05-30

Changed to using temp directory

50. By DanChapman <email address hidden> on 2013-05-31

added comments for sleep()

Unmerged revisions

=== modified file 'ubuntu_autopilot_tests/fileroller/__init__.py'
--- ubuntu_autopilot_tests/fileroller/__init__.py	2013-03-18 20:29:30 +0000
+++ ubuntu_autopilot_tests/fileroller/__init__.py	2013-05-30 21:02:26 +0000
@@ -0,0 +1,1 @@
+# -*- coding: utf-8 -*-

=== modified file 'ubuntu_autopilot_tests/fileroller/test_fileroller.py'
--- ubuntu_autopilot_tests/fileroller/test_fileroller.py	2013-05-23 14:46:17 +0000
+++ ubuntu_autopilot_tests/fileroller/test_fileroller.py	2013-05-30 21:02:26 +0000
@@ -1,205 +1,227 @@
 from autopilot.testcase import AutopilotTestCase
-from autopilot.introspection.gtk import GtkIntrospectionTestMixin
 from autopilot.matchers import Eventually
-from testtools.matchers import Equals, NotEquals, GreaterThan, LessThan, Contains
-
+from testtools.matchers import Equals, Contains, NotEquals
+from autopilot.input import Mouse, Pointer
 from time import sleep
+import os
+import shutil
 import tempfile
-import os
-
-
-#Register File-roller as an application so we can call it
-AutopilotTestCase.register_known_application("Archive Manager", "file-roller.desktop", "file-roller")
-#http://packages.qa.ubuntu.com/qatracker/testcases/1418/info
-class GtkToolbarTests(AutopilotTestCase, GtkIntrospectionTestMixin):
+
+class FileRollerTests(AutopilotTestCase):
+    '''Collection of autopilot test for file-roller (Archive Manager) '''
 
     def setUp(self):
-        #Open File-roller
-        super(GtkToolbarTests, self).setUp()
-        self.app = self.launch_test_application('file-roller')
-
-        #Verify that File-roller is open
-        #FrWindow
-        windowTitle = self.app.select_single('FrWindow', title='Archive Manager')
-        self.assertThat(windowTitle.title, Eventually(Equals('Archive Manager')))
-
-    def test_archive_and_extract(self):
-        #Test-case name: fileroller/flr-001
-        # This test will check that File Roller can archive and extract files
-
-        #Click 'New' button from the toolbar
-        #FrWindow, GtkGrid, GtkToolbar, GtkToolButton
-        self.assertThat(lambda: self.app.select_single('GtkToolButton', name='New'), Eventually(NotEquals(None)))
-        btn = self.app.select_single('GtkToolButton', name='New')
-        #let's click it
-        self.mouse.move_to_object(btn)
-        self.mouse.click()
-
-        #Verify new archive dialog opens
-        #FrNewArchiveDialog
-        dialogWindow = self.app.select_single('FrNewArchiveDialog')
-        self.assertThat(lambda: self.app.select_single('FrNewArchiveDialog').title, Eventually(Contains("New Archive")))
-
-        #Input any test name for archive
-        tempFile = _generateTempFileName()
-        self.keyboard.type(tempFile)
-
-        # select 'Tar compressed with gzip' from available formats combobox
-        #TODO
-        #FrNewArchiveDialog, Gtkbox, GtkHBox, GtkVbox, GtkTable, GtkHbox, GtkComboBoxText
-        # active = 9
-
-        #TODO
-        #Verify that .tar.gz file format is selected
-        #selectWindow = self.app.select_single('GtkComboBoxText', active='9')
-        #self.assertThat(lambda: self.app.select_single('GtkComboBoxText').active, Eventually(Contains(9)))
-        #does not work as it's not an unique identifier
-
-        #click 'Create' button
-        #FrNewArchiveDialog,   GtkBox, GtkButtonBox, GtkButton
-        #label: create-archive  (the name property is empty :(  )
-        self.assertThat(lambda: self.app.select_single('GtkButton', label='create-archive'), Eventually(NotEquals(None)))
-        createButton = self.app.select_single('GtkButton', label='create-archive')
-        #let's click it
-        self.mouse.move_to_object(createButton)
-        self.mouse.click()
-        #delay to wait
-        sleep(2)
-
-        #Click 'Add files to archive' button from toolbar
-        #FrWindow, GtkGrid, GtkToolButton
-        #name: 'Add_Toolbar'
-        self.assertThat(lambda: self.app.select_single('GtkToolButton', name='Add_Toolbar'), Eventually(NotEquals(None)))
-        addFilesButton = self.app.select_single('GtkToolButton', name='Add_Toolbar')
-        #let's click it
-        self.mouse.move_to_object(addFilesButton)
-        self.mouse.click()
-        #delay to wait
-        sleep(2)
-
-        #Verify that the Add files dialog window has opened
-        #FrFileSelectorDialog
-        selectWindow = self.app.select_single('FrFileSelectorDialog')
-        self.assertThat(lambda: self.app.select_single('FrFileSelectorDialog').title, Eventually(Contains("Add Files")))
-
-        #
-        # DOES NOT WORK !!!!   ********************************************
-        #
-        #Select any files and/or folders to be added to the archive, click 'Add' button
-        #self.keyboard.press_and_release("Alt+l")
-        #self.keyboard.type("/usr/share/example-content/Ubuntu_Free_Culture_Showcase/How fast.ogg")
-        #
-        # DOES NOT WORK !!!!    ********************************************
-        #
-
-        #make a temporary file in the ~/ directory
-#        tempFile = _generateTempFileName()
-#        if os.path.exists("~/" + tempFile):
-            #just use that file
-#            sleep(1)
-#        else:
-            #create it
-#            f = open(tempfile, 'w')
-#            f.write("this is a test file for fileroller!")
-#            f.close
-
-        self.keyboard.type("tmp")
-        self.keyboard.press_and_release("Enter")
-        self.keyboard.press_and_release("Space")
-
-
-        #FrFileSelectorDialog, GtkBox, GtkButtonBox, GtkButton, GtkAlignment, GtkBox, GtkLable
-        #label: _Add
-        self.assertThat(lambda: self.app.select_single('GtkLabel', label='_Add'), Eventually(NotEquals(None)))
-        addFolerButton = self.app.select_single('GtkLabel', label='_Add')
-        #let's click it
-        self.mouse.move_to_object(addFolerButton)
-        self.mouse.click()
-
-        #Close the archive and file-roller
-        self.keyboard.press_and_release("Alt+a")
-        self.keyboard.type("c")
-
-        #Open the archive using file-roller
-        super(GtkToolbarTests, self).setUp()
-        self.app = self.launch_test_application('file-roller')
-        #FrWindow, GtkGrid, GtkToolbar, GtkMenuToolButton, GTkBox, GtkButton, GtkBox, GtkImage
-        #stock: gtk-open
-        self.assertThat(lambda: self.app.select_single('GtkImage', stock='gtk-open'), Eventually(NotEquals(None)))
-        openRecentButton = self.app.select_single('GtkImage', stock='gtk-open')
-        #let's click it
-        self.mouse.move_to_object(openRecentButton)
-        self.mouse.click()
-        #delay to wait
-        sleep(2)
-        #GtkFileChooserDialog, GtkBox, GtkFileChooserWidget, GtkFileChooserDefault, GtkBox, GtkBox, GtkBox, GtkToggleButton, GtkAligmment, GtkBox, GtkImage
-        #stock: gtk-edit
-        self.assertThat(lambda: self.app.select_single('GtkImage', stock='gtk-edit'), Eventually(NotEquals(None)))
-        fileNameToggleButton = self.app.select_single('GtkImage', stock='gtk-edit')
-        #let's click it only if it is not already active
-        fileAttributeToggleBut = self.app.select_single('GtkToggleButton', tooltip_markup='Type a file name')
-        if  self.assertProperty(fileAttributeToggleBut, active = False):
-            self.mouse.move_to_object(fileNameToggleButton)
-            self.mouse.click()
-           #delay to wait
-            sleep(2)
-        else:
-            self.keyboard.press_and_release("Alt+1")
-
-        self.keyboard.type(tempFile)
-
-        #GtkFileChooserDialog, GtkBox, GtkButtonBox, GtkButton, GtkAligmment, GtkBox, GtkImage
-        #stock: gtk-open
-        self.assertThat(lambda: self.app.select_single('GtkImage', stock='gtk-open'), Eventually(NotEquals(None)))
-        openFileButton = self.app.select_single('GtkImage', stock='gtk-open')
-        #let's click it
-        self.mouse.move_to_object(openFileButton)
-        self.mouse.click()
-        #delay to wait
-        sleep(2)
-
-        # Click 'Extract' button from toolbar
-        #FrWindow, Gtkgrid, GtkToolBar, GtkMenuToolButton,
-        #name: Extract_ToolBar
-        self.assertThat(lambda: self.app.select_single('GtkMenuToolButton', name='Extract_ToolBar'), Eventually(NotEquals(None)))
-        extractFileButton = self.app.select_single('GtkMenuToolButton', name='Extract_ToolBar')
-        #let's click it
-        self.mouse.move_to_object(extractFileButton)
-        self.mouse.click()
-        #delay to wait
-        sleep(2)
-
-        #Select any folder to extract files to, click 'Extract' button
-        self.keyboard.press_and_release("Alt+l")
-        self.keyboard.type(tempfile.gettempdir)
-        #GtkFileChooserDialog, GtkBox, GtkButtonBox, GtkButton, GtkAligmment, GtkBox, GtkImage
-        #stock: extract-archive
-        self.assertThat(lambda: self.app.select_single('GtkImage', stock='extract-archive'), Eventually(NotEquals(None)))
-        extractFileButton = self.app.select_single('GtkImage', stock='extract-archive')
-        #let's click it
-        self.mouse.move_to_object(extractFileButton)
-        self.mouse.click()
-        #delay to wait
-        sleep(2)
-
-        #Wait until extracting process is complete
-        #'Extraction completed successfully' label appears
-        #GtkDialog, GtkBox, GtkHBox, GtkBox, GtkLabel
-        #label: <span weight="bold" size="larger">Extraction completed successfully</span>
-        selectWindow = self.app.select_single('GtkDialog')
-        self.assertThat(lambda: self.app.select_single('GtkLabel').label, Eventually(Contains("<span weight=""bold"" size=""larger"">Extraction completed successfully</span>")))
-
-        #TODO
-        #Open Nautilus and navigate to the selected extract folder
-        #Are the files and folders from archive extracted correctly in the selected folder?
-
-        #Delete the temp file we created
-        #Added sleep so file does not get removed too soon
-        sleep(1)
-        self.addCleanup(os.remove, tempFile + '.tar.gz')
-
-def _generateTempFileName():
-    #Create temporary file, then close it, so we can re-use the file name
+        '''Set-up method'''
+        super(FileRollerTests, self).setUp()
+        self.app = self.launch_test_application('file-roller')
+
+        # only instantiate these once for multiple tests
+        # these can only be instantiated here if you do not need to reload the application during a test
+        # As the Gtk id's change when application is relaunched. and throws error
+        # So for tests that are reloaded also grab new Gtkobject id's after relaunch
+        self.pointing_device = Pointer(Mouse.create())
+        self.archiveWindow = self.app.select_single('FrWindow')
+        self.add_files_button = self.app.select_single('GtkLabel', label=u'Add Files')
+        self.extract_button = self.app.select_single('GtkLabel', label=u'Extract')
+        self.open_button = self.app.select_single('GtkLabel', label=u'Open')
+        self.new_archive_button = self.app.select_single('GtkToolButton', name=u'New')
+        
+    def test_create_archive(self):
+        '''Creates an archive and adds sample data, Window title must contain archive name'''
+        
+        tempArchive = _tempArchiveName()
+        #Test: Archive must be created with sample data
+        self.create_archive_with_sample_data(tempArchive)
+        # If create archive successfull, then check here that the window title
+        # is the name of the archive.
+        (dirName, fileName) = os.path.split(tempArchive)
+        self.assertThat(self.archiveWindow.title, Eventually(Contains(fileName)))
+        
+        #Cleanup
+        self.delete_temp_archive()
+        
+        
+        
+    def test_open_archive(self):
+        '''Open archive window title must contains the archive name '''
+        
+        tempArchive = _tempArchiveName()
+        # Call create and relaunch to get a safe way of reloading an application
+        self.create_and_relaunch(tempArchive)
+               
+        #Test: Must open archive
+        self.open_test_archive(tempArchive)
+        # if open archive successful, then check here that the window title
+        # is the name of the archive.
+        (dirName, fileName) = os.path.split(tempArchive)
+        self.assertThat(self.archiveWindow.title, Eventually(Contains(fileName)))
+        # Cleanup
+        self.delete_temp_archive()
+        
+    def test_extract_archive(self):
+        '''Open archive and extract file'contents,'''
+        
+        tempArchive = _tempArchiveName()
+        # Call create and relaunch to get a safe way of reloading an application
+        self.create_and_relaunch(tempArchive)
+        self.assertThat(self.archiveWindow.title, Eventually(Contains('Archive Manager')))
+        #Test: Open and extract an archive
+        self.extract_test_archive(tempArchive)
+        ## assert we have come back to main window after extraction
+        ## Test Will not get back to mainWindow if extraction failed.
+        ## Check window title is same as archive
+        (dirName, fileName) = os.path.split(tempArchive)
+        self.assertThat(self.archiveWindow.title, Eventually(Contains(fileName)))
+        #Cleanup
+        self.delete_temp_archive()
+        self.delete_temp_directory(fileName)
+        
+    # this method needs some more assertions. At the moment its relying that commands are correct
+    def create_archive_with_sample_data(self, tempArchive):
+        ''' Must create archive and add sample data'''
+        #Click on the new archive button
+        self.pointing_device.move_to_object(self.new_archive_button)
+        self.pointing_device.click()
+        # The new archive dialog window title must have 'New Archive'
+        self.new_dialog = self.app.select_single('FrNewArchiveDialog')
+        self.assertThat(self.new_dialog.title, Eventually(Equals(u'New Archive')))
+
+        #Enter name of new archive
+        self.keyboard.type(tempArchive)
+
+        # TODO: Figure out a gzip commpress, does not have an active Id enabled
+
+        # select the create button and check it is clickable
+        self.create_button = self.app.select_single('GtkButton', label=u'create-archive')
+        self.assertThat(self.create_button.label, Eventually(NotEquals(None)))
+        # Click on Create button
+        self.pointing_device.move_to_object(self.create_button)
+        self.pointing_device.click()
+        # Click on the add files button
+        self.pointing_device.move_to_object(self.add_files_button)
+        self.pointing_device.click()
+        # The add files dialog title must contain 'Add Files'
+        self.add_files_dialog = self.app.select_single('FrFileSelectorDialog')
+        self.assertThat(self.add_files_dialog.title, Eventually(Equals('Add Files')))
+
+        # This is a horrible hacky workaround to add sample files from /usr/share/example-content/*
+        # Need to find a better workaround :S Location GtkEntry doesnt work when entering file path
+        # Maybe add some assertions to check that the Location GTKEntry contains correct path
+        self.keyboard.press_and_release("Alt+l")
+        self.keyboard.press_and_release("Tab")
+        self.keyboard.press_and_release("Tab")
+        self.keyboard.type("File")
+        self.keyboard.press_and_release("Enter")
+        self.keyboard.press_and_release("Tab")
+        self.keyboard.press_and_release("Right")
+        self.keyboard.press_and_release("Right")
+        self.keyboard.type("usr")
+        self.keyboard.press_and_release("Enter")
+        self.keyboard.type("share")
+        self.keyboard.press_and_release("Enter")
+        self.keyboard.type("example-content")
+        self.keyboard.press_and_release("Enter")
+        self.keyboard.press_and_release("Left")
+        self.keyboard.press_and_release("Left")
+        self.keyboard.press_and_release("Enter")
+        # We must be able to click the '_Add' button
+        self.add_folder_button = self.app.select_single('GtkLabel', label=u'_Add')
+        self.assertThat(self.add_folder_button.label, Eventually(NotEquals(None)))
+        #Click the '_Add" button
+        self.pointing_device.move_to_object(self.add_folder_button)
+        self.pointing_device.click()
+        # sleep needed to give sample data enough time to be added
+        sleep(3)
+        
+    # Method for opening an archive, needs assertions adding
+    def open_test_archive(self, tempArchive):
+        '''Open the test archive'''
+        self.open_button = self.app.select_single('GtkLabel', label=u'Open')
+        self.pointing_device.move_to_object(self.open_button)
+        self.pointing_device.click()
+
+        self.keyboard.press_and_release("Alt+l")
+        self.keyboard.type(tempArchive)
+        #self.keyboard.press_and_release("Enter")
+
+        self.open_archive_button = self.app.select_single('GtkLabel', label=u'_Open')
+        self.pointing_device.move_to_object(self.open_archive_button)
+        self.pointing_device.click()
+
+    def extract_test_archive(self, tempArchive):
+        '''Open Archive and extract the sample data'''
+        
+        self.open_test_archive(tempArchive)
+        (dirName, fileName) = os.path.split(tempArchive)
+
+        self.assertThat(self.archiveWindow.title, Eventually(Contains(fileName)))
+
+        # Check that the Extract button is now clickable
+        self.assertThat(self.extract_button.label, Eventually(NotEquals(None)))
+
+        #click on extract button
+        self.pointing_device.move_to_object(self.extract_button)
+        self.pointing_device.click()
+
+        self.keyboard.press_and_release("Alt+l")
+        self.keyboard.type(tempArchive)
+
+        self.extract_archive_button = self.app.select_single('GtkLabel', label=u'_Extract')
+        self.assertThat(self.extract_archive_button.label, Eventually(NotEquals(None)))
+
+        self.pointing_device.move_to_object(self.extract_archive_button)
+        self.pointing_device.click()
+        sleep(2)
+        self.extract_dialog = self.app.select_single('GtkDialog')
+        self.assertThat(self.extract_dialog.title, Eventually(Contains(u"")))
+        self.show_files_button = self.app.select_single('GtkLabel', label=u'_Show the Files')
+        self.assertThat(self.show_files_button.label, Eventually(NotEquals(None)))
+
+        self.pointing_device.move_to_object(self.show_files_button)
+        self.pointing_device.click()
+
+        sleep(2)
+
+        self.keyboard.press_and_release("Alt+F4")
+        
+    def create_and_relaunch(self, tempArchive):
+        ''' This method calls create archive_with_sample_data
+            then will close the application and relaunch it 
+            grabbing new Gtk object id's'''
+        # Create archive and check window title
+        self.create_archive_with_sample_data(tempArchive)
+        (dirName, fileName) = os.path.split(tempArchive)
+
+        self.assertThat(self.archiveWindow.title, Eventually(Contains(fileName)))
+        # Close the Application
+        self.keyboard.press_and_release('Ctrl+w')
+        # launch a new instance of fire-roller
+        self.app = self.launch_test_application('file-roller')
+        # We need to get the new object id's here as we have reloaded the application and
+        # will throw an error unknown id if we don't :)
+        self.archiveWindow = self.app.select_single('FrWindow')
+        self.add_files_button = self.app.select_single('GtkLabel', label=u'Add Files')
+        self.extract_button = self.app.select_single('GtkLabel', label=u'Extract')
+        self.open_button = self.app.select_single('GtkLabel', label=u'Open')
+        self.new_archive_button = self.app.select_single('GtkToolButton', name=u'New')
+    
+    def delete_temp_archive(self):
+        # Cleanup
+        temp = self.archiveWindow.title
+        # Strip archive name of whitespace
+        temp = temp.strip()
+        path = os.path.join('/tmp/'+temp)
+        self.addCleanup(os.unlink, path)
+        
+    def delete_temp_directory(self, fileName ):
+        #Delete the extracted directory
+        extract_path = os.path.join('/tmp/'+ fileName)
+        self.addCleanup(shutil.rmtree, extract_path)
+    
+    
+#hardcoded global archiveName
+def _tempArchiveName():
+    '''Temporary archive name for testing with.'''
     sFile = tempfile.NamedTemporaryFile()
     sFile.close()
     return sFile.name