vagrant-registration 0.0.11 → 0.0.12

data/lib/vagrant-registration/plugin.rb

@@ -28,7 +28,7 @@ module VagrantPlugins
 
       name "Registration"
       description <<-DESC
-      This plugin adds register and unregister functionality to Vagrant Guests that 
+      This plugin adds register and unregister functionality to Vagrant Guests that
       support the capability
       DESC
 
@@ -38,12 +38,13 @@ module VagrantPlugins
       action_hook(:registration_unregister, :machine_action_destroy, &method(:unregister))
 
       config(:registration) do
+        setup_logging
         require_relative 'config'
         Config
       end
 
       # This sets up our log level to be whatever VAGRANT_LOG is
-      # for loggers prepended with 'vagrant_libvirt'
+      # for loggers prepended with 'vagrant_registration'
       def self.setup_logging
         require 'log4r'
         level = nil

data/lib/vagrant-registration/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Registration
-    VERSION = "0.0.11"
+    VERSION = "0.0.12"
   end
 end

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

@@ -0,0 +1,67 @@
+module VagrantPlugins
+  module GuestRedHat
+    module Cap
+      # This provides registration capabilities for vagrant-registration
+      #
+      # As we might support more registration options (managers), this
+      # just calls the capabilities of the selected registration manager
+      # (from config.registration.manager).
+      class Registration
+        # Register the given machine
+        def self.registration_register(machine)
+          cap = "#{self.registration_manager(machine).to_s}_register".to_sym
+          if machine.guest.capability?(cap)
+            machine.guest.capability(cap, machine.config.registration)
+          else
+            false
+          end
+        end
+
+        # Unregister the given machine
+        def self.registration_unregister(machine)
+          cap = "#{self.registration_manager(machine).to_s}_unregister".to_sym
+          if machine.guest.capability?(cap)
+            machine.guest.capability(cap)
+          else
+            false
+          end
+        end
+
+        # Check that the machine has the selected registration manager installed
+        def self.registration_manager_installed(machine)
+          cap = "#{self.registration_manager(machine).to_s}".to_sym
+          if machine.guest.capability?(cap)
+            machine.guest.capability(cap)
+          else
+            false
+          end
+        end
+
+        # Required configuration options of the registration manager
+        def self.registration_credentials(machine)
+          cap = "#{self.registration_manager(machine).to_s}_credentials".to_sym
+          if machine.guest.capability?(cap)
+            machine.guest.capability(cap)
+          else
+            []
+          end
+        end
+
+        # Return secret options for the registration manager
+        def self.registration_secrets(machine)
+          cap = "#{self.registration_manager(machine).to_s}_secrets".to_sym
+          if machine.guest.capability?(cap)
+            machine.guest.capability(cap)
+          else
+            []
+          end
+        end
+
+        # Return selected registration manager or default
+        def self.registration_manager(machine)
+          (machine.config.registration.manager || 'subscription_manager').to_sym
+        end
+      end
+    end
+  end
+end

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

@@ -2,8 +2,55 @@ module VagrantPlugins
   module GuestRedHat
     module Cap
       class SubscriptionManager
+        # Test that we have subscription-manager installed
         def self.subscription_manager(machine)
-           machine.communicate.test("/sbin/subscription-manager", sudo: true)
+          machine.communicate.test("/sbin/subscription-manager", sudo: true)
+        end
+
+        # Register the machine using 'register' option, config is (Open)Struct
+        def self.subscription_manager_register(machine, config)
+          command = "subscription-manager register #{configuration_to_options(config)}"
+          machine.communicate.execute("cmd=$(#{command}); if [ \"$?\" != \"0\" ]; then echo $cmd | grep 'This system is already registered' || (echo $cmd 1>&2 && exit 1) ; fi", sudo: true)
+        end
+
+        # Unregister the machine using 'unregister' option
+        def self.subscription_manager_unregister(machine)
+          machine.communicate.execute("subscription-manager unregister || :", sudo: true)
+        end
+
+        # Return required configuration options for subscription-manager
+        def self.subscription_manager_credentials(machine)
+          [:username, :password]
+        end
+
+        # Return secret options for subscription-manager
+        def self.subscription_manager_secrets(machine)
+          [:password]
+        end
+
+        private
+
+        # 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
+
+          options = []
+          options << "--username=#{config.username}"
+          options << "--password=#{config.password}"
+          options << "--serverurl=#{config.serverurl}" if config.serverurl
+          options << "--baseurl=#{config.baseurl}" if config.baseurl
+          options << "--org=#{config.org}" if config.org
+          options << "--environment=#{config.environment}" if config.environment
+          options << "--name=#{config.name}" if config.name
+          options << "--auto-attach" if config.auto_attach
+          options << "--activationkey=#{config.activationkey}" if config.activationkey
+          options << "--servicelevel=#{config.servicelevel}" if config.servicelevel
+          options << "--release=#{config.release}" if config.release
+          options << "--force" if config.force
+          options << "--type=#{config.type}" if config.type
+          options.join(' ')
         end
       end
     end

