vagrant-registration 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af9192f2abd9ec96303436b364f4db50b7ae3ac
-  data.tar.gz: 2476fad812480a0c51256376450caaceedd8e8a1
+  metadata.gz: 5d8e7119e5e2b2817d170b215b712e7c31381590
+  data.tar.gz: 5a684f6e31d2a18cc662030057e08bd35e5e257c
 SHA512:
-  metadata.gz: 73f30cb1033ccfb9530912e7b5b29f47ab0cd061639d0a8758ea48d9c1cd3605c21eb98a4fbfbc5475a9c2e0e85ee732949e1272348d304114d4078b9c37d015
-  data.tar.gz: 4c0de9666ba6a07389f413be0e94648425db63c0b94e77eb2f026468f6c9539eccf495002165c9db3ed643cc3bcb87adcdd5b970ec1c4118149c69dca36badfd
+  metadata.gz: 8b6d313da487001b3be21481adb7a40756b1010f62da67e0f734a301fe9931c81d0ce9bc8ab70f2f1e7761d4a53673e6130485ee045e36f899d72b0e090f8fa3
+  data.tar.gz: 5e10cbb86cf1f3be46f76f664c05b1d38778c9d21a3d34a2432063b0964237d2c53ed1f6a7cbefaa3cfabd3569f9441417cbb6f889492188d872a5b1d2def4f7

data/README.md

@@ -2,22 +2,26 @@
 
 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 given OS.
 
 
 ## Installation
 
 Install vagrant-registration as any other Vagrant plugin:
 
-```ruby
-vagrant plugin install vagrant-registration
+```shell
+$ vagrant plugin install vagrant-registration
+```
+
+If you are on Fedora, you can install the packaged version of the plugin by running:
+
+```shell
+# dnf 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.
+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.
 
@@ -45,11 +49,17 @@ if Vagrant.has_plugin?('vagrant-registration')
   config.registration.username = 'foo'
   config.registration.password = 'bar'
 end
+
+# Alternatively
+if Vagrant.has_plugin?('vagrant-registration')
+  config.registration.org = 'foo'
+  config.registration.activationkey = 'bar'
+end
 ```
 
 This should go, preferably, into the Vagrantfile in your Vagrant home directory
 (defaults to ~/.vagrant.d), to make it available for every project. It can be
-later overriden in an individual project's Vagrantfile, if needed.
+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
@@ -62,6 +72,9 @@ variables, such as:
 
 If you do not provide credentials, you will be prompted for them in the "up process."
 
+Please note the the interactive mode asks you for the preferred registration pair only.
+In case of a subscription-manager, you would be ask on your username/password combination.
+
 #### 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`:
@@ -77,6 +90,8 @@ If you do not provide credentials, you will be prompted for them in the "up proc
   config.registration.auto_attach = false
 ```
 
+Note that the `auto_attach` option is set to false when using org/activationkey for registration.
+
 #### subscription-manager Options Reference
 
 ```ruby

data/Rakefile

@@ -1,8 +1,25 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'yard'
 
+# Documentation
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb', 'plugins/**/*.rb']
   t.options = []
   t.stats_options = ['--list-undoc']
 end
+
+task :clean do
+  `rm -rf pkg`
+end
+
+# Compare latest release with current git head
+require 'rubygems/comparator'
+task compare: [:clean, :build] do
+  git_version = VagrantPlugins::Registration::VERSION
+  options = {}
+  options[:output] = 'pkg'
+  options[:keep_all] = true
+  comparator = Gem::Comparator.new(options)
+  comparator.compare_versions('vagrant-registration', ['_', git_version])
+  comparator.print_results
+end

data/lib/vagrant-registration.rb

@@ -15,8 +15,6 @@ module VagrantPlugins
       @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
     end
 
-    # Temporally load the extra capability files for Fedora
-    load(File.join(self.source_root, 'plugins/guests/fedora/plugin.rb'))
     # Temporally load the extra capability files for Red Hat
     load(File.join(self.source_root, 'plugins/guests/redhat/plugin.rb'))
   end

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

@@ -47,7 +47,7 @@ module VagrantPlugins
             true
           else
             @logger.debug("Registration is skipped due to the missing guest capability")
-            return false
+            false
           end
         end
 
@@ -80,17 +80,25 @@ module VagrantPlugins
         end
 
         # Check if required credentials has been provided in Vagrantfile
