vagrant-registration 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3a6618588af63c7852552cbf4e5ce79ab13d36a
-  data.tar.gz: d3199ceda69643937bab2a8ba6266948a2ac601a
+  metadata.gz: 7d50591b44df73fbaf5754f6a5ad19b2d42116ab
+  data.tar.gz: f0414f8fa9bda6a5a74cefbd96f4c6315c888cb1
 SHA512:
-  metadata.gz: 6af730ec5035dbcc216a0996f7761c7ef42883ca1f882614911a64c07a3e3b53909edf7ab411bfbc37e54467c9cb89eb36025fb9ad10553c0200cdb68a0dddfa
-  data.tar.gz: 1dc370d37eb666c81f4c0f0b0cd1c606a46d825e0ddf9b6593b8197e0638541453334a351e8cbc398d7a8e3a8deea34e3ed33c82dc4d76c9054f9703add13761
+  metadata.gz: bfac4d465549f33f0798691dc2e7569d372b3bca7a6983f6fc373854cf5268f24dc8f50c86f5b4cef30a509cbbb0f638c1bd48afedc8f5531cc996b1352fdc01
+  data.tar.gz: ff6e8aab4cbb1882dfe7bd62168d42f39f03c3a744fff7155258f06ae40c8eb1cfb7a71aa08c51963ab99d49758c5432b461c46baa55f6887547f7d4fd9ac13d

data/README.md

@@ -1,14 +1,14 @@
 # vagrant-registration
 
-The vagrant-registration plugin supports new capabilities "register" and "unregister." The "register" event occurs during the "up" process, immediately after startup but before any provisioning (including built-in like rsync). The "unregister" event occurs during the "halt" process (which also is called during the "destroy" process) immediately before the instances goes down.
-
-This allows developers to easily register their guests that use subscription model for updates, like Red Hat Enterprise Linux.
+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.
 
 
 ## Installation
 
-Install as any other Vagrant plugin:
+Install vagrant-registration as any other Vagrant plugin:
 
 ```ruby
 vagrant plugin install vagrant-registration
@@ -16,9 +16,20 @@ vagrant plugin install vagrant-registration
 
 ## 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.
+
+That being said, this plugin currently ships only with registration capability files for RHEL's Subscription Manager. Feel free to submit others.
+
 *Note:* This plugin is still alpha. Please help us to find and fix any bugs.
 
-- Only RHEL Subscription Manager is currectly supported.
+### Plugin Configuration
+
+- **skip**: If you wish to skip the registration process altogether, you can do so by setting a `skip` option to `true`:
+
+```ruby
+  config.registration.skip = true
+```
 
 ### subscription-manager Configuration
 
@@ -30,8 +41,10 @@ description).
 Setting up the credentials can be done as follows:
 
 ```ruby
-    config.registration.username = 'foo'
-    config.registration.password = 'bar'
+if Vagrant.has_plugin?('vagrant-registration')
+  config.registration.username = 'foo'
+  config.registration.password = 'bar'
+end
 ```
 
 This should go, preferably, into the Vagrantfile in your Vagrant home directory
@@ -43,22 +56,79 @@ you can optionally configure vagrant-registration plugin to use environment
 variables, such as:
 
 ```ruby
-    config.registration.username = ENV['SUB_USERNAME']
-    config.registration.password = ENV['SUB_PASSWORD']
+  config.registration.username = ENV['SUB_USERNAME']
+  config.registration.password = ENV['SUB_PASSWORD']
 ```
 
-If you do not provide credentials, you will be prompted for them in the "up process". However, this is a tentative feature because if you are launching more than one VM from one Vagrantfile, the feature acts unexepectedly (appearing to hang because the prompt for creds gets lost in the scrollback). 
+If you do not provide credentials, you will be prompted for them in the "up process."
+
+#### 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`:
+
+```ruby
+  config.registration.force = false
+```
+- **--auto-attach**: Vagrant would fail to install packages on registered RHEL system if the subscription is not attached, therefore vagrant-registration appends the
+`--auto-attach` flag automatically when subscribing. To disable this option, set `auto_attach` option to `false`:
 
-You can also skip the registration process altogether by setting a `skip` option
-to `true`:
 
 ```ruby
-    config.registration.skip = true
+  config.registration.auto_attach = false
 ```
 
-*Note:* RHEL Subscription Manager will fail if you attempt to register an already registered machine (see man page for explanation). Not to slow the boot time, vagrant-registration appends the "--force" flag when subscribing. If you would like to disable this feature, set `force` option to `false`:
+#### subscription-manager Options Reference
 
 ```ruby
-    config.registration.force = false 
+  # The username to subscribe with (required)
+  config.registration.username
+
+  # The password of the subscriber (required)
+  config.registration.password
+
+  # Give the hostname of the subscription service to use (required for Subscription
+  # Asset Manager, defaults to Customer Portal Subscription Management)
+  config.registration.serverurl
+
+  # Give the hostname of the content delivery server to use to receive updates
+  # (required for Satellite 6)
+  config.registration.baseurl
+
+  # Give the organization to which to join the system (required, except for
+  # hosted environments)
+  config.registration.org
+
+  # Register the system to an environment within an organization (optional)
+  config.registration.environment
+
+  # Name of the subscribed system (optional, defaults to hostname if unset)
+  config.registration.name
+
+  # Auto attach suitable subscriptions (optional, auto attach if true,
+  # defaults to true)
+  config.registration.auto_attach
+
+  # Attach existing subscriptions as part of the registration process (optional)
+  config.registration.activationkey
+
+  # Set the service level to use for subscriptions on that machine
+  # (optional, used only used with the --auto-attach)
+  config.registration.servicelevel
+
+  # Set the operating system minor release to use for subscriptions for
+  # the system (optional, used only used with the --auto-attach)
+  config.registration.release
+
+  # Force the registration (optional, force if true, defaults to true)
+  config.registration.force
+
+  # Set what type of consumer is being registered (optional, defaults to system)
+  config.registration.type
+
+  # Skip the registration (optional, skip if true, defaults to false)
+  config.registration.skip
 ```
 
+## 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) and [goern](https://github.com/goern) (in no particular order) for their contributions of ideas, code and testing for this project.

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require 'yard'
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'plugins/**/*.rb']
+  t.options = []
+  t.stats_options = ['--list-undoc']
+end

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

@@ -5,7 +5,6 @@ module VagrantPlugins
     module Action
       # This registers the guest if the guest plugin supports it
       class Register
-
         def initialize(app, env)
           @app    = app
           @logger = Log4r::Logger.new("vagrant_registration::action::register")
@@ -13,56 +12,92 @@ module VagrantPlugins
 
         def call(env)
           @app.call(env)
+
+          # Configuration from Vagrantfile
           config = env[:machine].config.registration
+          machine = env[:machine]
           guest = env[:machine].guest
-          @logger.info("Testing for registration_register capability on ")
 
-          if guest.capability?(:register) && guest.capability?(:subscription_manager)
+          if capabilities_provided?(guest) && manager_installed?(guest) && !config.skip
+            env[:ui].info("Registering box with vagrant-registration...")
+
+            unless credentials_provided? machine
+              @logger.debug("Credentials for registration not provided")
 
-            unless guest.capability(:subscription_manager)
-              config.skip=true
-              @logger.info("subscription-manager not found on guest")
+              # Offer to register ATM or skip
+              register_now = env[:ui].ask("Would you like to register the system now (default: yes)? [y|n] ")
+
+              if register_now == 'n'
+                config.skip = true
+              else
+                config = register_on_screen(machine, env[:ui])
+              end
             end
+            guest.capability(:registration_register) unless config.skip
+          end
 
-            unless config.skip
-              env[:ui].info("Registering box with vagrant-registration...")
+          @logger.debug("Registration is skipped due to the configuration") if config.skip
+        end
 
-              # Check if credentials are provided, ask user if not
-              unless credentials_provided? config
-                @logger.debug("credentials for registration not provided")
+        private
 
-                # Offer to register ATM or skip
-                register_now = env[:ui].ask("Would you like to register the system now (default: yes)? [y|n] ")
+        # Check if registration capabilities are available
+        def capabilities_provided?(guest)
+          if guest.capability?(:registration_register) && guest.capability?(:registration_manager_installed)
+            true
+          else
+            @logger.debug("Registration is skipped due to the missing guest capability")
+            return false
+          end
+        end
 
