foreman_virt_who_configure 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc18a0a6855645558a541c028fdbc976a1e82a28
-  data.tar.gz: c665d9f4302ec737940875c5c668af1eeaf84588
+  metadata.gz: fcd1a62a927233569d45344186f1797f8f83f858
+  data.tar.gz: d85400e71ed4d0beb6de66f47a793cf0083cb35e
 SHA512:
-  metadata.gz: 94a21f9543e5519eadfda90acdddc83f5d035e14eca3c1952d5228e79eb608a6658c7852166fee9a3b320bdc56fded20291f8e036abe86bc2415f647e0136f32
-  data.tar.gz: 4727236938d4b4e145fb6452698985173f6292d476ea123362b83a3b55674e9eaefa942d7c2896acaf09255846f852ee98d87d68b946584b56551dfaa93f1464
+  metadata.gz: 4bc9ac6611d4c47f0323afdf087759cba98545e4d101a8b61ad974e2c97a8cc6a7ef05627bbf5c842261a03edb2a7063ab434ae1e12ad745ecd2ddef36be8ee3
+  data.tar.gz: bfb46ba995b7574ebd567e5f6017835bb27d688a85f24f9de7c368f2ff37cc64ffb44e80b79d215a85e67dfffecc2991fc2fe32a9d34714c80bec1bd2878d18f

data/app/assets/javascripts/foreman_virt_who_configure/config_copy_and_paste.js

@@ -0,0 +1,8 @@
+function virt_who_copy_configuration_to_clipboard(text) {
+  var aux = document.createElement("textarea");
+  $(aux).html(text);
+  document.body.appendChild(aux);
+  aux.select();
+  document.execCommand("copy");
+  document.body.removeChild(aux);
+}

data/app/assets/javascripts/foreman_virt_who_configure/config_edit.js

@@ -16,16 +16,31 @@ function virt_who_update_listing_mode() {
   }
 }
 
