vagrant-registration 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5986f6c0eaf90532c64bfb1c4ccf4763f8dcd130
-  data.tar.gz: 939849b4c8ddadb8edb6bfcb684faeb4c6e474cf
+  metadata.gz: 7d0a262191ce340767417bd2f542b36d2e2f866c
+  data.tar.gz: 3e87e116bf9fbe99e0aeeebef4ea150d4b2afab9
 SHA512:
-  metadata.gz: 05881a0cf219ee185fce48f1d41b92cabdfa9125b4faea4408f124512bc176c3e996723b169d8e458e448d8c02a7f93a06d83b3274cc2fe0625a14e767247a4c
-  data.tar.gz: 75696d5f372a0ef19e0da1a7eea93110693998de0293e502f2beae6b16517d4bd80029a836e891d133e2205ce3b8297d7f92269ce0b24398ad229a14a2fa2f3a
+  metadata.gz: ea8d8d230c3d3d1960fd518bc6670173f83cca21c62aff7a7c51c4e1d8e79eb3d95a7dc61fab7a2adb1622ba62e2ca434027943ce76604a222db31908dd3e19e
+  data.tar.gz: 03b3a92b92f327c7110bb71739b176f43f7878658b76f26e0b5d61852813b2edda0e64ca49a82e3a7296686f8e6284c6ba6875e8ade2cb13d0da5913f2938de9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.2.3
+
+- Issue #90 Use locale based messaging
+- Issue #65 Adding cucumber tests for proxy settings
+- Issue #65 Adding proxy options to rhn_register and subscription_manager
+- Adding minitest as unit test framework and setting up basic test harness for Vagrant plugins
+- Issue #65 Removing obsolete bash tests
+
 ## 1.2.2
 
 - Introducing Cucumber based acceptance tests.

data/Gemfile

@@ -1,16 +1,26 @@
 source 'https://rubygems.org'
 
-gemspec
-
 group :development do
-  gem 'vagrant',      git: 'https://github.com/mitchellh/vagrant.git'
-  gem 'rake'
+  gem 'vagrant',
+      :git => 'git://github.com/mitchellh/vagrant.git',
+      :ref => 'v1.8.4'
+
+  # test dependencies
+  gem 'minitest'
+  gem 'mocha'
+
   gem 'cucumber', '~> 2.1'
   gem 'aruba', '~> 0.13'
   gem 'komenda', '~> 0.1.6'
   gem 'launchy'
   gem 'gem-compare'
   gem 'mechanize'
+
+  # build tool
+  gem 'rake', '10.4.2'
+  gem 'yard'
+
+  # virtualization providers (for testing)
   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

data/README.md

