dns_mock 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc32cd03521879fd373e554a2dbb29ae26ca002586418675fdc066b7ad5eab57
-  data.tar.gz: f309b21a3e48780dedef123a95bab5267dc3679ec3809def258a189485f5a6c4
+  metadata.gz: f5b0d9099a1f5c837df39abb203d6217f0216dd0669acc7a209ce86cb00c2651
+  data.tar.gz: db3089761cf77aae5e69af2fdd961f5a26fdaf21abd7383113f3c86512676169
 SHA512:
-  metadata.gz: fa16a2db1e2c9b8e903b29241f08d2b7695dfa3b98c9364c7d8ea87b361a67b21e72f898378d64b75500f9bc0ab90d14a33b94443561760ec99a820e02c0d8b4
-  data.tar.gz: 3f236e1c88970784a9d137994562595b06f3d78c0555aa3279810ae1821792d5b46c50f56e8bb63b3c66c060f9f495e4e09f6ada7ee6ae0588772a2ebb7d1a72
+  metadata.gz: d14b6560b60a00c542db1930cbbfde077f75d9a89866543c2477817edb8951e4004df904930980ed2ce91815d7ca01e2d6d82fc25449d45347577dfe7ea464bc
+  data.tar.gz: 5a6fc8492af617c15229262a2faf6a4c5349504e40936f4be7954807db96d12f4954d9e667b9334aeb68fa8a2aeb11ae934049db52f8f08434f21010147edecc

data/.reek.yml

@@ -21,6 +21,8 @@ detectors:
       - DnsMock::ServerHelper#start_random_server
       - DnsMock::ServerHelper#stop_all_running_servers
       - DnsMock::Server::RecordsDictionaryBuilder#rdns_lookup_prefix
