scenario.py 36.5 KB
Newer Older
1 2
from __future__ import absolute_import

3
import binascii
4
import calendar
5
import errno
6
import logging
7
import os
8
import posixpath
9
import random
10
import socket
11
import string
12
import struct
Marek Vavruša's avatar
Marek Vavruša committed
13
import time
14
from datetime import datetime
15 16 17

import dns.dnssec
import dns.message
18
import dns.name
19 20 21
import dns.rcode
import dns.rrset
import dns.tsigkeyring
Marek Vavruša's avatar
Marek Vavruša committed
22

23
import pydnstest.augwrap
24
import pydnstest.matchpart
25

26

27 28 29 30 31
def str2bool(v):
    """ Return conversion of JSON-ish string value to boolean. """
    return v.lower() in ('yes', 'true', 'on', '1')


32 33 34 35
# Global statistics
g_rtt = 0.0
g_nqueries = 0

36

37 38 39 40 41 42 43 44 45 46 47 48
def recvfrom_msg(stream, raw=False):
    """
    Receive DNS message from TCP/UDP socket.

    Returns:
        if raw == False: (DNS message object, peer address)
        if raw == True: (blob, peer address)
    """
    if stream.type & socket.SOCK_DGRAM:
        data, addr = stream.recvfrom(4096)
    elif stream.type & socket.SOCK_STREAM:
        data = stream.recv(2)
49
        if not data:
50 51 52 53 54 55
            return None, None
        msg_len = struct.unpack_from("!H", data)[0]
        data = b""
        received = 0
        while received < msg_len:
            next_chunk = stream.recv(4096)
56
            if not next_chunk:
57 58 59 60 61 62
                return None, None
            data += next_chunk
            received += len(next_chunk)
        addr = stream.getpeername()[0]
    else:
        raise NotImplementedError("[recvfrom_msg]: unknown socket type '%i'" % stream.type)
63 64 65 66 67
    if raw:
        return data, addr
    else:
        msg = dns.message.from_wire(data, one_rr_per_rrset=True)
        return msg, addr
68 69 70 71 72 73 74 75 76 77 78 79 80 81


def sendto_msg(stream, message, addr=None):
    """ Send DNS/UDP/TCP message. """
    try:
        if stream.type & socket.SOCK_DGRAM:
            if addr is None:
                stream.send(message)
            else:
                stream.sendto(message, addr)
        elif stream.type & socket.SOCK_STREAM:
            data = struct.pack("!H", len(message)) + message
            stream.send(data)
        else:
82 83 84 85
            raise NotImplementedError("[sendto_msg]: unknown socket type '%i'" % stream.type)
    except socket.error as ex:
        if ex.errno != errno.ECONNREFUSED:  # TODO Investigate how this can happen
            raise
86 87


88
def replay_rrs(rrs, nqueries, destination, args=None):
89
    """ Replay list of queries and report statistics. """
90 91
    if args is None:
        args = []
92 93
    navail, queries = len(rrs), []
    chunksize = 16
94
    for i in range(nqueries if 'RAND' in args else navail):
95
        rr = rrs[i % navail]
96 97
        name = rr.name
        if 'RAND' in args:
98
            prefix = ''.join([random.choice(string.ascii_letters + string.digits)
99
                              for _ in range(8)])
100 101 102 103
            name = prefix + '.' + rr.name.to_text()
        msg = dns.message.make_query(name, rr.rdtype, rr.rdclass)
        if 'DO' in args:
            msg.want_dnssec(True)
104 105 106 107 108 109 110 111 112 113 114 115 116
        queries.append(msg.to_wire())
    # Make a UDP connected socket to the destination
    family = socket.AF_INET6 if ':' in destination[0] else socket.AF_INET
    sock = socket.socket(family, socket.SOCK_DGRAM)
    sock.connect(destination)
    sock.setblocking(False)
    # Play the query set
    # @NOTE: this is only good for relative low-speed replay
    rcvbuf = bytearray('\x00' * 512)
    nsent, nrcvd, nwait, navail = 0, 0, 0, len(queries)
    fdset = [sock]
    import select
    while nsent - nwait < nqueries:
117
        to_read, to_write, _ = select.select(fdset, fdset if nwait < chunksize else [], [], 0.5)
118
        if to_write:
119 120 121 122 123
            try:
                while nsent < nqueries and nwait < chunksize:
                    sock.send(queries[nsent % navail])
                    nwait += 1
                    nsent += 1
124
            except socket.error:
125
                pass  # EINVAL
126
        if to_read:
127 128 129 130 131
            try:
                while nwait > 0:
                    sock.recv_into(rcvbuf)
                    nwait -= 1
                    nrcvd += 1
132
            except socket.error:
133
                pass
134
        if not to_write and not to_read:
135
            nwait = 0  # Timeout, started dropping packets
136
            break
137 138
    return nsent, nrcvd

139

Marek Vavruša's avatar
Marek Vavruša committed
140 141
class Entry:
    """
142 143
    Data entry represents scripted message and extra metadata,
    notably match criteria and reply adjustments.
Marek Vavruša's avatar
Marek Vavruša committed
144 145 146 147 148 149 150
    """

    # Globals
    default_ttl = 3600
    default_cls = 'IN'
    default_rc = 'NOERROR'