+        #
+        # Checks if at least one of the registration options is able to
+        # register.
         def credentials_provided?(machine)
-          credentials_required(machine).each do |option|
-            return false unless machine.config.registration.send option
+          provided = true
+          credentials_required(machine).each do |registration_option|
+            provided = true
+            registration_option.each do |value|
+              provided = false unless machine.config.registration.send value
+            end
+            break if provided
           end
-          true
+          provided ? true : false
         end
 
         # 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|
+          credentials_required(machine)[0].each do |option|
             unless machine.config.registration.send(option)
               echo = !(secrets(machine).include? option)
               response = ui.ask("#{option}: ", echo: echo)

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

@@ -37,7 +37,7 @@ module VagrantPlugins
             true
           else
             @logger.debug("Unregistration is skipped due to the missing guest capability")
-            return false
+            false
           end
         end
 

data/lib/vagrant-registration/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Registration
-    VERSION = "0.0.15"
+    VERSION = "0.0.16"
   end
 end

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

@@ -38,6 +38,11 @@ module VagrantPlugins
         end
 
         # Required configuration options of the registration manager
+        #
+        # This is array of arrays of all possible registration combinations.
+        # First one is the default used in interactive mode.
+        #
+        # e.g. [[:username, :password]]
         def self.registration_credentials(machine)
           cap = "#{self.registration_manager(machine).to_s}_credentials".to_sym
           if machine.guest.capability?(cap)

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

@@ -20,7 +20,7 @@ module VagrantPlugins
 
         # Return required configuration options for subscription-manager
         def self.subscription_manager_credentials(machine)
-          [:username, :password]
+          [[:username, :password], [:org, :activationkey]]
         end
 
         # Return secret options for subscription-manager
@@ -32,13 +32,18 @@ module VagrantPlugins
 
         # Build additional subscription-manager options based on plugin configuration
         def self.configuration_to_options(config)
-          # Defaults
           config.force = true unless config.force
-          config.auto_attach = true unless config.auto_attach
+
+          # --auto-attach cannot be used in case of org/activationkey registration
+          if config.org && config.activationkey
+            config.auto_attach = false
+          else
+            config.auto_attach = true unless config.auto_attach
+          end
 
           options = []
-          options << "--username='#{config.username}'"
-          options << "--password='#{config.password}'"
+          options << "--username='#{config.username}'" if config.username
+          options << "--password='#{config.password}'" if config.password
           options << "--serverurl='#{config.serverurl}'" if config.serverurl
           options << "--baseurl='#{config.baseurl}'" if config.baseurl
           options << "--org='#{config.org}'" if config.org

data/plugins/guests/redhat/plugin.rb

@@ -57,11 +57,6 @@ module VagrantPlugins
         require_relative "cap/subscription_manager"
         Cap::SubscriptionManager
       end
-
-      guest_capability("redhat", "rhcert") do
-        require_relative "cap/redhat_certification_tool"
-        Cap::RedHatCertification
-      end
     end
   end
 end

data/tests/helpers.sh

@@ -31,6 +31,10 @@ function check_credentials() {
     echo "VAGRANT_REGISTRATION_USERNAME and VAGRANT_REGISTRATION_PASSWORD needs to be provided."
     exit 1
   fi
+  if [ "$VAGRANT_REGISTRATION_ORG" = "" ] || [ "$VAGRANT_REGISTRATION_ACTIVATIONKEY" = "" ]; then
+    echo "VAGRANT_REGISTRATION_ORG and VAGRANT_REGISTRATION_ACTIVATIONKEY needs to be provided."
+    exit 1
+  fi
 }
 
 # Install vagrant and vagrant-registration

data/tests/run.sh

@@ -12,13 +12,16 @@
 # registration. This can be provided in form of environment
 # variables.
 #
-# For testing subscription-manager on RHEL export
-# VAGRANT_REGISTRATION_USERNAME and
-# VAGRANT_REGISTRATION_PASSWORD.
-#
 # NOTE: This will install a development version of
 # vagrant-registration on your system.
 #
+# == subscription-manager
+#
+# For testing subscription-manager on RHEL export
+# VAGRANT_REGISTRATION_USERNAME with VAGRANT_REGISTRATION_PASSWORD
+# for username/password registration and VAGRANT_REGISTRATION_ORG
+# with VAGRANT_REGISTRATION_ACTIVATIONKEY for org/activationkey one.
+#
 
 DIR=$(dirname $(readlink -f "$0"))
 
