rspec-dns 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 0e6437ba3dc71e9939554d3b7d1f380bf004881f
-  data.tar.gz: bacd23f9468760b42c80831e89c66b47c249959b
-SHA512:
-  metadata.gz: 6ade41c2a15787e880c384dbfd999344e4c1d26ca5f4d1ea6b9eba4e65c21b87422182a58b8816b90152a18b6abcf830307648c930f32540073da5c08c854d2f
-  data.tar.gz: 292d742245a4ca87547701a6d8e9d1693ab8300d88b94db520c337088ebf0a42a66cb20fc626f9a1f10429f210f4206e32e88fb547678cbba581ab2c53458618
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjA1MGNlM2VlOWQ3N2M4OWI1MDMwN2ViNjc1ZmRhNDk0NTQ2NTBjNg==
+  data.tar.gz: !binary |-
+    YjAxNjUxYjEzZjM3YTg1YjA1MWVhMjdiMTM2NmU0ZjYzYmZhNDY2Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTA4ZWNlMWEwNTFmNWE1NWI0Nzk3NWIyYmI0MWIyNzlhNWRiNGJiZTQzZjA4
+    NmNjZDljOWUxOThkMDliNzYwNTIyZTQwMWFkY2EzNTlmNDhmYzZhZGFiZmIy
+    YWY5MTUzMzNmMTg3Mzk0ZjUxY2Q4Mzk4MzQ4NmUzN2Y1MDRkYzA=
+  data.tar.gz: !binary |-
+    NTFlMDk5YTJiNTAwMDQ5ZTkwNzYxNmU4N2FiYjc0MjI4NDI5ZjY4Zjc3YTcy
+    NjAxY2IxNmVkZjM1YzUxM2FiYzUzZGRjMjhjOWQ4M2Q5YmU5OGQzNDA1Nzkx
+    MDYwYTJkZmY1ZTMxYzFkY2QzYjM4YzdjNDEzYThiNTkzNzJkZmU=

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+script: "rake travis"
+
+rvm:
+  - 1.9.3
+  - 2.0.0

data/LICENSE

@@ -188,6 +188,7 @@ APPENDIX: How to apply the Apache License to your work.
 
 Copyright 2012-2013 Seth Vargo
 Copyright 2012-2013 CustomInk, LLC
+Copyright 2013-2014 Spotify AB
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,6 +1,9 @@
 rspec-dns
 =========