151
    def __init__(self, node):
Marek Vavruša's avatar
Marek Vavruša committed
152
        """ Initialize data entry. """
153
        self.node = node
Marek Vavruša's avatar
Marek Vavruša committed
154 155
        self.origin = '.'
        self.message = dns.message.Message()
156 157
        self.message.use_edns(edns=0, payload=4096)
        self.fired = 0
Marek Vavruša's avatar
Marek Vavruša committed
158

159
        # RAW
160 161
        self.raw_data = None
        self.is_raw_data_entry = self.process_raw()
162

163
        # MATCH
164
        self.match_fields = self.process_match()
165

166
        # FLAGS
167
        self.process_reply_line()
168

169
        # ADJUST
170
        self.adjust_fields = {m.value for m in node.match("/adjust")}
171

172
        # MANDATORY
173
        try:
174
            self.mandatory = list(node.match("/mandatory"))[0]
175
        except (KeyError, IndexError):
176
            self.mandatory = None
177

178
        # TSIG
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
        self.process_tsig()

        # SECTIONS & RECORDS
        self.sections = self.process_sections()

    def process_raw(self):
        try:
            self.raw_data = binascii.unhexlify(self.node["/raw"].value)
            return True
        except KeyError:
            return False

    def process_match(self):
        try:
            self.node["/match_present"]
        except KeyError:
            return None

        fields = set(m.value for m in self.node.match("/match"))

        if 'all' in fields:
            fields.remove("all")
            fields |= set(["opcode", "qtype", "qname", "flags",
                           "rcode", "answer", "authority", "additional"])

        if 'question' in fields:
            fields.remove("question")
            fields |= set(["qtype", "qname"])

        return fields

    def process_reply_line(self):
        """Extracts flags, rcode and opcode from given node and adjust dns message accordingly"""
        self.fields = [f.value for f in self.node.match("/reply")]
        if 'DO' in self.fields:
            self.message.want_dnssec(True)
        opcode = self.get_opcode(fields=self.fields)
        rcode = self.get_rcode(fields=self.fields)
        self.message.flags = self.get_flags(fields=self.fields)
        if rcode is not None:
            self.message.set_rcode(rcode)
        if opcode is not None:
            self.message.set_opcode(opcode)

    def process_tsig(self):
224
        try:
225
            tsig = list(self.node.match("/tsig"))[0]
226 227 228 229 230 231 232
            tsig_keyname = tsig["/keyname"].value
            tsig_secret = tsig["/secret"].value
            keyring = dns.tsigkeyring.from_text({tsig_keyname: tsig_secret})
            self.message.use_tsig(keyring=keyring, keyname=tsig_keyname)
        except (KeyError, IndexError):
            pass

233 234 235
    def process_sections(self):
        sections = set()
        for section in self.node.match("/section/*"):
236
            section_name = posixpath.basename(section.path)
237
            sections.add(section_name)
238 239 240
            for record in section.match("/record"):
                owner = record['/domain'].value
                if not owner.endswith("."):
241
                    owner += self.origin
242 243 244 245 246 247 248
                try:
                    ttl = dns.ttl.from_text(record['/ttl'].value)
                except KeyError:
                    ttl = self.default_ttl
                try:
                    rdclass = dns.rdataclass.from_text(record['/class'].value)
                except KeyError:
249
                    rdclass = dns.rdataclass.from_text(self.default_cls)
250 251 252 253
                rdtype = dns.rdatatype.from_text(record['/type'].value)
                rr = dns.rrset.from_text(owner, ttl, rdclass, rdtype)
                if section_name != "question":
                    rd = record['/data'].value.split()
254
                    if rd:
255 256 257 258 259 260 261 262
                        if rdtype == dns.rdatatype.DS:
                            rd[1] = str(dns.dnssec.algorithm_from_text(rd[1]))
                        rd = dns.rdata.from_text(rr.rdclass, rr.rdtype, ' '.join(
                            rd), origin=dns.name.from_text(self.origin), relativize=False)
                    rr.add(rd)
                if section_name == 'question':
                    if rr.rdtype == dns.rdatatype.AXFR:
                        self.message.xfr = True
263
                    self.message.question.append(rr)
264
                elif section_name == 'answer':
265
                    self.message.answer.append(rr)
266
                elif section_name == 'authority':
267
                    self.message.authority.append(rr)
268
                elif section_name == 'additional':
269
                    self.message.additional.append(rr)