@@ -27,21 +30,24 @@ DIR=$(dirname $(readlink -f "$0"))
 
 setup_tests
 
-# Test correct credentials
+# Test correct username/password and org/activationkey credentials in a multi-machine setup
 clean_up
 export VAGRANT_VAGRANTFILE=$DIR/vagrantfiles/Vagrantfile.rhel_multi_machine
 
-test_success 'vagrant up on RHEL multi_machine setup' 'vagrant up'
+test_success 'vagrant up on RHEL multi_machine setup' 'vagrant up rhel1-valid-credentials'
 
-test_output 'first machine is registered' \
+test_output 'first machine is registered with given username/password' \
             'vagrant ssh rhel1-valid-credentials -c '\''sudo subscription-manager register'\''' \
             'This system is already registered.'
 
-test_output 'second machine is registered' \
+test_success 'vagrant halt on RHEL multi_machine setup' 'vagrant halt rhel1-valid-credentials'
+test_success 'vagrant halt on RHEL multi_machine setup' 'vagrant destroy'
+test_success 'vagrant up on RHEL multi_machine setup' 'vagrant up rhel2-valid-credentials'
+
+test_output 'second machine is registered with given org/activationkey' \
             'vagrant ssh rhel2-valid-credentials -c '\''sudo subscription-manager register'\''' \
             'This system is already registered.'
 
-test_success 'vagrant halt on RHEL multi_machine setup' 'vagrant halt rhel1-valid-credentials'
 test_success 'vagrant halt on RHEL multi_machine setup' 'vagrant destroy'
 
 # Test wrong credentials

data/tests/vagrantfiles/Vagrantfile.rhel_multi_machine

@@ -1,4 +1,4 @@
-# Spin 2 RHEL machines that will be registered
+# Spin 3 RHEL machines that will be registered
 
 ENV['VAGRANT_DEFAULT_PROVIDER'] ||= 'libvirt'
 ENV['VAGRANT_REGISTRATION_RHEL_BOX'] ||= 'rhel-7.0'
@@ -12,8 +12,8 @@ Vagrant.configure('2') do |config|
   end
 
   config.vm.define "rhel2-valid-credentials" do |c|
-    c.registration.username = ENV['VAGRANT_REGISTRATION_USERNAME']
-    c.registration.password = ENV['VAGRANT_REGISTRATION_PASSWORD']
+    c.registration.org = ENV['VAGRANT_REGISTRATION_ORG']
+    c.registration.activationkey = ENV['VAGRANT_REGISTRATION_ACTIVATIONKEY']
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-registration
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Langdon White
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -50,18 +50,9 @@ files:
 - lib/vagrant-registration/config.rb
 - lib/vagrant-registration/plugin.rb
 - lib/vagrant-registration/version.rb
-- plugins/guests/fedora/cap/change_host_name.rb
-- plugins/guests/fedora/cap/configure_networks.rb
-- plugins/guests/fedora/cap/flavor.rb
-- plugins/guests/fedora/cap/network_scripts_dir.rb
-- plugins/guests/fedora/cap/nfs_client.rb
-- plugins/guests/fedora/guest.rb
-- plugins/guests/fedora/plugin.rb
-- plugins/guests/redhat/cap/redhat_certification_tool.rb
 - plugins/guests/redhat/cap/registration.rb
 - plugins/guests/redhat/cap/subscription_manager.rb
 - plugins/guests/redhat/plugin.rb
-- test
 - tests/helpers.sh
 - tests/run.sh
 - tests/vagrantfiles/Vagrantfile.rhel_multi_machine

data/plugins/guests/fedora/cap/change_host_name.rb

