1
=== added directory 'ubuntuone/controlpanel/web_client/tests'
2
=== added file 'ubuntuone/controlpanel/web_client/tests/__init__.py'
3
--- ubuntuone/controlpanel/web_client/tests/__init__.py	1970-01-01 00:00:00 +0000
4
+++ ubuntuone/controlpanel/web_client/tests/__init__.py	2011-09-09 00:01:23 +0000
5
@@ -0,0 +1,19 @@
6
1
# -*- coding: utf-8 -*-
7
2
8
3
# Authors: Alejandro J. Cura <alecu@canonical.com>
9
4
#
10
5
# Copyright 2011 Canonical Ltd.
11
6
#
12
7
# This program is free software: you can redistribute it and/or modify it
13
8
# under the terms of the GNU General Public License version 3, as published
14
9
# by the Free Software Foundation.
15
10
#
16
11
# This program is distributed in the hope that it will be useful, but
17
12
# WITHOUT ANY WARRANTY; without even the implied warranties of
18
13
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
19
14
# PURPOSE.  See the GNU General Public License for more details.
20
15
#
21
16
# You should have received a copy of the GNU General Public License along
22
17
# with this program.  If not, see <http://www.gnu.org/licenses/>.
23
18
24
19
"""Unit tests for the control panel backend webservice clients."""
25
0
20
26
=== added file 'ubuntuone/controlpanel/web_client/tests/test_txwebclient.py'
27
--- ubuntuone/controlpanel/web_client/tests/test_txwebclient.py	1970-01-01 00:00:00 +0000
28
+++ ubuntuone/controlpanel/web_client/tests/test_txwebclient.py	2011-09-09 00:01:23 +0000
29
@@ -0,0 +1,153 @@
30
1
# -*- coding: utf-8 -*-
31
2
32
3
# Authors: Alejandro J. Cura <alecu@canonical.com>
33
4
#
34
5
# Copyright 2011 Canonical Ltd.
35
6
#
36
7
# This program is free software: you can redistribute it and/or modify it
37
8
# under the terms of the GNU General Public License version 3, as published
38
9
# by the Free Software Foundation.
39
10
#
40
11
# This program is distributed in the hope that it will be useful, but
41
12
# WITHOUT ANY WARRANTY; without even the implied warranties of
42
13
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
43
14
# PURPOSE.  See the GNU General Public License for more details.
44
15
#
45
16
# You should have received a copy of the GNU General Public License along
46
17
# with this program.  If not, see <http://www.gnu.org/licenses/>.
47
18
48
19
"""Unit tests for the control panel backend twisted webservice client."""
49
20
50
21
from twisted.application import internet, service
51
22
from twisted.internet import defer, reactor
52
23
from twisted.internet.defer import inlineCallbacks
53
24
from twisted.web import server, resource
54
25
55
26
from ubuntuone.controlpanel.web_client import txwebclient
56
27
from ubuntuone.controlpanel.tests import TestCase
57
28
58
29
59
30
SAMPLE_KEY = "result"
60
31
SAMPLE_VALUE = "sample result"
61
32
SAMPLE_RESOURCE = '{"%s": "%s"}' % (SAMPLE_KEY, SAMPLE_VALUE)
62
33
SAMPLE_CREDENTIALS = dict(
63
34
    consumer_key="consumer key",
64
35
    consumer_secret="consumer secret",
65
36
    token="the real token",
66
37
    token_secret="the token secret",
67
38
)
68
39
69
40
70
41
def sample_get_credentials():
71
42
    """Will return the sample credentials right now."""
72
43
    return defer.succeed(SAMPLE_CREDENTIALS)
73
44
74
45
75
46
class MockResource(resource.Resource):
76
47
    """A simple web resource."""
77
48
    isLeaf = True
78
49
    contents = ""
79
50
80
51
    # pylint: disable=C0103
81
52
    # t.w.resource methods have freeform cased names
82
53
83
54
    def getChild(self, name, request):
84
55
        """Get a given child resource."""
85
56
        if name == '':
86
57
            return self
87
58
        return resource.Resource.getChild(self, name, request)
88
59
89
60
    def render_GET(self, request):
90
61
        """Make a bit of html out of these resource's content."""
91
62
        return self.contents
92
63
93
64
94
65
class MockWebService(object):
95
66
    """A mock webservice for testing"""
96
67
97
68
    def __init__(self):
98
69
        """Start up this instance."""
99
70
        root = resource.Resource()
100
71
        devices_resource = MockResource()
101
72
        devices_resource.contents = SAMPLE_RESOURCE
102
73
        root.putChild("devices", devices_resource)
103
74
        root.putChild("throwerror", resource.NoResource())
104
75
        unauthorized = resource.ErrorPage(resource.http.UNAUTHORIZED,
105
76
                                          "Unauthrorized", "Unauthrorized")
106
77
        root.putChild("unauthorized", unauthorized)
107
78
108
79
        site = server.Site(root)
109
80
        application = service.Application('web')
110
81
        self.service_collection = service.IServiceCollection(application)
111
82
        #pylint: disable=E1101
112
83
        self.tcpserver = internet.TCPServer(0, site)
113
84
        self.tcpserver.setServiceParent(self.service_collection)
114
85
        self.service_collection.startService()
115
86
116
87
    def get_url(self):
117
88
        """Build the url for this mock server."""
118
89
        #pylint: disable=W0212
119
90
        port_num = self.tcpserver._port.getHost().port