270
        return sections
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

    def __str__(self):
        txt = 'ENTRY_BEGIN\n'
        if not self.is_raw_data_entry:
            txt += 'MATCH {0}\n'.format(' '.join(self.match_fields))
        txt += 'ADJUST {0}\n'.format(' '.join(self.adjust_fields))
        txt += 'REPLY {rcode} {flags}\n'.format(
            rcode=dns.rcode.to_text(self.message.rcode()),
            flags=' '.join([dns.flags.to_text(self.message.flags),
                            dns.flags.edns_to_text(self.message.ednsflags)])
        )
        for sect_name in ['question', 'answer', 'authority', 'additional']:
            sect = getattr(self.message, sect_name)
            if not sect:
                continue
            txt += 'SECTION {n}\n'.format(n=sect_name.upper())
            for rr in sect:
                txt += str(rr)
                txt += '\n'
        if self.is_raw_data_entry:
            txt += 'RAW\n'
            if self.raw_data:
                txt += binascii.hexlify(self.raw_data)
            else:
                txt += 'NULL'
            txt += '\n'
        txt += 'ENTRY_END\n'
        return txt

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
    @classmethod
    def get_flags(cls, fields):
        """From `fields` extracts and returns flags"""
        flags = []
        for code in fields:
            try:
                dns.flags.from_text(code)  # throws KeyError on failure
                flags.append(code)
            except KeyError:
                pass
        return dns.flags.from_text(' '.join(flags))

    @classmethod
    def get_rcode(cls, fields):
        """
        From `fields` extracts and returns rcode.
        Throws `ValueError` if there are more then one rcodes
        """
        rcodes = []
        for code in fields:
            try:
                rcodes.append(dns.rcode.from_text(code))
            except dns.rcode.UnknownRcode:
                pass
        if len(rcodes) > 1:
            raise ValueError("Parse failed, too many rcode values.", rcodes)
326
        if not rcodes:
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
            return None
        return rcodes[0]

    @classmethod
    def get_opcode(cls, fields):
        """
        From `fields` extracts and returns opcode.
        Throws `ValueError` if there are more then one opcodes
        """
        opcodes = []
        for code in fields:
            try:
                opcodes.append(dns.opcode.from_text(code))
            except dns.opcode.UnknownOpcode:
                pass
        if len(opcodes) > 1:
            raise ValueError("Parse failed, too many opcode values.")
344
        if not opcodes:
345 346 347
            return None
        return opcodes[0]

Marek Vavruša's avatar
Marek Vavruša committed
348 349
    def match(self, msg):
        """ Compare scripted reply to given message based on match criteria. """
350
        for code in self.match_fields:
Marek Vavruša's avatar
Marek Vavruša committed
351
            try:
352 353
                pydnstest.matchpart.match_part(self.message, msg, code)
            except pydnstest.matchpart.DataMismatch as ex:
354
                errstr = '%s in the response:\n%s' % (str(ex), msg.to_text())
355 356
                # TODO: cisla radku
                raise ValueError("%s, \"%s\": %s" % (self.node.span, code, errstr))
Marek Vavruša's avatar
Marek Vavruša committed
357 358

    def cmp_raw(self, raw_value):
359
        assert self.is_raw_data_entry
Marek Vavruša's avatar
Marek Vavruša committed
360 361 362 363 364 365 366
        expected = None
        if self.raw_data is not None:
            expected = binascii.hexlify(self.raw_data)
        got = None
        if raw_value is not None:
            got = binascii.hexlify(raw_value)
        if expected != got:
367
            raise ValueError("raw message comparsion failed: expected %s got %s" % (expected, got))
Marek Vavruša's avatar
Marek Vavruša committed
368

369
    def _adjust_reply(self, query):
Marek Vavruša's avatar
Marek Vavruša committed
370
        """ Copy scripted reply and adjust to received query. """
371 372 373
        answer = dns.message.from_wire(self.message.to_wire(),
                                       xfr=self.message.xfr,
                                       one_rr_per_rrset=True)
Petr Špaček's avatar
Petr Špaček committed
374
        answer.use_edns(query.edns, query.ednsflags, options=self.message.options)
Marek Vavruša's avatar
Marek Vavruša committed
375 376
        if 'copy_id' in self.adjust_fields:
            answer.id = query.id
377
            # Copy letter-case if the template has QD
378
            if answer.question:
379
                answer.question[0].name = query.question[0].name
Marek Vavruša's avatar
Marek Vavruša committed
380 381
        if 'copy_query' in self.adjust_fields:
            answer.question = query.question
382 383
        # Re-set, as the EDNS might have reset the ext-rcode
        answer.set_rcode(self.message.rcode())
384 385 386 387 388

        # sanity check: adjusted answer should be almost the same
        assert len(answer.answer) == len(self.message.answer)
        assert len(answer.authority) == len(self.message.authority)
        assert len(answer.additional) == len(self.message.additional)
Marek Vavruša's avatar
Marek Vavruša committed
389 390
        return answer

391 392 393 394 395 396 397 398
    def _adjust_raw_reply(self, query):
        if 'raw_id' in self.adjust_fields:
            assert len(self.raw_data) >= 2, "RAW message has to contain at least 2 bytes"
            raw_answer = bytearray(self.raw_data)
            struct.pack_into('!H', raw_answer, 0, query.id)
            return bytes(raw_answer)
        return self.raw_data

399 400
    def reply(self, query):
        if self.is_raw_data_entry:
401
            return self._adjust_raw_reply(query), True
402 403
        return self._adjust_reply(query), False

404 405 406 407
    def set_edns(self, fields):
        """ Set EDNS version and bufsize. """
        version = 0
        bufsize = 4096
408
        if fields and fields[0].isdigit():
409
            version = int(fields.pop(0))
410
        if fields and fields[0].isdigit():
411
            bufsize = int(fields.pop(0))
412 413 414
        if bufsize == 0:
            self.message.use_edns(False)
            return
415 416
        opts = []
        for v in fields:
Marek Vavrusa's avatar
Marek Vavrusa committed
417
            k, v = tuple(v.split('=')) if '=' in v else (v, True)
418
            if k.lower() == 'nsid':