@@ -1,75 +0,0 @@
-module VagrantPlugins
-  module GuestFedora
-    module Cap
-      class ChangeHostName
-        def self.change_host_name(machine, name)
-          new(machine, name).change!
-        end
-
-        attr_reader :machine, :new_hostname
-
-        def initialize(machine, new_hostname)
-          @machine = machine
-          @new_hostname = new_hostname
-        end
-
-        def change!
-          return unless should_change?
-
-          update_etc_hostname
-          update_etc_hosts
-          refresh_hostname_service
-        end
-
-        def should_change?
-          new_hostname != current_hostname
-        end
-
-        def current_hostname
-          @current_hostname ||= get_current_hostname
-        end
-
-        def get_current_hostname
-          hostname = ""
-          sudo "hostname -f" do |type, data|
-            hostname = data.chomp if type == :stdout && hostname.empty?
-          end
-
-          hostname
-        end
-
-        def update_etc_hostname
-          sudo("echo '#{short_hostname}' > /etc/hostname")
-        end
-
-        # /etc/hosts should resemble:
-        # 127.0.0.1   localhost
-        # 127.0.1.1   host.fqdn.com host.fqdn host
-        def update_etc_hosts
-          ip_address = '([0-9]{1,3}\.){3}[0-9]{1,3}'
-          search     = "^(#{ip_address})\\s+#{Regexp.escape(current_hostname)}(\\s.*)?$"
-          replace    = "\\1 #{fqdn} #{short_hostname}"
-          expression = ['s', search, replace, 'g'].join('@')
-
-          sudo("sed -ri '#{expression}' /etc/hosts")
-        end
-
-        def refresh_hostname_service
-          sudo("hostname -F /etc/hostname")
-        end
-
-        def fqdn
-          new_hostname
-        end
-
-        def short_hostname
-          new_hostname.split('.').first
-        end
-
-        def sudo(cmd, &block)
-          machine.communicate.sudo(cmd, &block)
-        end
-      end
-    end
-  end
-end

data/plugins/guests/fedora/cap/configure_networks.rb

@@ -1,98 +0,0 @@
-require "set"
-require "tempfile"
-
-require "vagrant/util/retryable"
-require "vagrant/util/template_renderer"
-
-module VagrantPlugins
-  module GuestFedora
-    module Cap
-      class ConfigureNetworks
-        extend Vagrant::Util::Retryable
-        include Vagrant::Util
-
-        def self.configure_networks(machine, networks)
-          network_scripts_dir = machine.guest.capability("network_scripts_dir")
-
-          virtual = false
-          interface_names = Array.new
-          machine.communicate.sudo("/usr/sbin/biosdevname; echo $?") do |_, result|
-            virtual = true if result.chomp == '4'
-          end
-
-          if virtual
-            machine.communicate.sudo("ls /sys/class/net | grep -v lo") do |_, result|
-              interface_names = result.split("\n")
-            end
-
-            interface_names = networks.map do |network|
-               "#{interface_names[network[:interface]]}"
-            end
-          else
-            machine.communicate.sudo("/usr/sbin/biosdevname -d | grep Kernel | cut -f2 -d: | sed -e 's/ //;'") do |_, result|
-              interface_names = result.split("\n")
-            end
-
-            interface_name_pairs = Array.new
-            interface_names.each do |interface_name|
-              machine.communicate.sudo("/usr/sbin/biosdevname --policy=all_ethN -i #{interface_name}") do |_, result|
-                interface_name_pairs.push([interface_name, result.gsub("\n", "")])
-              end
-            end
-
-            setting_interface_names = networks.map do |network|
-               "eth#{network[:interface]}"
-            end
-
-            interface_name_pairs.each do |interface_name, previous_interface_name|
-              if setting_interface_names.index(previous_interface_name) == nil
-                interface_names.delete(interface_name)
-              end
-            end
-          end
-
-          # Accumulate the configurations to add to the interfaces file as well
-          # as what interfaces we're actually configuring since we use that later.
-          interfaces = Set.new
-          networks.each do |network|
-            interface = interface_names[network[:interface]-1]
-            interfaces.add(interface)
-            network[:device] = interface
-
-            # Remove any previous vagrant configuration in this network
-            # interface's configuration files.
-            machine.communicate.sudo("touch #{network_scripts_dir}/ifcfg-#{interface}")
-            machine.communicate.sudo("sed -e '/^#VAGRANT-BEGIN/,/^#VAGRANT-END/ d' #{network_scripts_dir}/ifcfg-#{interface} > /tmp/vagrant-ifcfg-#{interface}")
-            machine.communicate.sudo("cat /tmp/vagrant-ifcfg-#{interface} > #{network_scripts_dir}/ifcfg-#{interface}")
-            machine.communicate.sudo("rm -f /tmp/vagrant-ifcfg-#{interface}")
-
-            # Render and upload the network entry file to a deterministic
-            # temporary location.
-            entry = TemplateRenderer.render("guests/fedora/network_#{network[:type]}",
-                                            options: network)
-
-            temp = Tempfile.new("vagrant")
-            temp.binmode
-            temp.write(entry)
-            temp.close
-
-            machine.communicate.upload(temp.path, "/tmp/vagrant-network-entry_#{interface}")
-          end
-
-          # Bring down all the interfaces we're reconfiguring. By bringing down
-          # each specifically, we avoid reconfiguring p7p (the NAT interface) so
-          # SSH never dies.
-          interfaces.each do |interface|
-            retryable(on: Vagrant::Errors::VagrantError, tries: 3, sleep: 2) do
-              machine.communicate.sudo("cat /tmp/vagrant-network-entry_#{interface} >> #{network_scripts_dir}/ifcfg-#{interface}")
-              machine.communicate.sudo("/sbin/ifdown #{interface}", error_check: true)
-              machine.communicate.sudo("/sbin/ifup #{interface}")
-            end
-
-            machine.communicate.sudo("rm -f /tmp/vagrant-network-entry_#{interface}")
-          end
-        end
-      end
-    end
-  end
-end

