vagrant-registration 0.0.17 → 0.0.18

data/vagrant-registration-0.0.16/lib/vagrant-registration/version.rb

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

data/vagrant-registration-0.0.16/plugins/guests/redhat/cap/registration.rb

@@ -0,0 +1,72 @@
+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
+        #
+        # 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)
+            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/vagrant-registration-0.0.16/plugins/guests/redhat/cap/subscription_manager.rb

@@ -0,0 +1,63 @@
+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)
+        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], [:org, :activationkey]]
+        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)
+          config.force = true unless config.force
+
+          # --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}'" 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
+          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
+  end
+end

data/vagrant-registration-0.0.16/plugins/guests/redhat/plugin.rb

@@ -0,0 +1,62 @@
+require "vagrant"
+
+module VagrantPlugins
+  module GuestRedHat
+    class Plugin < Vagrant.plugin("2")
+      guest_capability("redhat", "registration_register") do
+        require_relative "cap/registration"
+        Cap::Registration
+      end
+
+      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
+        require_relative "cap/subscription_manager"
+        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
+    end
+  end
+end

data/vagrant-registration-0.0.16/tests/helpers.sh

@@ -0,0 +1,128 @@
+# 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
+  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
+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/vagrant-registration-0.0.16/tests/run.sh

@@ -0,0 +1,59 @@
+#!/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.
+#
+# 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"))
+
+# Import test helpers
+. $DIR/helpers.sh
+
+setup_tests
+
+# 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 rhel1-valid-credentials'
+
+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_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 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/vagrant-registration-0.0.16/tests/vagrantfiles/Vagrantfile.rhel_multi_machine

@@ -0,0 +1,19 @@
+# Spin 3 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.org = ENV['VAGRANT_REGISTRATION_ORG']
+    c.registration.activationkey = ENV['VAGRANT_REGISTRATION_ACTIVATIONKEY']
+  end
+
+end

data/vagrant-registration-0.0.16/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-0.0.16/vagrant-registration.gemspec

@@ -0,0 +1,49 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-registration/version"
+
+Gem::Specification.new do |s|
+  s.name          = "vagrant-registration"
+  s.version       = VagrantPlugins::Registration::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.license       = "GPL-2.0"
+  s.authors       = ["Langdon White", "Josef Strzibny", "et al"]
+  s.email         = ["langdon@fedoraproject.org", "strzibny@strzibny.name"]
+  s.summary       = "Automatic guest registration for Vagrant"
+  s.description   = "Enables guests to be registered automatically which is especially useful for RHEL or SLES guests."
+  s.homepage      = "https://github.com/projectatomic/adb-vagrant-registration"
+  s.required_rubygems_version = ">= 1.3.6"
+
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  s.files         = unignored_files
+  s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  s.require_path  = 'lib'
+
+  s.add_development_dependency 'yard'
+end