419
                opts.append(dns.edns.GenericOption(dns.edns.NSID, '' if v is True else v))
420 421 422
            if k.lower() == 'subnet':
                net = v.split('/')
                subnet_addr = net[0]
423 424
                family = socket.AF_INET6 if ':' in subnet_addr else socket.AF_INET
                addr = socket.inet_pton(family, subnet_addr)
425 426 427
                prefix = len(addr) * 8
                if len(net) > 1:
                    prefix = int(net[1])
428 429
                addr = addr[0: (prefix + 7) / 8]
                if prefix % 8 != 0:  # Mask the last byte
430
                    addr = addr[:-1] + chr(ord(addr[-1]) & 0xFF << (8 - prefix % 8))
431 432 433
                opts.append(dns.edns.GenericOption(8, struct.pack(
                    "!HBB", 1 if family == socket.AF_INET else 2, prefix, 0) + addr))
        self.message.use_edns(edns=version, payload=bufsize, options=opts)
434

435

Marek Vavruša's avatar
Marek Vavruša committed
436 437 438 439
class Range:
    """
    Range represents a set of scripted queries valid for given step range.
    """
440
    log = logging.getLogger('pydnstest.scenario.Range')
Marek Vavruša's avatar
Marek Vavruša committed
441

442
    def __init__(self, node):
Marek Vavruša's avatar
Marek Vavruša committed
443
        """ Initialize reply range. """
444
        self.node = node
445 446
        self.a = int(node['/from'].value)
        self.b = int(node['/to'].value)
447
        assert self.a <= self.b
448 449 450 451 452

        address = node["/address"].value
        self.addresses = {address} if address is not None else set()
        self.addresses |= set([a.value for a in node.match("/address/*")])
        self.stored = [Entry(n) for n in node.match("/entry")]
453 454 455 456 457
        self.args = {}
        self.received = 0
        self.sent = 0

    def __del__(self):
458 459
        self.log.info('[ RANGE %d-%d ] %s received: %d sent: %d',
                      self.a, self.b, self.addresses, self.received, self.sent)
Marek Vavruša's avatar
Marek Vavruša committed
460

461 462 463 464 465 466 467 468 469 470
    def __str__(self):
        txt = '\nRANGE_BEGIN {a} {b}\n'.format(a=self.a, b=self.b)
        for addr in self.addresses:
            txt += '        ADDRESS {0}\n'.format(addr)

        for entry in self.stored:
            txt += '\n'
            txt += str(entry)
        txt += 'RANGE_END\n\n'
        return txt
Marek Vavruša's avatar
Marek Vavruša committed
471

472
    def eligible(self, ident, address):
Marek Vavruša's avatar
Marek Vavruša committed
473
        """ Return true if this range is eligible for fetching reply. """
474
        if self.a <= ident <= self.b:
475
            return (None is address
476 477
                    or set() == self.addresses
                    or address in self.addresses)
Marek Vavruša's avatar
Marek Vavruša committed
478 479 480
        return False

    def reply(self, query):
481 482 483
        """
        Get answer for given query (adjusted if needed).

484 485 486 487
        Returns: (answer, is_raw_data)
            answer: DNS message object or wire-format (bytes) or None if there is no
                candidate in this range
            is_raw_data: True if response is wire-format bytes, instead of DNS message object
488
        """
489
        self.received += 1
Marek Vavruša's avatar
Marek Vavruša committed
490 491 492
        for candidate in self.stored:
            try:
                candidate.match(query)
493
                resp = candidate.reply(query)
494 495 496
                # Probabilistic loss
                if 'LOSS' in self.args:
                    if random.random() < float(self.args['LOSS']):
497
                        return None, None
498
                self.sent += 1
499
                candidate.fired += 1
500
                return resp
501
            except ValueError:
Marek Vavruša's avatar
Marek Vavruša committed
502
                pass
503
        return None, None
Marek Vavruša's avatar
Marek Vavruša committed
504 505


506
class StepLogger(logging.LoggerAdapter):  # pylint: disable=too-few-public-methods
507 508 509 510 511 512 513
    """
    Prepent Step identification before each log message.
    """
    def process(self, msg, kwargs):
        return '[STEP %s %s] %s' % (self.extra['id'], self.extra['type'], msg), kwargs


Marek Vavruša's avatar
Marek Vavruša committed
514 515 516 517 518
class Step:
    """
    Step represents one scripted action in a given moment,
    each step has an order identifier, type and optionally data entry.
    """
519
    require_data = ['QUERY', 'CHECK_ANSWER', 'REPLY']
Marek Vavruša's avatar
Marek Vavruša committed
520

521
    def __init__(self, node):
Marek Vavruša's avatar
Marek Vavruša committed
522
        """ Initialize single scenario step. """
523
        self.node = node
524 525
        self.id = int(node.value)
        self.type = node["/type"].value
526
        self.log = StepLogger(logging.getLogger('pydnstest.scenario.Step'),
527
                              {'id': self.id, 'type': self.type})
528 529 530 531 532
        try:
            self.delay = int(node["/timestamp"].value)
        except KeyError:
            pass
        self.data = [Entry(n) for n in node.match("/entry")]
533
        self.queries = []
534
        self.has_data = self.type in Step.require_data
