Issue vagrant-landrush#136 Adding basic cucumber/aruba acceptance test

.config/cucumber.yml

@@ -0,0 +1,7 @@
+# config/cucumber.yml
+##YAML Template
+---
+default: --profile html
+
+pretty: --format pretty -b
+html: --format progress --format html --out=build/features_report.html -b

.gitignore

@@ -2,7 +2,6 @@
 .ruby-version
 *.rbc
 .bundle
-.config
 .yardoc
 InstalledFiles
 _yardoc
@@ -13,11 +12,11 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+build
 tmp
 tags
 
 .vagrant
-.vagrant_dns.json
 
 *.iml
 .idea

Gemfile

@@ -24,4 +24,7 @@ group :development do
   gem 'byebug'
   gem 'mocha'
   gem 'minitest'
+  gem 'cucumber', '~> 2.1'
+  gem 'aruba', '~> 0.13'
+  gem 'komenda', '~> 0.1.6'
 end

Gemfile.lock

@@ -30,17 +30,39 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    aruba (0.14.1)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
     ast (2.2.0)
     builder (3.2.2)
     byebug (8.2.1)
     childprocess (0.5.9)
       ffi (~> 1.0, >= 1.0.11)
+    contracts (0.13.0)
+    cucumber (2.3.3)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 3.2.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
     domain_name (0.5.25)
       unf (>= 0.0.5, < 1.0.0)
     erubis (2.7.0)
     eventmachine (1.0.8)
+    events (0.9.8)
     ffi (1.9.10)
     ffi (1.9.10-x64-mingw32)
+    gherkin (3.2.0)
     gssapi (1.2.0)
       ffi (>= 1.0.1)
     gyoku (1.3.1)
@@ -51,6 +73,8 @@ GEM
     httpclient (2.7.1)
     i18n (0.7.0)
     json (1.8.3)
+    komenda (0.1.6)
+      events (~> 0.9.8)
     listen (3.0.5)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
@@ -66,6 +90,7 @@ GEM
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     multi_json (1.11.2)
+    multi_test (0.1.2)
     net-scp (1.1.2)
       net-ssh (>= 2.6.5)
     net-sftp (2.1.2)
@@ -96,6 +121,10 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     rubocop (0.38.0)
       parser (>= 2.3.0.6, < 3.0)
       powerpack (~> 0.1)
@@ -107,6 +136,7 @@ GEM
       eventmachine (~> 1.0.0)
     rubyntlm (0.4.0)
     rubyzip (1.1.7)
