rspec-dnsruby 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTIyMjVlMDQ1NDE3NDgyYmM2MGNiN2FmNjY3MDQxNTI5Nzc1NDY4MA==
+  data.tar.gz: !binary |-
+    YWEyMjhlNjhhNjZmYzgwNzRlZjZmODg2ZGMyMTQ3ZWQ1NTJiZGJjMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2Q0MDIxZTMwZDBlZWJkZTVmYjFiYmU5MzZjMzYxOGJiOTNkNDBjZmViYjA3
+    ZWRiNDkwY2QyNzRjYWNlNGY0OGE0ZTk0ZTNkMWFiM2UzNTg4NmEwMzU3MDMx
+    Yzc1NTM4OGI2NmQ2YTFjYzY5MjkwY2ZlZjdiYWRiM2ZjMzg5MWY=
+  data.tar.gz: !binary |-
+    N2Q0MjZiNjc3NmMyYzY4MWRjZDcwODFjN2JlZWY3Yjg0ZjUzOTE3MDJlZmJk
+    ZjI1ODFjODIyMzVmMzM5YWMzNjgzNmZhMTQ4MmNlMmQwYTVjZjYzMWFmY2E3
+    ZmRlNDdkYTYwZjk2ZmFjNzllY2Q4NTIxOGMwMTIzMmEwMzk4MGM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,203 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+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.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,177 @@
+rspec-dnsruby
+=========
+rspec-dnsruby is an rspec plugin for easy DNS testing. It is a fork of rspec-dns and uses dnsruby instead of the standard ruby library.
+
+Differences with rspec-dns
+--------------------------
+
+* dependency on dnsruby and activesupport
+* additional matchers: `at_least`, `in_authority`, `refuse_request`
+* a bit different API for the chain methods because of dnsruby
+
+Dnsruby was chosen because it gives a complete DNS implementation, including DNSSEC.
+
+Installation
+------------
+If you're using bundler, add this line to your application's `Gemfile`:
+
+```ruby
+gem 'rspec-dnsruby'
+```
+
+Don't forget to run the `bundle` command to install.
+
+Or install it manually with:
+
+    $ gem install rspec-dnsruby
+
+Usage
+-----
+RSpec DNS is best described by example. First, require `rspec-dnsruby` in your `spec_helper.rb`:
+
+```ruby
+# spec/spec_helper.rb
+require 'rspec'
+require 'rspec-dnsruby'
+```
+
+Then, create a spec like this:
+
+```ruby
+require 'spec_helper'
+
+describe 'www.example.com' do
+  it { should have_dns.with_type('TXT').and_ttl(300).and_data('a=b') }
+end
+```
+
+Or group all your DNS tests into a single file or context:
+
+```ruby
+require 'spec_helper'
+
+describe 'DNS tests' do
+  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
+
+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:
+
+- address
+- bitmap
+- cpu
+- data
+- domainname
+- emailbx
+- exchange
+- expire
+- minimum
+- mname
+- name
+- os
+- port
+- preference
+- priority
+- protocol
+- refresh
+- retry
+- rmailbx
+- rname
+- serial
+- target
+- ttl
+- type
+- weight
+
+If you try checking an attribute on a record that is non-existent (like checking the `rmailbx` on an `A` record), you'll get an error like this:
+
+```text
+Failure/Error: it { should have_dns.with_type('TXT').and_ftl(300).and_data('a=b') }
+  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.
+
+Configuring
+-----------
+All configurations must be in your project root at `config/dns.yml`. This YAML file directly corresponds to the Resolv DNS initializer.
+
+For example, to directly query your DNS servers (necessary for correct TTL tests), create a `config/dns.yml` file like this:
+
+```yaml
+nameserver:
+  - 1.2.3.5
+  - 6.7.8.9
+```
+
+If this file is missing Resolv will use the settings in /etc/resolv.conf.
+
+If you need to change the [timeout](http://dnsruby.rubyforge.org/classes/Dnsruby/Resolver.html) you can do so like this:
+
+```yaml
+nameserver:
+  - 1.2.3.5
+  - 6.7.8.9
+timeouts: 3
+```
+
+The full list of configuration options can be found on the [Dnsruby docs](http://dnsruby.rubyforge.org/classes/Dnsruby/Config.html).
+
+Contributing
+------------
+1. Fork the project on github
+2. Create your feature branch
+3. Open a Pull Request
+
+License & Authors
+-----------------
+- 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.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rspec-dnsruby/have_dns.rb

@@ -0,0 +1,134 @@
+RSpec::Matchers.define :have_dns do
+  match do |dns|
+    @dns = dns
+    @exceptions = []
+
+    if @authority
+      @records = _records.authority
+    else
+      @records = _records.answer
+    end
+
+    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|
+    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|
+    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
+
+  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
+      self
+    else
+      super
+    end
+  end
+
+  def _config
+    @config ||= if File.exists?(_config_file)
+      require 'yaml'
+      YAML::load(ERB.new(File.read(_config_file) ).result).symbolize_keys
+    else
+      nil
+    end
+  end
+
+  def _config_file
+    File.join('config', 'dns.yml')
+  end
+
+  def _options
+    @_options ||= {}
+  end
+
+  def _records
+    @_records ||= begin
+      Timeout::timeout(10) do
+        config = _config || {}
+        resolver =  Dnsruby::Resolver.new(config)
+        # Backwards compatible config option from the version which uses ruby stdlib
+        resolver.query_timeout = config[:timeouts] if config[:timeouts]
+        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_options
+    "\n  (#{_options.sort.map { |k, v| "#{k}:#{v.inspect}" }.join(', ')})\n"
+  end
+
+  def _pretty_print_records
+    "\n" + @records.map { |r| r.to_s }.join("\n")
+  end
+
+end

data/lib/rspec-dnsruby.rb

@@ -0,0 +1,4 @@
+require 'dnsruby'
+require 'active_support/core_ext/hash'
+require 'rspec/expectations'
+require 'rspec-dnsruby/have_dns'

data/rspec-dnsruby.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.version       = '0.1.0'
+  s.name          = 'rspec-dnsruby'
+  s.authors       = ['Alexey Lapitsky', 'Johannes Russek']
+  s.email         = 'alexey@spotify.com'
+  s.description   = 'Easily test your DNS entries with RSpec'
+  s.summary       = 'rspec-dnsruby provides an easy-to-use DSL for testing your DNS records are responding as they should.'
+  s.homepage      = 'https://github.com/vzctl/rspec-dnsruby'
+  s.license       = 'Apache 2.0'
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'dnsruby'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'rspec', '>= 2.9'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rspec-dnsruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Lapitsky
+- Johannes Russek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dnsruby
+  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: activesupport
+  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'
+description: Easily test your DNS entries with RSpec
+email: alexey@spotify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec-dnsruby.rb
+- lib/rspec-dnsruby/have_dns.rb
+- rspec-dnsruby.gemspec
+homepage: https://github.com/vzctl/rspec-dnsruby
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: rspec-dnsruby provides an easy-to-use DSL for testing your DNS records are
+  responding as they should.
+test_files: []
+has_rdoc: