/usr/share/pyshared/ubuntu-sso-client/ubuntu_sso/utils/tests/test_tcpactivation.py is in python-ubuntu-sso-client.tests 3.0.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | # -*- coding: utf-8 -*-
# Author: Alejandro J. Cura <alecu@canonical.com>
#
# Copyright 2011-2012 Canonical Ltd.
#
# 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.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
# PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#
# In addition, as a special exception, the copyright holders give
# permission to link the code of portions of this program with the
# OpenSSL library under certain conditions as described in each
# individual source file, and distribute linked combinations
# including the two.
# You must obey the GNU General Public License in all respects
# for all of the code used other than OpenSSL. If you modify
# file(s) with this exception, you may extend this exception to your
# version of the file(s), but you are not obligated to do so. If you
# do not wish to do so, delete this exception statement from your
# version. If you delete this exception statement from all source
# files in the program, then also delete it here.
"""Tests for the tcpactivation module."""
# twisted uses a different coding convention
# pylint: disable=C0103,W0232
# this test module access a few protected members (starting with _)
# pylint: disable=W0212
from twisted.internet import defer, protocol, reactor, task
from twisted.trial.unittest import TestCase
from ubuntu_sso.utils import tcpactivation
from ubuntu_sso.utils.tcpactivation import (
ActivationClient,
ActivationConfig,
ActivationDetector,
ActivationInstance,
ActivationTimeoutError,
AlreadyStartedError,
NullProtocol,
PortDetectFactory,
)
SAMPLE_SERVICE = "test_service_name"
SAMPLE_CMDLINE = ["python", __file__, "-server"]
SAMPLE_PORT = 55555
class FakeServerProtocol(protocol.Protocol):
"""A test protocol."""
def dataReceived(self, data):
"""Echo the data received."""
self.transport.write(data)
#pylint:disable=E1101
def connectionLost(self, *a):
self.factory.onConnectionLost.callback(self)
#pylint:enable=E1101
class FakeServerFactory(protocol.Factory):
"""A factory for the test server."""
protocol = FakeServerProtocol
#pylint:disable=W0201
def __init__(self, testcase=None):
"""Create a new instance for the testcase."""
if testcase is not None:
self.onConnectionLost = defer.Deferred()
testcase.addCleanup(lambda: self.onConnectionLost)
#pylint:enable=W0201
class FakeTransport(object):
"""A fake transport."""
connectionLost = False
def loseConnection(self):
"""Remember that the connection was dropped."""
self.connectionLost = True
class AsyncSleepTestCase(TestCase):
"""Tests for the async_sleep function."""
@defer.inlineCallbacks
def setUp(self):
"""Initialize this test instance."""
yield super(AsyncSleepTestCase, self).setUp()
self.test_timeout = 5.0
self.clock = task.Clock()
self.patch(tcpactivation, "reactor", self.clock)
self.d = tcpactivation.async_sleep(self.test_timeout)
def test_async_sleep_not_fired_immediately(self):
"""The async_sleep deferred is not fired immediately."""
self.assertFalse(self.d.called, "Must not be fired immediately.")
def test_async_sleep_not_fired_in_a_bit(self):
"""The async_sleep deferred is not fired before the right time."""
self.clock.advance(self.test_timeout / 2)
self.assertFalse(self.d.called, "Must not be fired yet.")
def test_async_sleep_fired_at_the_right_time(self):
"""The async_sleep deferred is fired at the right time."""
self.clock.advance(self.test_timeout)
self.assertTrue(self.d.called, "Must be fired by now.")
class NullProtocolTestCase(TestCase):
"""A test for the NullProtocol class."""
def test_drops_connection(self):
"""The protocol drops the connection."""
np = NullProtocol()
np.transport = FakeTransport()
np.connectionMade()
self.assertTrue(np.transport.connectionLost,
"the connection must be dropped.")
class PortDetectFactoryTestCase(TestCase):
"""Tests for the PortDetectFactory."""
timeout = 2
@defer.inlineCallbacks
def setUp(self):
"""Initialize this test instance."""
yield super(PortDetectFactoryTestCase, self).setUp()
self.factory = PortDetectFactory()
@defer.inlineCallbacks
def test_is_listening(self):
"""Test that the deferred returns True when something is listening."""
addr = (tcpactivation.LOCALHOST, SAMPLE_PORT)
self.factory.buildProtocol(addr)
is_listening = yield self.factory.is_listening()
self.assertTrue(is_listening)
@defer.inlineCallbacks
def test_connection_lost(self):
"""Test that the deferred returns False when the connection is lost."""
self.factory.clientConnectionLost(None, "test reason")
is_listening = yield self.factory.is_listening()
self.assertFalse(is_listening)
@defer.inlineCallbacks
def test_connection_failed(self):
"""Test that the deferred returns False when the connection fails."""
self.factory.clientConnectionFailed(None, "test reason")
is_listening = yield self.factory.is_listening()
self.assertFalse(is_listening)
@defer.inlineCallbacks
def test_connection_failed_then_lost(self):
"""It's not an error if two events happen."""
self.factory.clientConnectionFailed(None, "test reason")
self.factory.clientConnectionLost(None, "test reason")
is_listening = yield self.factory.is_listening()
self.assertFalse(is_listening)
@defer.inlineCallbacks
def test_connection_works_then_lost(self):
"""It's not an error if two events happen."""
addr = (tcpactivation.LOCALHOST, SAMPLE_PORT)
self.factory.buildProtocol(addr)
d = self.factory.is_listening()
self.factory.clientConnectionLost(None, "test reason")
is_listening = yield d
self.assertTrue(is_listening)
class ActivationConfigTestCase(TestCase):
"""Tests for the ActivationConfig class."""
def test_initialization(self):
"""Test the constructor."""
config = ActivationConfig(SAMPLE_SERVICE, SAMPLE_CMDLINE, SAMPLE_PORT)
self.assertEqual(config.service_name, SAMPLE_SERVICE)
self.assertEqual(config.command_line, SAMPLE_CMDLINE)
self.assertEqual(config.port, SAMPLE_PORT)
class ActivationDetectorTestCase(TestCase):
"""Tests for the ActivationDetector class."""
@defer.inlineCallbacks
def setUp(self):
"""Initialize this test instance."""
yield super(ActivationDetectorTestCase, self).setUp()
self.config = ActivationConfig(SAMPLE_SERVICE, SAMPLE_CMDLINE,
SAMPLE_PORT)
def test_initialization(self):
"""Test the constructor."""
self.config = ActivationConfig(SAMPLE_SERVICE, SAMPLE_CMDLINE,
SAMPLE_PORT)
ai = ActivationDetector(self.config)
self.assertEqual(ai.config, self.config)
@defer.inlineCallbacks
def test_is_not_already_running(self):
"""Test the is_already_running method returns False."""
ad = ActivationDetector(self.config)
result = yield ad.is_already_running()
self.assertFalse(result, "It should not be already running.")
@defer.inlineCallbacks
def test_is_already_running(self):
"""The is_already_running method returns True if already started."""
f = FakeServerFactory(self)
# pylint: disable=E1101
listener = reactor.listenTCP(SAMPLE_PORT, f,
interface=tcpactivation.LOCALHOST)
self.addCleanup(listener.stopListening)
ad = ActivationDetector(self.config)
result = yield ad.is_already_running()
self.assertTrue(result, "It should be already running.")
class ActivationClientTestCase(TestCase):
"""Tests for the ActivationClient class."""
timeout = 2
@defer.inlineCallbacks
def setUp(self):
"""Initialize this test instance."""
yield super(ActivationClientTestCase, self).setUp()
self.config = ActivationConfig(SAMPLE_SERVICE, SAMPLE_CMDLINE,
SAMPLE_PORT)
def test_initialization(self):
"""Test the constructor."""
ac = ActivationClient(self.config)
self.assertEqual(ac.config, self.config)
@defer.inlineCallbacks
def test_do_get_active_port_running(self):
"""Test the _do_get_active_port method when the server is running."""
ac = ActivationClient(self.config)
self.patch(ac, "is_already_running", lambda: defer.succeed(True))
result = yield ac._do_get_active_port()
self.assertEqual(result, SAMPLE_PORT)
@defer.inlineCallbacks
def test_do_get_active_port_not_running(self):
"""Test _do_get_active_port method when the server is not running."""
server_spawned = []
ac = ActivationClient(self.config)
self.patch(ac, "_spawn_server",
lambda *args: server_spawned.append(args))
self.patch(ac, "is_already_running", lambda: defer.succeed(False))
self.patch(ac, "_wait_server_active", lambda: defer.succeed(None))
result = yield ac._do_get_active_port()
self.assertEqual(result, SAMPLE_PORT)
self.assertEqual(len(server_spawned), 1)
def test_get_active_port_waits_classwide(self):
"""Test the get_active_port method locks classwide."""
d = defer.Deferred()
ac1 = ActivationClient(self.config)
ac2 = ActivationClient(self.config)
self.patch(ac1, "_do_get_active_port", lambda: d)
self.patch(ac2, "_do_get_active_port", lambda: defer.succeed(None))
ac1.get_active_port()
d2 = ac2.get_active_port()
self.assertFalse(d2.called, "The second must wait for the first.")
d.callback(SAMPLE_PORT)
self.assertTrue(d2.called, "The second can fire after the first.")
def test_wait_server_active(self):
"""Test the _wait_server_active method."""
ac = ActivationClient(self.config)
clock = task.Clock()
self.patch(tcpactivation, "reactor", clock)
self.patch(ac, "is_already_running", lambda: defer.succeed(False))
d = ac._wait_server_active()
self.assertFalse(d.called, "The deferred should not be fired yet.")
clock.advance(tcpactivation.DELAY_BETWEEN_CHECKS)
self.assertFalse(d.called, "The deferred should not be fired yet.")
self.patch(ac, "is_already_running", lambda: defer.succeed(True))
clock.advance(tcpactivation.DELAY_BETWEEN_CHECKS)
self.assertTrue(d.called, "The deferred should be fired by now.")
def test_wait_server_timeouts(self):
"""If the server takes too long to start then timeout."""
ac = ActivationClient(self.config)
clock = task.Clock()
self.patch(tcpactivation, "reactor", clock)
self.patch(ac, "is_already_running", lambda: defer.succeed(False))
d = ac._wait_server_active()
clock.pump([tcpactivation.DELAY_BETWEEN_CHECKS] *
tcpactivation.NUMBER_OF_CHECKS)
return self.assertFailure(d, ActivationTimeoutError)
def test_spawn_server(self):
"""Test the _spawn_server method."""
popen_calls = []
ac = ActivationClient(self.config)
self.patch(tcpactivation.subprocess, "Popen",
lambda *args, **kwargs: popen_calls.append((args, kwargs)))
ac._spawn_server()
self.assertEqual(len(popen_calls), 1)
class ActivationInstanceTestCase(TestCase):
"""Tests for the ActivationServer class."""
timeout = 2
@defer.inlineCallbacks
def setUp(self):
"""Initialize this test instance."""
yield super(ActivationInstanceTestCase, self).setUp()
self.config = ActivationConfig(SAMPLE_SERVICE, SAMPLE_CMDLINE,
SAMPLE_PORT)
def test_initialization(self):
"""Test the constructor."""
ai = ActivationInstance(self.config)
self.assertEqual(ai.config, self.config)
@defer.inlineCallbacks
def test_get_port(self):
"""Test the get_port method."""
ai = ActivationInstance(self.config)
port = yield ai.get_port()
self.assertEqual(port, SAMPLE_PORT)
#pylint:disable=W0201
@defer.inlineCallbacks
def test_get_port_fails_if_service_already_started(self):
"""The get_port method fails if service already started."""
ai1 = ActivationInstance(self.config)
port1 = yield ai1.get_port()
f = FakeServerFactory(self)
# pylint: disable=E1101
listener = reactor.listenTCP(port1, f,
interface=tcpactivation.LOCALHOST)
self.addCleanup(listener.stopListening)
ai2 = ActivationInstance(self.config)
yield self.assertFailure(ai2.get_port(), AlreadyStartedError)
#pylint:enable=W0201
def server_test(config):
"""An IRL test of the server."""
def got_port(port_number):
"""The port number was found."""
print "got server port:", port_number
# start listening
f = FakeServerFactory()
# pylint: disable=E1101
reactor.listenTCP(port_number, f)
# try to get the port again
get_port()
def already_started(failure):
"""This instance was already started."""
print "already started!"
# pylint: disable=E1101
reactor.callLater(3, reactor.stop)
def get_port():
"""Try to get the port number."""
get_port_d = ai.get_port()
get_port_d.addCallback(got_port)
get_port_d.addErrback(already_started)
print "starting the server."
ai = ActivationInstance(config)
get_port()
# pylint: disable=E1101
reactor.run()
def client_test(config):
"""An IRL test of the client."""
print "starting the client."
ac = ActivationClient(config)
d = ac.get_active_port()
def got_port(port_number):
"""The port number was found."""
print "client got server port:", port_number
reactor.stop()
d.addCallback(got_port)
# pylint: disable=E1101
reactor.run()
def irl_test():
"""Do an IRL test of the client and the server."""
import sys
config = ActivationConfig(SAMPLE_SERVICE, SAMPLE_CMDLINE, SAMPLE_PORT)
if "-server" in sys.argv[1:]:
server_test(config)
else:
client_test(config)
if __name__ == "__main__":
irl_test()
|