-RSpec DNS is an rspec plugin for easy DNS testing. It uses the built-in Ruby 1.9 library Resolv and is customizable.
+
+[![Build Status](https://travis-ci.org/spotify/rspec-dns.png?branch=master)](https://travis-ci.org/spotify/rspec-dns)
+
+rspec-dns is an rspec plugin for easy DNS testing. It uses dnsruby instead of the standard library for the name resolution.
 
 Installation
 ------------
@@ -42,13 +45,38 @@ Or group all your DNS tests into a single file or context:
 require 'spec_helper'
 
 describe 'DNS tests' do
-  'www.example.com'.should have_dns.with_type('TXT').and_ttl(300).and_data('a=b')
-  'www.example.com'.should have_dns.with_type('A').and_ttl(300).and_value('1.2.3.4')
+  it 'passes some tests' do
+    'www.example.com'.should have_dns.with_type('TXT').and_ttl(300).and_data('a=b')
+    'www.example.com'.should have_dns.with_type('A').and_ttl(300).and_address('1.2.3.4')
+  end
 end
 ```
 
 ### Chain Methods
-All of the method chains are actually [Resolv](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/resolv/rdoc/index.html) attributes on the record. You can prefix them with `and_`, `with_`, `and_with` or whatever your heart desires. The predicate is what is checked. The rest is syntactic sugar.
+
+Currently the following chaining methods are supported:
+
+- at\_least
+- in\_authority
+- refuse\_request
+
+Here's some usage examples:
+
+```ruby
+  it 'checks if recursion is disabled' do
+    'google.com'.should have_dns.refuse_request
+  end
+
+  it 'checks if gslb subdomain is delegated to dynect' do
+    'gslb.example.com'.should have_dns.in_authority.with_type('NS').and_name(/dynect/).at_least(3)
+  end
+
+  it 'checks number of hosts in round robin' do
+    'example.com'.should have_dns.with_type('A').at_least(3)
+  end
+```
+
+The other method chains are actually [Dnsruby](http://dnsruby.rubyforge.org/classes/Dnsruby/RR.html) attributes on the record. You can prefix them with `and_`, `with_`, `and_with` or whatever your heart desires. The predicate is what is checked. The rest is syntactic sugar.
 
 Depending on the type of record, the following attributes may be available:
 
@@ -56,6 +84,7 @@ Depending on the type of record, the following attributes may be available:
 - bitmap
 - cpu
 - data
+- domainname
 - emailbx
 - exchange
 - expire
@@ -81,8 +110,7 @@ If you try checking an attribute on a record that is non-existent (like checking
 
 ```text
 Failure/Error: it { should have_dns.with_type('TXT').and_ftl(300).and_data('a=b') }
-     NoMethodError:
-       undefined method `rmailbx' for #<Resolv::DNS::Resource::IN::A:0x007fb56302ed90>
+  got 1 exception(s): undefined method `rmailbx' for #<Dnsruby::RR::IN::A:0x007f66a0339b00>
 ```
 
 For this reason, you should always check the `type` attribute first in your chain.
@@ -101,7 +129,19 @@ nameserver:
 
 If this file is missing Resolv will use the settings in /etc/resolv.conf.
 
-If you need to incrase the timeout above the [default](https://github.com/ruby/ruby/blob/trunk/lib/resolv.rb#L344) you can do so like this:
+The full list of configuration options can be found on the [Dnsruby docs](http://dnsruby.rubyforge.org/classes/Dnsruby/Config.html).
+
+### Configuring connection timeout
+
+Connection timeout is to stop waiting for resolver.
+If you want to wait over default timeout `1`,
+you can change the timeout in spec files or spec_helpers like this:
+
+```ruby
+RSpec.configuration.rspec_dns_connection_timeout = 5
+```
+
+alternatively you can specify it in the `config/dns.yml` file:
 
 ```yaml
 nameserver:
@@ -110,8 +150,6 @@ nameserver:
 timeouts: 3
 ```
 
-The full list of configuration options can be found on the [Resolv docs](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/resolv/rdoc/index.html).
-
 Contributing
 ------------
 1. Fork the project on github
@@ -120,11 +158,14 @@ Contributing
 
 License & Authors
 -----------------
-- Author: Seth Vargo (sethvargo@gmail.com)
+- Seth Vargo (sethvargo@gmail.com)
+- Johannes Russek (jrussek@spotify.com)
+- Alexey Lapitsky (lex@realisticgroup.com)
 
 ```text
 Copyright 2012-2013 Seth Vargo
 Copyright 2012-2013 CustomInk, LLC
+Copyright 2013-2014 Spotify AB
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,2 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default => :travis
+task :travis => [:spec]
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/*/*_spec.rb'
+end

data/lib/rspec-dns/have_dns.rb

@@ -1,37 +1,85 @@
-require 'resolv'
+RSpec.configure do |c|
+  c.add_setting :rspec_dns_connection_timeout, :default => 1
+end
 
 RSpec::Matchers.define :have_dns do
   match do |dns|
     @dns = dns
+    @exceptions = []
+
+    if @authority
+      @records = _records.authority
+    else
+      @records = _records.answer
+    end
 
-    _records.any? do |record|
-      _options.all? do |option, value|
-        # To distinguish types because not all Resolv returns have type
-        if option == :type
-          record.class.name.split('::').last == value.to_s
-        else
+    results = @records.find_all do |record|
+      matched = _options.all? do |option, value|
+        begin
+          # To distinguish types because not all Resolv returns have type
           if value.is_a? String
             record.send(option).to_s == value
+          elsif value.is_a? Regexp
+            record.send(option).to_s =~ value
           else
             record.send(option) == value
           end
+        rescue Exception => e
+          @exceptions << e.message
+          false
         end
       end
+      matched
+    end
+
+    @number_matched = results.count
+
+    fail_with('exceptions') if !@exceptions.empty?
+    if @refuse_request
+      @refuse_request_received
+    else
+      @number_matched >= (@at_least ? @at_least : 1)
     end
   end
 
   failure_message_for_should do |actual|
-    "expected #{actual} to have: #{_pretty_print_options}, but did not. other records were: #{_pretty_print_records}"
+    if !@exceptions.empty?
+      "tried to look up #{actual} but got #{@exceptions.size} exception(s): #{@exceptions.join(", ")}"
+    elsif @refuse_request
+      "expected #{actual} to have request refused"
+    elsif @at_least
+      "expected #{actual} to have: #{@at_least} records of #{_pretty_print_options}, but found #{@number_matched}. Other records were: #{_pretty_print_records}"
+    else
+      "expected #{actual} to have: #{_pretty_print_options}, but did not. other records were: #{_pretty_print_records}"
+    end
   end
 
   failure_message_for_should_not do |actual|
-    "expected #{actual} not to have #{_pretty_print_options}, but it did"
+    if !@exceptions.empty?
+      "got #{@exceptions.size} exception(s):\n#{@exceptions.join("\n")}"
+    elsif @refuse_request
+      "expected #{actual} not to be refused"
+    else
+      "expected #{actual} not to have #{_pretty_print_options}, but it did. the records were: #{_pretty_print_records}"
+    end
   end
 
-  description do
+  def description
     "have the correct dns entries with #{_options}"
   end
 
+  chain :in_authority do
+    @authority = true
+  end
+
+  chain :at_least do |actual|
+    @at_least = actual
+  end
+
+  chain :refuse_request do
+    @refuse_request = true
+  end
+
   def method_missing(m, *args, &block)
     if m.to_s =~ /(and\_with|and|with)?\_(.*)$/
       _options[$2.to_sym] = args.first
@@ -44,7 +92,7 @@ RSpec::Matchers.define :have_dns do
   def _config
     @config ||= if File.exists?(_config_file)
       require 'yaml'
-      config = _symbolize_keys(YAML::load(ERB.new(File.read(_config_file) ).result))
+      _symbolize_keys(YAML::load(ERB.new(File.read(_config_file) ).result))
     else
       nil
     end
@@ -73,32 +121,34 @@ RSpec::Matchers.define :have_dns do
     @_options ||= {}
   end
 
-  def _pretty_print_options
-    "\n  (#{_options.sort.collect{ |k,v| "#{k}:#{v.inspect}" }.join(', ')})\n"
-  end
-
   def _records
     @_records ||= begin
-      Timeout::timeout(1) {
-        if _config.nil?
-          Resolv::DNS.new.getresources(@dns, Resolv::DNS::Resource::IN::ANY)
-        else
-          Resolv::DNS.new(_config).getresources(@dns, Resolv::DNS::Resource::IN::ANY)
-        end
-      }
-    rescue Timeout::Error
-      $stderr.puts "Connection timed out for #{@dns}"
-      []
+      config = _config || {}
+      # Backwards compatible config option for rspec-dnsruby
+      query_timeout = config[:timeouts] || RSpec.configuration.rspec_dns_connection_timeout
+      Timeout::timeout(query_timeout + 0.2) do
+        resolver =  Dnsruby::Resolver.new(config)
+        resolver.query_timeout = query_timeout
+        resolver.query(@dns, Dnsruby::Types.ANY)
+      end
+    rescue Exception => e
+      if Dnsruby::NXDomain === e
+        @exceptions << "Have not received any records"
+      elsif Dnsruby::Refused === e && @refuse_request
+        @refuse_request_received = true
+      else
+        @exceptions << e.message
+      end
+      Dnsruby::Message.new
     end
   end
 
-  def _pretty_print_records
-    "\n" + _records.collect { |record| _pretty_print_record(record) }.join("\n")
+  def _pretty_print_options
+    "\n  (#{_options.sort.map { |k, v| "#{k}:#{v.inspect}" }.join(', ')})\n"
   end
 
-  def _pretty_print_record(record)
-    '  (' + %w(address bitmap cpu data emailbx exchange expire minimum mname name os port preference priority protocol refresh retry rmailbx rname serial target ttl type weight).collect do |method|
-      "#{method}:#{record.send(method.to_sym).to_s.inspect}" if record.respond_to?(method.to_sym)
-    end.compact.join(', ') + ')'
+  def _pretty_print_records
+    "\n" + @records.map { |r| r.to_s }.join("\n")
   end
+
 end

data/rspec-dns.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
-  s.version       = '0.0.3'
+  s.version       = '0.1.0'
   s.name          = 'rspec-dns'
-  s.author        = 'Seth Vargo'
-  s.email         = 'sethvargo@gmail.com'
+  s.authors       = ['Seth Vargo', 'Alexey Lapitsky', 'Johannes Russek']
+  s.email         = 'alexey@spotify.com'
   s.description   = 'Easily test your DNS entries with RSpec'
   s.summary       = 'rspec-dns provides an easy-to-use DSL for testing your DNS records are responding as they should.'
-  s.homepage      = 'https://github.com/customink/rspec-dns'
+  s.homepage      = 'https://github.com/spotify/rspec-dns'
   s.license       = 'Apache 2.0'
 
   s.files         = `git ls-files`.split($\)
@@ -15,4 +15,5 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rake'
   s.add_dependency 'rspec', '>= 2.9'
+  s.add_dependency 'dnsruby', '~> 1.54'
 end

data/spec/rspec-dns/have_dns_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'dnsruby'
+require 'resolv'
+require_relative '../../lib/rspec-dns'
+
+def stub_records(strings)
+  records = strings.map { |s| Dnsruby::RR.new_from_string(s) }
+  resolver = Dnsruby::Resolver.new
+  Dnsruby::Resolver.stub(:new) do
+    yield if block_given?
+    resolver
+  end
+  resolver.stub_chain(:query, :answer).and_return(records)
+end
+
+describe 'rspec-dns matchers' do
+
+  describe '#have_dns' do
+    context 'with a sigle record' do
+      it 'can evalutate an A record' do
+        stub_records(['example.com 86400 A 192.168.100.100'])
+
+        'example.com'.should have_dns.with_type('A')
+        'example.com'.should_not have_dns.with_type('TXT')
+        'example.com'.should have_dns.with_type('A').and_address(Resolv::IPv4.create('192.168.100.100'))
+      end
+
+      it 'can evalutate a AAAA record' do
+        stub_records(['example.com 86400 AAAA 2001:0002:6c::430'])
+
+        'example.com'.should have_dns.with_type('AAAA')
+        'example.com'.should_not have_dns.with_type('A')
+        'example.com'.should have_dns.with_type('AAAA')
+          .and_address(Resolv::IPv6.create('2001:0002:6c::430'))
+      end
+
+      it 'can evalutate a CNAME record' do
+        stub_records(['www.example.com 300 IN CNAME example.com'])
+
+        'example.com'.should have_dns.with_type('CNAME')
+        'example.com'.should_not have_dns.with_type('AAAA')
+        'example.com'.should have_dns.with_type('CNAME').and_name('www.example.com')
+      end
+
+      it 'can evalutate an MX record' do
+        stub_records(['example.com. 7200 MX 40 mail.example.com.'])
+
+        'example.com'.should have_dns.with_type('MX')
+        'example.com'.should_not have_dns.with_type('CNAME')
+        'example.com'.should have_dns.with_type('MX').and_preference(40)
+        'example.com'.should have_dns.with_type('MX')
+          .and_preference(40).and_exchange('mail.example.com')
+        'example.com'.should_not have_dns.with_type('MX')
+          .and_preference(30).and_exchange('mail.example.com')
+        'example.com'.should_not have_dns.with_type('MX')
+          .and_preference(40).and_exchange('example.com')
+      end
+
+      it 'can evalutate an NS record' do
+        stub_records(['sub.example.com. 300 IN NS ns.sub.example.com.'])
+
+        'example.com'.should have_dns.with_type('NS')
+        'example.com'.should_not have_dns.with_type('MX')
+        'example.com'.should have_dns.with_type('NS').and_domainname('ns.sub.example.com')
+        'example.com'.should_not have_dns.with_type('NS').and_domainname('sub.example.com')
+      end
+
+      it 'can evalutate a PTR record' do
+        stub_records(['ptrs.example.com. 300 IN PTR ptr.example.com.'])
+
+        '192.168.100.100'.should have_dns.with_type('PTR')
+        '192.168.100.100'.should_not have_dns.with_type('MX')
+        '192.168.100.100'.should have_dns.with_type('PTR').and_domainname('ptr.example.com')
+        '192.168.100.100'.should_not have_dns.with_type('PTR').and_domainname('ptrs.example.com')
+      end
+
+      it 'can evalutate an SOA record' do
+        stub_records(['example.com 210 IN SOA ns.example.com a.example.com. 2014030712 60 25 3628800 900'])
+
+        'example.com'.should have_dns.with_type('SOA')
+        'example.com'.should_not have_dns.with_type('PTR')
+        'example.com'.should have_dns.with_type('SOA')
+          .and_mname('ns.example.com')
+          .and_rname('a.example.com')
+          .and_serial('2014030712')
+          .and_refresh(60)
+          .and_retry(25)
+          .and_expire(3628800)
+          .and_minimum(900)
+        'example.com'.should_not have_dns.with_type('SOA')
+          .and_mname('nstest.example.com')
+      end
+
+      it 'can evalutate a TXT record' do
+        stub_records(['example.com. 300 IN TXT "v=spf1 a:example.com ~all"'])
+
+        'example.com'.should have_dns.with_type('TXT')
+        'example.com'.should_not have_dns.with_type('SOA')
+        'example.com'.should have_dns.with_type('TXT').and_data('v=spf1 a:example.com ~all')
+        'example.com'.should_not have_dns.with_type('TXT').and_data('v=spf2 a:example.com ~all')
+      end
+    end
+
+    context 'with changable connection timeout' do
+      it 'should timeout within 3 seconds in default' do
+        stub_records(['example.com 86400 A 192.168.100.100']) do
+          sleep 3
+        end
+        'example.com'.should_not have_dns.with_type('A')
+      end
+
+      it 'should not timeout within 3 seconds when timeout is 5' do
+        RSpec.configuration.rspec_dns_connection_timeout = 5
+        stub_records(['example.com 86400 A 192.168.100.100']) do
+          sleep 3
+        end
+        'example.com'.should have_dns.with_type('A')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+RSpec.configure do |config|
+end

metadata

@@ -1,51 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: rspec-dns
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Seth Vargo
+- Alexey Lapitsky
+- Johannes Russek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: dnsruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.54'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.54'
 description: Easily test your DNS entries with RSpec
-email: sethvargo@gmail.com
+email: alexey@spotify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -53,7 +70,9 @@ files:
 - lib/rspec-dns.rb
 - lib/rspec-dns/have_dns.rb
 - rspec-dns.gemspec
-homepage: https://github.com/customink/rspec-dns
+- spec/rspec-dns/have_dns_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spotify/rspec-dns
 licenses:
 - Apache 2.0
 metadata: {}
@@ -63,20 +82,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: rspec-dns provides an easy-to-use DSL for testing your DNS records are responding
   as they should.
-test_files: []
+test_files:
+- spec/rspec-dns/have_dns_spec.rb
+- spec/spec_helper.rb
 has_rdoc: