foreman_virt_who_configure 0.0.1

data/README.md

@@ -0,0 +1,35 @@
+# ForemanVirtWhoConfigure
+
+A foreman plugin to make virt-who configuration easier.
+
+## Installation
+
+See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
+for how to install Foreman plugins
+
+## Usage
+
+After installation you should see Virt-who configurations menu item in Infrastructure menu. Create a new configuration
+and see the generated script for virt-who deployment.
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) 2017 - Foreman team
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanVirtWhoConfigure'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

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

@@ -0,0 +1,31 @@
+function virt_who_update_listing_mode() {
+  var filtering_mode = $('#foreman_virt_who_configure_config_listing_mode').val();
+  var whitelist = $('#foreman_virt_who_configure_config_whitelist').parents('div.form-group');
+  var blacklist = $('#foreman_virt_who_configure_config_blacklist').parents('div.form-group');
+
+  // UNLIMITED = 0, WHITELIST = 1, BLACKLIST = 2, see config.rb model for the definition
+  if (filtering_mode == '0') {
+    whitelist.hide();
+    blacklist.hide();
+  } else if (filtering_mode == '1') {
+    whitelist.show();
+    blacklist.hide();
+  } else if (filtering_mode == '2') {
+    whitelist.hide();
+    blacklist.show();
+  }
+}
+
+$(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);
+    });
+  });
+
+  virt_who_update_listing_mode();
+  $('#foreman_virt_who_configure_config_listing_mode').change(virt_who_update_listing_mode);
+});

data/app/assets/stylesheets/foreman_virt_who_configure/config.css.scss

@@ -0,0 +1,13 @@
+pre.terminal {
+  display: block;
+  padding: 9.5px;
+  margin: 0 0 10px;
+  font-size: 12px;
+  word-break: break-all;
+  word-wrap: break-word;
+  color: rgba(255, 255, 255, 1);
+  background-color: rgba(47, 47, 47, 1);
+  border: 1px solid #000000;
+  border-radius: 0px;
+  font-family: Menlo, Monaco, Consolas, monospace;
+}

data/app/controllers/foreman_virt_who_configure/application_controller.rb

@@ -0,0 +1,11 @@
+module ForemanVirtWhoConfigure
+  class ApplicationController < ::ApplicationController
+    def resource_class
+      self.class.to_s.sub(/Controller$/, '').singularize.constantize
+    end
+
+    def resource_name
+      'config'
+    end
+  end
+end

data/app/controllers/foreman_virt_who_configure/concerns/config_parameters.rb

@@ -0,0 +1,22 @@
+module ForemanVirtWhoConfigure
+  module Concerns
+    module ConfigParameters
+      extend ActiveSupport::Concern
+
+      # 6.2 compatibility layer
+      if respond_to?(:class_methods)
+        class_methods do
+          def config_params_filter
+            Foreman::ParameterFilter.new(::ForemanVirtWhoConfigure::Config).tap do |filter|
+              filter.permit(*ForemanVirtWhoConfigure::Config::PERMITTED_PARAMS)
+            end
+          end
+        end
+      end
+
+      def config_params
+        self.class.config_params_filter.filter_params(params, parameter_filter_context, 'foreman_virt_who_configure_config')
+      end
+    end
+  end
+end

data/app/controllers/foreman_virt_who_configure/configs_controller.rb

@@ -0,0 +1,94 @@
+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]
+
+    # in 1.11 we can't use welcome from application controller since it does not work with namespaces
+    def welcome
+      scope = apply_organization_filter(model_of_controller)
+      if scope.first.nil?
+        @welcome = true
+        render :action => :welcome
+      end
+    end
+
+    def index
+      if respond_to?(:resource_base_search_and_page)
+        @configs = resource_base_search_and_page
+      else
+        base = resource_base.search_for(params[:search], :order => params[:order])
+        @configs = base.paginate(:page => params[:page], :per_page => params[:per_page])
+      end
+      @configs = apply_organization_filter(@configs)
+    end
+
+    def new
+      @config = Config.new
+      if params.key?(:organization_id)
+        @config.organization = Organization.authorized(:view_organizations).where(:id => params[:organization_id]).first
+      end
+      @config.hypervisor_type ||= Config::HYPERVISOR_DEFAULT_TYPE
+      @config.organization ||= Organization.current
+      @config.satellite_url ||= URI.parse(Setting.foreman_url).host
+    end
+
+    def create
+      @config = Config.new(config_params)
+      if @config.save
+        process_success :success_redirect => foreman_virt_who_configure_config_path(@config)
+      else
+        render 'new'
+      end
+    end
+
+    def show
+    end
+
+    def edit
+    end
+
+    def update
+      if @config.update_attributes(config_params)
+        process_success :object => @config
+      else
+        process_error :object => @config
+      end
+    end
+
+    def destroy
+      if @config.destroy
+        process_success :object => @config
+      else
+        process_error :object => @config
+      end
+    end
+
+    def auto_complete_controller_name
+      'foreman_virt_who_configure_configs'
+    end
+
+    def controller_name
+      'foreman_virt_who_configure_configs'
+    end
+
+    # 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
+
+    private
+
+    def apply_organization_filter(scope)
+      Organization.current ? scope.where(:organization_id => Organization.current) : scope
+    end
+
+    def resource_scope(*args)
+      apply_organization_filter(super)
+    end
+  end
+end

data/app/helpers/foreman_virt_who_configure/compatibility_helper.rb

@@ -0,0 +1,22 @@
+module ForemanVirtWhoConfigure
+  module CompatibilityHelper
+    extend ActiveSupport::Concern
+
+    def new_config_link(options = {}, html_options = {})
+      if ApplicationHelper.instance_methods.include?(:new_link)
+        new_link(_("Create Config"), options, html_options)
+      else
+        display_link_if_authorized(_("New Config"), hash_for_new_foreman_virt_who_configure_config_path, html_options)
+      end
+    end
+
+    def help_button_or_path
+      if ApplicationHelper.instance_methods.include?(:help_button)
+        # help_button does not support plugins
+        link_to(_("Help"), { :action => "welcome" }, { :class => 'btn btn-default' })
+      else
+        help_path
+      end
+    end
+  end
+end

data/app/helpers/foreman_virt_who_configure/configs_helper.rb

@@ -0,0 +1,25 @@
+module ForemanVirtWhoConfigure
+  module ConfigsHelper
+    def hypervisor_server_help_data
+      {
+        'esx' => _('VMware vCenter server’s fully qualified host name or IP address.'),
+        'rhevm' => _('Red Hat Virtualization Manager’s fully qualified host name or IP address. For example, <code>https://hostname:443/ovirt-engine/</code> for v4, <code>https://hostname_or_IP:443</code> for v3'),
+        # 'vdsm' => 'Red Hat Enterprise Linux Hypervisor (vdsm)',
+        'hyperv' => _('Microsoft Hyper-V fully qualified host name or IP address.'),
+        'xen' => _('XenServer server’s fully qualified host name or IP address.'),
+        'libvirt' => _('Libvirt server’s fully qualified host name or IP address. You can also specify preferred schema, for example: <code>qemu+ssh://libvirt.example.com/system</code>. If you use SSH, make sure you setup root\'s SSH key on target host for a user specified at hypervisor username field')
+      }
+    end
+
+    def hypervisor_username_help_data
+      {
+        'esx' => _('Account name by which virt-who is to connect to the hypervisor, in the format <code>domain_name\account_name</code>. Note that only a single backslash separates the values for domain_name and account_name. If you are using a domain account, and the global configuration file <code>/etc/sysconfig/virt-who</code>, then <b>two</b> backslashes are required. For further details, see <a href="https://access.redhat.com/solutions/1270223">Red Hat Knowledgebase solution How to use a windows domain account with virt-who</a> for more information.'),
+        'rhevm' => _('Account name by which virt-who is to connect to the Red Hat Enterprise Virtualization Manager instance. The username option requires input in the format username@domain.'),
+        # '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.')
+      }
+    end
+  end
+end

data/app/models/foreman_virt_who_configure/auth_source_hidden_with_authentication.rb

@@ -0,0 +1,13 @@
+module ForemanVirtWhoConfigure
+  class AuthSourceHiddenWithAuthentication < ::AuthSourceHidden
+    def self.default
+      AuthSource.without_auditing do
+        where(:name => 'HiddenWithAuthentication').first_or_create!
+      end
+    end
+
+    def authenticate(login, password)
+      AuthSourceInternal.new.authenticate(login, password)
+    end
+  end
+end

data/app/models/foreman_virt_who_configure/config.rb

