Merge lp:~canonical-platform-qa/url-dispatcher/fake_dispatcher into lp:url-dispatcher/14.10

[Brendan Donegan]

Add url-dispatcher-testability binary package

Create a new url-dispatcher-testability binary package which provides a helper for writing tests which interact with the url dispatcher.

[Leo Arias (elopio)]

165 + call(['url-dispatcher', 'test://testurl'])

In order to run this test you need the package url-dispatcher-tools, so it needs to be part of the dependencies.

review: Needs Fixing (code review)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:59
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/120/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/12/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/12/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/12/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/120/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:59
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/121/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/13/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/13/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/13/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/121/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:59
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/123/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/15/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/15/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/15/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/123/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:59
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/124/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/16/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/16/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/16/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/124/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:61
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/125/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/17/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/125/rebuild

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/url-dispatcher/fake_dispatcher]

62. By Brendan Donegan on 2014-07-16

Add url-dispatcher-tools to control file

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:61
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/128/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/20
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/20
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/20

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/128/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:62
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/129/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/21
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/21
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/21

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/129/rebuild

review: Approve (continuous-integration)

[Brendan Donegan (brendan-donegan)]

This builds and the tests pass now.

[Ted Gould (ted)]

Some discussion on IRC putting here for tracking:

* The tests need to be run by CTest not by debian/rules
* We shouldn't override autotest here to run it under dbus, that should be in the individual test
* The package shouldn't have a build-dep on a binary it produces

review: Needs Fixing

[Ted Gould (ted)]

I think that this should use the CMake python module:

http://www.cmake.org/cmake/help/cmake2.6docs.html#module:FindPythonLibs

Instead of exec'ing Python. Also the build dep for python should probably be Python3. Not a change in this MR, but noticing with the addition of all the python modules :-)

[lp:~canonical-platform-qa/url-dispatcher/fake_dispatcher]

63. By Brendan Donegan on 2014-07-17

Refactor fake dispatcher to split into two modules

64. By Brendan Donegan on 2014-07-17

CMake changes to get url_dispatcher_testability tested with CMake

[Brendan Donegan (brendan-donegan)]

> Some discussion on IRC putting here for tracking:
>
> * The tests need to be run by CTest not by debian/rules
> * We shouldn't override autotest here to run it under dbus, that should be in
> the individual test
> * The package shouldn't have a build-dep on a binary it produces

All good points - CMake is proving very difficult to work with at the moment though. I updated the branch with some CMake changes, but they don't result in my python code being copied to build/tests/url_dispatcher_testability as I'd expect.

From reading about FindPythonLibs, I think it's intended as being useful in the case where one wants to create C/C++ extensions for python. I don't think it helps in this situation - all I have is some python modules that I want to test and install.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:64
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/131/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/23
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/23
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/23

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/131/rebuild

review: Approve (continuous-integration)

[lp:~canonical-platform-qa/url-dispatcher/fake_dispatcher]

65. By Brendan Donegan on 2014-07-20

CTest works now

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:65
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/133/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/25
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/25
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/25

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/133/rebuild

review: Approve (continuous-integration)

[Brendan Donegan (brendan-donegan)]

Using CTest now and the build passes.

[Ted Gould (ted)]

Looks good. One small thing tough, can you change the interface to be (ss) instead of (s) to match this branch? https://code.launchpad.net/~ted/url-dispatcher/test-url/+merge/226765 That way I can silo them all together

[Ted Gould (ted)]

tests/url_dispatcher_testability/test_fake_dispatcher.py:

Needs a copyright statement on top of it.

And the call to url-dispatcher command line utility needs to adjust based on the bindir. If you just make it a command line parameter then your test can pass it as the first parameter, that's pretty easy.

[lp:~canonical-platform-qa/url-dispatcher/fake_dispatcher]

66. By Brendan Donegan on 2014-07-21

Update signature

67. By Brendan Donegan on 2014-07-21

Add copyright header

[Brendan Donegan (brendan-donegan)]

As far as I know, no test runner supports command line arguments for tests. Can you explain the motivation by needing to adjust the call? Is it so that it can be run outside the build system as well? Just trying to understand why so I can come up with another solution.

[Leo Arias (elopio)]

There's an open bug for autopilot to do just that:
https://bugs.launchpad.net/autopilot/+bug/1266589

Currently, we are doing it with env vars.
like: BIN_DIR='../../' autopilot run ...

[Ted Gould (ted)]

The problem is that you don't know that it's going to be "../../" always. I could do:

cmake . ; make

Or I could do:

mkdir build ; cd build ; cmake .. ; make