120
91
        return "http://localhost:%d/" % port_num
121
92
122
93
    def stop(self):
123
94
        """Shut it down."""
124
95
        #pylint: disable=E1101
125
96
        self.service_collection.stopService()
126
97
127
98
128
99
class WebClientTestCase(TestCase):
129
100
    """Test for the webservice client."""
130
101
131
102
    timeout = 8
132
103
133
104
    def setUp(self):
134
105
        super(WebClientTestCase, self).setUp()
135
106
        self.ws = MockWebService()
136
107
        test_base_url = self.ws.get_url()
137
108
        self.wc = txwebclient.WebClient(sample_get_credentials, test_base_url)
138
109
139
110
    @inlineCallbacks
140
111
    def tearDown(self):
141
112
        super(WebClientTestCase, self).tearDown()
142
113
        yield self.ws.stop()
143
114
        self.wc.shutdown()
144
115
145
116
    @inlineCallbacks
146
117
    def test_get_url(self):
147
118
        """A method is successfully called in the mock webservice."""
148
119
        result = yield self.wc.call_api("devices")
149
120
        self.assertIn(SAMPLE_KEY, result)
150
121
        self.assertEqual(SAMPLE_VALUE, result[SAMPLE_KEY])
151
122
152
123
    @inlineCallbacks
153
124
    def test_get_url_error(self):
154
125
        """The errback is called when there's some error."""
155
126
        yield self.assertFailure(self.wc.call_api("throwerror"),
156
127
                                 txwebclient.WebClientError)
157
128
158
129
    @inlineCallbacks
159
130
    def test_unauthorized(self):
160
131
        """Detect when a request failed with UNAUTHORIZED."""
161
132
        yield self.assertFailure(self.wc.call_api("unauthorized"),
162
133
                                 txwebclient.UnauthorizedError)
163
134
164
135
165
136
class WebClientShutdownTestCase(TestCase):
166
137
    """The webclient behaviour during shutdown."""
167
138
168
139
    @inlineCallbacks
169
140
    def test_shutdown(self):
170
141
        """The webclient behaves well during shutdown."""
171
142
        d3 = defer.Deferred()
172
143
        # pylint: disable=E1101
173
144
        reactor.callLater(1, d3.callback, None)
174
145
        ws = MockWebService()
175
146
        test_base_url = ws.get_url()
176
147
        wc = txwebclient.WebClient(sample_get_credentials, test_base_url)
177
148
        d1 = wc.call_api("throwerror")
178
149
        d2 = ws.stop()
179
150
        wc.shutdown()
180
151
        yield d2
181
152
        yield defer.DeferredList([d1, d3], fireOnOneCallback=True,
182
153
                                 fireOnOneErrback=True)
183
0
154
184
=== modified file 'ubuntuone/controlpanel/web_client/txwebclient.py'
185
--- ubuntuone/controlpanel/web_client/txwebclient.py	2011-06-02 13:14:51 +0000
186
+++ ubuntuone/controlpanel/web_client/txwebclient.py	2011-09-09 00:01:23 +0000
187
@@ -20,6 +20,7 @@
188
20
20
189
21
import simplejson
21
import simplejson
190
22
22
191
23
from twisted.internet import defer, reactor
192
23
from twisted.web import client, error, http
24
from twisted.web import client, error, http
193
24
25
194
25
from ubuntuone.controlpanel import WEBSERVICE_BASE_URL
26
from ubuntuone.controlpanel import WEBSERVICE_BASE_URL
195
@@ -39,6 +40,10 @@
196
39
        """Initialize the webclient."""
40
        """Initialize the webclient."""
197
40
        self.base_url = base_url
41
        self.base_url = base_url
198
41
        self.get_credentials = get_credentials
42
        self.get_credentials = get_credentials
199
43
        self.running = True
200
44
        # pylint: disable=E1101
201
45
        self.trigger_id = reactor.addSystemEventTrigger("before", "shutdown",
202
46
                                                        self.shutdown)
203
42
47
204
43
    def _handle_response(self, result):
48
    def _handle_response(self, result):
205
44
        """Handle the response of the webservice call."""
49
        """Handle the response of the webservice call."""
206
@@ -74,7 +79,19 @@
207
74
        d = self.get_credentials()
79
        d = self.get_credentials()
208
75
        d.addErrback(self._handle_error)
80
        d.addErrback(self._handle_error)
209
76
        d.addCallback(self._call_api_with_creds, api_name)
81
        d.addCallback(self._call_api_with_creds, api_name)
211
77
        return d
82
        d2 = defer.Deferred()
212
83
        d.addCallback(d2.callback)
213
84
214
85
        def mask_errors_on_shutdown(failure):
215
86
            """Do not fire the errbacks if we are shutting down."""
216
87
            if self.running:
217
88
                d2.errback(failure)
218
89
219
90
        d.addErrback(mask_errors_on_shutdown)
220
91
        return d2
221
78
92
222
79
    def shutdown(self):
93
    def shutdown(self):
223
80
        """End the pending webclient calls."""
94
        """End the pending webclient calls."""
224
95
        self.running = False
225
96
        # pylint: disable=E1101
226
97
        reactor.removeSystemEventTrigger(self.trigger_id)
Reviewer	Review Type	Date Requested	Status
Natalia Bidart (community)		2011-09-09	Needs Fixing on 2011-09-09
Review via email: mp+74708@code.launchpad.net