vagrant-registration 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4191a4626a0062ffe74a7e58f3a81ccedec71aed
-  data.tar.gz: 4f804fb385b4b3078f3d1533616a790ab227dc3a
+  metadata.gz: 5986f6c0eaf90532c64bfb1c4ccf4763f8dcd130
+  data.tar.gz: 939849b4c8ddadb8edb6bfcb684faeb4c6e474cf
 SHA512:
-  metadata.gz: 77ecff557286bb6180d7cb2d300b48e6907e6bb361e12d48d2235241c24d391a4c38378e9778a91107576238bbd1b7b310f990b9777332ddf5d91273e73f2754
-  data.tar.gz: 4a199eb7a7d81e568e96c51a44313a4f4d3c1b563c233760f28ffdc0e34d7d3a39f052cfda3df6c24a3e8dd98609ef9acd0ddc99a94dd89a162b748567737974
+  metadata.gz: 05881a0cf219ee185fce48f1d41b92cabdfa9125b4faea4408f124512bc176c3e996723b169d8e458e448d8c02a7f93a06d83b3274cc2fe0625a14e767247a4c
+  data.tar.gz: 75696d5f372a0ef19e0da1a7eea93110693998de0293e502f2beae6b16517d4bd80029a836e891d133e2205ce3b8297d7f92269ce0b24398ad229a14a2fa2f3a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.2.2
+
+- Introducing Cucumber based acceptance tests.
+- Fix: Handling of vagrant-registration action hooks depending on provider used.
+
 ## 1.2.1
 
 - Fix regression: Use sudo when asking on registration managers being present

data/Gemfile

@@ -3,9 +3,17 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
-  gem 'gem-compare'
+  gem 'vagrant',      git: 'https://github.com/mitchellh/vagrant.git'
   gem 'rake'
+  gem 'cucumber', '~> 2.1'
+  gem 'aruba', '~> 0.13'
+  gem 'komenda', '~> 0.1.6'
+  gem 'launchy'
+  gem 'gem-compare'
+  gem 'mechanize'
+  gem 'vagrant-vbguest'
+  gem 'vagrant-libvirt' if RUBY_PLATFORM =~ /linux/i
+  gem 'fog-libvirt', '0.0.3' if RUBY_PLATFORM =~ /linux/i # https://github.com/pradels/vagrant-libvirt/issues/568
 end
 
 group :plugins do

data/README.md

@@ -1,10 +1,30 @@
 # vagrant-registration
 