data/plugins/guests/redhat/plugin.rb

@@ -3,14 +3,34 @@ require "vagrant"
 module VagrantPlugins
   module GuestRedHat
     class Plugin < Vagrant.plugin("2")
-      guest_capability("redhat", "register") do
-        require_relative "cap/register"
-        Cap::Register
+      guest_capability("redhat", "registration_register") do
+        require_relative "cap/registration"
+        Cap::Registration
       end
 
-      guest_capability("redhat", "unregister") do
-        require_relative "cap/unregister"
-        Cap::Unregister
+      guest_capability("redhat", "registration_unregister") do
+        require_relative "cap/registration"
+        Cap::Registration
+      end
+
+      guest_capability("redhat", "registration_manager_installed") do
+        require_relative "cap/registration"
+        Cap::Registration
+      end
+
+      guest_capability("redhat", "registration_credentials") do
+        require_relative "cap/registration"
+        Cap::Registration
+      end
+
+      guest_capability("redhat", "registration_secrets") do
+        require_relative "cap/registration"
+        Cap::Registration
+      end
+
+      guest_capability("redhat", "registration_manager") do
+        require_relative "cap/registration"
+        Cap::Registration
       end
 
       guest_capability("redhat", "subscription_manager") do
@@ -18,6 +38,26 @@ module VagrantPlugins
         Cap::SubscriptionManager
       end
 
+      guest_capability("redhat", "subscription_manager_register") do
+        require_relative "cap/subscription_manager"
+        Cap::SubscriptionManager
+      end
+
+      guest_capability("redhat", "subscription_manager_unregister") do
+        require_relative "cap/subscription_manager"
+        Cap::SubscriptionManager
+      end
+
+      guest_capability("redhat", "subscription_manager_credentials") do
+        require_relative "cap/subscription_manager"
+        Cap::SubscriptionManager
+      end
+
+      guest_capability("redhat", "subscription_manager_secrets") do
+        require_relative "cap/subscription_manager"
+        Cap::SubscriptionManager
+      end
+
       guest_capability("redhat", "rhcert") do
         require_relative "cap/redhat_certification_tool"
         Cap::RedHatCertification

data/tests/helpers.sh

@@ -0,0 +1,124 @@
+# Set up test environment
+function setup_tests() {
+  check_credentials
+  install_dependencies
+
+  # Test results that should be printed at the end
+  TEST_RESULTS=''
+  FAILED=0
+  SUCCEDED=0
+  EXIT_CODE=0
+}
+
+# Print test results
+function print_results() {
+  if [ "$TEST_RESULTS" != "" ]; then
+    printf "\n$TEST_RESULTS\n"
+  fi
+  printf "\n$SUCCEDED succeded, $FAILED failed.\n"
+  exit $EXIT_CODE
+}
+
+# Clean up before each test
+function clean_up() {
+  # Clean up Vagrant metadata
+  rm -rf $DIR/.vagrant
+}
+
+# Check that we have credentials to run the test suite
+function check_credentials() {
+  if [ "$VAGRANT_REGISTRATION_USERNAME" = "" ] || [ "$VAGRANT_REGISTRATION_PASSWORD" = "" ]; then
+    echo "VAGRANT_REGISTRATION_USERNAME and VAGRANT_REGISTRATION_PASSWORD needs to be provided."
+    exit 1
+  fi
+}
+
+# Install vagrant and vagrant-registration
+function install_dependencies() {
+  # Install Vagrant if it's not present
+  PLUGIN_INSTALLED=$(vagrant --help)
+  if [ $? -ne 0 ]; then
+    sudo yum install vagrant-libvirt -y
+  fi
+
+  # Uninstall vagrant-registration if installed
+  # TODO: Uninstall RPM package if needed
+  PLUGIN_INSTALLED=$(vagrant plugin list | grep vagrant-registration)
+  if [ -z "$PLUGIN_INSTALLED" ]; then
+    vagrant plugin uninstall vagrant-registration
+  fi
+
+  # Install vagrant-registration from current sources
+  rm -rf pkg
+  rake build
+  vagrant plugin install pkg/vagrant-registration*.gem
+}
+
+# Test that command succeded
+#
+# Usage:
+#
+#   test_success TEST_NAME COMMAND_TO_RUN
+#
+# Example:
+#
+#   test_success "ls won't fail" "ls -all"
+function test_success() {
+  eval $2 >&1 >/dev/null
+  if [ $? -ne 0 ]; then
+    printf "F"
+    FAILED=$((FAILED + 1))
+    EXIT_CODE=1
+    TEST_RESULTS="$TEST_RESULTS\nTest '$1' failed with command:"
+    TEST_RESULTS="$TEST_RESULTS\n    $2"
+  else
+    SUCCEDED=$((SUCCEDED + 1))
+    printf '.'
+  fi
+}
+
+# Test that command failed
+#
+# Usage:
+#
+#   test_failure TEST_NAME COMMAND_TO_RUN
+#
+# Example:
+#
+#   test_failure "this should fail" "echoo"
+function test_failure() {
+  eval $2 >&1 >/dev/null
+  if [ $? -ne 0 ]; then
+    SUCCEDED=$((SUCCEDED + 1))
+    printf '.'
+  else
+    printf "F"
+    FAILED=$((FAILED + 1))
+    EXIT_CODE=1
+    TEST_RESULTS="$TEST_RESULTS\nTest '$1' dit not fail with command:"
+    TEST_RESULTS="$TEST_RESULTS\n    $2"
+  fi
+}
+
+# Test that command produced an expected output
+#
+# Usage:
+#
+#   test_output TEST_NAME COMMAND_TO_RUN EXPECTED_OUTPUT
+#
+# Example:
+#
+#   test_output "echo abc outputs abc" "echo 'abc'" "abc"
+function test_output() {
+  eval $2 >&1| grep "$3" >/dev/null
+  if [ $? -ne 0 ]; then
+    printf "F"
+    FAILED=$((FAILED + 1))
+    EXIT_CODE=1
+    TEST_RESULTS="$TEST_RESULTS\nTest '$1' failed with command:"
+    TEST_RESULTS="$TEST_RESULTS\n    $2 | grep '$3'"
+  else
+    SUCCEDED=$((SUCCEDED + 1))
+    printf '.'
+  fi
+}

