/usr/share/pyshared/twisted/names/test/test_client.py is in python-twisted-names 11.1.0-1.
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 | # Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Test cases for L{twisted.names.client}.
"""
from twisted.names import client, dns
from twisted.names.error import DNSQueryTimeoutError
from twisted.trial import unittest
from twisted.names.common import ResolverBase
from twisted.internet import defer, error
from twisted.python import failure
from twisted.python.deprecate import getWarningMethod, setWarningMethod
from twisted.python.compat import set
class FakeResolver(ResolverBase):
def _lookup(self, name, cls, qtype, timeout):
"""
The getHostByNameTest does a different type of query that requires it
return an A record from an ALL_RECORDS lookup, so we accomodate that
here.
"""
if name == 'getHostByNameTest':
rr = dns.RRHeader(name=name, type=dns.A, cls=cls, ttl=60,
payload=dns.Record_A(address='127.0.0.1', ttl=60))
else:
rr = dns.RRHeader(name=name, type=qtype, cls=cls, ttl=60)
results = [rr]
authority = []
addtional = []
return defer.succeed((results, authority, addtional))
class StubPort(object):
"""
A partial implementation of L{IListeningPort} which only keeps track of
whether it has been stopped.
@ivar disconnected: A C{bool} which is C{False} until C{stopListening} is
called, C{True} afterwards.
"""
disconnected = False
def stopListening(self):
self.disconnected = True
class StubDNSDatagramProtocol(object):
"""
L{dns.DNSDatagramProtocol}-alike.
@ivar queries: A C{list} of tuples giving the arguments passed to
C{query} along with the L{defer.Deferred} which was returned from
the call.
"""
def __init__(self):
self.queries = []
self.transport = StubPort()
def query(self, address, queries, timeout=10, id=None):
"""
Record the given arguments and return a Deferred which will not be
called back by this code.
"""
result = defer.Deferred()
self.queries.append((address, queries, timeout, id, result))
return result
class ResolverTests(unittest.TestCase):
"""
Tests for L{client.Resolver}.
"""
def test_resolverProtocol(self):
"""
Reading L{client.Resolver.protocol} causes a deprecation warning to be
emitted and evaluates to an instance of L{DNSDatagramProtocol}.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
self.addCleanup(setWarningMethod, getWarningMethod())
warnings = []
setWarningMethod(
lambda message, category, stacklevel:
warnings.append((message, category, stacklevel)))
protocol = resolver.protocol
self.assertIsInstance(protocol, dns.DNSDatagramProtocol)
self.assertEqual(
warnings, [("Resolver.protocol is deprecated; use "
"Resolver.queryUDP instead.",
PendingDeprecationWarning, 0)])
self.assertIdentical(protocol, resolver.protocol)
def test_datagramQueryServerOrder(self):
"""
L{client.Resolver.queryUDP} should issue queries to its
L{dns.DNSDatagramProtocol} with server addresses taken from its own
C{servers} and C{dynServers} lists, proceeding through them in order
as L{DNSQueryTimeoutError}s occur.
"""
protocol = StubDNSDatagramProtocol()
servers = [object(), object()]
dynServers = [object(), object()]
resolver = client.Resolver(servers=servers)
resolver.dynServers = dynServers
resolver.protocol = protocol
expectedResult = object()
queryResult = resolver.queryUDP(None)
queryResult.addCallback(self.assertEqual, expectedResult)
self.assertEqual(len(protocol.queries), 1)
self.assertIdentical(protocol.queries[0][0], servers[0])
protocol.queries[0][-1].errback(DNSQueryTimeoutError(0))
self.assertEqual(len(protocol.queries), 2)
self.assertIdentical(protocol.queries[1][0], servers[1])
protocol.queries[1][-1].errback(DNSQueryTimeoutError(1))
self.assertEqual(len(protocol.queries), 3)
self.assertIdentical(protocol.queries[2][0], dynServers[0])
protocol.queries[2][-1].errback(DNSQueryTimeoutError(2))
self.assertEqual(len(protocol.queries), 4)
self.assertIdentical(protocol.queries[3][0], dynServers[1])
protocol.queries[3][-1].callback(expectedResult)
return queryResult
def test_singleConcurrentRequest(self):
"""
L{client.Resolver.query} only issues one request at a time per query.
Subsequent requests made before responses to prior ones are received
are queued and given the same response as is given to the first one.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
resolver.protocol = StubDNSDatagramProtocol()
queries = resolver.protocol.queries
query = dns.Query('foo.example.com', dns.A, dns.IN)
# The first query should be passed to the underlying protocol.
firstResult = resolver.query(query)
self.assertEqual(len(queries), 1)
# The same query again should not be passed to the underlying protocol.
secondResult = resolver.query(query)
self.assertEqual(len(queries), 1)
# The response to the first query should be sent in response to both
# queries.
answer = object()
response = dns.Message()
response.answers.append(answer)
queries.pop()[-1].callback(response)
d = defer.gatherResults([firstResult, secondResult])
def cbFinished((firstResponse, secondResponse)):
self.assertEqual(firstResponse, ([answer], [], []))
self.assertEqual(secondResponse, ([answer], [], []))
d.addCallback(cbFinished)
return d
def test_multipleConcurrentRequests(self):
"""
L{client.Resolver.query} issues a request for each different concurrent
query.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
resolver.protocol = StubDNSDatagramProtocol()
queries = resolver.protocol.queries
# The first query should be passed to the underlying protocol.
firstQuery = dns.Query('foo.example.com', dns.A)
resolver.query(firstQuery)
self.assertEqual(len(queries), 1)
# A query for a different name is also passed to the underlying
# protocol.
secondQuery = dns.Query('bar.example.com', dns.A)
resolver.query(secondQuery)
self.assertEqual(len(queries), 2)
# A query for a different type is also passed to the underlying
# protocol.
thirdQuery = dns.Query('foo.example.com', dns.A6)
resolver.query(thirdQuery)
self.assertEqual(len(queries), 3)
def test_multipleSequentialRequests(self):
"""
After a response is received to a query issued with
L{client.Resolver.query}, another query with the same parameters
results in a new network request.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
resolver.protocol = StubDNSDatagramProtocol()
queries = resolver.protocol.queries
query = dns.Query('foo.example.com', dns.A)
# The first query should be passed to the underlying protocol.
resolver.query(query)
self.assertEqual(len(queries), 1)
# Deliver the response.
queries.pop()[-1].callback(dns.Message())
# Repeating the first query should touch the protocol again.
resolver.query(query)
self.assertEqual(len(queries), 1)
def test_multipleConcurrentFailure(self):
"""
If the result of a request is an error response, the Deferreds for all
concurrently issued requests associated with that result fire with the
L{Failure}.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
resolver.protocol = StubDNSDatagramProtocol()
queries = resolver.protocol.queries
query = dns.Query('foo.example.com', dns.A)
firstResult = resolver.query(query)
secondResult = resolver.query(query)
class ExpectedException(Exception):
pass
queries.pop()[-1].errback(failure.Failure(ExpectedException()))
return defer.gatherResults([
self.assertFailure(firstResult, ExpectedException),
self.assertFailure(secondResult, ExpectedException)])
def test_connectedProtocol(self):
"""
L{client.Resolver._connectedProtocol} returns a new
L{DNSDatagramProtocol} connected to a new address with a
cryptographically secure random port number.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
firstProto = resolver._connectedProtocol()
secondProto = resolver._connectedProtocol()
self.assertNotIdentical(firstProto.transport, None)
self.assertNotIdentical(secondProto.transport, None)
self.assertNotEqual(
firstProto.transport.getHost().port,
secondProto.transport.getHost().port)
return defer.gatherResults([
defer.maybeDeferred(firstProto.transport.stopListening),
defer.maybeDeferred(secondProto.transport.stopListening)])
def test_differentProtocol(self):
"""
L{client.Resolver._connectedProtocol} is called once each time a UDP
request needs to be issued and the resulting protocol instance is used
for that request.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
protocols = []
class FakeProtocol(object):
def __init__(self):
self.transport = StubPort()
def query(self, address, query, timeout=10, id=None):
protocols.append(self)
return defer.succeed(dns.Message())
resolver._connectedProtocol = FakeProtocol
resolver.query(dns.Query('foo.example.com'))
resolver.query(dns.Query('bar.example.com'))
self.assertEqual(len(set(protocols)), 2)
def test_disallowedPort(self):
"""
If a port number is initially selected which cannot be bound, the
L{CannotListenError} is handled and another port number is attempted.
"""
ports = []
class FakeReactor(object):
def listenUDP(self, port, *args):
ports.append(port)
if len(ports) == 1:
raise error.CannotListenError(None, port, None)
resolver = client.Resolver(servers=[('example.com', 53)])
resolver._reactor = FakeReactor()
proto = resolver._connectedProtocol()
self.assertEqual(len(set(ports)), 2)
def test_differentProtocolAfterTimeout(self):
"""
When a query issued by L{client.Resolver.query} times out, the retry
uses a new protocol instance.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
protocols = []
results = [defer.fail(failure.Failure(DNSQueryTimeoutError(None))),
defer.succeed(dns.Message())]
class FakeProtocol(object):
def __init__(self):
self.transport = StubPort()
def query(self, address, query, timeout=10, id=None):
protocols.append(self)
return results.pop(0)
resolver._connectedProtocol = FakeProtocol
resolver.query(dns.Query('foo.example.com'))
self.assertEqual(len(set(protocols)), 2)
def test_protocolShutDown(self):
"""
After the L{Deferred} returned by L{DNSDatagramProtocol.query} is
called back, the L{DNSDatagramProtocol} is disconnected from its
transport.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
protocols = []
result = defer.Deferred()
class FakeProtocol(object):
def __init__(self):
self.transport = StubPort()
def query(self, address, query, timeout=10, id=None):
protocols.append(self)
return result
resolver._connectedProtocol = FakeProtocol
resolver.query(dns.Query('foo.example.com'))
self.assertFalse(protocols[0].transport.disconnected)
result.callback(dns.Message())
self.assertTrue(protocols[0].transport.disconnected)
def test_protocolShutDownAfterTimeout(self):
"""
The L{DNSDatagramProtocol} created when an interim timeout occurs is
also disconnected from its transport after the Deferred returned by its
query method completes.
"""
resolver = client.Resolver(servers=[('example.com', 53)])
protocols = []
result = defer.Deferred()
results = [defer.fail(failure.Failure(DNSQueryTimeoutError(None))),
result]
class FakeProtocol(object):
def __init__(self):
self.transport = StubPort()
def query(self, address, query, timeout=10, id=None):
protocols.append(self)
return results.pop(0)
resolver._connectedProtocol = FakeProtocol
resolver.query(dns.Query('foo.example.com'))
self.assertFalse(protocols[1].transport.disconnected)
result.callback(dns.Message())
self.assertTrue(protocols[1].transport.disconnected)
def test_protocolShutDownAfterFailure(self):
"""
If the L{Deferred} returned by L{DNSDatagramProtocol.query} fires with
a failure, the L{DNSDatagramProtocol} is still disconnected from its
transport.
"""
class ExpectedException(Exception):
pass
resolver = client.Resolver(servers=[('example.com', 53)])
protocols = []
result = defer.Deferred()
class FakeProtocol(object):
def __init__(self):
self.transport = StubPort()
def query(self, address, query, timeout=10, id=None):
protocols.append(self)
return result
resolver._connectedProtocol = FakeProtocol
queryResult = resolver.query(dns.Query('foo.example.com'))
self.assertFalse(protocols[0].transport.disconnected)
result.errback(failure.Failure(ExpectedException()))
self.assertTrue(protocols[0].transport.disconnected)
return self.assertFailure(queryResult, ExpectedException)
class ClientTestCase(unittest.TestCase):
def setUp(self):
"""
Replace the resolver with a FakeResolver
"""
client.theResolver = FakeResolver()
self.hostname = 'example.com'
self.ghbntest = 'getHostByNameTest'
def tearDown(self):
"""
By setting the resolver to None, it will be recreated next time a name
lookup is done.
"""
client.theResolver = None
def checkResult(self, (results, authority, additional), qtype):
"""
Verify that the result is the same query type as what is expected.
"""
result = results[0]
self.assertEqual(str(result.name), self.hostname)
self.assertEqual(result.type, qtype)
def checkGetHostByName(self, result):
"""
Test that the getHostByName query returns the 127.0.0.1 address.
"""
self.assertEqual(result, '127.0.0.1')
def test_getHostByName(self):
"""
do a getHostByName of a value that should return 127.0.0.1.
"""
d = client.getHostByName(self.ghbntest)
d.addCallback(self.checkGetHostByName)
return d
def test_lookupAddress(self):
"""
Do a lookup and test that the resolver will issue the correct type of
query type. We do this by checking that FakeResolver returns a result
record with the same query type as what we issued.
"""
d = client.lookupAddress(self.hostname)
d.addCallback(self.checkResult, dns.A)
return d
def test_lookupIPV6Address(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupIPV6Address(self.hostname)
d.addCallback(self.checkResult, dns.AAAA)
return d
def test_lookupAddress6(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupAddress6(self.hostname)
d.addCallback(self.checkResult, dns.A6)
return d
def test_lookupNameservers(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupNameservers(self.hostname)
d.addCallback(self.checkResult, dns.NS)
return d
def test_lookupCanonicalName(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupCanonicalName(self.hostname)
d.addCallback(self.checkResult, dns.CNAME)
return d
def test_lookupAuthority(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupAuthority(self.hostname)
d.addCallback(self.checkResult, dns.SOA)
return d
def test_lookupMailBox(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupMailBox(self.hostname)
d.addCallback(self.checkResult, dns.MB)
return d
def test_lookupMailGroup(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupMailGroup(self.hostname)
d.addCallback(self.checkResult, dns.MG)
return d
def test_lookupMailRename(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupMailRename(self.hostname)
d.addCallback(self.checkResult, dns.MR)
return d
def test_lookupNull(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupNull(self.hostname)
d.addCallback(self.checkResult, dns.NULL)
return d
def test_lookupWellKnownServices(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupWellKnownServices(self.hostname)
d.addCallback(self.checkResult, dns.WKS)
return d
def test_lookupPointer(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupPointer(self.hostname)
d.addCallback(self.checkResult, dns.PTR)
return d
def test_lookupHostInfo(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupHostInfo(self.hostname)
d.addCallback(self.checkResult, dns.HINFO)
return d
def test_lookupMailboxInfo(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupMailboxInfo(self.hostname)
d.addCallback(self.checkResult, dns.MINFO)
return d
def test_lookupMailExchange(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupMailExchange(self.hostname)
d.addCallback(self.checkResult, dns.MX)
return d
def test_lookupText(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupText(self.hostname)
d.addCallback(self.checkResult, dns.TXT)
return d
def test_lookupSenderPolicy(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupSenderPolicy(self.hostname)
d.addCallback(self.checkResult, dns.SPF)
return d
def test_lookupResponsibility(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupResponsibility(self.hostname)
d.addCallback(self.checkResult, dns.RP)
return d
def test_lookupAFSDatabase(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupAFSDatabase(self.hostname)
d.addCallback(self.checkResult, dns.AFSDB)
return d
def test_lookupService(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupService(self.hostname)
d.addCallback(self.checkResult, dns.SRV)
return d
def test_lookupZone(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupZone(self.hostname)
d.addCallback(self.checkResult, dns.AXFR)
return d
def test_lookupAllRecords(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupAllRecords(self.hostname)
d.addCallback(self.checkResult, dns.ALL_RECORDS)
return d
def test_lookupNamingAuthorityPointer(self):
"""
See L{test_lookupAddress}
"""
d = client.lookupNamingAuthorityPointer(self.hostname)
d.addCallback(self.checkResult, dns.NAPTR)
return d
class ThreadedResolverTests(unittest.TestCase):
"""
Tests for L{client.ThreadedResolver}.
"""
def test_deprecated(self):
"""
L{client.ThreadedResolver} is deprecated. Instantiating it emits a
deprecation warning pointing at the code that does the instantiation.
"""
client.ThreadedResolver()
warnings = self.flushWarnings(offendingFunctions=[self.test_deprecated])
self.assertEqual(
warnings[0]['message'],
"twisted.names.client.ThreadedResolver is deprecated since "
"Twisted 9.0, use twisted.internet.base.ThreadedResolver "
"instead.")
self.assertEqual(warnings[0]['category'], DeprecationWarning)
self.assertEqual(len(warnings), 1)
|