Merge lp:~diane-trout/py3dns/py3dns into lp:py3dns

[Diane Trout]

Diane Trout on 2013-03-22

Add a unittest based test driver.

To make testing ParseResolvConf easier split it into two functions. The first takes a filename and opens it, and then passes it to a new function ParseResolvConfFromIterable which actually does the parsing. This makes it possible to test the parsing code without actually needing a valid file.

Added tests to check the A, AAAA, MX, SRV return values and DKIM txt records and IDN domain names

Ignore some common auto-generated python

I added a test driver that uses unittest to do some basic sanity checks for the DnsResolv api. I moved the one unittest style test case form py3dns/tests into DNS/tests to make it more like the dkim test code.

Undoubtibly it needs more test coverage.

What do you think of that test layout?

The next feature is should it return a byte string for names? E.g.

b'mail.ietf.org' instead of 'mail.ietf.org'?

[lp:~diane-trout/py3dns/py3dns]

107. By Diane Trout on 2013-03-22

Test DKIM txt records and IDN domain names.

108. By Diane Trout on 2013-03-25

Ignore some common auto-generated python

[Scott Kitterman (kitterman)]

Looks good. I've just merged and pushed this as well os some other test related changes I had locally I'd found I forgot to commit. You can see in tests/test7.py the start of an idea for returning different types based on what hte application asks for that Stuart mentioned in one of his earlier replies.

Thank you for your contribution to py3dns. I look forward to more. Sorry it took a little while to get it merged.

review: Approve

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2013-03-25 18:24:21 +0000
@@ -0,0 +1,3 @@
+__pycache__
+*.py[co~]
+

=== modified file 'DNS/Base.py'
--- DNS/Base.py	2012-07-22 05:58:00 +0000
+++ DNS/Base.py	2013-03-25 18:24:21 +0000
@@ -47,8 +47,12 @@
 
 def ParseResolvConf(resolv_path="/etc/resolv.conf"):
     "parses the /etc/resolv.conf file and sets defaults for name servers"
+    with open(resolv_path, 'r') as stream:
+        return ParseResolvConfFromIterable(stream)
+
+def ParseResolvConfFromIterable(lines):
+    "parses a resolv.conf formatted stream and sets defaults for name servers"
     global defaults
-    lines=open(resolv_path).readlines()
     for line in lines:
         line = line.strip()
         if not line or line[0]==';' or line[0]=='#':

=== added directory 'DNS/tests'
=== added file 'DNS/tests/__init__.py'
--- DNS/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ DNS/tests/__init__.py	2013-03-25 18:24:21 +0000
@@ -0,0 +1,13 @@
+import unittest
+import importlib
+
+def test_suite():
+    module_names = [
+        '.testPackers',
+        '.test_base',
+    ]
+    suites = []
+    for m in module_names:
+        module = importlib.import_module(m, 'DNS.tests')
+        suites.append(module.test_suite())
+    return unittest.TestSuite(suites)

=== renamed file 'tests/testPackers.py' => 'DNS/tests/testPackers.py'
--- tests/testPackers.py	2012-07-22 06:38:10 +0000
+++ DNS/tests/testPackers.py	2013-03-25 18:24:21 +0000
@@ -367,6 +367,9 @@
 #    def doPack(self, p):
 #        self.assertEquals(0,"NotImplemented")
 
+def test_suite():
+    from unittest import TestLoader
+    return TestLoader().loadTestsFromName(__name__)
 
 if __name__ == "__main__":
     unittest.main()