data/tests/run.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# This tests test vagrant-registration plugin running on Fedora
+# with libvirt. If you do not have Vagrant installed or if you
+# have vagrant-libvirt package on your system, Vagrant will be
+# installed or vagrant-libvirt removed respectively. In that case
+# you need sudo to run the tests. If you do not run Fedora, make
+# sure you have Vagrant installed (any provider should do if you
+# add RHEL box called 'rhel-7').
+#
+# IMPORTANT: Tests need valid credentials to actually test
+# 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.
+#
+
+DIR=$(dirname $(readlink -f "$0"))
+
+# Import test helpers
+. $DIR/helpers.sh
+
+setup_tests
+
+# Test correct credentials
+clean_up
+export VAGRANT_VAGRANTFILE=$DIR/vagrantfiles/Vagrantfile.rhel_multi_machine
+
+test_success 'vagrant up on RHEL multi_machine setup' 'vagrant up'
+
+test_output 'first machine is registered' \
+            'vagrant ssh rhel1-valid-credentials -c '\''sudo subscription-manager register'\''' \
+            'This system is already registered.'
+
+test_output 'second machine is registered' \
+            '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
+clean_up
+export VAGRANT_VAGRANTFILE=$DIR/vagrantfiles/Vagrantfile.rhel_wrong_credentials
+test_failure 'vagrant up on RHEL with wrong credentials should fail' 'vagrant up'
+test_success 'vagrant destroy on RHEL with wrong credentials' 'vagrant destroy'
+
+print_results

data/tests/vagrantfiles/Vagrantfile.rhel_multi_machine

@@ -0,0 +1,19 @@
+# Spin 2 RHEL machines that will be registered
+
+ENV['VAGRANT_DEFAULT_PROVIDER'] ||= 'libvirt'
+ENV['VAGRANT_REGISTRATION_RHEL_BOX'] ||= 'rhel-7.0'
+
+Vagrant.configure('2') do |config|
+  config.vm.box = ENV['VAGRANT_REGISTRATION_RHEL_BOX']
+
+  config.vm.define "rhel1-valid-credentials" do |c|
+    c.registration.username = ENV['VAGRANT_REGISTRATION_USERNAME']
+    c.registration.password = ENV['VAGRANT_REGISTRATION_PASSWORD']
+  end
+
+  config.vm.define "rhel2-valid-credentials" do |c|
+    c.registration.username = ENV['VAGRANT_REGISTRATION_USERNAME']
+    c.registration.password = ENV['VAGRANT_REGISTRATION_PASSWORD']
+  end
+
+end

data/tests/vagrantfiles/Vagrantfile.rhel_wrong_credentials

@@ -0,0 +1,14 @@
+# Spin 1 RHEL machine with wrong credentials
+
+ENV['VAGRANT_DEFAULT_PROVIDER'] ||= 'libvirt'
+ENV['VAGRANT_REGISTRATION_RHEL_BOX'] ||= 'rhel-7.0'
+
+Vagrant.configure('2') do |config|
+  config.vm.box = ENV['VAGRANT_REGISTRATION_RHEL_BOX']
+
+  config.vm.define "rhel1-wrong-credentials" do |c|
+    c.registration.username = 'wrong_username'
+    c.registration.password = 'wrong_password'
+  end
+
+end

data/vagrant-registration.gemspec

@@ -46,5 +46,6 @@ Gem::Specification.new do |s|
   s.files         = unignored_files
   s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
   s.require_path  = 'lib'
-end
 
+  s.add_development_dependency 'yard'
+end