Marek Vavruša's avatar
Marek Vavruša committed
535 536
        self.answer = None
        self.raw_answer = None
537 538 539
        self.repeat_if_fail = 0
        self.pause_if_fail = 0
        self.next_if_fail = -1
Petr Špaček's avatar
Petr Špaček committed
540

541
        # TODO Parser currently can't parse CHECK_ANSWER args, player doesn't understand them anyway
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
        # if type == 'CHECK_ANSWER':
        #     for arg in extra_args:
        #         param = arg.split('=')
        #         try:
        #             if param[0] == 'REPEAT':
        #                 self.repeat_if_fail = int(param[1])
        #             elif param[0] == 'PAUSE':
        #                 self.pause_if_fail = float(param[1])
        #             elif param[0] == 'NEXT':
        #                 self.next_if_fail = int(param[1])
        #         except Exception as e:
        #             raise Exception('step %d - wrong %s arg: %s' % (self.id, param[0], str(e)))

    def __str__(self):
        txt = '\nSTEP {i} {t}'.format(i=self.id, t=self.type)
        if self.repeat_if_fail:
            txt += ' REPEAT {v}'.format(v=self.repeat_if_fail)
        elif self.pause_if_fail:
            txt += ' PAUSE {v}'.format(v=self.pause_if_fail)
        elif self.next_if_fail != -1:
            txt += ' NEXT {v}'.format(v=self.next_if_fail)
        # if self.args:
        #     txt += ' '
        #     txt += ' '.join(self.args)
        txt += '\n'

        for data in self.data:
            # from IPython.core.debugger import Tracer
            # Tracer()()
            txt += str(data)
        return txt
Marek Vavruša's avatar
Marek Vavruša committed
573

574
    def play(self, ctx):
Marek Vavruša's avatar
Marek Vavruša committed
575 576
        """ Play one step from a scenario. """
        if self.type == 'QUERY':
577 578
            self.log.info('')
            self.log.debug(self.data[0].message.to_text())
579 580
            # Parse QUERY-specific parameters
            choice, tcp, source = None, False, None
581
            return self.__query(ctx, tcp=tcp, choice=choice, source=source)
582
        elif self.type == 'CHECK_OUT_QUERY':  # ignore
583
            self.log.info('')
584
            return None
585
        elif self.type == 'CHECK_ANSWER' or self.type == 'ANSWER':
586
            self.log.info('')
Marek Vavruša's avatar
Marek Vavruša committed
587
            return self.__check_answer(ctx)
588
        elif self.type == 'TIME_PASSES ELAPSE':
589
            self.log.info('')
590
            return self.__time_passes()
591
        elif self.type == 'REPLY' or self.type == 'MOCK':
592
            self.log.info('')
593
            return None
594 595 596 597 598 599 600 601 602 603
        # Parser currently doesn't support step types LOG, REPLAY and ASSERT.
        # No test uses them.
        # elif self.type == 'LOG':
        #     if not ctx.log:
        #         raise Exception('scenario has no log interface')
        #     return ctx.log.match(self.args)
        # elif self.type == 'REPLAY':
        #     self.__replay(ctx)
        # elif self.type == 'ASSERT':
        #     self.__assert(ctx)
Marek Vavruša's avatar
Marek Vavruša committed
604
        else:
605
            raise NotImplementedError('step %03d type %s unsupported' % (self.id, self.type))
606

Marek Vavruša's avatar
Marek Vavruša committed
607 608
    def __check_answer(self, ctx):
        """ Compare answer from previously resolved query. """
609
        if not self.data:
610
            raise ValueError("response definition required")
Marek Vavruša's avatar
Marek Vavruša committed
611 612
        expected = self.data[0]
        if expected.is_raw_data_entry is True:
613
            self.log.debug("raw answer: %s", ctx.last_raw_answer.to_text())
Marek Vavruša's avatar
Marek Vavruša committed
614 615 616
            expected.cmp_raw(ctx.last_raw_answer)
        else:
            if ctx.last_answer is None:
617
                raise ValueError("no answer from preceding query")
618
            self.log.debug("answer: %s", ctx.last_answer.to_text())
Marek Vavruša's avatar
Marek Vavruša committed
619 620
            expected.match(ctx.last_answer)

621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
    # def __replay(self, ctx, chunksize=8):
    #     nqueries = len(self.queries)
    #     if len(self.args) > 0 and self.args[0].isdigit():
    #         nqueries = int(self.args.pop(0))
    #     destination = ctx.client[ctx.client.keys()[0]]
    #     self.log.info('replaying %d queries to %s@%d (%s)',
    #                   nqueries, destination[0], destination[1], ' '.join(self.args))
    #     if 'INTENSIFY' in os.environ:
    #         nqueries *= int(os.environ['INTENSIFY'])
    #     tstart = datetime.now()
    #     nsent, nrcvd = replay_rrs(self.queries, nqueries, destination, self.args)
    #     # Keep/print the statistics
    #     rtt = (datetime.now() - tstart).total_seconds() * 1000
    #     pps = 1000 * nrcvd / rtt
    #     self.log.debug('sent: %d, received: %d (%d ms, %d p/s)', nsent, nrcvd, rtt, pps)
    #     tag = None
    #     for arg in self.args:
    #         if arg.upper().startswith('PRINT'):
    #             _, tag = tuple(arg.split('=')) if '=' in arg else (None, 'replay')
    #     if tag:
    #         self.log.info('[ REPLAY ] test: %s pps: %5d time: %4d sent: %5d received: %5d',
    #                       tag.ljust(11), pps, rtt, nsent, nrcvd)
