vagrant-registration 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d0a262191ce340767417bd2f542b36d2e2f866c
-  data.tar.gz: 3e87e116bf9fbe99e0aeeebef4ea150d4b2afab9
+  metadata.gz: 30c4aa8836dba26f3cc2bd37286f4553f0811677
+  data.tar.gz: 5137ad1f5fee66e21228b4e8be7e8c186aa36076
 SHA512:
-  metadata.gz: ea8d8d230c3d3d1960fd518bc6670173f83cca21c62aff7a7c51c4e1d8e79eb3d95a7dc61fab7a2adb1622ba62e2ca434027943ce76604a222db31908dd3e19e
-  data.tar.gz: 03b3a92b92f327c7110bb71739b176f43f7878658b76f26e0b5d61852813b2edda0e64ca49a82e3a7296686f8e6284c6ba6875e8ade2cb13d0da5913f2938de9
+  metadata.gz: fc371bfb460697d54d35ae498ddf36e50a1483d8cc6544aaa2c7e54a93c113458f67e6c9ba528b5cb9454b7b2ff39d78ca64ad1428a9e52a01cfe187d70f2c26
+  data.tar.gz: f35f25302ca53fd14c75503b7c4e4bfe4bc70368065ab5eeafcd766e4d3971cdb0b5d5a6887c90c6efc68f25bcc1e7637706309b3cd537c25125b2431c18e6bf

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.3.0
+
+- Fixed formatting, typo, grammar in README
+- Added MAINTAINERS file
+- Fix #44 allow more than one try to fill username and password
+- Fixes #99 using proxy info to unregister
+- Fix #107 register when passing credentials as env variables
+
 ## 1.2.3
 
 - Issue #90 Use locale based messaging

data/README.md

@@ -21,9 +21,9 @@
 
 <!-- /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).
+The 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.
+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 the given OS.
 
 <a name="installation"></a>
 ## Installation
@@ -43,7 +43,7 @@ If you are on Fedora, you can install the packaged version of the plugin by runn
 <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.
+The plugin is designed in a registration-manager agnostic way, which means, that the plugin itself, depends neither on any OS nor on the way of registration. The vagrant-registration plugin only calls registration capabilities for the given guest, passes the configuration options to them and handles interactive registration.
 
 That being said, this plugin currently ships only with registration capability files for RHEL's Subscription Manager and `rhn_register`. Feel free to submit others.
 
@@ -51,7 +51,7 @@ To configure the plugin, always include the configuration options mentioned in t
 
 ```
 Vagrant.configure('2') do |config|
-...
+  ...
 end
 ```
 
@@ -64,13 +64,13 @@ end
   config.registration.skip = true
 ```
 
-- **unregister_on_halt** disables or enables automatic unregistration on halt (on shut down) so the box will unregister only on destroy. By default the plugin unregisters on halt, you can however change that by setting the option to `false`:
+- **unregister_on_halt** disables or enables automatic unregistration on halt (on shut down). By default the plugin unregisters on halt, you can however change that by setting the option to `false` so that the box will unregister only on destroy:
 
 ```ruby
   config.registration.unregister_on_halt = false
 ```
 
-- **manager** selects the registration manager provider. By default the plugin will use the `subscription_manager` manager, you can however change that by setting the option to a different manager:
+- **manager** selects the registration manager provider. By default the plugin will use the `subscription_manager` as the registration manager provider. You can however, change that by setting the option to a different manager:
 
 ```ruby
   config.registration.manager = 'subscription_manager'
@@ -79,11 +79,11 @@ end
 <a name="credential-configuration"></a>
 ### Credential Configuration
 
-Setting up the credentials can be done as follows:
+You can set up the credentials as follows:
 
 ```ruby
 Vagrant.configure('2') do |config|
-...
+  ...
   if Vagrant.has_plugin?('vagrant-registration')
     config.registration.username = 'foo'
     config.registration.password = 'bar'
@@ -94,7 +94,7 @@ Vagrant.configure('2') do |config|
     config.registration.org = 'foo'
     config.registration.activationkey = 'bar'
   end
-...
+  ...
 end
 ```
 