data/plugins/guests/fedora/cap/flavor.rb

@@ -1,21 +0,0 @@
-module VagrantPlugins
-  module GuestFedora
-    module Cap
-      class Flavor
-        def self.flavor(machine)
-          # Read the version file
-          machine.communicate.sudo("grep VERSION_ID /etc/os-release") do |type, data|
-            version = data.split("=")[1].chomp.to_i if type == :stdout
-          end
-
-          # Detect various flavors we care about
-          if version >= 20
-            return :"fedora_#{version}"
-          else
-            return :fedora
-          end
-        end
-      end
-    end
-  end
-end

data/plugins/guests/fedora/cap/network_scripts_dir.rb

@@ -1,15 +0,0 @@
-module VagrantPlugins
-  module GuestFedora
-    module Cap
-      class NetworkScriptsDir
-        # The path to the directory with the network configuration scripts.
-        # This is pulled out into its own directory since there are other
-        # operating systems (SUSE) which behave similarly but with a different
-        # path to the network scripts.
-        def self.network_scripts_dir(machine)
-          "/etc/sysconfig/network-scripts"
-        end
-      end
-    end
-  end
-end

data/plugins/guests/fedora/cap/nfs_client.rb

@@ -1,11 +0,0 @@
-module VagrantPlugins
-  module GuestFedora
-    module Cap
-      class NFSClient
-        def self.nfs_client_install(machine)
-          machine.communicate.sudo("yum -y install nfs-utils nfs-utils-lib")
-        end
-      end
-    end
-  end
-end

data/plugins/guests/fedora/guest.rb

@@ -1,11 +0,0 @@
-require "vagrant"
-
-module VagrantPlugins
-  module GuestFedora
-    class Guest < Vagrant.plugin("2", :guest)
-      def detect?(machine)
-        machine.communicate.test("grep 'Fedora release 1[6789]\\|Fedora release 2[0-9]' /etc/redhat-release")
-      end
-    end
-  end
-end

data/plugins/guests/fedora/plugin.rb

@@ -1,41 +0,0 @@
-require "vagrant"
-
-module VagrantPlugins
-  module GuestFedora
-    class Plugin < Vagrant.plugin("2")
-      name "Fedora guest"
-      description "Fedora guest support."
-
-      guest("fedora", "redhat") do
-        require File.expand_path("../guest", __FILE__)
-        Guest
-      end     
- 
-      guest_capability("fedora", "change_host_name") do
-        require_relative "cap/change_host_name"
-        Cap::ChangeHostName
-      end
-
-      guest_capability("fedora", "configure_networks") do
-        require_relative "cap/configure_networks"
-        Cap::ConfigureNetworks
-      end
-
-      guest_capability("fedora", "network_scripts_dir") do
-        require_relative "cap/network_scripts_dir"
-        Cap::NetworkScriptsDir
-      end
-
-      guest_capability("fedora", "flavor") do
-        require_relative "cap/flavor"
-        Cap::Flavor
-      end
-
-      guest_capability("fedora", "nfs_client_install") do
-        require_relative "cap/nfs_client"
-        Cap::NFSClient
-      end
-
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-module VagrantPlugins
-  module GuestRedHat
-    module Cap
-      class RedHatCertification
-        def self.rhcert(machine)
-          machine.communicate.test("/usr/bin/rhcert", sudo: true)
-        end
-      end
-    end
-  end
-end

data/test

@@ -1 +0,0 @@
-Fedora release 22