643

644
    def __query(self, ctx, tcp=False, choice=None, source=None):
645 646 647 648 649
        """
        Send query and wait for an answer (if the query is not RAW).

        The received answer is stored in self.answer and ctx.last_answer.
        """
650
        if not self.data:
651
            raise ValueError("query definition required")
Marek Vavruša's avatar
Marek Vavruša committed
652 653 654 655 656
        if self.data[0].is_raw_data_entry is True:
            data_to_wire = self.data[0].raw_data
        else:
            # Don't use a message copy as the EDNS data portion is not copied.
            data_to_wire = self.data[0].message.to_wire()
657
        if choice is None or not choice:
658
            choice = list(ctx.client.keys())[0]
659
        if choice not in ctx.client:
660
            raise ValueError('step %03d invalid QUERY target: %s' % (self.id, choice))
661 662 663
        # Create socket to test subject
        sock = None
        destination = ctx.client[choice]
664
        family = socket.AF_INET6 if ':' in destination[0] else socket.AF_INET
665 666
        sock = socket.socket(family, socket.SOCK_STREAM if tcp else socket.SOCK_DGRAM)
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
667
        if tcp:
668 669 670
            sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, True)
        sock.settimeout(3)
        if source:
671
            sock.bind((source, 0))
672
        sock.connect(destination)
673
        # Send query to client and wait for response
674
        tstart = datetime.now()
Marek Vavruša's avatar
Marek Vavruša committed
675 676
        while True:
            try:
677
                sendto_msg(sock, data_to_wire)
Marek Vavruša's avatar
Marek Vavruša committed
678
                break
679
            except OSError as ex:
Marek Vavruša's avatar
Marek Vavruša committed
680
                # ENOBUFS, throttle sending
681
                if ex.errno == errno.ENOBUFS:
Marek Vavruša's avatar
Marek Vavruša committed
682 683 684 685
                    time.sleep(0.1)
        # Wait for a response for a reasonable time
        answer = None
        if not self.data[0].is_raw_data_entry:
686 687
            while True:
                try:
688
                    answer, _ = recvfrom_msg(sock, True)
689
                    break
690 691
                except OSError as ex:
                    if ex.errno == errno.ENOBUFS:
692
                        time.sleep(0.1)
693 694 695 696 697
        # Track RTT
        rtt = (datetime.now() - tstart).total_seconds() * 1000
        global g_rtt, g_nqueries
        g_nqueries += 1
        g_rtt += rtt
Marek Vavruša's avatar
Marek Vavruša committed
698 699 700 701
        # Remember last answer for checking later
        self.raw_answer = answer
        ctx.last_raw_answer = answer
        if self.raw_answer is not None:
Petr Špaček's avatar
Petr Špaček committed
702
            self.answer = dns.message.from_wire(self.raw_answer, one_rr_per_rrset=True)
Marek Vavruša's avatar
Marek Vavruša committed
703 704 705 706
        else:
            self.answer = None
        ctx.last_answer = self.answer

707
    def __time_passes(self):
Marek Vavruša's avatar
Marek Vavruša committed
708
        """ Modify system time. """
709 710 711 712
        file_old = os.environ["FAKETIME_TIMESTAMP_FILE"]
        file_next = os.environ["FAKETIME_TIMESTAMP_FILE"] + ".next"
        with open(file_old, 'r') as time_file:
            line = time_file.readline().strip()
713
        t = time.mktime(datetime.strptime(line, '@%Y-%m-%d %H:%M:%S').timetuple())
714
        t += self.delay
715 716 717 718
        with open(file_next, 'w') as time_file:
            time_file.write(datetime.fromtimestamp(t).strftime('@%Y-%m-%d %H:%M:%S') + "\n")
            time_file.flush()
        os.replace(file_next, file_old)
Marek Vavruša's avatar
Marek Vavruša committed
719

720 721 722 723 724 725 726 727 728 729 730 731 732
    # def __assert(self, ctx):
    #     """ Assert that a passed expression evaluates to True. """
    #     result = eval(' '.join(self.args), {'SCENARIO': ctx, 'RANGE': ctx.ranges})
    #     # Evaluate subexpressions for clarity
    #     subexpr = []
    #     for expr in self.args:
    #         try:
    #             ee = eval(expr, {'SCENARIO': ctx, 'RANGE': ctx.ranges})
    #             subexpr.append(str(ee))
    #         except:
    #             subexpr.append(expr)
    #     assert result is True, '"%s" assertion fails (%s)' % (
    #                            ' '.join(self.args), ' '.join(subexpr))
733

734

Marek Vavruša's avatar
Marek Vavruša committed
735
class Scenario:
736
    log = logging.getLogger('pydnstest.scenatio.Scenario')
737

738
    def __init__(self, node, filename):
Marek Vavruša's avatar
Marek Vavruša committed
739
        """ Initialize scenario with description. """
740
        self.node = node
741
        self.info = node.value
742
        self.file = filename
743
        self.ranges = [Range(n) for n in node.match("/range")]