=== added file 'DNS/tests/test_base.py'
--- DNS/tests/test_base.py	1970-01-01 00:00:00 +0000
+++ DNS/tests/test_base.py	2013-03-25 18:24:21 +0000
@@ -0,0 +1,123 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+
+import DNS
+import unittest
+
+def assertIsByte(b):
+    assert b >= 0
+    assert b <= 255
+    
+class TestBase(unittest.TestCase):
+    def testParseResolvConf(self):
+        # reset elments set by Base._DiscoverNameServers
+        DNS.defaults['server'] = []
+        del DNS.defaults['domain']
+        self.assertEqual(len(DNS.defaults['server']), 0)
+        resolv = ['# a comment',
+                  'domain example.org',
+                  'nameserver 127.0.0.1',
+                 ]
+        DNS.ParseResolvConfFromIterable(resolv)
+        self.assertEqual(len(DNS.defaults['server']), 1)
+        self.assertEqual(DNS.defaults['server'][0], '127.0.0.1')
+        self.assertEqual(DNS.defaults['domain'], 'example.org')
+        
+    def testDnsRequestA(self):
+        # try with asking for strings, and asking for bytes
+        dnsobj = DNS.DnsRequest('example.org')
+        
+        a_response = dnsobj.req(qtype='A', resulttype='text')
+        self.assertTrue(a_response.answers)
+        # is the result vaguely ipv4 like?
+        self.assertEqual(a_response.answers[0]['data'].count('.'), 3)
+
+        ad_response = dnsobj.req(qtype='A')
+        self.assertTrue(ad_response.answers)
+        # is the result vaguely ipv4 like?
+        self.assertEqual(ad_response.answers[0]['data'].count('.'), 3)
+
+        ab_response = dnsobj.req(qtype='A', resulttype='binary')
+        self.assertTrue(ab_response.answers)
+        # is the result ipv4 binary like?
+        self.assertEqual(len(ab_response.answers[0]['data']), 4)
+        for b in ab_response.answers[0]['data']:
+            assertIsByte(b)
+
+
+    def testDnsRequestAAAA(self):
+        dnsobj = DNS.DnsRequest('example.org')
+        
+        aaaa_response = dnsobj.req(qtype='AAAA', resulttype='text')
+        self.assertTrue(aaaa_response.answers)
+        # does the result look like an ipv6 address?
+        self.assertTrue(':' in aaaa_response.answers[0]['data'])
+
+        # default is returning binary instead of text
+        aaaad_response = dnsobj.req(qtype='AAAA')
+        self.assertTrue(aaaad_response.answers)
+        # does the result look like a binary ipv6 address?
+        self.assertEqual(len(aaaad_response.answers[0]['data']) , 16)
+        for b in aaaad_response.answers[0]['data']:
+            assertIsByte(b)
+        
+        aaaab_response = dnsobj.req(qtype='AAAA', resulttype='binary')
+        self.assertTrue(aaaab_response.answers)
+        # is it ipv6 looking?
+        self.assertEqual(len(aaaab_response.answers[0]['data']) , 16)
+        for b in aaaab_response.answers[0]['data']:
+            assertIsByte(b)
+
+    def testDnsRequestEmptyMX(self):
+        dnsobj = DNS.DnsRequest('example.org')
+
+        mx_empty_response = dnsobj.req(qtype='MX')
+        self.assertFalse(mx_empty_response.answers)
+
+    def testDnsRequestMX(self):
+        dnsobj = DNS.DnsRequest('ietf.org')
+        mx_response = dnsobj.req(qtype='MX')
+        self.assertTrue(mx_response.answers[0])
+        # is hard coding a remote address a good idea?
+        self.assertEqual(mx_response.answers[0]['data'], (0, 'mail.ietf.org'))
+
+        m = DNS.mxlookup('ietf.org')
+        self.assertEqual(mx_response.answers[0]['data'], m[0])
+
+    def testDnsRequestSrv(self):
+        dnsobj = DNS.Request(qtype='srv')
+        resp = dnsobj.req('_ldap._tcp.openldap.org', resulttype='text')
+        self.assertTrue(resp.answers)
+        data = resp.answers[0]['data']
+        self.assertEqual(len(data), 4)
+        self.assertEqual(data[2], 389)
+        self.assertTrue('openldap.org' in data[3])
+
+    def testDkimRequest(self):
+        q = '20120113._domainkey.google.com'
+        dnsobj = DNS.Request(q, qtype='txt')
+        resp = dnsobj.req()
+        
+        self.assertTrue(resp.answers)
+        # should the result be bytes or a string?
+        data = resp.answers[0]['data']
+        self.assertTrue(isinstance(data[0], str))
+        self.assertTrue(data[0].startswith('k='))
+
+    def testIDN(self):
+        """Can we lookup an internationalized domain name?"""
+        dnsobj = DNS.DnsRequest('xn--hxajbheg2az3al.xn--jxalpdlp')
+        unidnsobj = DNS.DnsRequest('παράδειγμα.δοκιμή')
+        a_resp = dnsobj.req(qtype='AAAA', resulttype='text')
+        ua_resp = unidnsobj.req(qtype='AAAA', resulttype='text')
+        self.assertTrue(a_resp.answers)
+        self.assertTrue(ua_resp.answers)
+        self.assertEqual(ua_resp.answers[0]['data'], 
+                         a_resp.answers[0]['data'])
+            
+def test_suite():
+    from unittest import TestLoader
+    return TestLoader().loadTestsFromName(__name__)
+
+if __name__ == "__main__":
+    unittest.main()

=== added file 'test.py'
--- test.py	1970-01-01 00:00:00 +0000
+++ test.py	2013-03-25 18:24:21 +0000
@@ -0,0 +1,6 @@
+import unittest
+import doctest
+import DNS
+from DNS.tests import test_suite
+
+unittest.TextTestRunner().run(test_suite())