dns-zone2 0.3.2

data/test/rr/rrsig_test.rb

@@ -0,0 +1,40 @@
+require 'dns/zone/test_case'
+
+class RR_RRSIG_Test < DNS::Zone::TestCase
+
+  TEST_SIGNATURE = 'oJB1W6WNGv+ldvQ3WDG0MQkg5IEhjRip8WTrPYGv07h108dUKGMeDPKijVCHX3DDKdfb+v6oB9wfuh3DTJXUAfI/M0zmO/zz8bW0Rznl8O3tGNazPwQKkRN20XPXV6nwwfoXmJQbsLNrLfkGJ5D6fwFm8nN+6pBzeDQfsS3Ap3o='
+
+  def test_build_rr__rrsig
+    rr = DNS::Zone::RR::RRSIG.new
+    rr.label = 'host.example.com.'
+    rr.type_covered = 'A'
+    rr.algorithm = 5
+    rr.labels = 3
+    rr.original_ttl = 86400
+    rr.signature_expiration = 20030322173103
+    rr.signature_inception = 20030220173103
+    rr.key_tag = 2642
+    rr.signer = 'example.com.'
+    rr.signature = TEST_SIGNATURE
+
+    assert_equal "host.example.com. IN RRSIG A 5 3 86400 20030322173103 20030220173103 2642 example.com. #{TEST_SIGNATURE}", rr.dump
+
+  end
+
+  def test_load_rr__rrsig
+    rr = DNS::Zone::RR::RRSIG.new.load("host.example.com. IN RRSIG A 5 3 86400 20030322173103 20030220173103 2642 example.com. #{TEST_SIGNATURE}")
+    assert_equal 'host.example.com.', rr.label
+    assert_equal 'RRSIG', rr.type
+
+    assert_equal 'A', rr.type_covered
+    assert_equal 5, rr.algorithm
+    assert_equal 3, rr.labels
+    assert_equal 86400, rr.original_ttl
+    assert_equal 20030322173103, rr.signature_expiration
+    assert_equal 20030220173103, rr.signature_inception
+    assert_equal 2642, rr.key_tag
+    assert_equal 'example.com.', rr.signer
+    assert_equal TEST_SIGNATURE, rr.signature
+  end
+
+end

data/test/rr/soa_test.rb

@@ -0,0 +1,34 @@
+require 'dns/zone/test_case'
+
+class RR_SOA_Test < DNS::Zone::TestCase
+
+  EXAMPLE_SOA_IN  = '@ IN SOA ns0.lividpenguin.com. luke.lividpenguin.com. 2014021601 3h 15m 4w 30m'
+  EXAMPLE_SOA_OUT = '@ IN SOA ns0.lividpenguin.com. luke.lividpenguin.com. ( 2014021601 3h 15m 4w 30m )'
+
+  def test_build_rr__soa
+    rr = DNS::Zone::RR::SOA.new
+    rr.nameserver = 'ns0.lividpenguin.com.'
+    rr.email = 'luke.lividpenguin.com.'
+    rr.serial = 2014_02_16_01
+    rr.refresh_ttl = '3h'
+    rr.retry_ttl = '15m'
+    rr.expiry_ttl = '4w'
+    rr.minimum_ttl = '30m'
+    assert_equal EXAMPLE_SOA_OUT, rr.dump
+  end
+
+  def test_load_rr__soa
+    rr = DNS::Zone::RR::SOA.new.load(EXAMPLE_SOA_IN)
+    assert_equal '@', rr.label
+    assert_equal 'SOA', rr.type
+
+    assert_equal 'ns0.lividpenguin.com.', rr.nameserver
+    assert_equal 'luke.lividpenguin.com.', rr.email
+    assert_equal 2014_02_16_01, rr.serial
+    assert_equal '3h', rr.refresh_ttl
+    assert_equal '15m', rr.retry_ttl
+    assert_equal '4w', rr.expiry_ttl
+    assert_equal '30m', rr.minimum_ttl
+  end
+
+end

data/test/rr/spf_test.rb

