Merge lp:~adam-disc0tech/ubuntu-autopilot-tests/fileroller into lp:ubuntu-autopilot-tests

[Adam Smith]

Fixes https://bugs.launchpad.net/ubuntu-autopilot-tests/+bug/1206386 by doing two things

1) correcting the way content is selected for the archive
2) checking the correct content is extracted

Fixes https://bugs.launchpad.net/ubuntu-autopilot-tests/+bug/1206386 by doing two things

1) correcting the way content is selected for the archive
2) checking the correct content is extracted

[Nicholas Skaggs (nskaggs)]

Thanks for the merge Adam. I have a few questions;

We can't use sudo in a test; this are non-interactive, and I'm confused why you would need root anyway. However, the symbolic linking to /home is very confusing to me; what are you trying to accomplish?

Adding logging and the 'check the files have actually been extracted' are both welcome additions.

review: Needs Fixing

[Adam Smith (adam-disc0tech)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi

You are right, sudo shouldn't even be required.

What I'm trying to achieve, is to create a syncing in home with the name ___000, pointing to the content under /usr/share/example-content.

This seemed easier / safer to me than navigating the folder structure through the gui. This is the bit that seemed to be broken when I picked up the test. I can be pretty sure that the link is the first item listed in home.

- -adam

On 25 February 2014 21:30:51 GMT+00:00, Nicholas Skaggs <email address hidden> wrote:
>
>Review: Needs Fixing
>
>Thanks for the merge Adam. I have a few questions;
>
>We can't use sudo in a test; this are non-interactive, and I'm confused
>why you would need root anyway. However, the symbolic linking to /home
>is very confusing to me; what are you trying to accomplish?
>
>Adding logging and the 'check the files have actually been extracted'
>are both welcome additions.
>--
>https://code.launchpad.net/~adam-disc0tech/ubuntu-autopilot-tests/fileroller/+merge/208183
>You are the owner of
>lp:~adam-disc0tech/ubuntu-autopilot-tests/fileroller.

- --
Sent from my Android device with K-9 Mail. Please excuse my brevity.
-----BEGIN PGP SIGNATURE-----
Version: APG v1.0.9

iQI8BAEBCAAmBQJTDaQrHxxkaXNjMHRlY2ggPGFkYW1AZGlzYzB0ZWNoLmNvbT4A
CgkQveW9bcQ9QGwjtRAAiPgywHrGVnfnwYm2pxIEeYZHjbXQp2Y2UQ2WMebuB8iM
vvPDPxm6tPudxZ63QFooUNTS7Y3FiAfnyhLSDM93vCeIfysTBVZ6Va9WuT02B8Is
SyGaNLI4pV0PL4c/xNkK2FPWjJtL62W6Q9WxmYLjbi6jw+tKA6aa87QIsO6aioW/
2FgF3wtyMU24iYkNSStRls50EYiG9BflmYobWagAolpJ1ZfQEW6Os+nVMaaJULOY
ow9CLSitwm4huSNEhFk8pPb2QFH5T+YEhfIcXZA5OGOLJGbQ3uWE+2kAkDOlPSfk
hSUIREMcaqPIoW3/EidbOCU24cRUrl9Q901s6xYGBU1ql7wa7mbIFdNhqZk0hnJj
R/6QrN+LF14s0GeO/+GA4Jts+LTLhNHaxUau9W9Yq+r3nbLV9qs9//jW5+1TjUPF
31kF8PIol1AEehEqVtVCdOreEEd0dVvOaY/gX2K0LrkWY8WEBMPf9Rb8hDf5SoEe
XO/QzjUcSaobPNA3iNyS9aX4yprGfuVONjcTE3qkwZk17X4heA5EReVeA/8Nb2d1
83Ga7EqDCkN7IlhCdDufwM+od7d6lIHNmkucDSghwjPRgSdo/jZaaUJGT0UvOI0W
oZmuH9ZHp39EjrGhoaQncru/3X24WfZBs+gfwpsbwPXBWkdcVBZIFnTr1YTQCdo=
=lWOT
-----END PGP SIGNATURE-----

[lp:~adam-disc0tech/ubuntu-autopilot-tests/fileroller]

68. By Adam Smith on 2014-03-02

Removed unnecessary use of root

[Adam Smith (adam-disc0tech)]

Fixed

[Nicholas Skaggs (nskaggs)]

I'm still not sure on using ___000 in home. Let me suggest something we can both approve of; mocking /home and doing the same thing (though you can pick a saner name as your folder will be the only one in the new "/home"). This will ensure we don't leave any remenants of testing behind, nor mangle with /home dirs. Be sure and put the mock location as a temporary dir in /tmp.

You can do this with python mock. For an example see http://bazaar.launchpad.net/~music-app-dev/music-app/trunk/view/head:/tests/autopilot/music_app/tests/__init__.py, specifically in regards to _patch_home.

review: Needs Fixing

[Chris Gagnon (chris.gagnon)]

I saw this in my email and thought I should comment.

import's should not be on the same line according to pep8 http://legacy.python.org/dev/peps/pep-0008/#imports, it's also good practice to keep them in alphabetical order.

13 +import os, subprocess
14 +import shutil, logging
15 import tempfile

should be:

import logging
import os
import shutil
import subprocess
import tempfile

if you apt-get install python-flake8 you can run 'flake8 some_file.py' and it will tell you about the pep8 style guides problems in your code.

A lot of code editors have a flake8 plugin that will tell you when you have errors, so you don't have to do it manually.

review: Needs Fixing

[lp:~adam-disc0tech/ubuntu-autopilot-tests/fileroller]

69. By Adam Smith on 2014-03-14

PEP8 compliance issues (mostly) fixed

70. By Adam Smith on 2014-03-14

Syntax issue fixed

71. By Adam Smith on 2014-03-14

Implemented fake home directory

72. By Adam Smith on 2014-03-14

removed redundant method

73. By Adam Smith on 2014-03-14

Removed 25 character temp directory code, not required for this app test

Unmerged revisions

73. By Adam Smith on 2014-03-14

Removed 25 character temp directory code, not required for this app test

72. By Adam Smith on 2014-03-14

removed redundant method

71. By Adam Smith on 2014-03-14

Implemented fake home directory

70. By Adam Smith on 2014-03-14

Syntax issue fixed

69. By Adam Smith on 2014-03-14

PEP8 compliance issues (mostly) fixed

68. By Adam Smith on 2014-03-02

Removed unnecessary use of root

67. By Adam Smith on 2014-02-25

Hit UP a lot when you enter the file dialog to ensure the same starting location

66. By Adam Smith on 2014-02-25

Added to step to go back to home directory each time the file dialog is opened

65. By Adam Smith on 2014-02-25

Changed mechanism for identifying content to archive.

64. By Adam Smith on 2014-02-25

Added assertions to check files and directories are actually extracted

=== modified file 'ubuntu_autopilot_tests/fileroller/__init__.py'
--- ubuntu_autopilot_tests/fileroller/__init__.py	2013-05-29 11:56:42 +0000
+++ ubuntu_autopilot_tests/fileroller/__init__.py	2014-03-14 15:16:49 +0000
@@ -1,1 +0,0 @@
-# -*- coding: utf-8 -*-

=== modified file 'ubuntu_autopilot_tests/fileroller/test_fileroller.py'
--- ubuntu_autopilot_tests/fileroller/test_fileroller.py	2013-11-22 22:00:27 +0000
+++ ubuntu_autopilot_tests/fileroller/test_fileroller.py	2014-03-14 15:16:49 +0000
@@ -1,12 +1,20 @@
 from autopilot.testcase import AutopilotTestCase
 from autopilot.matchers import Eventually
-from testtools.matchers import Equals, Contains, NotEquals
+from testtools.matchers import Equals, Contains
+from testtools.matchers import NotEquals, DirExists, FileExists
 from autopilot.input import Mouse, Pointer
 from time import sleep
+import logging
 import os
+try:
+    from unittest import mock
+except ImportError:
+    import mock
 import shutil
 import tempfile
 
+logger = logging.getLogger('__name__')
+
 
 class FileRollerTests(AutopilotTestCase):
     '''Collection of autopilot test for file-roller (Archive Manager) '''
@@ -14,6 +22,10 @@
     def setUp(self):
         '''Set-up method'''
         super(FileRollerTests, self).setUp()
+        #mock out the home dir
+        self.home_dir = self._patch_home()
+
+        #launch the app
         self.app = self.launch_test_application('file-roller')
 
         # only instantiate these once for multiple tests
@@ -32,6 +44,12 @@
         self.new_archive_button = self.app.select_single('GtkToolButton',
                                                          name=u'New')
 
+        #create symbolic link for fast test content location
+        src_dir = '/usr/share/example-content/Ubuntu_Free_Culture_Showcase/'
+        files = os.listdir(src_dir)
+        for f in files:
+            shutil.copyfile(src_dir + str(f), os.getenv("HOME") + '/' + str(f))
+
     def test_create_archive(self):
         '''Creates an archive and adds sample data,
            Window title must contain archive name'''
@@ -103,7 +121,6 @@
         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')
@@ -118,30 +135,24 @@
         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
+        #first ensure we are in the home directory
+
         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")
+
+        self.keyboard.press_and_release("Space")
+        self.keyboard.press_and_release("Down")
+        self.keyboard.press_and_release("Down")
+        self.keyboard.press_and_release("Space")
+
         # We must be able to click the '_Add' button
         self.add_folder_button = self.app.select_single('GtkLabel',
                                                         label=u'_Add')
@@ -186,6 +197,7 @@
 
         self.keyboard.press_and_release("Alt+l")
         self.keyboard.type(tempArchive)
+        self.keyboard.press_and_release('Enter')
 
         self.extract_archive_button = self.app.select_single(
             'GtkLabel', label=u'_Extract')
@@ -207,6 +219,12 @@
 
         self.pointing_device.move_to_object(self.show_files_button)
         self.pointing_device.click()
+
+        #check the files have actually been extracted
+        self.assertThat(tempArchive, DirExists())
+        self.assertThat(tempArchive + '/' + '/How fast.ogg', FileExists())
+        self.assertThat(tempArchive + '/' + '/Josh Woodward - Swansong.ogg', FileExists())
+
         # This sleep is needed as we can't introspect
         # nautilus when it shows the files
         # TODO: Once nautilus can be introspected we need to lose this sleep
@@ -254,6 +272,47 @@
         extract_path = os.path.join('/tmp/' + fileName)
         self.addCleanup(shutil.rmtree, extract_path)
 
+    def _save_home(self):
+            logger.debug('Saving HOME')
+            home_dir = os.environ['HOME']
+            backup_list = ('Music', )  # '.cache/mediascanner')
+            backup_path = [os.path.join(home_dir, i) for i in backup_list]
+            backups = [(i, '%s.bak' % i) for i in backup_path if os.path.exists(i)]
+            for b in backups:
+                logger.debug('backing up %s to %s' % b)
+                try:
+                    shutil.rmtree(b[1])
+                except:
+                    pass
+                shutil.move(b[0], b[1])
+                #self.addCleanup(shutil.move(b[1], b[0]))
+            return home_dir
+
+    def _patch_home(self):
+        #make a temp dir
+        temp_dir = tempfile.mkdtemp()
+        #delete it, and recreate it to the length
+        #required so our patching the db works
+        #require a length of 25
+        shutil.rmtree(temp_dir)
+        temp_dir = temp_dir.ljust(25, 'X')
+        os.mkdir(temp_dir)
+        logger.debug("Created fake home directory " + temp_dir)
+        self.addCleanup(shutil.rmtree, temp_dir)
+        #if the Xauthority file is in home directory
+        #make sure we copy it to temp home, otherwise do nothing
+        xauth = os.path.expanduser(os.path.join('~', '.Xauthority'))
+        if os.path.isfile(xauth):
+            logger.debug("Copying .Xauthority to fake home " + temp_dir)
+            shutil.copyfile(
+                os.path.expanduser(os.path.join('~', '.Xauthority')),
+                os.path.join(temp_dir, '.Xauthority'))
+        patcher = mock.patch.dict('os.environ', {'HOME': temp_dir})
+        patcher.start()
+        logger.debug("Patched home to fake home directory " + temp_dir)
+        self.addCleanup(patcher.stop)
+        return temp_dir
+
 
 #hardcoded global archiveName
 def _tempArchiveName():