foreman_virt_who_configure 0.0.1

data/app/models/foreman_virt_who_configure/output_generator.rb

@@ -0,0 +1,152 @@
+module ForemanVirtWhoConfigure
+  class OutputGenerator
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def ready_for_virt_who_output?
+      missing_virt_who_input_messages.empty?
+    end
+
+    def missing_virt_who_input_messages
+      messages = []
+      messages.push _('Owner was not provided') unless config.organization_id?
+      messages.push _('Interval was not provided') unless config.interval.present?
+      # messages.push _('Cofiguration not stored') unless config.persisted?
+      # messages.push _('Service user was not provided') unless config.service_user_id.present?
+      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
+[#{identifier}]
+type=#{type}
+hypervisor_id=#{hypervisor_id}
+owner=#{owner}
+env=Library
+server=#{cr_server}
+username=#{cr_username}
+encrypted_password=$cr_password#{filtering}
+rhsm_hostname=#{satellite_url}
+rhsm_username=#{service_user_username}
+rhsm_encrypted_password=$user_password
+rhsm_prefix=/rhsm
+EOF
+
+echo "Creating sysconfig virt-who configuration.."
+cat > /etc/sysconfig/virt-who << EOF
+VIRTWHO_SATELLITE6=1
+VIRTWHO_DEBUG=#{config.debug? ? 1 : 0}
+VIRTWHO_INTERVAL=#{config.interval * 60}#{proxy_strings}
+EOF
+
+echo "Enabling and restarting the virt-who service"
+chkconfig virt-who on
+service virt-who restart
+
+echo "Done."
+EOS
+    end
+
+    def filtering
+      case config.listing_mode.to_i
+        when ForemanVirtWhoConfigure::Config::UNLIMITED
+          return ''
+        when ForemanVirtWhoConfigure::Config::WHITELIST
+          return filtering_line_sanitized('filter_hosts', config.whitelist)
+        when ForemanVirtWhoConfigure::Config::BLACKLIST
+          return filtering_line_sanitized('exclude_hosts', config.blacklist)
+      end
+    end
+
+    def filtering_line_sanitized(filter, list)
+      "\n" + filter + '=' + sanitize_filter(list.to_s)
+    end
+
+    def sanitize_filter(list)
+      sanitize(list)
+    end
+
+    def config_file_path
+      "/etc/virt-who.d/#{identifier}.conf"
+    end
+
+    def identifier
+      "virt-who-config-#{config.id}"
+    end
+
+    def hypervisor_id
+      config.hypervisor_id
+    end
+
+    def owner
+      config.organization.label
+    end
+
+    def type
+      config.hypervisor_type
+    end
+
+    # returns nil if url could not be parsed or is invalid, e.g. qemu:///system
+    def cr_server
+      config.hypervisor_server
+    end
+
+    def cr_username
+      config.hypervisor_username
+    end
+
+    def cr_password
+      config.hypervisor_password
+    end
+
+    def satellite_url
+      config.satellite_url
+    end
+
+    def service_user_username
+      config.service_user.username
+    end
+
+    def service_user_password
+      config.service_user.encrypted_password
+    end
+
+    def cr
+      config.compute_resource
+    end
+
+    def proxy
+      config.proxy
+    end
+
+    def no_proxy
+      config.no_proxy
+    end
+
+    def sanitize_proxy(string)
+      sanitize(string)
+    end
+
+    def proxy_strings
+      output = ''
+      output << "\nhttp_proxy=#{sanitize_proxy(proxy)}" if proxy.present?
+      output << "\nno_proxy=#{sanitize_proxy(no_proxy)}" if no_proxy.present?
+      output
+    end
+
+    def sanitize(string)
+      string.tr("\r\n", '').strip.chomp(",")
+    end
+  end
+end

data/app/models/foreman_virt_who_configure/service_user.rb

@@ -0,0 +1,21 @@
+module ForemanVirtWhoConfigure
+  # holds the encrypted password for internal user that can be deployed to virt who reporter
+  class ServiceUser < ActiveRecord::Base
+    include Authorizable
+    include Encryptable
+    encrypts :encrypted_password
+
+    belongs_to :user
+    has_many :configs
+
+    # 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
+      self.username || self.to_s
+    end
+
+    def username
+      self.user.login if self.user
+    end
+  end
+end

data/app/services/sso/basic_with_hidden.rb

@@ -0,0 +1,11 @@
+module SSO
+  class BasicWithHidden < Basic
+    def available?
+      controller.api_request? && http_auth_set? && controller.is_a?(::Katello::Api::Rhsm::CandlepinProxiesController)
+    end
+
+    def current_user
+      User.unscoped.where(:auth_source_id => ForemanVirtWhoConfigure::AuthSourceHiddenWithAuthentication.default.id).find_by_login(self.user)
+    end
+  end
+end

data/app/views/dashboard/_foreman_virt_who_configure_widget.html.erb

@@ -0,0 +1,2 @@
+<h4 class="header ca"><%= _('ForemanVirtWhoConfigure') %></h4>
+<%= _('Widget content') %>

data/app/views/foreman_virt_who_configure/configs/_form.html.erb

@@ -0,0 +1,20 @@
+<% javascript 'foreman_virt_who_configure/config_edit' %>
+
+<%= form_for @config, :as => 'foreman_virt_who_configure_config', :url => (@config.new_record? ? foreman_virt_who_configure_configs_path : foreman_virt_who_configure_config_path(:id => @config)) do |f| %>
+  <%= base_errors_for @config %>
+
+  <div class="tab-content">
+
+    <% @config.steps.each do |step| %>
+      <fieldset>
+        <h3><%= @config.step_name(step) %></h3>
+        <hr>
+        <%= render :partial => "foreman_virt_who_configure/configs/steps/#{step.downcase.tr(' ', '_')}_form", :locals => { :f => f } %>
+      </fieldset>
+
+    <% end %>
+
+  </div>
+
+  <%= submit_or_cancel f %>
+<% end %>

data/app/views/foreman_virt_who_configure/configs/edit.html.erb

@@ -0,0 +1,3 @@
+<% title _("Edit Config") %>
+
+<%= render :partial => 'form' %>

data/app/views/foreman_virt_who_configure/configs/index.html.erb

@@ -0,0 +1,27 @@
+<% title _("Configs") %>
+
+<% title_actions new_config_link, help_button_or_path %>
+
+<table class="<%= table_css_classes 'table-fixed' %>">
+  <thead>
+    <tr>
+      <th class="col-md-8"><%= sort :name, :as => s_("Config|Title") %></th>
+      <th><%= s_("Config|Interval") %></th>
+      <th><%= _('Actions') %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @configs.each do |config| %>
+    <tr>
+      <td class="display-two-pane ellipsis"><%= link_to_if_authorized (config.title), hash_for_foreman_virt_who_configure_config_path(:id => config).merge(:auth_object => config, :authorizer => authorizer) %></td>
+      <td><%= config.humanized_interval %></td>
+      <td class="col-md-1"><%= action_buttons(
+                                   display_link_if_authorized(_('Edit'), hash_for_edit_foreman_virt_who_configure_config_path(:id => config).merge(:auth_object => config, :authorizer => authorizer)),
+                                   display_delete_if_authorized((hash_for_foreman_virt_who_configure_config_path(:id => config).merge(:auth_object => config, :authorizer => authorizer)), :data => { :confirm => _("Delete virt-who configuration %s?") % config.title })
+                               ) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= will_paginate_with_info @configs %>

data/app/views/foreman_virt_who_configure/configs/new.html.erb

@@ -0,0 +1,3 @@
+<% title _("New Virt Who Config") %>
+
+<%= render :partial => "foreman_virt_who_configure/configs/form" %>

data/app/views/foreman_virt_who_configure/configs/show.html.erb

@@ -0,0 +1,24 @@
+<% stylesheet 'foreman_virt_who_configure/config' %>
+
+<div class="clearfix">
+  <div class="form-group">
+    <div class="row">
+      <div class="col-md-12">
+        <label><%= _("Run this script on the target host which will run virt-who reporting, preferably Satellite host:") %></label>
+        <p>
+          <%= _("1. Copy this configuration script to a safe directory on the host.") %></br>
+          <%= _("2. Make the script executable and run it on the host.") %></br>
+          <%= _("3. Delete the script on the host.") %></br>
+        </p>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="col-md-8">
+        <pre class="terminal"><%= @config.virt_who_config_file %></pre>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%= link_to _('Change this configuration'), edit_foreman_virt_who_configure_config_path(@config), :class => 'btn btn-default' %>

data/app/views/foreman_virt_who_configure/configs/steps/_connection_form.erb

@@ -0,0 +1,16 @@
+<div id="config_connection">
+  <%= text_f f, :satellite_url, :help_inline => popover('', _('Satellite Server’s fully-qualified host name, for example: satellite.example.com')), :label => _('Satellite Server FQDN') %>
+  <%= select_f f, :hypervisor_id, ForemanVirtWhoConfigure::Config::HYPERVISOR_IDS, :to_s, :to_s, {}, :label => _('Hypervisor ID'),
+               :help_inline => popover('', _("Specifies that hypervisors will be identified by their <b>hostname</b>, <b>uuid</b> or <b>hwuuid</b>.
+                                  Note that some virtualization backends don't have all of them implemented.
+                                  Default is <b>uuid</b>, which we also recommend to use. <b>hostname</b> provides more meaningful hypervisor
+                                  names but can cause duplicated hypervisor registrations if the host is renamed. <b>hwuuid</b> is applicable to esx and rhevm only.
+                                  This property is meant to be set up before the initial run of virt-who. Changing it later will result in duplicated entries in the subscription manager.").html_safe) %>
+  <%= select_f f, :listing_mode, ForemanVirtWhoConfigure::Config::FILTERING_MODES, :first, :last, {}, :label => _('Filtering'),
+               :help_inline => popover('', _("If you run a hybrid environment, with virtual machines running Red Hat Enterprise Linux and other operating systems, you may want to limit the scope of virt-who’s access to hosts. For example, if some hypervisors host only Microsoft Windows Server instances, there is no benefit in having those hypervisors reported by the virt-who agent."))%>
+  <%= textarea_f f, :whitelist, :help_inline => popover('', _('Only hosts which uuid (or hostname or hwuuid, based on <code>hypervisor_id</code>) is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma.  Put the value into the double-quotes if it contains special characters like comma.  All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.')), :label => _('Filter hosts') %>
+  <%= textarea_f f, :blacklist, :help_inline => popover('', _('Hosts which uuid (or hostname or hwuuid, based on <code>hypervisor_id</code>) is specified in comma-separated list in this option will <b>NOT</b> be reported.  Wildcards and regular expressions are supported, multiple records must be separated by comma.  Put the value into the double-quotes if it contains special characters like comma.  All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.').html_safe), :label => _('Exclude hosts') %>
+  <%= checkbox_f f, :debug, :label => _('Do you want to enable debugging output?') %>
+  <%= text_f f, :proxy, :help_inline => popover('', _('HTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers. Leave this blank if no proxy is used.')), :label => _('HTTP Proxy') %>
+  <%= text_f f, :no_proxy, :help_inline => popover('', _('A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to <code>*</code> to bypass proxy settings for all hostnames domains or ip addresses.')), :label => _('Ignore Proxy') %>
+</div>

data/app/views/foreman_virt_who_configure/configs/steps/_general_information_form.erb

@@ -0,0 +1,12 @@
+<div id="config_general_information">
+  <% if f.object.organization_id.present? %>
+    <%= f.hidden_field :organization_id %>
+  <% else %>
+    <%= select_f f, :organization_id, Organization.authorized(:view_organizations), :id, :to_s, {}, :label => _('Owner') %>
+  <% end %>
+
+  <%= select_f f, :hypervisor_type, ForemanVirtWhoConfigure::Config::HYPERVISOR_TYPES, :first, :last %>
+  <%= text_f f, :hypervisor_server, :help_inline => popover('', hypervisor_server_help_data[f.object.hypervisor_type].html_safe), :data => { :help => hypervisor_server_help_data } %>
+  <%= text_f f, :hypervisor_username, :help_inline => popover('', hypervisor_username_help_data[f.object.hypervisor_type].html_safe), :data => { :help => hypervisor_username_help_data }  %>
+  <%= password_f f, :hypervisor_password, :value => f.object.hypervisor_password, :help_inline => popover('', _('Account password by which virt-who is to connect to the hypervisor instance.')) %>
+</div>

data/app/views/foreman_virt_who_configure/configs/steps/_schedule_form.erb

@@ -0,0 +1,4 @@
+<div id="config_schedule">
+  <%= select_f f, :interval, ForemanVirtWhoConfigure::Config::AVAILABLE_INTERVALS, :first, :last, {},
+               :help_inline => popover('', _("How often to check connected hypervisors for changes? Also affects how often a mapping is reported. The recommended value for most environments is every two hours.")) %>
+</div>

data/app/views/foreman_virt_who_configure/configs/welcome.html.erb

@@ -0,0 +1,14 @@
+<div class="blank-slate-pf">
+  <div class="blank-slate-pf-icon">
+    <%= icon_text("globe", "", :kind => "fa") %>
+  </div>
+  <h1><%= _('Configs') %></h1>
+  <p>
+    <%= _("On this page you can define virt-who configurations for your hypervisors.") %></br>
+    <%= _("One virt-who configuration represents one config file in /etc/virt-who.d directory and maps to single hypervisor, organization and lifecycle environment.") %></br>
+    <%= _("To define a new configuration, click the New Config button and fill in the form. After you provide all required information a virt-who configuration script will be generated. You could either install it manually by copying the script or deploy it on a selected target host through Remote Execution.") %></br>
+  </p>
+  <div class="blank-slate-pf-main-action">
+      <%= new_config_link({}, { :class => "btn btn-primary btn-lg" }) %>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+  namespace :foreman_virt_who_configure do
+    resources :configs do
+      collection do
+        get 'auto_complete_search'
+      end
+    end
+  end
+end

data/db/migrate/20170102152649_create_service_users.rb

@@ -0,0 +1,12 @@
+class CreateServiceUsers < ActiveRecord::Migration
+  def change
+    create_table :foreman_virt_who_configure_service_users do |t|
+      t.string :encrypted_password, :null => false
+      t.references :user, :index => { :name => 'fvwc_su_user_id' }, :null => false
+
+      t.timestamps :null => false
+    end
+
+    add_foreign_key :foreman_virt_who_configure_service_users, :users, :column => :user_id
+  end
+end

data/db/migrate/20170102152650_create_configs.rb

@@ -0,0 +1,22 @@
+class CreateConfigs < ActiveRecord::Migration
+  def change
+    create_table :foreman_virt_who_configure_configs do |t|
+      t.integer :interval, :default => 60, :null => true
+      # this is not a foreign key but one of 'hostname', 'uuid', 'hwuuid'
+      t.string :hypervisor_id, :null => true
+      t.integer :listing_mode, :null => true
+      t.text :whitelist, :null => true
+      t.text :blacklist, :null => true
+
+      t.references :compute_resource, :index => { :name => 'fvwc_c_compute_resource_id' }, :null => true
+      t.references :organization, :index => { :name => 'fvwc_c_oragnization_id' }, :null => true
+      t.references :service_user, :index => { :name => 'fvwc_su_service_user' }, :null => true
+
+      t.timestamps :null => false
+    end
+
+    add_foreign_key :foreman_virt_who_configure_configs, :compute_resources, :column => :compute_resource_id
+    add_foreign_key :foreman_virt_who_configure_configs, :taxonomies, :column => :organization_id
+    add_foreign_key :foreman_virt_who_configure_configs, :foreman_virt_who_configure_service_users, :column => :service_user_id
+  end
+end

data/db/migrate/20170102152751_add_lab_attrs_to_config.rb

@@ -0,0 +1,9 @@
+class AddLabAttrsToConfig < ActiveRecord::Migration
+  def change
+    add_column :foreman_virt_who_configure_configs, :debug, :boolean, :default => false, :null => true
+    add_column :foreman_virt_who_configure_configs, :hypervisor_type, :string, :null => true
+    add_column :foreman_virt_who_configure_configs, :hypervisor_server, :string, :null => true
+    add_column :foreman_virt_who_configure_configs, :hypervisor_username, :string, :null => true
+    add_column :foreman_virt_who_configure_configs, :hypervisor_password, :string, :null => true
+  end
+end

data/db/migrate/20170102152851_add_satellite_url_to_config.rb

@@ -0,0 +1,5 @@
+class AddSatelliteUrlToConfig < ActiveRecord::Migration
+  def change
+    add_column :foreman_virt_who_configure_configs, :satellite_url, :string, :null => true
+  end
+end

data/db/migrate/20170215152851_change_default_interval.rb

@@ -0,0 +1,9 @@
+class ChangeDefaultInterval < ActiveRecord::Migration
+  def up
+    change_column :foreman_virt_who_configure_configs, :interval, :integer, :default => 120
+  end
+
+  def down
+    change_column :foreman_virt_who_configure_configs, :interval, :integer, :default => 60
+  end
+end

data/db/migrate/20170309161551_add_proxy_and_no_proxy_to_config.rb

@@ -0,0 +1,11 @@
+class AddProxyAndNoProxyToConfig < ActiveRecord::Migration
+  def up
+    add_column :foreman_virt_who_configure_configs, :proxy, :string
+    add_column :foreman_virt_who_configure_configs, :no_proxy, :string
+  end
+
+  def down
+    remove_column :foreman_virt_who_configure_configs, :no_proxy
+    remove_column :foreman_virt_who_configure_configs, :proxy
+  end
+end

data/lib/foreman_virt_who_configure/engine.rb

@@ -0,0 +1,108 @@
+require 'katello'
+
+module ForemanVirtWhoConfigure
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_virt_who_configure'
+
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/test/"]
+
+    # Add any db migrations
+    initializer 'foreman_virt_who_configure.load_app_instance_data' do |app|
+      ForemanVirtWhoConfigure::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_virt_who_configure.register_plugin', :before => :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_virt_who_configure do
+        requires_foreman '>= 1.11'
+        requires_foreman_plugin 'katello', '>= 3.0.0'
+
+        # Add permissions
+        security_block :foreman_virt_who_configure do
+          permission :view_virt_who_config, :'foreman_virt_who_configure/configs' => [:index, :show, :auto_complete_search], :resource_type => 'ForemanVirtWhoConfigure::Config'
+          permission :create_virt_who_config, :'foreman_virt_who_configure/configs' => [:new, :create], :resource_type => 'ForemanVirtWhoConfigure::Config'
+          permission :edit_virt_who_config, :'foreman_virt_who_configure/configs' => [:edit, :update], :resource_type => 'ForemanVirtWhoConfigure::Config'
+          permission :destroy_virt_who_config, :'foreman_virt_who_configure/configs' => [:destroy], :resource_type => 'ForemanVirtWhoConfigure::Config'
+        end
+
+        reporter_permissions = [ :create_hosts, :edit_hosts, :view_lifecycle_environments, :my_organizations ]
+        begin
+          if Permission.where(:name => ['create_content_hosts', 'edit_content_hosts']).count > 0
+            # old Katello permissions detected (6.2 era)
+            reporter_permissions += [:create_content_hosts, :edit_content_hosts]
+          end
+        rescue ActiveRecord::StatementInvalid
+          # permissions could not be loaded, probably migration hasn't been run yet
+        end
+
+        begin
+          role 'Virt-who Reporter', reporter_permissions
+        rescue ArgumentError
+          # could not configure role, some permissions are missing
+        end
+
+        role 'Virt-who Manager', [ :view_virt_who_config, :create_virt_who_config, :edit_virt_who_config, :destroy_virt_who_config ]
+        role 'Virt-who Viewer', [ :view_virt_who_config ]
+
+        # add menu entry
+        menu :top_menu, :virt_who_configs,
+             url_hash: { controller: 'foreman_virt_who_configure/configs', action: :index },
+             caption: N_('Virt-who configurations'),
+             parent: :infrastructure_menu,
+             after: :compute_resources
+
+        # add dashboard widget
+        # widget 'foreman_virt_who_configure_widget', name: N_('Foreman plugin template widget'), sizex: 4, sizey: 1
+      end
+    end
+
+    # Precompile any JS or CSS files under app/assets/
+    # If requiring files from each other, list them explicitly here to avoid precompiling the same
+    # content twice.
+    assets_to_precompile =
+      Dir.chdir(root) do
+        Dir['app/assets/javascripts/foreman_virt_who_configure/**/*', 'app/assets/stylesheets/foreman_virt_who_configure/**/*'].map do |f|
+          f.split(File::SEPARATOR, 4).last.gsub(/\.scss\Z/, '')
+        end
+      end
+    initializer 'foreman_virt_who_configure.assets.precompile' do |app|
+      app.config.assets.precompile += assets_to_precompile
+    end
+    initializer 'foreman_virt_who_configure.configure_assets', group: :assets do
+      SETTINGS[:foreman_virt_who_configure] = { assets: { precompile: assets_to_precompile } }
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      SSO::METHODS.unshift SSO::BasicWithHidden
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanVirtWhoConfigure::Engine.load_seed
+      end
+    end
+
+    initializer 'foreman_virt_who_configure.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_domain = 'foreman_virt_who_configure'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+
+  def self.with_katello?
+    (Katello rescue false) ? true : false
+  end
+
+  def self.table_name_prefix
+    "foreman_virt_who_configure_"
+  end
+
+  def self.use_relative_model_naming?
+    true
+  end
+end