744
        self.current_range = None
745
        self.steps = [Step(n) for n in node.match("/step")]
Marek Vavruša's avatar
Marek Vavruša committed
746
        self.current_step = None
747
        self.client = {}
Marek Vavruša's avatar
Marek Vavruša committed
748

749 750 751 752 753
    def __str__(self):
        txt = 'SCENARIO_BEGIN'
        if self.info:
            txt += ' {0}'.format(self.info)
        txt += '\n'
754 755
        for range_ in self.ranges:
            txt += str(range_)
756 757 758 759 760
        for step in self.steps:
            txt += str(step)
        txt += "\nSCENARIO_END"
        return txt

761
    def reply(self, query, address=None):
762 763 764 765 766 767 768
        """
        Generate answer packet for given query.

        The answer can be DNS message object or a binary blob.
        Returns:
            (answer, boolean "is the answer binary blob?")
        """
769
        current_step_id = self.current_step.id
Marek Vavruša's avatar
Marek Vavruša committed
770 771
        # Unknown address, select any match
        # TODO: workaround until the server supports stub zones
772 773 774 775
        all_addresses = set()
        for rng in self.ranges:
            all_addresses.update(rng.addresses)
        if address not in all_addresses:
Marek Vavruša's avatar
Marek Vavruša committed
776 777 778
            address = None
        # Find current valid query response range
        for rng in self.ranges:
779
            if rng.eligible(current_step_id, address):
780
                self.current_range = rng
781
                return rng.reply(query)
Marek Vavruša's avatar
Marek Vavruša committed
782 783
        # Find any prescripted one-shot replies
        for step in self.steps:
784
            if step.id < current_step_id or step.type != 'REPLY':
Marek Vavruša's avatar
Marek Vavruša committed
785 786 787
                continue
            try:
                candidate = step.data[0]
788 789 790
                candidate.match(query)
                step.data.remove(candidate)
                return candidate.reply(query)
791
            except (IndexError, ValueError):
Marek Vavruša's avatar
Marek Vavruša committed
792
                pass
793
        return None, True
Marek Vavruša's avatar
Marek Vavruša committed
794

795
    def play(self, paddr):
Marek Vavruša's avatar
Marek Vavruša committed
796
        """ Play given scenario. """
797 798
        # Store test subject => address mapping
        self.client = paddr
Marek Vavruša's avatar
Marek Vavruša committed
799

800 801 802 803 804 805 806
        step = None
        i = 0
        while i < len(self.steps):
            step = self.steps[i]
            self.current_step = step
            try:
                step.play(self)
807
            except ValueError as ex:
808
                if step.repeat_if_fail > 0:
809
                    self.log.info("[play] step %d: exception - '%s', retrying step %d (%d left)",
810
                                  step.id, ex, step.next_if_fail, step.repeat_if_fail)
811
                    step.repeat_if_fail -= 1
812
                    if step.pause_if_fail > 0:
813
                        time.sleep(step.pause_if_fail)
814
                    if step.next_if_fail != -1:
815 816
                        next_steps = [j for j in range(len(self.steps)) if self.steps[
                            j].id == step.next_if_fail]
817
                        if not next_steps:
818 819
                            raise ValueError('step %d: wrong NEXT value "%d"' %
                                             (step.id, step.next_if_fail))
820
                        next_step = next_steps[0]
821
                        if next_step < len(self.steps):
822 823
                            i = next_step
                        else:
824 825
                            raise ValueError('step %d: Can''t branch to NEXT value "%d"' %
                                             (step.id, step.next_if_fail))
826 827
                    continue
                else:
828 829
                    raise ValueError('%s step %d %s' % (self.file, step.id, str(ex)))
            i += 1
830

831 832
        for r in self.ranges:
            for e in r.stored:
833
                if e.mandatory and e.fired == 0:
834
                    # TODO: cisla radku
835
                    raise RuntimeError('Mandatory section at %s not fired' % e.mandatory.span)
836

837

838
def get_next(file_in, skip_empty=True):
839 840 841
    """ Return next token from the input stream. """
    while True:
        line = file_in.readline()
842
        if not line:
843
            return False
844
        quoted, escaped = False, False
845 846
        for i, char in enumerate(line):
            if char == '\\':
847
                escaped = not escaped
848
            if not escaped and char == '"':
849
                quoted = not quoted
850
            if char == ';' and not quoted:
851 852
                line = line[0:i]
                break
853
            if char != '\\':
854
                escaped = False
855
        tokens = ' '.join(line.strip().split()).split()
856
        if not tokens:
857 858 859 860
            if skip_empty:
                continue
            else:
                return '', []
861 862 863
        op = tokens.pop(0)
        return op, tokens

864

865
def parse_config(scn_cfg, qmin, installdir):  # FIXME: pylint: disable=too-many-statements
866 867
    """
    Transform scene config (key, value) pairs into dict filled with defaults.
868 869 870
    Returns tuple:
      context dict: {Jinja2 variable: value}
      trust anchor dict: {domain: [TA lines for particular domain]}
871 872 873 874 875 876
    """
    # defaults
    do_not_query_localhost = True
    harden_glue = True
    sockfamily = 0  # auto-select value for socket.getaddrinfo
    trust_anchor_list = []
877
    trust_anchor_files = {}