-                if register_now == 'n'
-                  config.skip = true
-                # Accept anything else as default
-                else
-                  config.username, config.password = register_on_screen(env[:ui])
-                end
-              end
-              @logger.info("Registration is forced") if config.force
-              result = guest.capability(:register) unless config.skip
-            else
-              @logger.debug("registration skipped due to configuration")
-            end
+        # Check if selected registration manager is installed
+        def manager_installed?(guest)
+          if guest.capability(:registration_manager_installed)
+            true
           else
-            @logger.debug("registration skipped due to missing guest capability")
+            @logger.debug("Registration manager not found on guest")
+            false
           end
         end
 
-        private
+        # Fetch required credentials for selected manager
+        def credentials_required(machine)
+          if machine.guest.capability?(:registration_credentials)
+            machine.guest.capability(:registration_credentials)
+          else
+            []
+          end
+        end
+
+        # Secret options for selected manager
+        def secrets(machine)
+          if machine.guest.capability?(:registration_secrets)
+            machine.guest.capability(:registration_secrets)
+          else
+            []
+          end
+        end
 
-        # Ask user on username/password and return them
-        def register_on_screen(ui)
-          username = ui.ask("Subscriber username: ")
-          password = ui.ask("Subscriber password: ", echo: false)
-          [username, password]
+        # Check if required credentials has been provided in Vagrantfile
+        def credentials_provided?(machine)
+          credentials_required(machine).each do |option|
+            return false unless machine.config.registration.send option
+          end
+          true
         end
 
-        # Check if username and password has been provided in Vagrantfile
-        def credentials_provided?(config)
-          config.username && config.password
+        # Ask user on required credentials and return them,
+        # skip options that are provided by Vagrantfile
+        def register_on_screen(machine, ui)
+          credentials_required(machine).each do |option|
+            unless machine.config.registration.send(option)
+              echo = !(secrets(machine).include? option)
+              response = ui.ask("#{option}: ", echo: echo)
+              machine.config.registration.send("#{option.to_s}=".to_sym, response)
+            end
+          end
+          machine.config.registration
         end
       end
     end

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

@@ -3,38 +3,53 @@ require "log4r"
 module VagrantPlugins
   module Registration
     module Action
-      # This unregisters the guest if the guest plugin supports it
+      # This unregisters the guest if the guest has registration capability
       class Unregister
-
         def initialize(app, env)
           @app    = app
           @logger = Log4r::Logger.new("vagrant_registration::action::unregister")
         end
 
         def call(env)
+          config = env[:machine].config.registration
           guest = env[:machine].guest
 
-          if guest.capability?(:unregister) && guest.capability?(:subscription_manager)
-            if !env[:machine].config.registration.skip
-              env[:ui].info("Unregistering box with vagrant-registration...")
-              @logger.info("registration_unregister capability exists on ")
-              result = guest.capability(:unregister)
-              @logger.info("called registration_unregister capability on ")
-            else
-              @logger.debug("unregistration is skipped due to configuration")
-            end
-          else
-            @logger.debug("unregistration is skipped due to missing guest capability")
+          if capabilities_provided?(guest) && manager_installed?(guest) && !config.skip
+            env[:ui].info("Unregistering box with vagrant-registration...")
+            guest.capability(:registration_unregister)
           end
 
+          @logger.debug("Unregistration is skipped due to the configuration") 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("Guest is not available, ignore unregistration")
           @app.call(env)
         end
+
+        private
+
+        # Check if registration capabilities are available
+        def capabilities_provided?(guest)
+          if guest.capability?(:registration_unregister) && guest.capability?(:registration_manager_installed)
+            true
+          else
+            @logger.debug("Unregistration is skipped due to the missing guest capability")
+            return false
+          end
+        end
+
+        # Check if selected registration manager is installed
+        def manager_installed?(guest)
+          if guest.capability(:registration_manager_installed)
+            true
+          else
+            @logger.debug("Registration manager not found on guest")
+            false
+          end
+        end
       end
     end
   end

data/lib/vagrant-registration/config.rb

@@ -1,122 +1,31 @@
 require "vagrant"
+require "ostruct"
 
 module VagrantPlugins
   module Registration
     class Config < Vagrant.plugin("2", :config)