Or I could do:

mkdir -p foo/bar/foo/bar ; cd foo/bar/foo/bar ; cmake ../../../.. ; make

The way that is kept track of is the variables in CMake. So when people starting doing things like cross compilation the variables get complex.

I figured command line is easier, but setting an environment variable works as well. Just some something that can get information from the build system as the path to the binaries that isn't hard coded. You can also make the python file a .py.in and have the build system do the substitution.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:66
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/134/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/26/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/26/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/26/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/134/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:67
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/135/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/27/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/135/rebuild

review: Needs Fixing (continuous-integration)

[Brendan Donegan (brendan-donegan)]

The problem is CTest sucks, so I've not been able to figure out either how to set the environment (the setting seems to take effect only during the actual execution of cmake), or set the PATH in the test command - CTest automatically thinks the first word in the add_test line is a command. The .in substitution could work, maybe - but that might depend on getting these files copied into the build directory, which I've had no success with so far.

[lp:~canonical-platform-qa/url-dispatcher/fake_dispatcher]

68. By Brendan Donegan on 2014-07-22

Use .in file to set bin_dir

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:68
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/136/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-amd64-ci/28/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-armhf-ci/28/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-utopic-i386-ci/28/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/url-dispatcher-ci/136/rebuild

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/url-dispatcher/fake_dispatcher]

69. By Leo Arias on 2014-07-22

Added python3:Depends as suggested by Colin.

Unmerged revisions

=== modified file 'debian/control'
--- debian/control	2014-05-26 12:56:47 +0000
+++ debian/control	2014-07-22 13:09:58 +0000
@@ -16,8 +16,11 @@
                libgtest-dev,
                libsqlite3-dev,
                libubuntu-app-launch2-dev (>= 0.3),
-               python,
+               python3,
                python3-dbusmock,
+               python3-fixtures,
+               python3-nose,
+               python3-testtools,
                sqlite3,
 Standards-Version: 3.9.4
 Homepage: http://launchpad.net/url-dispatcher
@@ -83,3 +86,10 @@
  starting them inside its own Application Confinement.
  .
  This package contains files that are needed to build applications.
+
+Package: url-dispatcher-testability
+Architecture: all
+Depends: ${misc:Depends},
+         python3-dbusmock,
+         python3-dbus,
+Description: A fake URL dispatcher for use in testing.

=== modified file 'debian/rules'
--- debian/rules	2014-06-06 16:06:24 +0000
+++ debian/rules	2014-07-22 13:09:58 +0000
@@ -12,4 +12,3 @@
 	mkdir -p debian/url-dispatcher/etc/apport/crashdb.conf.d/
 	install -m 644 debian/url-dispatcher-crashdb.conf debian/url-dispatcher/etc/apport/crashdb.conf.d/
 	dh_install --fail-missing
-