878
    negative_ta_list = []
879 880 881 882 883 884 885 886 887 888 889
    stub_addr = None
    override_timestamp = None

    features = {}
    feature_list_delimiter = ';'
    feature_pair_delimiter = '='

    for k, v in scn_cfg:
        # Enable selectively for some tests
        if k == 'do-not-query-localhost':
            do_not_query_localhost = str2bool(v)
890
        elif k == 'domain-insecure':
891
            negative_ta_list.append(v)
892
        elif k == 'harden-glue':
893
            harden_glue = str2bool(v)
894
        elif k == 'query-minimization':
895 896
            qmin = str2bool(v)
        elif k == 'trust-anchor':
897 898 899 900 901 902
            trust_anchor = v.strip('"\'')
            trust_anchor_list.append(trust_anchor)
            domain = dns.name.from_text(trust_anchor.split()[0]).canonicalize()
            if domain not in trust_anchor_files:
                trust_anchor_files[domain] = []
            trust_anchor_files[domain].append(trust_anchor)
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
        elif k == 'val-override-timestamp':
            override_timestamp_str = v.strip('"\'')
            override_timestamp = int(override_timestamp_str)
        elif k == 'val-override-date':
            override_date_str = v.strip('"\'')
            ovr_yr = override_date_str[0:4]
            ovr_mnt = override_date_str[4:6]
            ovr_day = override_date_str[6:8]
            ovr_hr = override_date_str[8:10]
            ovr_min = override_date_str[10:12]
            ovr_sec = override_date_str[12:]
            override_date_str_arg = '{0} {1} {2} {3} {4} {5}'.format(
                ovr_yr, ovr_mnt, ovr_day, ovr_hr, ovr_min, ovr_sec)
            override_date = time.strptime(override_date_str_arg, "%Y %m %d %H %M %S")
            override_timestamp = calendar.timegm(override_date)
        elif k == 'stub-addr':
            stub_addr = v.strip('"\'')
        elif k == 'features':
            feature_list = v.split(feature_list_delimiter)
            try:
                for f_item in feature_list:
                    if f_item.find(feature_pair_delimiter) != -1:
                        f_key, f_value = [x.strip()
                                          for x
                                          in f_item.split(feature_pair_delimiter, 1)]
                    else:
                        f_key = f_item.strip()
                        f_value = ""
                    features[f_key] = f_value
932 933
            except KeyError as ex:
                raise KeyError("can't parse features (%s) in config section (%s)" % (v, str(ex)))
934 935 936 937 938 939 940
        elif k == 'feature-list':
            try:
                f_key, f_value = [x.strip() for x in v.split(feature_pair_delimiter, 1)]
                if f_key not in features:
                    features[f_key] = []
                f_value = f_value.replace("{{INSTALL_DIR}}", installdir)
                features[f_key].append(f_value)
941 942 943
            except KeyError as ex:
                raise KeyError("can't parse feature-list (%s) in config section (%s)"
                               % (v, str(ex)))
944 945
        elif k == 'force-ipv6' and v.upper() == 'TRUE':
            sockfamily = socket.AF_INET6
946 947
        else:
            raise NotImplementedError('unsupported CONFIG key "%s"' % k)
948 949 950

    ctx = {
        "DO_NOT_QUERY_LOCALHOST": str(do_not_query_localhost).lower(),
951
        "NEGATIVE_TRUST_ANCHORS": negative_ta_list,
952 953 954 955 956
        "FEATURES": features,
        "HARDEN_GLUE": str(harden_glue).lower(),
        "INSTALL_DIR": installdir,
        "QMIN": str(qmin).lower(),
        "TRUST_ANCHORS": trust_anchor_list,
957
        "TRUST_ANCHOR_FILES": trust_anchor_files.keys()
958 959 960 961 962 963 964 965 966 967 968 969 970
    }
    if stub_addr:
        ctx['ROOT_ADDR'] = stub_addr
        # determine and verify socket family for specified root address
        gai = socket.getaddrinfo(stub_addr, 53, sockfamily, 0,
                                 socket.IPPROTO_UDP, socket.AI_NUMERICHOST)
        assert len(gai) == 1
        sockfamily = gai[0][0]
    if not sockfamily:
        sockfamily = socket.AF_INET  # default to IPv4
    ctx['_SOCKET_FAMILY'] = sockfamily
    if override_timestamp:
        ctx['_OVERRIDE_TIMESTAMP'] = override_timestamp
971
    return (ctx, trust_anchor_files)
972 973


974
def parse_file(path):
975
    """ Parse scenario from a file. """
976

977 978
    aug = pydnstest.augwrap.AugeasWrapper(
        confpath=path, lens='Deckard', loadpath=os.path.dirname(__file__))
979
    node = aug.tree
980 981 982
    config = []
    for line in [c.value for c in node.match("/config/*")]:
        if line:
983 984 985 986 987
            if not line.startswith(';'):
                if '#' in line:
                    line = line[0:line.index('#')]
                # Break to key-value pairs
                # e.g.: ['minimization', 'on']
988
                kv = [x.strip() for x in line.split(':', 1)]
989 990
                if len(kv) >= 2:
                    config.append(kv)
991 992
    scenario = Scenario(node["/scenario"], posixpath.basename(node.path))
    return scenario, config