Merge lp:~dpm/ubuntu-filemanager-app/run-ap-from-out-of-source-build into lp:ubuntu-filemanager-app

[David Planella]

Enable detection of the build dir and running the autopilot tests from there.

Enable detection of the build dir and running the autopilot tests from there.

The idea is that we can dogfood the tools we're providing to developers, thus this branch brings the ability of building the app with Qt Creator and then running the AP tests from that same build directory.

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

FAILED: Continuous integration, rev:174
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/180/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2268/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-raring-amd64-ci/180/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-saucy-amd64-ci/180/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-trusty-amd64-ci/130/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/180/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:174
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/184/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2276/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-raring-amd64-ci/184/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-saucy-amd64-ci/184/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-trusty-amd64-ci/134/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/184/rebuild

review: Needs Fixing (continuous-integration)

[lp:~dpm/ubuntu-filemanager-app/run-ap-from-out-of-source-build]

175. By David Planella on 2014-04-29

Fix pep8 warnings

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

PASSED: Continuous integration, rev:175
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/185/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2285
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-filemanager-app-raring-amd64-ci/185
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-filemanager-app-saucy-amd64-ci/185
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-filemanager-app-trusty-amd64-ci/135

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/185/rebuild

review: Approve (continuous-integration)

[Nicholas Skaggs (nskaggs)]

Thanks David, this makes it easier to review.

[Nicholas Skaggs (nskaggs)]

David, I need Leo's feedback here again, but initially speaking about this, I think we would rather see an argument to autopilot, rather than the test parse something. Leo should have a bug around for this. I don't want to let this languish, so certainly we can land something as a stop-gap if needed.

[David Planella (dpm)]

The issue with an argument is that is less automated (i.e. with this branch I can just run autopilot with the right build dir being auto-detected, whereas with an argument I'd have to look for the build dir and pass it to AP).

However, if you guys have got a better solution that supersedes this branch, happy to go with that too.

[David Planella (dpm)]

I'll mark this as Work in progress, to drop the dependency on python-lxml, which is not installed in the phone images.

[Leo Arias (elopio)]

> The issue with an argument is that is less automated (i.e. with this branch I
> can just run autopilot with the right build dir being auto-detected, whereas
> with an argument I'd have to look for the build dir and pass it to AP).

What I think is that we shouldn't call autopilot run directly if we are developing the app. IMO, we should call the cmake autopilot tasks.
I'm also thinking about more complex scenarios that need to start fake servers or set up fake services. For example, on the click scope we run:
make test-click-scope-autopilot-fake-servers
And it takes care of passing the right variables to the scripts to find the compiled scope and to set the right addresses for the servers.

=== added file 'tests/autopilot/filemanager/CMakePluginParser.py'
--- tests/autopilot/filemanager/CMakePluginParser.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/filemanager/CMakePluginParser.py	2014-04-29 12:03:28 +0000
@@ -0,0 +1,120 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+# Author:
+#   David Planella <[e-mail]>
+
+"""
+This module parses a configuration file from the Qt Creator's CMake plugin and
+enables programmatical read-only access to several of its configuration options
+"""
+
+import sys
+from lxml import etree
+
+
+class CMakePluginParseError(Exception):
+    """
+    Custom exception for errors during the parsing of a
+    CMakeLists.txt.user file
+    """
+    def __init__(self, message):
+        Exception.__init__(self, message)
+
+
+class CMakePluginParser(object):
+    """
+    Parses a CMake plugin's config file and provides R/O access to its
+    configuration options """
+
+    def __init__(self, cmakelists_usr_file='CMakeLists.txt.user'):
+        self.usr_file = cmakelists_usr_file
+
+        try:
+            self.info = etree.parse(self.usr_file)
+        except:
+            sys.stderr.write("Could not open the given " +
+                             "CMakeLists.txt.user file: " + self.info)
+            raise
+
+    def _get_active_build_target(self):
+        """
+        Return the active build target from the current project in Qt Creator
+        """
+
+        try:
+            active_build_target_nr = self.info.xpath(
+                "./data/variable" +
+                "[text()='ProjectExplorer.Project.ActiveTarget']" +
+                "/../value")[0].text
+        except:
+            raise CMakePluginParseError("Could not find the active build " +
+                                        "target in the CMake plugin's config")
+
+        active_build_target = "ProjectExplorer.Project.Target." + \
+            active_build_target_nr
+
+        return active_build_target
+
+    def _get_active_build_config(self, active_build_target):
+        """Return the active build config from the active build targed"""
+
+        try:
+            active_build_config_nr = self.info.xpath(
+                "./data/variable[text()='{0}']".format(active_build_target) +
+                "/..//value[@key="
+                "'ProjectExplorer.Target.ActiveBuildConfiguration']")[0].text
+        except:
+            raise CMakePluginParseError("Could not find the active build " +
+                                        "target's active build config " +
+                                        "in the CMake plugin's config")
+
+        active_build_config = "ProjectExplorer.Target.BuildConfiguration." + \
+            active_build_config_nr
+
+        return active_build_config
+
+    def _get_active_build_config_path(self):
+        """Return the active build config's absolute path"""
+
+        active_build_target = self._get_active_build_target()
+        active_build_config = \
+            self._get_active_build_config(active_build_target)
+
+        try:
+            active_build_config_node = self.info.xpath(
+                "./data/variable[text()='{0}']".format(active_build_target) +
+                "/..//valuemap[@key='{0}']".format(active_build_config))[0]
+        except:
+            raise CMakePluginParseError("Could not find the active " +
+                                        "build config's node " +
+                                        "in the CMake plugin's config")
+
+        try:
+            active_build_config_path = active_build_config_node.xpath(
+                "./value[@key=" +
+                "'ProjectExplorer.BuildConfiguration.BuildDirectory']")[0].text
+        except:
+            raise CMakePluginParseError("Could not find the active build " +
+                                        "directory in the CMake plugin's " +
+                                        "config")
+
+        return active_build_config_path
+
+    @property
+    def active_build_dir(self):
+        """Return the active build config's directory as an absolute path"""
+        return self._get_active_build_config_path()

=== modified file 'tests/autopilot/filemanager/tests/__init__.py'
--- tests/autopilot/filemanager/tests/__init__.py	2014-04-29 12:03:28 +0000
+++ tests/autopilot/filemanager/tests/__init__.py	2014-04-29 12:03:28 +0000
@@ -13,7 +13,7 @@
 import logging
 
 import fixtures
-from filemanager import emulators
+from filemanager import emulators, CMakePluginParser
 
 from autopilot.input import Mouse, Touch, Pointer
 from autopilot.platform import model
@@ -73,7 +73,17 @@
             self.app = self.launch_test_click()
 
     def _get_build_dir(self):
-        build_dir = self.source_dir
+        """
+        Returns the build dir after having parsed the CMake config file
+        generated by Qt Creator. If it cannot find it or it cannot be parsed,
+        an in-tree build is assumed and thus returned.
+        """
+        try:
+            cmake_config = CMakePluginParser.CMakePluginParser(os.path.join(
+                self.source_dir, 'CMakeLists.txt.user'))
+            build_dir = cmake_config.active_build_dir
+        except:
+            build_dir = self.source_dir
 
         return build_dir