=== added file 'debian/url-dispatcher-testability.install'
--- debian/url-dispatcher-testability.install	1970-01-01 00:00:00 +0000
+++ debian/url-dispatcher-testability.install	2014-07-22 13:09:58 +0000
@@ -0,0 +1,1 @@
+/usr/lib/python*/dist-packages/url_dispatcher_testability/*

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2014-05-26 13:09:00 +0000
+++ tests/CMakeLists.txt	2014-07-22 13:09:58 +0000
@@ -131,4 +131,4 @@
 	${GTEST_LIBS})
 
 add_test (url-db-test url-db-test)
-
+add_subdirectory(url_dispatcher_testability)

=== added directory 'tests/url_dispatcher_testability'
=== added file 'tests/url_dispatcher_testability/CMakeLists.txt'
--- tests/url_dispatcher_testability/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/url_dispatcher_testability/CMakeLists.txt	2014-07-22 13:09:58 +0000
@@ -0,0 +1,13 @@
+execute_process(COMMAND python3 -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"
+    OUTPUT_VARIABLE PYTHON_PACKAGE_DIR OUTPUT_STRIP_TRAILING_WHITESPACE)
+
+install(FILES fixture_setup.py fake_dispatcher.py test_fake_dispatcher.py
+    DESTINATION ${PYTHON_PACKAGE_DIR}/url_dispatcher_testability
+)
+
+configure_file(
+  "${PROJECT_SOURCE_DIR}/tests/url_dispatcher_testability/test_fake_dispatcher.py.in"
+  "${PROJECT_SOURCE_DIR}/tests/url_dispatcher_testability/test_fake_dispatcher.py"
+  )
+
+add_test(fake-dispatcher dbus-launch --exit-with-session nosetests3 ${PROJECT_SOURCE_DIR}/tests/url_dispatcher_testability/test_fake_dispatcher.py)

=== added file 'tests/url_dispatcher_testability/__init__.py'
=== added file 'tests/url_dispatcher_testability/fake_dispatcher.py'
--- tests/url_dispatcher_testability/fake_dispatcher.py	1970-01-01 00:00:00 +0000
+++ tests/url_dispatcher_testability/fake_dispatcher.py	2014-07-22 13:09:58 +0000
@@ -0,0 +1,67 @@
+# -*- 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/>.
+
+import dbus
+import dbusmock
+import subprocess
+
+
+class FakeDispatcherException(Exception):
+    pass
+
+
+class FakeURLDispatcherService:
+
+    """Fake URL Dispatcher service using a dbusmock interface."""
+
+    def __init__(self):
+        super(FakeURLDispatcherService, self).__init__()
+        self.dbus_connection = dbusmock.DBusTestCase.get_dbus(system_bus=False)
+
+    def start(self):
+        """Start the fake URL Dispatcher service."""
+        # Stop the real url-dispatcher.
+        subprocess.call(['initctl', 'stop', 'url-dispatcher'])
+        self.dbus_mock_server = dbusmock.DBusTestCase.spawn_server(
+            'com.canonical.URLDispatcher',
+            '/com/canonical/URLDispatcher',
+            'com.canonical.URLDispatcher',
+            system_bus=False,
+            stdout=subprocess.PIPE)
+        self.mock = self._get_mock_interface()
+        self.mock.AddMethod(
+            'com.canonical.URLDispatcher', 'DispatchURL', 'ss', '', '')
+
+    def _get_mock_interface(self):
+        return dbus.Interface(
+            self.dbus_connection.get_object(
+                'com.canonical.URLDispatcher',
+                '/com/canonical/URLDispatcher'),
+            dbusmock.MOCK_IFACE)
+
+    def stop(self):
+        """Stop the fake URL Dispatcher service."""
+        self.dbus_mock_server.terminate()
+        self.dbus_mock_server.wait()
+
+    def get_last_dispatch_url_call_parameter(self):
+        """Return the parameter used in the last call to dispatch URL."""
+        calls = self.mock.GetCalls()
+        if len(calls) == 0:
+            raise FakeDispatcherException(
+                'URL dispatcher has not been called.')
+        last_call = self.mock.GetCalls()[-1]
+        return last_call[2][0]

=== added file 'tests/url_dispatcher_testability/fixture_setup.py'
--- tests/url_dispatcher_testability/fixture_setup.py	1970-01-01 00:00:00 +0000
+++ tests/url_dispatcher_testability/fixture_setup.py	2014-07-22 13:09:58 +0000
@@ -0,0 +1,30 @@
+# -*- 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/>.
+
+import fixtures
+from url_dispatcher_testability import fake_dispatcher
+
+
+class FakeURLDispatcher(fixtures.Fixture):
+
+    def setUp(self):
+        super(FakeURLDispatcher, self).setUp()
+        self.fake_service = fake_dispatcher.FakeURLDispatcherService()
+        self.addCleanup(self.fake_service.stop)
+        self.fake_service.start()
+
+    def get_last_dispatch_url_call_parameter(self):
+        return self.fake_service.get_last_dispatch_url_call_parameter()

=== added file 'tests/url_dispatcher_testability/test_fake_dispatcher.py.in'
--- tests/url_dispatcher_testability/test_fake_dispatcher.py.in	1970-01-01 00:00:00 +0000
+++ tests/url_dispatcher_testability/test_fake_dispatcher.py.in	2014-07-22 13:09:58 +0000
@@ -0,0 +1,37 @@
+# -*- 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/>.
+
+import testtools
+from url_dispatcher_testability import fixture_setup, fake_dispatcher
+
+from subprocess import call, CalledProcessError
+
+
+class FakeDispatcherTestCase(testtools.TestCase):
+
+    def setUp(self):
+        super(FakeDispatcherTestCase, self).setUp()
+        self.dispatcher = fixture_setup.FakeURLDispatcher()
+        self.useFixture(self.dispatcher)
+
+    def test_url_dispatcher(self):
+        bin_dir = "@PROJECT_BINARY_DIR@"
+        call([bin_dir + '/tools/url-dispatcher', 'test://testurl'])
+        try:
+            last_url = self.dispatcher.get_last_dispatch_url_call_parameter()
+        except fake_dispatcher.FakeDispatcherException:
+            last_url = None
+        self.assertEqual(last_url, 'test://testurl')