@@ -0,0 +1,20 @@
+require 'dns/zone/test_case'
+
+class RR_SPF_Test < DNS::Zone::TestCase
+
+  def test_build_rr__spf
+    rr = DNS::Zone::RR::SPF.new
+    rr.ttl = '2w'
+    rr.text = '"v=spf1 +mx -all"'
+    assert_equal '@ 2w IN SPF "v=spf1 +mx -all"', rr.dump
+  end
+
+  def test_load_rr__spf
+    rr = DNS::Zone::RR::SPF.new.load('@ 2w IN SPF "v=spf1 +mx -all"')
+    assert_equal '@', rr.label
+    assert_equal 'IN', rr.klass
+    assert_equal 'SPF', rr.type
+    assert_equal '"v=spf1 +mx -all"', rr.text
+  end
+
+end

data/test/rr/srv_test.rb

@@ -0,0 +1,24 @@
+require 'dns/zone/test_case'
+
+class RR_SRV_Test < DNS::Zone::TestCase
+
+  def test_build_rr__srv
+    rr = DNS::Zone::RR::SRV.new
+    rr.priority = 5
+    rr.weight = 0
+    rr.port = 5269
+    rr.target = 'xmpp-server.l.google.com.'
+    assert_equal '@ IN SRV 5 0 5269 xmpp-server.l.google.com.', rr.dump
+  end
+
+  def test_load_rr__srv
+    rr = DNS::Zone::RR::SRV.new.load('@ IN SRV 5 0 5269 xmpp-server.l.google.com.')
+    assert_equal '@', rr.label
+    assert_equal 'SRV', rr.type
+    assert_equal 5, rr.priority
+    assert_equal 0, rr.weight
+    assert_equal 5269, rr.port
+    assert_equal 'xmpp-server.l.google.com.', rr.target
+  end
+
+end

data/test/rr/sshfp_test.rb

@@ -0,0 +1,24 @@
+require 'dns/zone/test_case'
+
+class RR_SSHFP_Test < DNS::Zone::TestCase
+
+  def test_build_rr__sshfp
+    rr = DNS::Zone::RR::SSHFP.new
+    rr.label = 'host.example.'
+    rr.algorithm_number = 2
+    rr.fingerprint_type = 1
+    rr.fingerprint = '123456789abcdef67890123456789abcdef67890'
+
+    assert_equal 'host.example. IN SSHFP 2 1 123456789abcdef67890123456789abcdef67890', rr.dump
+  end
+
+  def test_load_rr__sshfp
+    rr = DNS::Zone::RR::SSHFP.new.load('host.example. IN SSHFP 2 1 123456789abcdef67890123456789abcdef67890')
+    assert_equal 'host.example.', rr.label
+    assert_equal 'SSHFP', rr.type
+    assert_equal 2, rr.algorithm_number
+    assert_equal 1, rr.fingerprint_type
+    assert_equal '123456789abcdef67890123456789abcdef67890', rr.fingerprint
+  end
+
+end

data/test/rr/txt_test.rb

@@ -0,0 +1,44 @@
+require 'dns/zone/test_case'
+
+class RR_TXT_Test < DNS::Zone::TestCase
+
+  def test_build_rr__txt
+    rr = DNS::Zone::RR::TXT.new
+
+    # ensure we can set text parameter
+    rr.text = '"test text"'
+    assert_equal '@ IN TXT "test text"', rr.dump
+
+    # with a label set
+    rr.label = 'labelname'
+    assert_equal 'labelname IN TXT "test text"', rr.dump
+
+    # with a ttl
+    rr.ttl = '2w'
+    assert_equal 'labelname 2w IN TXT "test text"', rr.dump
+  end
+
+  def test_load_rr__txt
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "test text"')
+    assert_equal 'txtrecord', rr.label
+    assert_equal 'IN', rr.klass
+    assert_equal 'TXT', rr.type
+    assert_equal '"test text"', rr.text
+  end
+
+  def test_load_multiple_quoted_strings
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "part1 yo" " part2 yo"')
+    assert_equal '"part1 yo" " part2 yo"', rr.text
+  end
+
+  def test_load_string_with_quotes
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "we have \"double\" quotes"')
+    assert_equal %q{"we have \"double\" quotes"}, rr.text
+  end
+
+  def test_load_multiple_strings_with_quotes
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "part1 " "we have \"double\" quotes" " part3"')
+    assert_equal %q{"part1 " "we have \"double\" quotes" " part3"}, rr.text
+  end
+
+end