+    thor (0.19.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
@@ -134,8 +164,11 @@ PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
+  aruba (~> 0.13)
   byebug
+  cucumber (~> 2.1)
   json
+  komenda (~> 0.1.6)
   landrush!
   minitest
   mocha

README.md

@@ -225,30 +225,39 @@ Check out `vagrant landrush` for additional commands to monitor the DNS server d
 <a name="development"></a>
 ## Development
 
-Install dependencies:
+* Install dependencies:
 
-    bundle install
+        bundle install
 
-Get a list of all available build tasks:
+* Get a list of all available build tasks:
 
-    bundle exec rake -T
+        bundle exec rake -T
 
-Run the test suite:
+* Run the test suite:
 
-    bundle exec rake test
+        bundle exec rake test
 
-Build the Landrush gem:
+* Build the Landrush gem:
 
-    bundle exec rake install
+        bundle exec rake install
 
-Clean generated files:
+* Clean generated files:
 
-    bundle exec rake clobber
+        bundle exec rake clobber
 
-Run the vagrant binary with the Landrush plugin loaded from your local
+* Run cucumber/aruba acceptance tests:
+
+        bundle exec cucumber
+
+  Note, that the acceptance tests currently only work out of the box on OS X.
+  On Linux one has to manually configure the host visibility for the TLD
+  _landrush-acceptance-test_. See for [Linux](#linux). On Windows the acceptance
+  tests won't work due to a current bug in [Aruba](https://github.com/cucumber/aruba/issues/387).
+
+* Run the vagrant binary with the Landrush plugin loaded from your local
 source code:
 
-    bundle exec vagrant landrush <command>
+        bundle exec vagrant landrush <command>
 
 <a name="roadmap"></a>
 ## RoadMap

Rakefile

@@ -3,8 +3,15 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/clean'
 require 'rubocop/rake_task'
+require 'cucumber/rake/task'
+require 'fileutils'
 
-CLOBBER.include('pkg/*')
+CLOBBER.include('pkg')
+CLEAN.include('build')
+
+task :init do
+  FileUtils.mkdir_p 'build'
+end
 
 # Default test task
 Rake::TestTask.new do |t|
@@ -35,3 +42,6 @@ task :generate_diagrams do
 end
 
 RuboCop::RakeTask.new
+
+Cucumber::Rake::Task.new(:features)
+task :features => :init

features/dns_resolution.feature

@@ -0,0 +1,26 @@
+Feature: dns_resolution
+  Landrush should make a virtual machine's IP address DNS-resolvable.
+
+  Scenario Outline: booting a box
+    Given a file named "Vagrantfile" with:
+    """
+    Vagrant.configure('2') do |config|
+      config.vm.box = '<box>'
+      config.vm.hostname = 'my-host.landrush-acceptance-test'
+      config.vm.network :private_network, ip: '10.10.10.123'
+
+      config.vm.synced_folder '.', '/vagrant', disabled: true
+
+      config.landrush.enabled = true
+      config.landrush.tld = 'landrush-acceptance-test'
+    end
+    """
+    When I successfully run `bundle exec vagrant up --provider <provider>`
+    Then the hostname "my-host.landrush-acceptance-test" should resolve to "10.10.10.123" on the internal DNS server
+    And the hostname "my-host.landrush-acceptance-test" should resolve to "10.10.10.123" on the host
+    And the hostname "my-host.landrush-acceptance-test" should resolve to "10.10.10.123" on the guest
+
+    Examples:
+      | box             | provider   |
+      | debian/jessie64 | virtualbox |
+      #| ubuntu/wily64   | virtualbox |

features/step_definitions/dns.rb

@@ -0,0 +1,19 @@
+require 'landrush/server'
+
+Then(/^the hostname "([^"]+)" should resolve to "([^"]+)" on the internal DNS server$/) do |host, ip|
+  port = Landrush::Server.port
+  resolver = Resolv::DNS.new(:nameserver_port => [['localhost', port]], :search => ['local'], :ndots => 1)
+  ip_resolved = resolver.getaddress(host).to_s
+  expect(ip_resolved).to eq(ip)
+end
+
+Then(/^the hostname "([^"]+)" should resolve to "([^"]+)" on the host$/) do |host, ip|
+  addrinfo = Addrinfo.getaddrinfo(host, nil, Socket::AF_INET)
+  ip_resolved = addrinfo.first.ip_address
+  expect(ip_resolved).to eq(ip)
+end
+
+Then(/^the hostname "([^"]+)" should resolve to "([^"]+)" on the guest/) do |host, ip|
+  run("vagrant ssh -c \"dig +short '#{host}' A\"")
+  expect(last_command_started).to have_output(/^#{ip}$/)
+end

features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'komenda'
+
+Aruba.configure do |config|
+  config.exit_timeout = 300
+  config.activate_announcer_on_command_failure = [:stdout, :stderr]
+  config.working_directory = 'build/aruba'
+end
+
+After do |_scenario|
+  Komenda.run('bundle exec vagrant landrush stop', fail_on_fail: true)
+
+  if File.exist?(File.join(aruba.config.working_directory, 'Vagrantfile'))
+    Komenda.run('bundle exec vagrant destroy -f', cwd: aruba.config.working_directory, fail_on_fail: true)
+  end
+end