+      - DnsMock::ContextGeneratorHelper#random_port_number
+      - DnsMock::TestFramework::RSpec::Helper#dns_mock_server
 
   ControlParameter:
     exclude:

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2021-02-01
+
+### RSpec native support
+
+Added DnsMock helper which can simplify integration with RSpec.
+
+```ruby
+# spec/support/config/dns_mock.rb
+require 'dns_mock/test_framework/rspec'
+
+RSpec.configure do |config|
+  config.include DnsMock::TestFramework::RSpec::Helper
+end
+
+# your awesome first_a_record_spec.rb
+RSpec.describe FirstARecord do
+  subject(:service) do
+    described_class.call(
+      hostname,
+      dns_gateway_host: 'localhost',
+      dns_gateway_port: dns_mock_server.port
+    )
+  end
+
+  let(:hostname) { 'example.com' }
+  let(:first_a_record) { '1.2.3.4' }
+  let(:records) { { hostname => { a: [first_a_record] } } }
+
+  before { dns_mock_server.assign_mocks(records) }
+
+  it { is_expected.to eq(first_a_record) }
+end
+```
+
 ## [1.0.0] - 2021-01-29
 
 ### Configurable record not found behaviour

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dns_mock (1.0.0)
+    dns_mock (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -16,6 +16,7 @@
 - [Requirements](#requirements)
 - [Installation](#installation)
 - [Usage](#usage)
+  - [RSpec](#rspec)
 - [Contributing](#contributing)
 - [License](#license)
 - [Code of Conduct](#code-of-conduct)
@@ -110,6 +111,68 @@ DnsMock.running_servers # => [DnsMock::Server instance]
 DnsMock.stop_running_servers! # => true
 ```
 
+### RSpec
+
+Require this either in your Gemfile or in RSpec's support scripts. So either:
+
+```ruby
+# Gemfile
+group :test do
+  gem 'rspec'
+  gem 'dns_mock', require: 'dns_mock/test_framework/rspec'
+end
+```
+
+or
+
+```ruby
+# spec/support/config/dns_mock.rb
+require 'dns_mock/test_framework/rspec'
+```
+
+#### DnsMock RSpec helper
+
+Just add `DnsMock::TestFramework::RSpec::Helper` if you wanna have shortcut for DnsMock server instance into your RSpec.describe blocks:
+
+```ruby
+# spec/support/config/dns_mock.rb
+RSpec.configure do |config|
+  config.include DnsMock::TestFramework::RSpec::Helper
+end
+```
+
+```ruby
+# your awesome first_a_record_spec.rb
+RSpec.describe FirstARecord do
+  subject(:service) do
+    described_class.call(
+      hostname,
+      dns_gateway_host: 'localhost',
+      dns_gateway_port: dns_mock_server.port
+    )
+  end
+
+  let(:hostname) { 'example.com' }
+  let(:first_a_record) { '1.2.3.4' }
+  let(:records) { { hostname => { a: [first_a_record] } } }
+
+  before { dns_mock_server.assign_mocks(records) }
+
+  it { is_expected.to eq(first_a_record) }
+end
+```
+
+#### DnsMock RSpec interface
+
+If you won't use `DnsMock::TestFramework::RSpec::Helper` you can use `DnsMock::TestFramework::RSpec::Interface` directly instead:
+
+```ruby
+DnsMock::TestFramework::RSpec::Interface.start_server  # creates and runs DnsMock server instance
+DnsMock::TestFramework::RSpec::Interface.stop_server!  # stops current DnsMock server instance
+DnsMock::TestFramework::RSpec::Interface.reset_mocks!  # resets mocks in current DnsMock server instance
+DnsMock::TestFramework::RSpec::Interface.clear_server! # stops and clears current DnsMock server instance
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mocktools/ruby-dns-mock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Please check the [open tikets](https://github.com/mocktools/ruby-dns-mock/issues). Be shure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).

data/lib/dns_mock/test_framework/rspec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require_relative '../../dns_mock'
+require_relative './rspec/interface'
+require_relative './rspec/helper'
+
+RSpec.configure do |config|
+  config.before(:suite) { DnsMock::TestFramework::RSpec::Interface.start_server }
+  config.after(:suite) { DnsMock::TestFramework::RSpec::Interface.stop_server! }
+  config.after { DnsMock::TestFramework::RSpec::Interface.reset_mocks! }
+end

data/lib/dns_mock/test_framework/rspec/helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative './interface'
+
+module DnsMock
+  module TestFramework
+    module RSpec
+      module Helper
+        def dns_mock_server(**options)
+          DnsMock::TestFramework::RSpec::Interface.start_server(**options)
+        end
+      end
+    end
+  end
+end

data/lib/dns_mock/test_framework/rspec/interface.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DnsMock
+  module TestFramework
+    module RSpec
+      module Interface
+        class << self
+          def start_server(**options)
+            @dns_mock_server ||= DnsMock.start_server(**options) # rubocop:disable Naming/MemoizedInstanceVariableName
+          end
+
+          def stop_server!
+            return unless dns_mock_server
+
+            dns_mock_server.stop!
+          end
+
+          def reset_mocks!
+            return unless dns_mock_server
+
+            dns_mock_server.reset_mocks!
+          end
+
+          def clear_server!
+            @dns_mock_server = nil
+          end
+
+          private
+
+          attr_reader :dns_mock_server
+        end
+      end
+    end
+  end
+end

data/lib/dns_mock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DnsMock
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dns_mock
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -298,6 +298,9 @@ files:
 - lib/dns_mock/server.rb
 - lib/dns_mock/server/random_available_port.rb
 - lib/dns_mock/server/records_dictionary_builder.rb
+- lib/dns_mock/test_framework/rspec.rb
+- lib/dns_mock/test_framework/rspec/helper.rb
+- lib/dns_mock/test_framework/rspec/interface.rb
 - lib/dns_mock/version.rb
 homepage: https://github.com/mocktools/ruby-dns-mock
 licenses: