#!/usr/bin/env python2
""" Tests for the DNS resolver and server """

# pylint: disable=too-many-public-methods, invalid-name

import copy
from random import randint
import socket
import sys
import time
import unittest

from dns.cache import RecordCache
from dns.classes import Class
from dns.message import Header, Message, Question
from dns.resolver import Resolver
from dns.resource import ResourceRecord, CNAMERecordData
from dns.types import Type


portnr = 5300
server = '127.0.0.1'


class TestResolver(unittest.TestCase):
    """Test cases for the resolver with caching disabled"""

    def setUp(self):
        self.resolv = Resolver(False, 0)

    def test_solve(self):
        """Test solving some FQDN"""
        host, aliases, addrs = self.resolv.gethostbyname('camilstaps.nl')
        self.assertEqual(host, 'camilstaps.nl')
        self.assertEqual(aliases, [])
        self.assertEqual(addrs, ['84.22.111.158'])

    def test_nonexistant(self):
        """Test solving a nonexistant FQDN"""
        host, aliases, addrs = self.resolv.gethostbyname('nothing.ru.nl')
        self.assertEqual(host, 'nothing.ru.nl')
        self.assertEqual(aliases, [])
        self.assertEqual(addrs, [])


class TestResolverCache(unittest.TestCase):
    """Test cases for the resolver with caching enabled"""

    TTL = 3

    def __init__(self, *pargs):
        self.resolv = None
        self.cache = None
        super(TestResolverCache, self).__init__(*pargs)

    def setup_resolver(self):
        """Setup a resolver with an invalid cache"""
        self.resolv = Resolver(True, self.TTL)
        self.cache = RecordCache(self.TTL)
        self.cache.add_record(ResourceRecord(
            'nothing.ru.nl', Type.CNAME, Class.IN, self.TTL,
            CNAMERecordData('camilstaps.nl')))
        self.resolv.cache = self.cache

    def test_solve_invalid(self):
        """Test solving an invalid cached FQDN"""
        self.setup_resolver()
        host, aliases, addrs = self.resolv.gethostbyname('nothing.ru.nl')
        self.assertEqual(host, 'camilstaps.nl')
        self.assertEqual(aliases, [])
        self.assertEqual(addrs, ['84.22.111.158'])

    def test_solve_invalid_after_expiration(self):
        """Test solving an invalid cached FQDN after TTL expiration"""
        self.setup_resolver()
        time.sleep(self.TTL + 1)
        host, aliases, addrs = self.resolv.gethostbyname('nothing.ru.nl')
        self.assertEqual(host, 'nothing.ru.nl')
        self.assertEqual(aliases, [])
        self.assertEqual(addrs, [])


class TestServer(unittest.TestCase):
    """Test cases for the server"""

    TIMEOUT = 5

    def setUp(self):
        self.resolv = Resolver(False, 0)

    def do_query(self, hostname, type_=Type.A, class_=Class.IN):
        """Send a query to the server"""
        ident = randint(0, 65535)
        header = Header(ident, 0, 1, 0, 0, 0)
        header.qr = 0
        header.opcode = 0
        header.rd = 1
        req = Message(header, [Question(hostname, type_, class_)])

        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        sock.settimeout(self.TIMEOUT)
        sock.sendto(req.to_bytes(), ('127.0.0.1', portnr))

        try:
            data = sock.recv(512)
            resp = Message.from_bytes(data)
            if resp.header.ident == ident:
                return resp.answers, resp.authorities, resp.additionals
        except socket.timeout:
            pass
        return [], [], []

    # pylint: disable=too-many-arguments
    def assert_match(self, rec, name=None, type_=None, class_=None, data=None):
        """Assert that a ResourceRecord matches some properties"""
        self.assertTrue(
            (name is None or rec.name == name) and
            (type_ is None or rec.type_ == type_) and
            (class_ is None or rec.class_ == class_) and
            (data is None or rec.rdata.data == data))

    def test_solve_auth(self):
        """Test solving a name for which we are authoritative"""
        answs, auths, adds = self.do_query('cloogle.org')
        self.assertEqual(answs, [])
        self.assert_match(
            auths[0], 'cloogle.org', Type.A, Class.IN, '84.22.111.158')
        self.assertEqual(adds, [])

    def test_solve_zone(self):
        """Test solving a name in our zone"""
        answs, auths, adds = self.do_query('sub.cloogle.org')
        self.assertEquals(answs + auths + adds, [])

    def test_solve_outside(self):
        """Test solving a name outside our zone"""
        for name in ['camilstaps.nl', 'cname.camilstaps.nl']:
            answs, auths, adds = self.do_query(name)
            _, aliases, addrs = self.resolv.gethostbyname(name)

            for record in answs + auths + adds:
                if record.type_ == Type.A:
                    self.assertIn(record.rdata.data, addrs)
                elif record.type_ == Type.CNAME:
                    self.assertIn(record.rdata.data, aliases)

    def test_concurrency(self):
        """Test the server's concurrent abilities

        Note: we can never be sure that the server handles these requests in
        parallel. What we do is (1) sending a request for a domain outside the
        zone, and (2) sending a request for inside the zone. We would expect
        the latter to be quicker.
        """
        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        sock.settimeout(self.TIMEOUT)

        header = Header(0, 0, 1, 0, 0, 0)
        header.qr = 0
        header.opcode = 0
        header.rd = 1

        header.ident = 1
        req1 = Message(header, [Question('camilstaps.nl', Type.A, Class.IN)])

        header = copy.copy(header)
        header.ident = 2
        req2 = Message(header, [Question('cloogle.org', Type.A, Class.IN)])

        sock.sendto(req1.to_bytes(), ('127.0.0.1', portnr))
        sock.sendto(req2.to_bytes(), ('127.0.0.1', portnr))

        try:
            # The second request
            data = sock.recv(512)
            resp = Message.from_bytes(data)
            self.assertEqual(resp.header.ident, 2)
            self.assert_match(
                resp.authorities[0],
                'cloogle.org', Type.A, Class.IN, '84.22.111.158')
            self.assertEqual(resp.answers + resp.additionals, [])

            # The first request
            data = sock.recv(512)
            resp = Message.from_bytes(data)
            self.assertEqual(resp.header.ident, 1)
            self.assert_match(
                resp.answers[0],
                'camilstaps.nl', Type.A, Class.IN, '84.22.111.158')
            self.assertEqual(resp.authorities + resp.additionals, [])
        except socket.timeout:
            self.fail('timeout')

if __name__ == "__main__":
    # Parse command line arguments
    import argparse
    parser = argparse.ArgumentParser(description="HTTP Tests")
    parser.add_argument("-s", "--server", type=str, default="localhost")
    parser.add_argument("-p", "--port", type=int, default=5300)
    args, extra = parser.parse_known_args()
    portnr = args.port
    server = args.server

    # Pass the extra arguments to unittest
    sys.argv[1:] = extra

    # Start test suite
    unittest.main()