@@ -104,63 +104,60 @@ later overridden in an individual project's Vagrantfile if needed.
 
 If you prefer not to store your username and/or password on your filesystem,
 you can optionally configure vagrant-registration plugin to use environment
-variables, such as:
+variables such as:
 
 ```ruby
 Vagrant.configure('2') do |config|
-...
+  ...
   config.registration.username = ENV['SUB_USERNAME']
   config.registration.password = ENV['SUB_PASSWORD']
-...
+  ...
 end
 ```
 
-If you do not provide credentials, you will be prompted for them in the "up process."
+If you do not configure your credentials as outlined above, you will receive a maximum of 3 prompts for them during the `vagrant up` process.
 
-Please note the the interactive mode asks you for the preferred registration pair only
-of the configured manager.
+Please note that the interactive mode asks you for the preferred registration pair only for 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:
+HTTP Proxy 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
+can be placed either into the Vagrantfile in the 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`:
+The vagrant-registration plugin uses `subscription_manager` as the default manager. This can also be explicitly configured by setting the `manager` option to `subscription_manager`:
 
 ```ruby
 Vagrant.configure('2') do |config|
-...
+  ...
   if Vagrant.has_plugin?('vagrant-registration')
     config.registration.manager = 'subscription_manager'
   end
-...
+  ...
 end
 ```
 
-In case of `subscription_manager` manager for the preferred registration pair,
-you would be ask on your username/password combination.
+In case you choose `subscription_manager` as the manager, you would be asked for your user credentials, such as the username and password.
 
-vagrant-registration supports all the options of subscription-manager's register command.
+The vagrant-registration plugin supports all the options for the subscription-manager's register command.
 You can set any option easily by setting `config.registration.OPTION_NAME = 'OPTION_VALUE'`
 in your Vagrantfile (please see the subscription-manager's documentation for option
 description).
@@ -263,11 +260,11 @@ vagrant-registration will use the `rhn_register` manager only if explicitly conf
 
 ```ruby
 Vagrant.configure('2') do |config|
-...
+  ...
   if Vagrant.has_plugin?('vagrant-registration')
     config.registration.manager = 'rhn_register'
   end
-...
+  ...
 end
 ```
 
@@ -365,7 +362,7 @@ vagrant-registration supports most of the options of rhnreg_ks's command. You ca
 <a name="development"></a>
 ## Development
 
-To install a development environment, clone the repo and prepare dependencies by
+To install a development environment, clone the repo and prepare dependencies by:
 
 ```
 gem install bundler