-$(document).ready(function () {
-  $('#foreman_virt_who_configure_config_hypervisor_type').change(function () {
-    selected_type = $(this).val();
-    $.each(['hypervisor_server', 'hypervisor_username'], function(index, value) {
-      var element = $('#foreman_virt_who_configure_config_' + value)
-      var help = element.data("help")[selected_type];
-      element.parent().siblings('span.help-block.help-inline').children('a[rel=popover]').attr('data-content', help);
-    });
+function virt_who_update_hypervisor_fields() {
+  selected_type = $('#foreman_virt_who_configure_config_hypervisor_type').val();
+  var element = $('#foreman_virt_who_configure_config_hypervisor_password');
+  element.closest('.form-group').toggle(selected_type != 'libvirt');
+}
+
+function virt_who_update_credentials_help() {
+  selected_type = $(this).val();
+  $.each(['hypervisor_server', 'hypervisor_username'], function(index, value) {
+    var element = $('#foreman_virt_who_configure_config_' + value);
+    var help = element.data("help")[selected_type];
+    var inline_help_popover = element.parents('.form-group').find('.help-inline a[rel=popover]');
+    if (inline_help_popover[0]) {
+      // pre Foreman 1.15
+      inline_help_popover.attr('data-content', help);
+    } else {
+      element.parents('.form-group').find('label a[rel=popover]').attr('data-content', help);
+    }
   });
+}
 
+$(document).ready(function () {
   virt_who_update_listing_mode();
+  virt_who_update_hypervisor_fields();
   $('#foreman_virt_who_configure_config_listing_mode').change(virt_who_update_listing_mode);
+  $('#foreman_virt_who_configure_config_hypervisor_type').change(virt_who_update_credentials_help);
+  $('#foreman_virt_who_configure_config_hypervisor_type').change(virt_who_update_hypervisor_fields);
 });

data/app/controllers/foreman_virt_who_configure/api/v2/configs_controller.rb

@@ -0,0 +1,120 @@
+module ForemanVirtWhoConfigure
+  module Api
+    module V2
+      class ConfigsController < ::Api::V2::BaseController
+        include ::Api::Version2
+        include ForemanVirtWhoConfigure::Concerns::ConfigParameters if Foreman::Version.new.short >= '1.13'
+        resource_description do
+          api_base_url "/foreman_virt_who_configure/api"
+        end
+
+        before_action :find_resource, :only => %w{show deploy_script update destroy}
+
+        api :GET, '/configs', N_("List of virt-who configurations")
+        api :GET, "/organizations/:organization_id/configs", N_("List of virt-who configurations per organization")
+        param_group :search_and_pagination, ::Api::V2::BaseController
+
+        def index
+          @configs = resource_scope_for_index
+        end
+
+        api :GET, "/configs/:id/", N_("Show a virt-who configuration")
+        param :id, :identifier, :required => true
+
+        def show
+        end
+
+        api :GET, "/configs/:id/deploy_script/", N_("Renders a deploy script for the specified virt-who configuration")
+        param :id, :identifier, :required => true
+        def deploy_script
+          respond_to do |format|
+            format.text { render :text => @config.virt_who_bash_script }
+            format.sh { render :text => @config.virt_who_bash_script }
+            format.json
+          end
+        end
+
+        def_param_group :config do
+          param :foreman_virt_who_configure_config, Hash, :required => true, :action_aware => true do
+            param :name, String, :desc => N_("Configuration name"), :required => true
+            param :interval, Config::AVAILABLE_INTERVALS.keys.map(&:to_i), :desc => N_("Configuration interval in minutes"), :required => true
+            param :filtering_mode, Config::FILTERING_MODES.keys.map(&:to_i), :desc => N_("Hypervisor filtering mode, %{unlimited} means no filtering, %{whitelist} means whitelist, %{blacklist} means blacklist") % { :unlimited => Config::UNLIMITED, :whitelist => Config::WHITELIST, :blacklist => Config::BLACKLIST }, :required => true
+            param :whitelist, String, :desc => N_("Hypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma."), :required => false
+            param :blacklist, String, :desc => N_("Hypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma."), :required => false
+            param :hypervisor_id, Config::HYPERVISOR_IDS, :desc => N_("Specifies how the hypervisor will be identified."), :required => true
+            param :hypervisor_type, Config::HYPERVISOR_TYPES.keys, :desc => N_("Hypervisor type"), :required => true
+            param :hypervisor_server, String, :desc => N_("Fully qualified host name or IP address of the hypervisor"), :required => true
+            param :hypervisor_username, String, :desc => N_("Account name by which virt-who is to connect to the hypervisor."), :required => true
+            param :hypervisor_password, String, :desc => N_("Hypervisor password, required for all hypervisor types except for libvirt"), :required => false
+            param :satellite_url, String, :desc => N_("Satellite server FQDN"), :required => true
+            param :debug, :bool, :desc => N_("Enable debugging output")
+            param :proxy, String, :desc => N_('HTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.'), :required => false
+            param :no_proxy, String, :desc => N_("Ignore proxy. A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.")
+            param :organization_id, Integer, :required => true, :desc => N_("Organization of the virt-who configuration") if ::SETTINGS[:organizations_enabled]
+          end
+        end
+
+        api :POST, '/configs', N_("Create a virt-who configuration")
+        param_group :config, :as => :create
+
+        def create
+          @config = Config.new(config_params)
+          process_response @config.save
+        end
+
+        api :PUT, '/configs/:id', N_("Update a virt-who configuration")
+        param :id, :number, :desc => N_("Configuration numeric identifier"), :required => true
+        param_group :config
+
+        def update
+          process_response @config.update_attributes(config_params)
+        end
+
+        api :DELETE, '/configs/:id', N_("Delete a virt-who configuration")
+        param :id, :number, :desc => N_("Configuration numeric identifier"), :required => true
+
+        def destroy
+          process_response @config.destroy
+        end
+
+        def apply_organization_filter(scope)
+          scope.for_organization(Organization.current)
+        end
+
+        def resource_scope(*args)
+          apply_organization_filter(super)
+        end
+
+        def resource_class
+          ForemanVirtWhoConfigure::Config
+        end
+
+        protected
+
+        def action_permission
+          case params[:action]
+            when 'deploy_script'
+              'view'
+            else
+              super
+          end
+        end
+
+        private
+
+        # compatibility layer for 1.11 - pre strong params patch
+        def config_params
+          if defined?(super)
+            super
+          else
+            params[:foreman_virt_who_configure_config]
+          end
+        end
+
+        def allowed_nested_id
+          %w(organization_id)
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_virt_who_configure/configs_controller.rb

@@ -2,7 +2,7 @@ module ForemanVirtWhoConfigure
   class ConfigsController < ::ForemanVirtWhoConfigure::ApplicationController
     include Foreman::Controller::AutoCompleteSearch
     include ForemanVirtWhoConfigure::Concerns::ConfigParameters if Foreman::Version.new.short >= '1.13'
-    before_action :find_resource, :only => [:edit, :update, :destroy, :show]
+    before_action :find_resource, :only => [:edit, :update, :destroy, :show, :deploy_script]
 
     # in 1.11 we can't use welcome from application controller since it does not work with namespaces
     def welcome
@@ -30,7 +30,7 @@ module ForemanVirtWhoConfigure
       end
       @config.hypervisor_type ||= Config::HYPERVISOR_DEFAULT_TYPE
       @config.organization ||= Organization.current
-      @config.satellite_url ||= URI.parse(Setting.foreman_url).host
+      @config.satellite_url ||= URI.parse(Setting[:foreman_url]).host
     end
 
     def create
@@ -64,6 +64,10 @@ module ForemanVirtWhoConfigure
       end
     end
 
+    def deploy_script
+      send_data @config.virt_who_bash_script, :filename => "deploy_virt_who_config_#{@config.id}.sh", :type => 'text/x-shellscript', :disposition => :attachment
+    end
+
     def auto_complete_controller_name
       'foreman_virt_who_configure_configs'
     end
@@ -90,5 +94,16 @@ module ForemanVirtWhoConfigure
     def resource_scope(*args)
       apply_organization_filter(super)
     end
+
+    # equivalent to which was added after 1.11
+    #   define_action_permission ['deploy_script'], :view
+    def action_permission
+      case params[:action]
+        when 'deploy_script'
+          :view
+        else
+          super
+      end
+    end
   end
 end

data/app/helpers/foreman_virt_who_configure/compatibility_helper.rb

@@ -18,5 +18,14 @@ module ForemanVirtWhoConfigure
         help_path
       end
     end
+
+    def inline_help_popover(message)
+      version = Foreman::Version.new
+      if version.major.to_i >= 1 && version.minor.to_i >= 15
+        { :label_help => message.html_safe }
+      else
+        { :help_inline => popover('', message).html_safe }
+      end
+    end
   end
 end

data/app/helpers/foreman_virt_who_configure/configs_helper.rb

@@ -18,7 +18,7 @@ module ForemanVirtWhoConfigure
         # 'vdsm' => '',
         'hyperv' => _('Account name by which virt-who is to connect to the hypervisor. By default this is <code>Administrator</code>. To use an alternate account, create a user account and assign that account to the following groups (Windows 2012 Server): Hyper-V Administrators and Remote Management Users.'),
         'xen' => _('Account name by which virt-who is to connect to the hypervisor.'),
-        'libvirt' => _('Account name by which virt-who is to connect to the hypervisor.')
+        'libvirt' => _('Account name by which virt-who is to connect to the hypervisor. Virt-who does not support password based authentication, you must manually setup SSH key, see <a href="https://access.redhat.com/solutions/1515983">Red Hat Knowledgebase solution How to configure virt-who for a KVM host</a> for more information.')
       }
     end
 
@@ -26,9 +26,7 @@ module ForemanVirtWhoConfigure
       message = case config.status
                   when :unknown
                     _('No Report Yet')
-                  when :ok
-                    l(config.last_report_at, :format => :long)
-                  when :error
+                  when :ok, :out_of_date
                     l(config.last_report_at, :format => :long)
                   else
                     _('Unknown configuration status')
@@ -43,10 +41,8 @@ module ForemanVirtWhoConfigure
 
     def report_status_class(status)
       icon_class = case status
-                     when :ok
+                     when :ok, :out_of_date
                        'pficon-ok'
-                     when :error
-                       'pficon-error-circle-o'
                      when :unknown
                        'pficon-info'
                      else
@@ -58,12 +54,10 @@ module ForemanVirtWhoConfigure
 
     def status_class(status)
       case status
-        when :ok
+        when :ok, :out_of_date
           'status-ok'.html_safe
         when :unknown
           'status-info'.html_safe
-        when :error
-          'status-error'.html_safe
         else
           'status-warn'.html_safe
       end

data/app/models/foreman_virt_who_configure/auth_source_hidden_with_authentication.rb

@@ -6,8 +6,17 @@ module ForemanVirtWhoConfigure
       end
     end
 
+    def auth_method_name
+      "HIDDEN with API access"
+    end
+    alias_method :to_label, :auth_method_name
+
     def authenticate(login, password)
-      AuthSourceInternal.new.authenticate(login, password)
+      # the authentication should only happen if our SSO signals that it's available
+      # we need to reset the signal since for non API calls the SSO is not used at all and does not set signal to false
+      result = Thread.current[:service_user_login] ? AuthSourceInternal.new.authenticate(login, password) : false
+      Thread.current[:service_user_login] = nil
+      result
     end
   end
 end

data/app/models/foreman_virt_who_configure/config.rb

@@ -6,22 +6,22 @@ module ForemanVirtWhoConfigure
       :satellite_url, :proxy, :no_proxy, :name
     ]
     include Authorizable
-    audited
+    audited :except => [ :hypervisor_password, :last_report_at, :out_of_date_at ]
     validates_lengths_from_database
 
     UNLIMITED = 0
     WHITELIST = 1
     BLACKLIST = 2
     FILTERING_MODES = {
-      UNLIMITED.to_s => _('Unlimited'),
-      WHITELIST.to_s => _('Whitelist'),
-      BLACKLIST.to_s => _('Blacklist'),
+      UNLIMITED.to_s => N_('Unlimited'),
+      WHITELIST.to_s => N_('Whitelist'),
+      BLACKLIST.to_s => N_('Blacklist'),
     }
 
     WIZARD_STEPS = {
-      'general_information' => _('General information'),
-      'schedule' => _('Schedule'),
-      'connection' => _('Connection')
+      'general_information' => N_('General information'),
+      'schedule' => N_('Schedule'),
+      'connection' => N_('Connection')
     }
 
     HYPERVISOR_IDS = [ 'hostname', 'uuid', 'hwuuid' ]
@@ -38,18 +38,18 @@ module ForemanVirtWhoConfigure
     HYPERVISOR_DEFAULT_TYPE = 'esx'
 
     AVAILABLE_INTERVALS = {
-      '60' => _('Every hour'),
-      '120' => _('Every 2 hours'),
-      '240' => _('Every 4 hours'),
-      '480' => _('Every 8 hours'),
-      '720' => _('Every 12 hours'),
+      '60' => N_('Every hour'),
+      '120' => N_('Every 2 hours'),
+      '240' => N_('Every 4 hours'),
+      '480' => N_('Every 8 hours'),
+      '720' => N_('Every 12 hours'),
     }
 
     DEFAULT_INTERVAL = 120
 
     STATUSES = {
       'ok' => N_('OK'),
-      'error' => N_('Error'),
+      'out_of_date' => N_('No change'),
       'unknown' => N_('Unknown')
     }
 
@@ -57,7 +57,7 @@ module ForemanVirtWhoConfigure
       {
         :unknown => N_('The configuration was not deployed yet or the virt-who was unable to report the status'),
         :ok => N_('The virt-who report arrived within the interval'),
-        :error => N_('The virt-who report has not arrived within the interval, please check the virt-who reporter status and logs')
+        :out_of_date => N_('The virt-who report has not arrived within the interval, which indicates there was no change on hypervisor')
       }
     )
 
@@ -77,16 +77,6 @@ module ForemanVirtWhoConfigure
     scoped_search :on => :last_report_at, :complete_value => true, :only_explicit => true
     # TODO add more related objects and attributes
 
-    # Foreman 1.11 specifics, can be removed later, otherwise when string does not start with "encrypts" prefix
-    # we get 500 when we try to create log message that relies on name method
-    def name
-      title
-    end
-
-    def title
-      compute_resource ? compute_resource.name : hypervisor_server
-    end
-
     # compatibility layer for 1.11 - pre strong params patch
     if self.respond_to?(:attr_accessible)
       attr_accessible(*PERMITTED_PARAMS)
@@ -117,7 +107,7 @@ module ForemanVirtWhoConfigure
                       sanitize_sql_for_conditions([' out_of_date_at >= ? ', DateTime.now.utc.to_s(:db)])
                     when 'unknown'
                       sanitize_sql_for_conditions({:last_report_at => nil})
-                    when 'error'
+                    when 'out_of_date'
                       sanitize_sql_for_conditions([' out_of_date_at < ? ', DateTime.now.utc.to_s(:db)])
                   end
       { :conditions => condition }
@@ -169,17 +159,21 @@ module ForemanVirtWhoConfigure
     end
 
     def step_name(step_key)
-      WIZARD_STEPS[step_key]
+      _(WIZARD_STEPS[step_key])
     end
 
     def steps
       WIZARD_STEPS.keys
     end
 
-    def virt_who_config_file
+    def virt_who_bash_script
+      virt_who_config_script(:bash_script)
+    end
+
+    def virt_who_config_script(format = nil)
       generator = OutputGenerator.new(self)
       if generator.ready_for_virt_who_output?
-        generator.virt_who_output
+        generator.virt_who_output(format)
       else
         generator.missing_virt_who_input_messages.join("\n")
       end
@@ -198,7 +192,8 @@ module ForemanVirtWhoConfigure
         when !self.out_of_date?
           :ok
         else
-          :error
+          # out of date is currently considered ok too, virt-who does not send any report if there's no change on hypervisor
+          :out_of_date
       end
     end
 

data/app/models/foreman_virt_who_configure/output_generator.rb

@@ -1,11 +1,35 @@
 module ForemanVirtWhoConfigure
   class OutputGenerator
+    class ConfigurationResult
+      attr_reader :code, :identifier, :message
+      def initialize(code, identifier, message)
+        @code, @message, @identifier = code, message, identifier
+      end
+    end
+
+    MINIMUM_VIRT_WHO_VERSION = '0.19'
+
+    CONFIGURATION_RESULTS = [
+      ConfigurationResult.new(0, 'success', N_('Success')),
+      ConfigurationResult.new(1, 'virt_who_too_old', N_('Newer version of virt-who is required, minimum version is %s') % MINIMUM_VIRT_WHO_VERSION),
+      ConfigurationResult.new(2, 'virt_who_config_file_issue', N_('Unable to create virt-who config file')),
+      ConfigurationResult.new(4, 'virt_who_sysconfig_file_issue', N_('Unable to create sysconfig file')),
+      ConfigurationResult.new(8, 'virt_who_chkconfig_issue', N_('Unable to enable virt-who service using chkconfig')),
+      ConfigurationResult.new(16, 'virt_who_service_issue', N_('Unable to start virt-who service, please see virt-who logs for more details')),
+      ConfigurationResult.new(32, 'virt_who_installation', N_('Unable to install virt-who package, make sure the host is properly subscribed and has access to satellite-tools repository')),
+    ]
+
     attr_reader :config
 
     def initialize(config)
       @config = config
     end
 
+    def error_code(error_name)
+      result = CONFIGURATION_RESULTS.find { |result| result.identifier == error_name.to_s }
+      result.try(:code)
+    end
+
     def ready_for_virt_who_output?
       missing_virt_who_input_messages.empty?
     end
@@ -19,16 +43,50 @@ module ForemanVirtWhoConfigure
       messages
     end
 
-    def virt_who_output
-<<EOS
-echo "Installing virt-who.."
-yum install -y virt-who
-echo "Encrypting password.."
-cr_password=`virt-who-password --password "#{cr_password}" 2> /dev/null`
-user_password=`virt-who-password --password "#{service_user_password}" 2> /dev/null`
-
-echo "Creating virt-who configuration.."
-cat > #{config_file_path} << EOF
+    def virt_who_output(format = nil)
+      result = ''
+      result += "#!/usr/bin/bash\n" if format == :bash_script
+      result += <<EOS
+heading() {
+  echo -e "\\n== $1 =="
+}
+
+step() {
+  step_count=5
+  heading "[$1/$step_count] $2"
+}
+
+version_lte() {
+  [ "$1" = "`echo -e "$1\\n$2" | sort -V | head -n1`" ]
+}
+
+version_lt() {
+  [ "$1" = "$2" ] && return 1 || version_lte $1 $2
+}
+
+verify_minimal_version() {
+  minimal_version=#{MINIMUM_VIRT_WHO_VERSION}
+  installed_version=`rpm -q --queryformat '%{VERSION}' virt-who`
+
+  if version_lt $installed_version $minimal_version; then
+    echo "virt-who $installed_version does not meet minimum requirements, please make sure this host is properly subscribed and has access to satellite-tools repository, minimal virt-who version is $minimal_version"
+    return 1
+  else
+    return 0
+  fi
+}
+
+result_code=#{error_code(:success)}
+step 1 "Installing virt-who"
+yum install -y virt-who || result_code=$(($result_code|#{error_code(:virt_who_installation)}))
+
+if verify_minimal_version; then
+  step 2 "Encrypting password"
+  cr_password=`virt-who-password --password "#{cr_password}" 2> /dev/null`
+  user_password=`virt-who-password --password "#{service_user_password}" 2> /dev/null`
+
+  step 3 "Creating virt-who configuration"
+  cat > #{config_file_path} << EOF
 [#{identifier}]
 type=#{type}
 hypervisor_id=#{hypervisor_id}
@@ -42,20 +100,40 @@ rhsm_username=#{service_user_username}
 rhsm_encrypted_password=$user_password
 rhsm_prefix=/rhsm
 EOF
+  if [ $? -ne 0 ]; then result_code=$(($result_code|#{error_code(:virt_who_config_file_issue)})); fi
 
-echo "Creating sysconfig virt-who configuration.."
-cat > /etc/sysconfig/virt-who << EOF
+  step 4 "Creating sysconfig virt-who configuration"
+  cat > #{sysconfig_file_path} << EOF
 VIRTWHO_SATELLITE6=1
 VIRTWHO_DEBUG=#{config.debug? ? 1 : 0}
 VIRTWHO_INTERVAL=#{config.interval * 60}#{proxy_strings}
 EOF
+  if [ $? -ne 0 ]; then result_code=$(($result_code|#{error_code(:virt_who_sysconfig_file_issue)})); fi
+
+  step 5 "Enabling and restarting the virt-who service"
+  chkconfig virt-who on || result_code=$(($result_code|#{error_code(:virt_who_chkconfig_issue)}))
+  service virt-who restart || result_code=$(($result_code|#{error_code(:virt_who_service_issue)}))
+else
+  result_code=$(($result_code|#{error_code(:virt_who_too_old)}))
+fi
+
+heading "Finished"
+if [ $result_code -ne 0 ]; then
+  echo "There were some errors during configuration:"
+  #{error_handling}
+else
+  echo "Finished successully"
+fi
 
-echo "Enabling and restarting the virt-who service"
-chkconfig virt-who on
-service virt-who restart
-
-echo "Done."
 EOS
+      result += "exit $result_code\n" if format == :bash_script
+      result
+    end
+
+    def error_handling
+      CONFIGURATION_RESULTS.map do |result|
+        "[ $(($result_code&#{result.code})) -ge 1 ] && echo '#{result.message}'"
+      end.join("\n  ")
     end
 
     def filtering
@@ -81,6 +159,10 @@ EOS
       "/etc/virt-who.d/#{identifier}.conf"
     end
 
+    def sysconfig_file_path
+      '/etc/sysconfig/virt-who'
+    end
+
     def identifier
       "virt-who-config-#{config.id}"
     end