-      # The username to subscribe with (required)
-      #
-      # @return [String]
-      attr_accessor :username
-      attr_accessor :subscriber_username # to stay backwards compatible
-
-      # The password of the subscriber (required)
-      #
-      # @return [String]
-      attr_accessor :password
-      attr_accessor :subscriber_password # to stay backwards compatible
-
-      # Give the hostname of the subscription service to use (required for Subscription
-      # Asset Manager, defaults to Customer Portal Subscription Management)
-      #
-      # @return [String]
-      attr_accessor :serverurl
-
-      # Give the hostname of the content delivery server to use to receive updates
-      # (required for Satellite 6)
-      #
-      # @return [String]
-      attr_accessor :baseurl
-
-      # Give the organization to which to join the system (required, except for
-      # hosted environments)
-      #
-      # @return [String]
-      attr_accessor :org
-
-      # Register the system to an environment within an organization (optional)
-      #
-      # @return [String]
-      attr_accessor :environment
-
-      # Name of the subscribed system (optional, defaults to hostname if unset)
-      #
-      # @return [String]
-      attr_accessor :name
-
-      # Auto attach suitable subscriptions (optional, auto attach if true)
-      #
-      # @return [Bool]
-      attr_accessor :auto_attach
-
-      # Attach existing subscriptions as part of the registration process (optional)
-      #
-      # @return [String]
-      attr_accessor :activationkey
-
-      # Set the service level to use for subscriptions on that machine
-      # (optional, used only used with the --auto-attach)
-      #
-      # @return [String]
-      attr_accessor :servicelevel
-
-      # Set the operating system minor release to use for subscriptions for
-      # the system (optional, used only used with the --auto-attach)
-      #
-      # @return [String]
-      attr_accessor :release
-
-      # Force the registration (optional, force if true, defaults to true)
-      #
-      # @return [Bool]
-      attr_accessor :force
-
-      # Set what type of consumer is being registered (optional, defaults to system)
-      #
-      # @return [String]
-      attr_accessor :type
-
-      # Skip the registration (optional, skip if true, defaults to false)
-      #
-      # @return [Bool]
-      attr_accessor :skip
-
       def initialize(region_specific=false)
-        @username = UNSET_VALUE
-        @subscriber_username = UNSET_VALUE
-        @password = UNSET_VALUE
-        @subscriber_password = UNSET_VALUE
-        @serverurl = UNSET_VALUE
-        @baseurl = UNSET_VALUE
-        @org = UNSET_VALUE
-        @environment = UNSET_VALUE
-        @name = UNSET_VALUE
-        @auto_attach = true
-        @activationkey = UNSET_VALUE
-        @servicelevel = UNSET_VALUE
-        @release = UNSET_VALUE
-        @force = true
-        @type = UNSET_VALUE
-        @skip = UNSET_VALUE
+        @conf = OpenStruct.new
+        @logger = Log4r::Logger.new("vagrant_registration::config")
       end
 
       def finalize!
-        @username = @subscriber_username if @username == UNSET_VALUE
-        @password = @subscriber_password if @password == UNSET_VALUE
-        @username = nil if @username == UNSET_VALUE
-        @password = nil if @password == UNSET_VALUE
-        @serverurl = nil if @serverurl = UNSET_VALUE
-        @baseurl = nil if @baseurl = UNSET_VALUE
-        @org = nil if @org = UNSET_VALUE
-        @environment = nil if @environment = UNSET_VALUE
-        @name = nil if @name == UNSET_VALUE
-        @auto_attach = true if @auto_attach == UNSET_VALUE
-        @activationkey = nil if @activationkey = UNSET_VALUE
-        @servicelevel = nil if @servicelevel = UNSET_VALUE
-        @release = nil if @release = UNSET_VALUE
-        @force = true if @force == UNSET_VALUE
-        @type = nil if @type == UNSET_VALUE
-        @skip = false if @skip == UNSET_VALUE
+        @conf.skip = false unless @conf.skip
+        @logger.info "Final registration configuration: #{@conf.inspect}"
       end
+
+      def method_missing(method_sym, *arguments, &block)
+        command = "@conf.#{method_sym} #{adjust_arguments(arguments)}"
+        @logger.info "Evaluating registration configuration: #{command}"
+        eval command
+      end
+
+      private
+
+        def adjust_arguments(args)
+          return '' if args.size < 1
+          args.map{|a| a.is_a?(String) ? "'#{a}'" : a}.join(',')
+        end
     end
   end
 end