Merge lp:~nskaggs/music-app/clean-up-mediascanner-tests into lp:music-app/trusty

[Nicholas Skaggs]

Clean up mediascanner autopilot tests and allow them to run properly in the lab

This will fix the issue with running the new mediascanner autopilot tests in the lab. In addition, I attempt to add some nice logging and clean up the code to be a bit more pythonic (no more os.system calls to sed, etc)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:135
http://91.189.93.70:8080/job/music-app-ci/86/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests/599
    SUCCESS: http://91.189.93.70:8080/job/music-app-precise-amd64-ci/86
    SUCCESS: http://91.189.93.70:8080/job/music-app-quantal-amd64-ci/86
    SUCCESS: http://91.189.93.70:8080/job/music-app-raring-amd64-ci/86
    SUCCESS: http://91.189.93.70:8080/job/music-app-saucy-amd64-ci/86

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/music-app-ci/86/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

review: Approve (continuous-integration)

=== removed directory 'tests/autopilot/music_app/emulators'
=== renamed file 'tests/autopilot/music_app/emulators/emulators.py' => 'tests/autopilot/music_app/emulators.py'
--- tests/autopilot/music_app/emulators/emulators.py	2013-09-27 15:14:10 +0000
+++ tests/autopilot/music_app/emulators.py	2013-10-01 19:27:03 +0000
@@ -6,10 +6,11 @@
 # by the Free Software Foundation.
 
 """Music app autopilot emulators."""
-
-from ubuntuuitoolkit import emulators as uitk
-
-class MainView(uitk.MainView):
+from ubuntuuitoolkit import emulators as toolkit_emulators
+
+
+class MainView(toolkit_emulators.MainView):
+
     """An emulator class that makes it easy to interact with the
     music-app.
     """
@@ -29,11 +30,11 @@
         """Returns the item that is searched for with app.select_many
         In case of no item was not found (not created yet) a second attempt is
         taken 1 second later"""
-        items = self.select_many(object_type, **kwargs)
+        items = self.app.select_many(object_type, **kwargs)
         tries = 10
         while len(items) < 1 and tries > 0:
-            sleep(self.retry_delay)
-            items = self.select_many(object_type, **kwargs)
+            sleep(self.app.retry_delay)
+            items = self.app.select_many(object_type, **kwargs)
             tries = tries - 1
         return items
 
@@ -41,19 +42,19 @@
         """Returns the item that is searched for with app.select_single
         In case of the item was not found (not created yet) a second attempt is
         taken 1 second later."""
-        item = self.select_single(object_type, **kwargs)
+        item = self.app.select_single(object_type, **kwargs)
         tries = 10
         while item is None and tries > 0:
-            sleep(self.retry_delay)
-            item = self.select_single(object_type, **kwargs)
+            sleep(self.app.retry_delay)
+            item = self.app.select_single(object_type, **kwargs)
             tries = tries - 1
         return item
 
     def tap_item(self, item):
-        self.pointing_device.move_to_object(item)
-        self.pointing_device.press()
+        self.app.pointing_device.move_to_object(item)
+        self.app.pointing_device.press()
         sleep(2)
-        self.pointing_device.release()
+        self.app.pointing_device.release()
 
     def get_play_button(self):
         return self.app.select_single("UbuntuShape", objectName = "playshape")

=== removed file 'tests/autopilot/music_app/emulators/__init__.py'
--- tests/autopilot/music_app/emulators/__init__.py	2013-06-21 23:06:10 +0000
+++ tests/autopilot/music_app/emulators/__init__.py	1970-01-01 00:00:00 +0000
@@ -1,6 +0,0 @@
-# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-# Copyright 2013 Canonical
-#
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU General Public License version 3, as published
-# by the Free Software Foundation.

=== modified file 'tests/autopilot/music_app/tests/__init__.py'
--- tests/autopilot/music_app/tests/__init__.py	2013-09-27 21:55:49 +0000
+++ tests/autopilot/music_app/tests/__init__.py	2013-10-01 19:27:03 +0000
@@ -13,15 +13,17 @@
 import os
 import os.path
 import shutil
+import logging
 
 from autopilot.input import Mouse, Touch, Pointer
 from autopilot.platform import model
 from autopilot.testcase import AutopilotTestCase
 
-from time import sleep
-
-from ubuntuuitoolkit import emulators as uitk
-from music_app.emulators.emulators import MainView
+from ubuntuuitoolkit import emulators as toolkit_emulators
+from music_app.emulators import MainView
+
+logger = logging.getLogger(__name__)
+
 
 class MusicTestCase(AutopilotTestCase):
 