data/test/rr_test.rb

@@ -0,0 +1,50 @@
+require 'dns/zone/test_case'
+
+class RRTest < DNS::Zone::TestCase
+
+  def test_load_ignores_comments
+    rr = DNS::Zone::RR.load('; comment lines are ignored')
+    assert_nil rr, 'should be nil when its a comment line'
+  end
+
+  def test_load_ignores_unparsable_input
+    rr = DNS::Zone::RR.load('invalid input should not be parsed')
+    assert_nil rr, 'should be nil when input cant be parsed at all'
+  end
+
+  def test_load_a_rr
+    rr = DNS::Zone::RR.load('www IN A 10.2.3.1')
+    assert_instance_of DNS::Zone::RR::A, rr, 'should be instance of A RR'
+    assert_equal 'www', rr.label
+    assert_equal 'A', rr.type
+    assert_equal '10.2.3.1', rr.address
+  end
+
+  def test_load_txt_rr
+    rr = DNS::Zone::RR.load('mytxt IN TXT "test text"')
+    assert_instance_of DNS::Zone::RR::TXT, rr, 'should be instance of TXT RR'
+    assert_equal 'mytxt', rr.label
+    assert_equal 'TXT', rr.type
+    assert_equal '"test text"', rr.text
+  end
+
+  def test_load_txt_semicolon_rr
+    rr = DNS::Zone::RR.load('_domainkey IN TXT "t=y; o=~;"')
+    assert_instance_of DNS::Zone::RR::TXT, rr, 'should be instance of TXT RR'
+    assert_equal '_domainkey', rr.label
+    assert_equal 'TXT', rr.type
+    assert_equal '"t=y; o=~;"', rr.text
+  end
+
+  def test_load_a_rr_with_options_hash
+    rr = DNS::Zone::RR.load(' IN A 10.2.3.1', { last_label: 'www' })
+    assert_equal 'www', rr.label
+
+    rr = DNS::Zone::RR.load('blog IN A 10.2.3.1', { last_label: 'www' })
+    assert_equal 'blog', rr.label
+
+    rr = DNS::Zone::RR.load('@ IN A 10.2.3.1', { last_label: 'mail' })
+    assert_equal '@', rr.label
+  end
+
+end

data/test/version_test.rb

@@ -0,0 +1,9 @@
+require 'dns/zone/test_case'
+
+class VersionTest < DNS::Zone::TestCase
+
+  def test_should_have_a_version
+    assert DNS::Zone::Version, 'unable to access the version number'
+  end
+
+end

data/test/zone_test.rb