@@ -0,0 +1,157 @@
+module ForemanVirtWhoConfigure
+  class Config < ActiveRecord::Base
+    PERMITTED_PARAMS = [
+      :interval, :organization_id, :compute_resource_id, :whitelist, :blacklist, :listing_mode, :hypervisor_id,
+      :hypervisor_type, :hypervisor_server, :hypervisor_username, :hypervisor_password, :debug,
+      :satellite_url, :proxy, :no_proxy
+    ]
+    include Authorizable
+    audited
+    validates_lengths_from_database
+
+    UNLIMITED = 0
+    WHITELIST = 1
+    BLACKLIST = 2
+    FILTERING_MODES = {
+      UNLIMITED.to_s => _('Unlimited'),
+      WHITELIST.to_s => _('Whitelist'),
+      BLACKLIST.to_s => _('Blacklist'),
+    }
+
+    WIZARD_STEPS = {
+      'general_information' => _('General information'),
+      'schedule' => _('Schedule'),
+      'connection' => _('Connection')
+    }
+
+    HYPERVISOR_IDS = [ 'hostname', 'uuid', 'hwuuid' ]
+
+    HYPERVISOR_TYPES = {
+      'esx' => 'VMware vSphere / vCenter (esx)',
+      'rhevm' => 'Red Hat Virtualization Hypervisor (rhevm)',
+      # 'vdsm' => 'Red Hat Enterprise Linux Hypervisor (vdsm)',
+      'hyperv' => 'Microsoft Hyper-V (hyperv)',
+      'xen' => 'XenServer (xen)',
+      'libvirt' => 'libvirt'
+    }
+
+    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'),
+    }
+
+    DEFAULT_INTERVAL = 120
+
+    include Encryptable
+    encrypts :hypervisor_password
+
+    belongs_to :compute_resource
+    belongs_to :organization
+
+    # service user used by virt-who to report back
+    belongs_to :service_user
+
+    scoped_search :on => :interval, :complete_value => true
+    # TODO add more related objects and attributes
+
+    # compatibility layer for 1.11 - pre strong params patch
+    if self.respond_to?(:attr_accessible)
+      attr_accessible(*PERMITTED_PARAMS)
+    end
+
+    after_create :create_service_user
+    after_destroy :destroy_service_user
+
+    validates :interval, :hypervisor_type, :hypervisor_server, :hypervisor_username, :hypervisor_password,
+              :satellite_url, :hypervisor_id, :organization_id,
+              :presence => true
+    validates :hypervisor_type, :inclusion => HYPERVISOR_TYPES.keys
+    validates :hypervisor_id, :inclusion => HYPERVISOR_IDS
+    validates :interval, :inclusion => AVAILABLE_INTERVALS.keys.map(&:to_i)
+    validates :listing_mode, :inclusion => FILTERING_MODES.keys.map(&:to_i)
+    validates :whitelist, :presence => true, :if => Proc.new { |c| c.listing_mode.to_i == WHITELIST }
+    validates :blacklist, :presence => true, :if => Proc.new { |c| c.listing_mode.to_i == BLACKLIST }
+    validates_lengths_from_database
+
+    before_validation :remove_whitespaces
+
+    def create_service_user
+      password = User.random_password
+      service_user = self.build_service_user
+      user = service_user.build_user
+      user.auth_source = AuthSourceHiddenWithAuthentication.default
+      user.password = password
+      user.login = "virt_who_reporter_#{self.id}"
+      user.organizations = [ self.organization ]
+      user.roles = [ Role.where(:name => 'Virt-who Reporter').first ]
+      user.valid? # to trigger password hashing
+      user.save!(:validate => false)
+
+      service_user.encrypted_password = password
+      service_user.save!
+
+      self.update_attribute :service_user_id, service_user.id
+    end
+
+    def destroy_service_user
+      # skip validation that prevents hidden user deletion
+      user = service_user.user
+      service_user.destroy
+      user.delete
+    end
+
+    # mapping of supported CR types
+    # case config.compute_resource
+    #   when Foreman::Model::Libvirt
+    #     'libvirt'
+    #   when Foreman::Model::Vmware
+    #     'esx'
+    #   when Foreman::Model::Ovirt
+    #     'rhevm'
+    #   else
+    #     raise 'unsupported compute resource type'
+    # end
+
+    # 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
+
+    def humanized_interval
+      _("every %s hours") % (self.interval / 60)
+    end
+
+    def step_name(step_key)
+      WIZARD_STEPS[step_key]
+    end
+
+    def steps
+      WIZARD_STEPS.keys
+    end
+
+    def virt_who_config_file
+      generator = OutputGenerator.new(self)
+      if generator.ready_for_virt_who_output?
+        generator.virt_who_output
+      else
+        generator.missing_virt_who_input_messages.join("\n")
+      end
+    end
+
+    private
+
+    def remove_whitespaces
+      satellite_url.strip! if satellite_url.present?
+    end
+  end
+end