@@ -78,22 +80,30 @@
         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)
         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)
 
     def _create_music_library(self):
         #use fake home
         home = os.environ['HOME']
+        logger.debug("Home set to " + home)
         musicpath = home + '/Music'
+        logger.debug("Music path set to " + musicpath)
         mediascannerpath = home + '/.cache/mediascanner'
         os.mkdir(musicpath)
+        logger.debug("Mediascanner path set to " + mediascannerpath)
 
         #copy over our index
         shutil.copytree(self.working_dir + '/music_app/content/mediascanner',
                         mediascannerpath)
 
+        logger.debug("Mediascanner database copied, files " + str(os.listdir(mediascannerpath)))
+
+        #copy over the music
         if os.path.exists(self.local_location):
             shutil.copy(self.working_dir + '/music_app/content/'
                 +'1.ogg',
@@ -109,20 +119,39 @@
             +'2.ogg',
             musicpath)
 
+        logger.debug("Music copied, files " + str(os.listdir(musicpath)))
+
         #do some inline db patching
         #patch mediaindex to proper home
         #these values are dependent upon our sampled db
+        logger.debug("Patching fake mediascanner database")
         relhome = home[1:]
         dblocation = "home/autopilot-music-app"
         dbfoldername = "ea50858c-4b21-4f87-9005-40aa960a84a3"
         #patch mediaindex
-        os.system("sed -i 's!" + dblocation + "!" + str(relhome) + "!g' " + str(mediascannerpath) + "/mediaindex")
+        self._file_find_replace(mediascannerpath + "/mediaindex", dblocation, relhome)
 
         #patch file indexes
-        os.system("sed -i 's!" + dblocation + "!" + str(relhome) + "!g' " + str(mediascannerpath) + "/" + dbfoldername + "/_0.cfs")
-        os.system("sed -i 's!" + dblocation + "!" + str(relhome) + "!g' " + str(mediascannerpath) + "/" + dbfoldername + "/_1.cfs")
-        os.system("sed -i 's!" + dblocation + "!" + str(relhome) + "!g' " + str(mediascannerpath) + "/" + dbfoldername + "/_2.cfs")
-        os.system("sed -i 's!" + dblocation + "!" + str(relhome) + "!g' " + str(mediascannerpath) + "/" + dbfoldername + "/_3.cfs")
+        self._file_find_replace(mediascannerpath + "/" + dbfoldername + "/_0.cfs", dblocation, relhome)
+        self._file_find_replace(mediascannerpath + "/" + dbfoldername + "/_1.cfs", dblocation, relhome)
+        self._file_find_replace(mediascannerpath + "/" + dbfoldername + "/_2.cfs", dblocation, relhome)
+        self._file_find_replace(mediascannerpath + "/" + dbfoldername + "/_3.cfs", dblocation, relhome)
+
+    def _file_find_replace(self, in_filename, find, replace):
+        #replace all occurences of string find with string replace
+        #in the given file
+        out_filename = in_filename + ".tmp"
+        infile = open(in_filename, 'r')
+        outfile = open(out_filename, 'w')
+        for s in infile.xreadlines():
+            outfile.write(s.replace(find, replace))
+        infile.close()
+        outfile.close()
+
+        #remove original file and copy new file back
+        os.remove(in_filename)
+        os.rename(out_filename, in_filename)
+
 
     @property
     def main_view(self):

=== modified file 'tests/autopilot/music_app/tests/test_music.py'
--- tests/autopilot/music_app/tests/test_music.py	2013-09-15 13:43:45 +0000
+++ tests/autopilot/music_app/tests/test_music.py	2013-10-01 19:27:03 +0000
@@ -18,10 +18,9 @@
 
 class TestMainWindow(MusicTestCase):
 
-    def test_reads_music_from_home(self):
-        """ tests if the music library is populated from our fake home
-            directory
-        """
+    def test_reads_music_library(self):
+        """ tests if the music library is populated from our
+        fake mediascanner database"""
 
         mainView = self.main_view.get_main_view()
         title = lambda: mainView.currentTracktitle
@@ -77,5 +76,3 @@
         self.assertThat(mainView.isPlaying, Eventually(Equals(True)))
         self.assertThat(title, Eventually(Equals("Swansong")))
         self.assertThat(artist, Eventually(Equals("Josh Woodward")))
-
-