@@ -0,0 +1,273 @@
+require 'dns/zone/test_case'
+
+class ZoneTest < DNS::Zone::TestCase
+
+  # example zone file, with a couple of things that could trip us up.
+  ZONE_FILE_EXAMPLE =<<-EOL
+$ORIGIN lividpenguin.com.
+$TTL 3d
+@           IN  SOA  ns0.lividpenguin.com. luke.lividpenguin.com. (
+                           2013101406 ; zone serial number
+                           12h        ; refresh ttl
+                           15m        ; retry ttl
+                           3w         ; expiry ttl
+                           3h         ; minimum ttl
+                         )
+
+; a more difficult ; comment ( that is trying to break things!
+
+@           IN  NS    ns0.lividpenguin.com.
+@           IN  NS    ns1.lividpenguin.com.
+@           IN  NS    ns2.lividpenguin.com.
+
+@           IN  MX 10 mx0.lividpenguin.com.
+@           IN  MX 20 mx1.lividpenguin.com.
+
+@           IN  A     78.47.253.85
+ns0         IN  A     78.47.253.85
+ns0         IN  HINFO "Intel" "Ubuntu"
+
+ns0         IN  AAAA  2a01:4f8:d12:5ca::2
+
+foo         IN  TXT   "part1" "part2"
+bar         IN  TXT   ("part1 "
+                       "part2 "
+                       "part3")
+_domainkey  IN  TXT    "t=y; o=~;"
+
+longttl  5d IN A      10.1.2.3
+
+cake        IN  CNAME the.cake.is.a.lie.com.
+xmpp        IN  SRV 5 0 5269 xmpp-server.google.com.
+@           IN  SPF "v=spf1 +mx -all"
+
+; a record to be expanded
+@           IN  NS    ns3
+
+; a record that uses tab spaces
+tabed				IN	A			10.1.2.3
+
+EOL
+
+  # basic zone file example
+  ZONE_FILE_BASIC_EXAMPLE =<<-EOL
+@ IN SOA ns0.lividpenguin.com. luke.lividpenguin.com. ( 2013101406 12h 15m 3w 3h )
+@ IN NS ns0.lividpenguin.com.
+@ IN MX 10 mail
+@ IN MX 99 mx.fakemx.net.
+@ IN A 78.47.253.85
+mail IN A 78.47.253.85
+foo IN TXT "part1" "part2"
+EOL
+
+  # zone file with multiple zones
+  ZONE_FILE_MULTIPLE_ORIGINS_EXAMPLE =<<-EOL
+$ORIGIN lividpenguin.com.
+$TTL 3d
+@           IN  SOA  ns0.lividpenguin.com. luke.lividpenguin.com. (
+                           2013101406 ; zone serial number
+                           12h        ; refresh ttl
+                           15m        ; retry ttl
+                           3w         ; expiry ttl
+                           3h         ; minimum ttl
+                         )
+
+@           IN  NS    ns0.lividpenguin.com.
+@           IN  NS    ns1.lividpenguin.com.
+@           IN  NS    ns2.lividpenguin.com.
+
+@           IN  A     78.47.253.85
+www         IN  A     78.47.253.85
+
+foo         IN  TXT   "part1" "part2"
+
+$ORIGIN sub.lividpenguin.com.
+app1                    60 A     1.2.3.4
+app2                    60 A     1.2.3.5
+app3                    60 A     1.2.3.6
+$ORIGIN another.lividpenguin.com.
+@                     3600 A     1.1.1.1
+app1                    60 A     4.3.2.1
+
+EOL
+
+  def test_create_new_instance
+    assert DNS::Zone.new
+  end
+
+  def test_programmatic_readme_example
+    zone = DNS::Zone.new
+    zone.origin = 'example.com.'
+    zone.ttl = '1d'
+    # quick access to SOA RR
+    zone.soa.nameserver = 'ns0.lividpenguin.com.'
+    zone.soa.email = 'hostmaster.lividpenguin.com.'
+    # create and add new record
+    rec = DNS::Zone::RR::A.new
+    rec.address = '127.0.0.1'
+    zone.records << rec
+
+    assert_equal 2, zone.records.length, "were expecting 2 records, including the SOA"
+  end
+
+  def test_load_zone_basic
+    # load zone file.
+    zone = DNS::Zone.load(ZONE_FILE_BASIC_EXAMPLE)
+    # dump zone file.
+    dump = zone.dump
+    # check input matches output.
+    assert_equal ZONE_FILE_BASIC_EXAMPLE, dump, 'loaded zone file should match dumped zone file'
+  end
+
+  def test_load_zone_with_origin_param
+    # --- zone without $ORIGIN directive
+
+    zone = DNS::Zone.load(ZONE_FILE_BASIC_EXAMPLE, 'lividpenguin.com.')
+    dump = zone.dump
+    assert_equal ZONE_FILE_BASIC_EXAMPLE, dump, 'loaded zone file should match dumped zone file'
+    assert_equal 'lividpenguin.com.', zone.origin, 'check origin matches example input'
+
+    # --- zone with $ORIGIN directive
+
+    zone = DNS::Zone.load(ZONE_FILE_EXAMPLE, 'ignore.this.origin.favor.zone.com.')
+    assert_equal 'lividpenguin.com.', zone.origin, 'origin should come from test zone, not passed param'
+  end
+
+  def test_load_zone_labels_are_correct
+    zone = DNS::Zone.load(ZONE_FILE_BASIC_EXAMPLE, 'lividpenguin.com.')
+    assert_equal 'mail', zone.records[5].label, 'check label is correct'
+
+    zone = DNS::Zone.load(ZONE_FILE_EXAMPLE)
+    assert_equal 'ns0', zone.records[7].label, 'check label is correct'
+  end
+
+  def test_load_zone
+    # load example dns master zone file.
+    zone = DNS::Zone.load(ZONE_FILE_EXAMPLE)
+
+    # test attributes are correct.
+    assert_equal '3d', zone.ttl, 'check ttl matches example input'
+    assert_equal 'lividpenguin.com.', zone.origin, 'check origin matches example input'
+    assert_equal 19, zone.records.length, 'we should have multiple records (including SOA)'
+
+    #p ''
+    #zone.records.each do |rec|
+    #  p rec
+    #end
+  end
+
+  def test_load_zone_with_empty_labels
+    # basic zone file that uses empty labels (ie. use previous)
+    zone_as_string =<<-EOL
+@    IN A     78.47.253.85
+     IN AAAA  2a01:4f8:d12:5ca::2
+www  IN A     78.47.253.85
+     IN AAAA  2a01:4f8:d12:5ca::2
+EOL
+
+    # load zone file.
+    zone = DNS::Zone.load(zone_as_string)
+
+    # test labels are 'inherited' from last used.
+    assert_equal '@', zone.records[0].label
+    assert_equal '@', zone.records[1].label, 'label should be inherited from last label used'
+    assert_equal 'www', zone.records[2].label
+    assert_equal 'www', zone.records[3].label, 'label should be inherited from last label used'
+  end
+
+  def test_load_zone_that_uses_tabs_rather_then_spaces
+    zone_as_string =<<-EOL
+*		IN	A			78.47.253.85
+EOL
+
+    # load zone file.
+    zone = DNS::Zone.load(zone_as_string)
+
+    record = zone.records[0]
+    assert_equal '*', record.label
+    assert_equal 'A', record.type
+    assert_equal '78.47.253.85', record.address
+  end
+
+  def test_load_multiple_origins
+    zone = DNS::Zone.load(ZONE_FILE_MULTIPLE_ORIGINS_EXAMPLE)
+    assert_equal 'lividpenguin.com.', zone.origin
+    assert_equal 12, zone.records.length, 'we should have multiple records (including SOA)'
+    assert_equal 'app1.sub', zone.records[7].label
+    assert_equal '1.2.3.4', zone.records[7].address
+    assert_equal 'another', zone.records[10].label
+    assert_equal '1.1.1.1', zone.records[10].address
+    assert_equal 'app1.another', zone.records[11].label
+    assert_equal '4.3.2.1', zone.records[11].address
+  end
+
+  def test_extract_entry_from_one_line
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT "purr"})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_including_semicolon_within_quotes
+    entries = DNS::Zone.extract_entries(%Q{_domainkey IN TXT "t=y; o=~;"})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal '_domainkey IN TXT "t=y; o=~;"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_should_ignore_comments
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT "purr"; this is a comment})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_should_ignore_empty_lines
+    entries = DNS::Zone.extract_entries(%Q{\n\nmaiow IN TXT "purr";\n\n})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_using_parentheses_but_not_crossing_line_boundary
+    entries = DNS::Zone.extract_entries(%Q{maiow  IN  TXT ("part1" "part2")})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow  IN  TXT  "part1" "part2"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_crossing_line_boundary
+    entries = DNS::Zone.extract_entries(%Q{maiow1  IN  TXT ("part1"\n "part2" )})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow1  IN  TXT  "part1" "part2"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_soa_crossing_line_boundary
+    entries = DNS::Zone.extract_entries(%Q{
+@ IN  SOA  ns0.lividpenguin.com. luke.lividpenguin.com. (
+ 2013101406 ; zone serial number
+ 12h ; refresh ttl
+ 15m ; retry ttl
+ 3w  ; expiry ttl
+ 3h  ; minimum ttl
+)})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+
+    expected_soa = '@ IN  SOA  ns0.lividpenguin.com. luke.lividpenguin.com.  2013101406  12h  15m  3w  3h'
+    assert_equal expected_soa, entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entries_with_parentheses_crossing_multiple_line_boundaries
+    entries = DNS::Zone.extract_entries(%Q{maiow1  IN  TXT (\n"part1"\n "part2"\n)})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow1  IN  TXT  "part1" "part2"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entries_with_legal_but_crazy_parentheses_used
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT (\n(\n("part1")\n \n("part2" \n("part3"\n)\n)\n)\n)})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT  "part1" "part2" "part3"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_with_parentheses_in_character_string
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT ("purr((maiow)")})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr((maiow)"', entries[0], 'entry should match expected'
+  end
+
+end