@@ -381,27 +378,26 @@ The use of [RVM](https://rvm.io) is recommended. Verified to work with ruby 2.0.
 #### Minitest
 
 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:
+based unit tests. They can be run via:
 
     $ bundle exec rake test
 
 <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:
+The source also contains a set of [Cucumber](https://cucumber.io/) based 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.
+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_:
+As per default, only the scenarios for CDK in combination with VirtualBox
+are run. You can also run the tests against Libvirt, using the environment variable _PROVIDER_:
 
     # Run tests against Libvirt
-    $ bundle exec rake features  PROVIDER=libvirt
+    $ bundle exec rake features PROVIDER=libvirt
 
     # Run against VirtualBox and Libvirt
     $ bundle exec rake features PROVIDER=virtualbox,libvirt
@@ -410,8 +406,8 @@ 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
+After test execution the acceptance test reports can be found under _build/features_report.html_.
+They can also be opened via:
 
     $ bundle exec rake features:open_report
 

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

@@ -5,34 +5,33 @@ module VagrantPlugins
     module Action
       # This registers the guest if the guest plugin supports it
       class Register
+        MAX_REGISTRATION_ATTEMPTS = 3
+
         def initialize(app, _)
           @app    = app
           @logger = Log4r::Logger.new('vagrant_registration::action::register')
         end
 
         def call(env)
+          ui = env[:ui]
           # Configuration from Vagrantfile
           config = env[:machine].config.registration
           machine = env[:machine]
           guest = env[:machine].guest
 
-          if should_register?(machine, env[:ui])
-            env[:ui].info I18n.t('registration.action.register.registration_info')
-            check_configuration_options(machine, env[:ui])
+          if should_register?(machine, ui)
+            ui.info I18n.t('registration.action.register.registration_info')
+            check_configuration_options(machine, ui)
 
-            unless credentials_provided? machine
+            if credentials_provided? machine
+              guest.capability(:registration_register, ui)
+            else
               @logger.debug I18n.t('registration.action.register.no_credentials')
 
               # Offer to register ATM or skip
-              register_now = env[:ui].ask I18n.t('registration.action.register.prompt')
-
-              if register_now == 'n'
-                config.skip = true
-              else
-                config = register_on_screen(machine, env[:ui])
-              end
+              register_now = ui.ask I18n.t('registration.action.register.prompt')
+              process_registration(guest, machine, ui, config) if register_now == 'y'
             end
-            guest.capability(:registration_register, env[:ui]) unless config.skip
           end
 
           @logger.debug(I18n.t('registration.action.register.skip_due_config')) if config.skip
@@ -145,6 +144,40 @@ module VagrantPlugins
           end
           machine.config.registration
         end
+
+        def process_registration(guest, machine, ui, config)
+          attempt_count = 1
+
+          MAX_REGISTRATION_ATTEMPTS.times do
+            config = register_on_screen(machine, ui)
+
+            begin
+              guest.capability(:registration_register, ui)
+              ui.info I18n.t('registration.action.register.registration_success')
+              # break out of loop on successful registration
+              break
+            rescue StandardError => e
+              if attempt_count == MAX_REGISTRATION_ATTEMPTS
+                ui.error e.message
+                exit 126
+              else
+                # reset registration config
+                reset_registration_config(machine)
+                attempt_count += 1
+                ui.info I18n.t('registration.action.register.registration_retry',
+                               attempt_count: attempt_count, max_attempt: MAX_REGISTRATION_ATTEMPTS)
+              end
+            end
+          end
+
+          config
+        end
+
+        def reset_registration_config(machine)
+          credentials_required(machine)[0].each do |option|
+            machine.config.registration.send("#{option}=".to_sym, nil)
+          end
+        end
       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.3'
+    VERSION = '1.3.0'
   end
 end

data/locales/en.yml

@@ -21,6 +21,9 @@ en:
           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'
+        registration_retry: |-
+          Invalid username/password. Try again (%{attempt_count}/%{max_attempt})
+        registration_success: 'Registration successful.'
       unregister:
         unregistration_info: 'Unregistering box with vagrant-registration...'
         skip_due_config: 'Unregistration is skipped due to the configuration'

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

@@ -34,7 +34,7 @@ module VagrantPlugins
 
         # Unregister the machine using 'unregister' option
         def self.subscription_manager_unregister(machine)
-          machine.communicate.sudo('subscription-manager unregister || :')
+          machine.communicate.sudo("subscription-manager unregister #{configuration_to_options_unregister(machine.config.registration)}")
         end
 
         # Return required configuration options for subscription-manager
@@ -114,6 +114,15 @@ module VagrantPlugins
           options.join(' ')
         end
 
+        # Build subscription manager options for unregistering the Vagrant guest
+        def self.configuration_to_options_unregister(config)
+          options = []
+          options << "--proxy='#{config.proxy}'" if config.proxy
+          options << "--proxyuser='#{config.proxyUser}'" if config.proxyUser
+          options << "--proxypassword='#{config.proxyPassword}'" if config.proxyPassword
+          options.join(' ')
+        end
+
         # Attach subscription pools
         def self.attach_pools(machine, pools)
           if pools

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-registration
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Langdon White
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies: []
 description: Enables guests to be registered automatically which is especially useful
   for RHEL or SLES guests.