@@ -4,8 +4,9 @@
 
 - [Installation](#installation)
 - [Usage](#usage)
-  - [Plugin Configuration](#plugin-configuration)
-  - [Credentials Configuration](#credentials-configuration)
+  - [General Configuration](#general-configuration)
+  - [Credential Configuration](#credential-configuration)
+  - [HTTP Proxy Configuration](#http-proxy-configuration)
   - [subscription-manager Configuration](#subscription-manager-configuration)
     - [subscription-manager Default Options](#subscription-manager-default-options)
     - [subscription-manager Options Reference](#subscription-manager-options-reference)
@@ -14,7 +15,7 @@
     - [rhn-register Options Reference](#rhn-register-options-reference)
 - [Development](#development)
   - [Tests](#tests)
-    - [Shell script based tests](#shell-script-based-tests)
+    - [Minitest](#minitest)
     - [Acceptance tests](#acceptance-tests)
 - [Acknowledgements](#acknowledgements)
 
@@ -54,8 +55,8 @@ Vagrant.configure('2') do |config|
 end
 ```
 
-<a name="plugin-configuration"></a>
-### Plugin Configuration
+<a name="general-configuration"></a>
+### General 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`:
 
@@ -75,8 +76,8 @@ end
   config.registration.manager = 'subscription_manager'
 ```
 
-<a name="credentials-configuration"></a>
-### Credentials Configuration
+<a name="credential-configuration"></a>
+### Credential Configuration
 
 Setting up the credentials can be done as follows:
 
@@ -119,10 +120,32 @@ 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="http-proxy-configuration"></a>
+### HTTP Proxy Configuration
+
+HTTP Proxies can be configured via the _proxy_, _proxyUser_ and _proxyPassword_ configuration options:
+
+```ruby
+Vagrant.configure('2') do |config|
+...
+  if Vagrant.has_plugin?('vagrant-registration')
+    config.registration.proxy = 'mongo:8080'
+    config.registration.proxyUser = 'flash'
+    config.registration.proxyPassword = 'zarkov'
+  end
+...
+end
+```
+
+As described in the [credentials configuration](#credentials-configuration) section, these settings
+can also either be placed into the Vagrantfile in your Vagrant home directory or provided as
+environment variables.
+
 <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`:
+vagrant-registration will use the `subscription_manager` manager by default or can be explicitly
+configured by setting the `manager` option to `subscription_manager`:
 
 ```ruby
 Vagrant.configure('2') do |config|
@@ -158,7 +181,8 @@ description).
   config.registration.auto_attach = false
 ```
 
-Note that the `auto_attach` option is set to false when using org/activationkey for registration or if pools are specified.
+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
@@ -216,6 +240,15 @@ Note that the `auto_attach` option is set to false when using org/activationkey
   # Skip the registration (optional, skip if true, defaults to false)
   config.registration.skip
 
+  # Specify a HTTP proxy to use. This config option if of the format [<host>|<ip>:<port>], eg mongo:8080
+  config.registration.proxy
+
+  # Specify a username to use with an authenticated HTTP proxy
+  config.registration.proxyUser
+
+  # Specify a password to use with an authenticated HTTP proxy
+  config.registration.proxyPassword
+
   # Attach to specified pool(s) (optional)
   #
   # Example:
@@ -318,6 +351,15 @@ vagrant-registration supports most of the options of rhnreg_ks's command. You ca
 
   # Skip the registration (optional, skip if true, defaults to false)
   config.registration.skip
+
+  # Specify a HTTP proxy to use. This config option if of the format [<host>|<ip>:<port>], eg mongo:8080
+  config.registration.proxy
+
+  # Specify a username to use with an authenticated HTTP proxy
+  config.registration.proxyUser
+
+  # Specify a password to use with an authenticated HTTP proxy
+  config.registration.proxyPassword
 ```
 
 <a name="development"></a>
@@ -326,40 +368,22 @@ vagrant-registration supports most of the options of rhnreg_ks's command. You ca
 To install a development environment, clone the repo and prepare dependencies by
 
 ```
-gem install bundler -v 1.7.5
+gem install bundler
 bundler install
 ```
 
-The use of [RVM|https://rvm.io] is recommended. Verified to work with ruby 2.0.0p643.
+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`.
+<a name="minitest"></a>
+#### Minitest
 
-To run them:
+The source contains a set of [Minitest](http://ruby-doc.org/stdlib-2.0.0/libdoc/minitest/rdoc/MiniTest.html)
+unit tests. They can be run via:
 
-```
-export VAGRANT_REGISTRATION_MANAGER=
-export VAGRANT_REGISTRATION_USERNAME=
-export VAGRANT_REGISTRATION_PASSWORD=
-export VAGRANT_REGISTRATION_ORG=
-export VAGRANT_REGISTRATION_ACTIVATIONKEY=
-export VAGRANT_REGISTRATION_SERVERURL=
-export VAGRANT_REGISTRATION_CA_CERT=
-./tests/run.sh
-./tests/run_rhn_register.sh
-```
-
-To show the Vagrant output on the console during the tests run, set the `DEBUG`
-environment variable on `1` before executing the test script:
-
-```
-export DEBUG=1
-```
+    $ bundle exec rake test
 
 <a name="acceptance-tests"></a>
 #### Acceptance tests

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake/clean'
+require 'rake/testtask'
 require 'cucumber/rake/task'
 require 'yard'
 require 'rubygems/comparator'
@@ -21,6 +22,13 @@ task :init do
   FileUtils.mkdir_p 'build'
 end
 
+# Default test task
+desc 'Run all unit tests'
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test'
+end
+
 # Cucumber acceptance test tasks
 Cucumber::Rake::Task.new(:features)
 task :features => :init

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

@@ -17,14 +17,14 @@ module VagrantPlugins
           guest = env[:machine].guest
 
           if should_register?(machine, env[:ui])
-            env[:ui].info('Registering box with vagrant-registration...')
+            env[:ui].info I18n.t('registration.action.register.registration_info')
             check_configuration_options(machine, env[:ui])
 
             unless credentials_provided? machine
-              @logger.debug('Credentials for registration not provided')
+              @logger.debug I18n.t('registration.action.register.no_credentials')
 
               # Offer to register ATM or skip
-              register_now = env[:ui].ask('Would you like to register the system now (default: yes)? [y|n]')
+              register_now = env[:ui].ask I18n.t('registration.action.register.prompt')
 
               if register_now == 'n'
                 config.skip = true
@@ -35,7 +35,7 @@ module VagrantPlugins
             guest.capability(:registration_register, env[:ui]) unless config.skip
           end
 
-          @logger.debug('Registration is skipped due to the configuration') if config.skip
+          @logger.debug(I18n.t('registration.action.register.skip_due_config')) if config.skip
 
           # Call next middleware in chain
           @app.call(env)
@@ -59,8 +59,8 @@ module VagrantPlugins
           options = machine.config.registration.conf.each_pair.map { |pair| pair[0] }
 
           if unsupported_options_provided?(manager, available_options, options, ui)
-            ui.warn("WARNING: #{manager} supports only the following options:" \
-                    "\nWARNING: #{available_options.join(', ')}")
+            ui.warn(I18n.t('registration.action.register.options_support_warning',
+                           manager: manager, options: available_options.join(', ')))
           end
         end
 
@@ -69,7 +69,8 @@ module VagrantPlugins
           warned = false
           options.each do |option|
             unless available_options.include? option
-              ui.warn("WARNING: #{option} option is not supported for #{manager}")
+              ui.warn(I18n.t('registration.action.register.unsupported_option',
+                             manager: manager, option: option))
               warned = true
             end
           end
@@ -83,7 +84,7 @@ module VagrantPlugins
              guest.capability?(:registration_registered?)
             true
           else
-            @logger.debug('Registration is skipped due to the missing guest capability')
+            @logger.debug I18n.t('registration.action.register.skip_missing_guest_capability')
             false
           end
         end
@@ -93,7 +94,7 @@ module VagrantPlugins
           if guest.capability(:registration_manager_installed, ui)
             true
           else
-            @logger.debug('Registration manager not found on guest')
+            @logger.debug I18n.t('registration.action.manager_not_found')
             false
           end
         end

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

@@ -15,17 +15,17 @@ module VagrantPlugins
           guest = env[:machine].guest
 
           if capabilities_provided?(guest) && manager_installed?(guest, env[:ui]) && !config.skip
-            env[:ui].info('Unregistering box with vagrant-registration...')
+            env[:ui].info I18n.t('registration.action.unregister.unregistration_info')
             guest.capability(:registration_unregister)
           end
 
-          @logger.debug('Unregistration is skipped due to the configuration') if config.skip
+          @logger.debug(I18n.t('registration.action.unregister.skip_due_config')) if config.skip
           @app.call(env)
 
         # Guest might not be available after halting, so log the exception and continue
         rescue => e
           @logger.info(e)
-          @logger.debug('Guest is not available, ignore unregistration')
+          @logger.debug I18n.t('registration.action.unregister.guest_unavailable')
           @app.call(env)
         end
 
@@ -36,7 +36,7 @@ module VagrantPlugins
           if guest.capability?(:registration_unregister) && guest.capability?(:registration_manager_installed)
             true
           else
-            @logger.debug('Unregistration is skipped due to the missing guest capability')
+            @logger.debug I18n.t('registration.action.unregister.skip_missing_guest_capability')
             false
           end
         end
@@ -46,7 +46,7 @@ module VagrantPlugins
           if guest.capability(:registration_manager_installed, ui)
             true
           else
-            @logger.debug('Registration manager not found on guest')
+            @logger.debug I18n.t('registration.action.manager_not_found')
             false
           end
         end

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

@@ -15,18 +15,18 @@ module VagrantPlugins
           guest = env[:machine].guest
 
           if capabilities_provided?(guest) && manager_installed?(guest, env[:ui]) && !config.skip && config.unregister_on_halt
-            env[:ui].info('Unregistering box with vagrant-registration...')
+            env[:ui].info I18n.t('registration.action.unregister.unregistration_info')
             guest.capability(:registration_unregister)
           end
 
-          @logger.debug('Unregistration is skipped due to the configuration') if config.skip
-          @logger.debug('Unregistration is skipped on halt due to the configuration') unless config.unregister_on_halt
+          @logger.debug(I18n.t('registration.action.unregister.skip_due_config')) if config.skip
+          @logger.debug(I18n.t('registration.action.unregister.skip_on_halt_due_config')) unless config.unregister_on_halt
           @app.call(env)
 
         # Guest might not be available after halting, so log the exception and continue
         rescue => e
           @logger.info(e)
-          @logger.debug('Guest is not available, ignore unregistration')
+          @logger.debug I18n.t('registration.action.unregister.guest_unavailable')
           @app.call(env)
         end
 
@@ -37,7 +37,7 @@ module VagrantPlugins
           if guest.capability?(:registration_unregister) && guest.capability?(:registration_manager_installed)
             true
           else
-            @logger.debug('Unregistration is skipped due to the missing guest capability')
+            @logger.debug I18n.t('registration.action.unregister.skip_missing_guest_capability')
             false
           end
         end
@@ -47,7 +47,7 @@ module VagrantPlugins
           if guest.capability(:registration_manager_installed, ui)
             true
           else
-            @logger.debug('Registration manager not found on guest')
+            @logger.debug I18n.t('registration.action.manager_not_found')
             false
           end
         end

data/lib/vagrant-registration/config.rb

@@ -16,13 +16,13 @@ module VagrantPlugins
         @conf.skip = false unless @conf.skip
         # Unregister on halt by default
         @conf.unregister_on_halt = true if @conf.unregister_on_halt.nil?
-        @logger.info "Final registration configuration: #{@conf.inspect}"
+        @logger.info I18n.t('registration.config.final_message', conf: @conf.inspect)
       end
 
       def method_missing(method_sym, *arguments, &block)
         get_config
         command = "@conf.#{method_sym} #{adjust_arguments(arguments)}"
-        @logger.info "Evaluating registration configuration: #{command}"
+        @logger.info I18n.t('registration.config.method_missing_command', command: command)
         eval command
       end
 

data/lib/vagrant-registration/plugin.rb

@@ -7,14 +7,13 @@ end
 # This is a sanity check to make sure no one is attempting to install
 # this into an early Vagrant version.
 if Vagrant::VERSION < '1.2.0'
-  fail 'The Vagrant RHEL plugin is only compatible with Vagrant 1.2+.'
+  fail I18n.t('registration.plugin.compatible_message')
 end
 
 module VagrantPlugins
   module Registration
     class Plugin < Vagrant.plugin('2')
       class << self
-
         # 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
@@ -57,11 +56,8 @@ module VagrantPlugins
         end
       end
 
-      name 'Registration'
-      description <<-DESC
-      This plugin adds register and unregister functionality to Vagrant Guests that
-      support the capability
-      DESC
+      name I18n.t('registration.plugin.name')
+      description I18n.t('registration.plugin.description')
 
       action_hook(:registration_register, :machine_action_up, &method(:register))
       action_hook(:registration_register, :machine_action_provision, &method(:register))

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.2'
+    VERSION = '1.2.3'
   end
 end

data/lib/vagrant-registration.rb

@@ -13,5 +13,7 @@ module VagrantPlugins
 
     # Temporally load the extra capability files for Red Hat
     load(File.join(source_root, 'plugins/guests/redhat/plugin.rb'))
+    # Default I18n to load the en locale
+    I18n.load_path << File.expand_path('locales/en.yml', source_root)
   end
 end

data/locales/en.yml

@@ -0,0 +1,29 @@
+en:
+  registration:
+    config:
+      final_message: 'Final registration configuration: %{conf}'
+      method_missing_command: 'Evaluating registration configuration: %{command}'
+    plugin:
+      compatible_message: 'The Vagrant RHEL plugin is only compatible with Vagrant 1.2+.'
+      name: 'Registration'
+      description: |-
+        This plugin adds register and unregister functionality to Vagrant Guests that
+        support the capability
+    action:
+      manager_not_found: 'Registration manager not found on guest'
+      register:
+        registration_info: 'Registering box with vagrant-registration...'
+        no_credentials: 'Credentials for registration not provided'
+        prompt: 'Would you like to register the system now (default: yes)? [y|n]'
+        skip_due_config: 'Registration is skipped due to the configuration'
+        options_support_warning: |-
+          WARNING: %{manager} supports only the following options:
+          WARNING: %{options}"
+        unsupported_option: "WARNING: %{option} option is not supported for %{manager}"
+        skip_missing_guest_capability: 'Registration is skipped due to the missing guest capability'
+      unregister:
+        unregistration_info: 'Unregistering box with vagrant-registration...'
+        skip_due_config: 'Unregistration is skipped due to the configuration'
+        skip_on_halt_due_config: 'Unregistration is skipped on halt due to the configuration'
+        guest_unavailable: 'Guest is not available, ignore unregistration'
+        skip_missing_guest_capability: 'Unregistration is skipped due to the missing guest capability'

data/plugins/guests/redhat/cap/rhn_register.rb

@@ -61,7 +61,7 @@ module VagrantPlugins
         def self.rhn_register_options(machine)
           [:name, :username, :password, :org, :serverurl, :ca_cert,
            :activationkey, :use_eus_channel, :nohardware, :nopackages,
-           :novirtinfo, :norhnsd, :force]
+           :novirtinfo, :norhnsd, :force, :proxy, :proxyUser, :proxyPassword]
         end
 
         # Return secret options for rhreg_ks
@@ -131,6 +131,9 @@ module VagrantPlugins
           options << '--novirtinfo' if config.novirtinfo
           options << '--norhnsd' if config.norhnsd
           options << '--force' if config.force
+          options << "--proxy='#{config.proxy}'" if config.proxy
+          options << "--proxyUser='#{config.proxyUser}'" if config.proxyUser
+          options << "--proxyPassword='#{config.proxyPassword}'" if config.proxyPassword
           options.join(' ')
         end
       end

data/plugins/guests/redhat/cap/subscription_manager.rb

@@ -49,7 +49,7 @@ module VagrantPlugins
         def self.subscription_manager_options(machine)
           [:username, :password, :serverurl, :baseurl, :org, :environment,
            :name, :auto_attach, :activationkey, :servicelevel, :release,
-           :force, :type, :ca_cert, :pools]
+           :force, :type, :ca_cert, :pools, :proxy, :proxyUser, :proxyPassword]
         end
 
         # Return secret options for subscription-manager
@@ -108,6 +108,9 @@ module VagrantPlugins
           options << "--release='#{config.release}'" if config.release
           options << '--force' if config.force
           options << "--type='#{config.type}'" if config.type
+          options << "--proxy='#{config.proxy}'" if config.proxy
+          options << "--proxyuser='#{config.proxyUser}'" if config.proxyUser
+          options << "--proxypassword='#{config.proxyPassword}'" if config.proxyPassword
           options.join(' ')
         end
 

data/vagrant-registration.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   all_files      = Dir.chdir(root_path) do
     Dir.glob('lib/**/{*,.*}') +
     Dir.glob('plugins/**/{*,.*}') +
+    Dir.glob('locales/**/{*,.*}') +
     Dir.glob('resources/**/{*,.*}') +
     ['Rakefile', 'Gemfile', 'README.md', 'CHANGELOG.md', 'LICENSE.md', 'vagrant-registration.gemspec']
   end
@@ -49,6 +50,4 @@ Gem::Specification.new do |s|
   s.files         = unignored_files
   s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
   s.require_path  = 'lib'
-
-  s.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-registration
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Langdon White
@@ -10,22 +10,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2016-07-26 00:00:00.000000000 Z
+dependencies: []
 description: Enables guests to be registered automatically which is especially useful
   for RHEL or SLES guests.
 email:
@@ -48,6 +34,7 @@ files:
 - lib/vagrant-registration/config.rb
 - lib/vagrant-registration/plugin.rb
 - lib/vagrant-registration/version.rb
+- locales/en.yml
 - plugins/guests/redhat/cap/registration.rb
 - plugins/guests/redhat/cap/rhn_register.rb
 - plugins/guests/redhat/cap/subscription_manager.rb