+<!-- MarkdownTOC -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Plugin Configuration](#plugin-configuration)
+  - [Credentials Configuration](#credentials-configuration)
+  - [subscription-manager Configuration](#subscription-manager-configuration)
+    - [subscription-manager Default Options](#subscription-manager-default-options)
+    - [subscription-manager Options Reference](#subscription-manager-options-reference)
+  - [rhn-register Configuration](#rhn-register-configuration)
+    - [rhn-register Default Options](#rhn-register-default-options)
+    - [rhn-register Options Reference](#rhn-register-options-reference)
+- [Development](#development)
+  - [Tests](#tests)
+    - [Shell script based tests](#shell-script-based-tests)
+    - [Acceptance tests](#acceptance-tests)
+- [Acknowledgements](#acknowledgements)
+
+<!-- /MarkdownTOC -->
+
 vagrant-registration plugin for Vagrant allows developers to easily register their guests for updates on systems with a subscription model (like Red Hat Enterprise Linux).
 
 This plugin would run *register* action on `vagrant up` before any provisioning and *unregister* on `vagrant halt` or `vagrant destroy`. The actions then call the registration capabilities that have to be provided for given OS.
 
-
+<a name="installation"></a>
 ## Installation
 
 Install vagrant-registration as any other Vagrant plugin:
@@ -19,6 +39,7 @@ If you are on Fedora, you can install the packaged version of the plugin by runn
 # dnf install vagrant-registration
 ```
 
+<a name="usage"></a>
 ## Usage
 
 The plugin is designed in an registration-manager-agnostic way which means that plugin itself does not depend on any OS nor way of registration. vagrant-registration only calls registration capabilities for given guest, passes the configuration options to them and handles interactive registration.
@@ -33,6 +54,7 @@ Vagrant.configure('2') do |config|
 end
 ```
 
+<a name="plugin-configuration"></a>
 ### Plugin Configuration
 
 - **skip** skips the registration. If you wish to skip the registration process altogether, you can do so by setting a `skip` option to `true`:
@@ -53,6 +75,7 @@ end
   config.registration.manager = 'subscription_manager'
 ```
 
+<a name="credentials-configuration"></a>
 ### Credentials Configuration
 
 Setting up the credentials can be done as follows:
@@ -96,6 +119,7 @@ If you do not provide credentials, you will be prompted for them in the "up proc
 Please note the the interactive mode asks you for the preferred registration pair only
 of the configured manager.
 
+<a name="subscription-manager-configuration"></a>
 ### subscription-manager Configuration
 
 vagrant-registration will use the `subscription_manager` manager by default or can be explicitly configured by setting the `manager` option to `subscription_manager`:
@@ -118,6 +142,7 @@ You can set any option easily by setting `config.registration.OPTION_NAME = 'OPT
 in your Vagrantfile (please see the subscription-manager's documentation for option
 description).
 
+<a name="subscription-manager-default-options"></a>
 #### subscription-manager Default Options
 
 - **--force**: Subscription Manager will fail if you attempt to register an already registered machine (see the man page for explanation), therefore vagrant-registration appends the `--force` flag automatically when subscribing. If you would like to disable this feature, set `force` option to `false`:
@@ -135,6 +160,7 @@ description).
 
 Note that the `auto_attach` option is set to false when using org/activationkey for registration or if pools are specified.
 
+<a name="subscription-manager-options-reference"></a>
 #### subscription-manager Options Reference
 
 ```ruby
@@ -197,6 +223,7 @@ Note that the `auto_attach` option is set to false when using org/activationkey
   config.registration.pools
 ```
 
+<a name="rhn-register-configuration"></a>
 ### rhn-register Configuration
 
 vagrant-registration will use the `rhn_register` manager only if explicitly configured by setting the `manager` option to `rhn_register`:
@@ -217,6 +244,7 @@ vagrant-registration supports most of the options of rhnreg_ks's command. You ca
 
 `rhn_register` manager reuses the naming of `subscription-manager`'s command options where possible.
 
+<a name="rhn-register-default-options"></a>
 #### rhn-register Default Options
 
 - **--force**: `rhnreg_ks` command will fail if you attempt to register an already registered machine (see the man page for explanation), therefore vagrant-registration appends the `--force` flag automatically when subscribing. If you would like to disable this feature, set `force` option to `false`:
@@ -225,6 +253,7 @@ vagrant-registration supports most of the options of rhnreg_ks's command. You ca
   config.registration.force = false
 ```
 
+<a name="rhn-register-options-reference"></a>
 #### rhn-register Options Reference
 
 ```ruby
@@ -291,7 +320,23 @@ vagrant-registration supports most of the options of rhnreg_ks's command. You ca
   config.registration.skip
 ```
 
-## Tests
+<a name="development"></a>
+## Development
+
+To install a development environment, clone the repo and prepare dependencies by
+
+```
+gem install bundler -v 1.7.5
+bundler install
+```
+
+The use of [RVM|https://rvm.io] is recommended. Verified to work with ruby 2.0.0p643.
+
+<a name="tests"></a>
+### Tests
+
+<a name="shell-script-based-tests"></a>
+#### Shell script based tests
 
 Tests currently test the plugin with `subscription-manager` and  `rhn_register` on RHEL 7.1 guest and Fedora host. You need an imported RHEL 7.1 Vagrant box named `rhel-7.1`.
 
@@ -316,6 +361,37 @@ environment variable on `1` before executing the test script:
 export DEBUG=1
 ```
 
+<a name="acceptance-tests"></a>
+#### Acceptance tests
+
+The source also contains a set of [Cucumber](https://cucumber.io/) acceptance tests. They can be run via:
+
+    $ bundle exec rake features
+
+The tests assume that the CDK box files are available under
+_build/boxes/cdk-\<provider\>.box_. You can either copy the box files manually or
+use the _get_cdk_ Rake task to download them.
+
+Per default only the scenarios for CDK in combination with VirtualBox
+are run. You can also run against Libvirt using the environment variable
+_PROVIDER_:
+
+    # Run tests against Libvirt
+    $ bundle exec rake features  PROVIDER=libvirt
+
+    # Run against VirtualBox and Libvirt
+    $ bundle exec rake features PROVIDER=virtualbox,libvirt
+
+You can also run a single feature specifying the explicit feature file to use:
+
+    $ bundle exec rake features FEATURE=features/<feature-filename>.feature
+
+After test execution the Cucumber test reports can be found under _build/features_report.html_.
+They can also be opened via
+
+    $ bundle exec rake features:open_report
+
+<a name="acknowledgements"></a>
 ## Acknowledgements
 
 The project would like to make sure we thank [purpleidea](https://github.com/purpleidea/), [humaton](https://github.com/humaton/), [strzibny](https://github.com/strzibny), [scollier](https://github.com/scollier/), [puzzle](https://github.com/puzzle), [voxik](https://github.com/voxik), [lukaszachy](https://github.com/lukaszachy), [goern](https://github.com/goern), [iconoeugen](https://github.com/iconoeugen)  and [pvalena](https://github.com/pvalena) (in no particular order) for their contributions of ideas, code and testing for this project.

data/Rakefile

@@ -1,5 +1,14 @@
 require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'cucumber/rake/task'
 require 'yard'
+require 'rubygems/comparator'
+require 'launchy'
+require 'mechanize'
+require 'fileutils'
+
+CLOBBER.include('pkg')
+CLEAN.include('build')
 
 # Documentation
 YARD::Rake::YardocTask.new do |t|
@@ -8,12 +17,22 @@ YARD::Rake::YardocTask.new do |t|
   t.stats_options = ['--list-undoc']
 end
 
-task :clean do
-  `rm -rf pkg`
+task :init do
+  FileUtils.mkdir_p 'build'
+end
+
+# Cucumber acceptance test tasks
+Cucumber::Rake::Task.new(:features)
+task :features => :init
+
+namespace :features do
+  desc 'Opens the HTML Cucumber test report'
+  task :open_report do
+    Launchy.open('./build/features_report.html')
+  end
 end
 
 # Compare latest release with current git head
-require 'rubygems/comparator'
 task compare: [:clean, :build] do
   git_version = VagrantPlugins::Registration::VERSION
   options = {}
@@ -23,3 +42,39 @@ task compare: [:clean, :build] do
   comparator.compare_versions('vagrant-registration', ['_', git_version])
   comparator.print_results
 end
+
+desc 'Download CDK Vagrant box using the specified provider (default \'virtualbox\')'
+task :get_cdk, [:provider] do |t, args|
+  provider = args[:provider].nil? ? 'virtualbox' : args[:provider]
+  agent = Mechanize.new
+  agent.follow_meta_refresh = true
+  agent.get(CDK_DOWNLOAD_URL) do |page|
+
+    # Submit first form which is the redirect to login page form
+    login_page = page.forms.first.submit
+
+    # Submit the login form
+    after_login = login_page.form_with(:name => 'login_form') do |f|
+      username_field = f.field_with(:id => 'username')
+      username_field.value = 'service-manager@mailinator.com'
+      password_field = f.field_with(:id => 'password')
+      password_field.value = 'service-manager'
+    end.click_button
+
+    # There is one more redirect after successful login
+    download_page = after_login.forms.first.submit
+
+    download_page.links.each do |link|
+      if link.href =~ /#{Regexp.quote(CDK_BOX_BASE_NAME)}-#{Regexp.quote(provider)}.box/
+        download_dir = File.join(File.dirname(__FILE__), 'build', 'boxes')
+        unless File.directory?(download_dir)
+          FileUtils.mkdir_p(download_dir)
+        end
+        agent.pluggable_parser.default = Mechanize::Download
+        puts "Downloading #{link.href}"
+        agent.get(link.href).save(File.join(download_dir, "cdk-#{provider}.box"))
+      end
+    end
+  end
+end
+task :get_cdk => :init

data/lib/vagrant-registration/action/register.rb

@@ -11,11 +11,6 @@ module VagrantPlugins
         end
 
         def call(env)
-          # Vbguest plugin (if present) is called next. Therefore registration
-          # needs to be done first. This does not work with the default
-          # 'action_register' hook.
-          @app.call(env) unless Plugin.vbguest_plugin?
-
           # Configuration from Vagrantfile
           config = env[:machine].config.registration
           machine = env[:machine]
@@ -42,7 +37,8 @@ module VagrantPlugins
 
           @logger.debug('Registration is skipped due to the configuration') if config.skip
 
-          @app.call(env) if Plugin.vbguest_plugin?
+          # Call next middleware in chain
+          @app.call(env)
         end
 
         private

data/lib/vagrant-registration/plugin.rb

@@ -15,20 +15,34 @@ module VagrantPlugins
     class Plugin < Vagrant.plugin('2')
       class << self
 
-        # Vbguest plugin updates GuestAdditions for VirtualBox before
-        # '::Vagrant::Action::Builtin::SyncedFolders' and therefore needs
-        # to be registered. Prepending Vbguest hook ensures that, but this
-        # is done only with Vbguest plugin and VirtualBox provider. In other
-        # cases the behavior is unchanged.
+        # vagrant-vbguest plugin updates GuestAdditions for VirtualBox
+        # and therefore needs to be run after the box got registered.
+        # See https://github.com/projectatomic/adb-vagrant-registration/issues/69
+        #
+        # vagrant-vbguest hooks before VagrantPlugins::ProviderVirtualBox::Action::CheckGuestAdditions
+        # (see https://github.com/mitchellh/vagrant/blob/master/plugins/providers/virtualbox/action.rb#L81)
+        # For registration to occur in time, it has to happen before that. Using WaitForCommunicator
+        # to be sure - https://github.com/dotless-de/vagrant-vbguest/blob/master/lib/vagrant-vbguest.rb#L53
+        #
+        # For vagrant-libvirt WaitTillUp is used
         def register(hook)
           setup_logging
 
-          if vbguest_plugin?
-            hook.before(::VagrantVbguest::Middleware,
-                                 VagrantPlugins::Registration::Action.action_register)
-          else
-            hook.after(::Vagrant::Action::Builtin::SyncedFolders,
-                               VagrantPlugins::Registration::Action.action_register)
+          registered = false
+          if virtual_box?
+            hook.after(VagrantPlugins::ProviderVirtualBox::Action::WaitForCommunicator,
+                        VagrantPlugins::Registration::Action.action_register)
+            registered = true
+          end
+          if libvirt?
+            hook.after(VagrantPlugins::ProviderLibvirt::Action::WaitTillUp,
+                      VagrantPlugins::Registration::Action.action_register)
+            registered = true
+          end
+          # Best guess for the other providers
+          unless registered
+            hook.after(Vagrant::Action::Builtin::WaitForCommunicator,
+                      VagrantPlugins::Registration::Action.action_register)
           end
         end
 
@@ -87,12 +101,14 @@ module VagrantPlugins
         end
       end
 
-      # Determines if both VirtualBox provider and Vbguest plugin are present.
-      def self.vbguest_plugin?
-        @@vbguest_plugin ||= (
-          defined?(VagrantPlugins::ProviderVirtualBox::Provider) &&
-          defined?(VagrantVbguest::Middleware)
-        )
+      # Determines if VirtualBox is provider
+      def self.virtual_box?
+        defined?(VagrantPlugins::ProviderVirtualBox::Provider)
+      end
+
+      # Determines if LibVirt is provider
+      def self.libvirt?
+        defined?(VagrantPlugins::ProviderLibvirt::Provider)
       end
     end
   end

data/lib/vagrant-registration/version.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   # Registration plugin to auto-register guests on `vagrant up`
   module Registration
-    VERSION = '1.2.1'
+    VERSION = '1.2.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-registration
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Langdon White
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard