foreman_ansible 2.2.14 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fe5dcbfcc552d6c416de77ef25a716f4f88c873
-  data.tar.gz: abc7f71191be7c080ffcd5a95c5a4fc7c4d6f700
+  metadata.gz: 0dc5e5a7b0474fef241b4607911073f5e3b94bbc
+  data.tar.gz: 0e57147506ec6cac87ca5107e832bfe80d594ecb
 SHA512:
-  metadata.gz: 3bcaf1df6a76b741140c3cb550c3e2c0b7e606dafc20d76d4638d89ce921f22696923b5e1fe90cf8fa8730606e5ac6e7a9c2219c145bb8f3f396662ab2da27cb
-  data.tar.gz: '09e53ac570633a62e5a7c2aff18c9712aa702020fd532c9202d335ccf636030a9596b8fbc244f3efe9185e49172ef899fc8893278b5a1c80533375dbb885d6d7'
+  metadata.gz: aca0209523ab2b7eac8ad76877ef2946a1a7fa9ce04c860cb972dcee73296f8d9c7afeac575170265a0a946084e5f5d2d0393628deeaf624a5d18784809bcae2
+  data.tar.gz: 44db93653e958c13d72d80e68f8c7b188c59059078b942397d25664cbda18ec1756b0a709e3e15c75ba4aee319622f31a77f615894b4210f0a155f9fcca5634d

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError

data/app/controllers/ansible_roles_controller.rb

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 # UI controller for ansible roles
 class AnsibleRolesController < ::ApplicationController
   include Foreman::Controller::AutoCompleteSearch
-
-  before_action :find_resource, :only => [:destroy]
-  before_action :find_proxy, :only => [:import]
-  before_action :create_importer, :only => [:import, :confirm_import]
-  before_action :default_order, :only => [:index]
+  include ForemanAnsible::Concerns::ImportControllerHelper
 
   def index
     @ansible_roles = resource_base.search_for(params[:search],
@@ -33,7 +31,7 @@ class AnsibleRolesController < ::ApplicationController
   end
 
   def confirm_import
-    @importer.finish_import(params[:changed].to_unsafe_h)
+    @importer.finish_import(params[:changed]&.to_unsafe_h)
     success _('Import of roles successfully finished.')
     redirect_to ansible_roles_path
   end
@@ -44,11 +42,6 @@ class AnsibleRolesController < ::ApplicationController
     params[:order] ||= 'name ASC'
   end
 
-  def find_proxy
-    return nil unless params[:proxy]
-    @proxy = SmartProxy.authorized(:view_smart_proxies).find(params[:proxy])
-  end
-
   def create_importer
     @importer = ForemanAnsible::UiRolesImporter.new(@proxy)
   end

data/app/controllers/ansible_variables_controller.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# UI controller for ansible variables
+class AnsibleVariablesController < ::LookupKeysController
+  include Foreman::Controller::AutoCompleteSearch
+  include ForemanAnsible::Concerns::ImportControllerHelper
+  include Foreman::Controller::Parameters::AnsibleVariable
+
+  before_action :import_new_roles, :only => [:confirm_import]
+  before_action :find_required_proxy, :only => [:import]
+  before_action :find_resource, :only => [:edit, :update, :destroy],
+                                :if => proc { params[:id] }
+
+  def index
+    @ansible_variables = resource_base.search_for(params[:search],
+                                                  :order => params[:order]).
+                         paginate(:page => params[:page],
+                                  :per_page => params[:per_page])
+  end
+
+  def import
+    import_roles = @importer_roles.import_role_names
+    import_roles[:new_roles] = import_roles[:new]
+    import_variables = @importer.import_variable_names(import_roles[:new_roles])
+    render 'ansible_variables/import',
+           :locals => { :changed => import_variables }
+  end
+
+  def confirm_import
+    results = @importer.finish_import(new_vars, old_vars)
+    info _(
+      "Import of variables successfully finished.\n"\
+      "Added: #{results[:added].join(', ')} \n "\
+      "Removed: #{results[:obsolete].join(', ')}"
+    )
+    redirect_to ansible_variables_path
+  end
+
+  private
+
+  def default_order; end
+
+  def resource
+    @ansible_variable
+  end
+
+  def resource_params
+    ansible_variable_params
+  end
+
+  def new_vars
+    params[:changed] ? params[:changed][:new].as_json : {}
+  end
+
+  def old_vars
+    params[:changed] ? params[:changed][:obsolete].as_json : {}
+  end
+
+  def import_new_roles
+    return if new_vars.blank?
+    new_vars.each_key do |role_name|
+      ::AnsibleRole.find_or_create_by(:name => role_name)
+    end
+  end
+
+  def create_importer
+    @importer = ForemanAnsible::VariablesImporter.new(@proxy)
+    @importer_roles = ForemanAnsible::UiRolesImporter.new(@proxy)
+  end
+
+  def find_required_proxy
+    id = params['proxy']
+    @smart_proxy = SmartProxy.authorized(:view_smart_proxies).find(id)
+    unless @smart_proxy&.has_feature?('Ansible')
+      not_found _('No proxy found to import variables from, ensure that the '\
+                  'smart proxy has the Ansible feature enabled.')
+    end
+    @smart_proxy
+  end
+end

data/app/controllers/api/v2/ansible_roles_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Api
   module V2
     # API controller for Ansible Roles

data/app/controllers/api/v2/ansible_variables_controller.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Api
+  module V2
+    # API controller for Ansible Variables
+    class AnsibleVariablesController < ::Api::V2::BaseController
+      include ::Api::Version2
+
+      resource_description do
+        api_version 'v2'
+        api_base_url '/ansible/api'
+      end
+
+      before_action :find_resource, :only => [:show, :destroy]
+      before_action :find_proxy, :only => [:import, :obsolete]
+      before_action :create_importer, :only => [:import, :obsolete]
+
+      api :GET, '/ansible_variables/:id', N_('Show variable')
+      param :id, :identifier, :required => true
+      def show; end
+
+      api :GET, '/ansible_variables', N_('List Ansible variables')
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      def index
+        @ansible_variables = resource_scope_for_index
+      end
+
+      api :DELETE, '/ansible_variables/:id', N_('Deletes Ansible variable')
+      param :id, :identifier, :required => true
+      def destroy
+        process_response @ansible_variable.destroy
+      end
+
+      api :PUT, '/ansible_variables/import',
+          N_('Import Ansible variables. This will only import variables '\
+             'for already existing roles, it will not import any new roles')
+      param :proxy_id, :identifier, N_('Smart Proxy to import from')
+      def import
+        new_variables = @importer.import_variable_names([])[:new]
+        new_variables.map(&:save)
+        @imported = new_variables
+      end
+
+      api :PUT, '/ansible_variables/obsolete',
+          N_('Obsolete Ansible variables. This will only obsolete variables '\
+             'for already existing roles, it will not delete any old roles')
+      param :proxy_id, :identifier, N_('Smart Proxy to import from')
+      def obsolete
+        old_variables = @importer.import_variable_names([])[:obsolete]
+        old_variables.map(&:destroy)
+        @obsoleted = old_variables
+      end
+
+      private
+
+      def find_proxy
+        return nil unless params[:proxy_id]
+        @proxy = SmartProxy.
+                 authorized(:view_smart_proxies).
+                 find(params[:proxy_id])
+      end
+
+      def create_importer
+        @importer = ForemanAnsible::VariablesImporter.new(@proxy)
+      end
+    end
+  end
+end

data/app/controllers/concerns/foreman/controller/parameters/ansible_variable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Foreman
+  module Controller
+    module Parameters
+      # Keys to allow as parameters in the AnsibleVariable controller
+      module AnsibleVariable
+        extend ActiveSupport::Concern
+        include Foreman::Controller::Parameters::LookupKey
+
+        class_methods do
+          def ansible_variable_params_filter
+            Foreman::ParameterFilter.new(::AnsibleVariable).tap do |filter|
+              filter.permit :ansible_roles => [], :ansible_role_ids => [],
+                            :ansible_role_names => [],
+                            :param_classes => [], :param_classes_ids => [],
+                            :param_classes_names => []
+              filter.permit_by_context :required, :nested => true
+              filter.permit_by_context :id, :ui => false, :api => false,
+                                            :nested => true
+
+              add_lookup_key_params_filter(filter)
+            end
+          end
+        end
+
+        def ansible_variable_params
+          self.class.ansible_variable_params_filter.filter_params(
+            params,
+            parameter_filter_context
+          )
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_ansible/api/v2/hostgroups_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   module Api
     module V2

data/app/controllers/foreman_ansible/api/v2/hostgroups_param_group_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   module Api
     module V2

data/app/controllers/foreman_ansible/api/v2/hosts_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   module Api
     module V2

data/app/controllers/foreman_ansible/api/v2/hosts_param_group_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   module Api
     module V2

data/app/controllers/foreman_ansible/concerns/hostgroups_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   module Concerns
     # Extra methods to enforce Ansible roles on a host or multiple hosts

data/app/controllers/foreman_ansible/concerns/hosts_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   module Concerns
     # Extra methods to enforce Ansible roles on a host or multiple hosts

data/app/controllers/foreman_ansible/concerns/import_controller_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  module Concerns
+    # Helpers to select proxy and call ProxyAPI
+    module ImportControllerHelper
+      extend ActiveSupport::Concern
+
+      included do
+        # rubocop:disable Rails/LexicallyScopedActionFilter
+        before_action :find_resource, :only => [:destroy]
+        before_action :find_proxy, :only => [:import]
+        before_action :create_importer, :only => [:import, :confirm_import]
+        before_action :default_order, :only => [:index]
+        # rubocop:enable Rails/LexicallyScopedActionFilter
+      end
+
+      def find_proxy
+        return nil unless params[:proxy]
+        @proxy = SmartProxy.authorized(:view_smart_proxies).find(params[:proxy])
+      end
+    end
+  end
+end

data/app/controllers/foreman_ansible/concerns/job_invocation_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   module Concerns
     # Helpers to compose the JobInvocation in other controllers

data/app/helpers/foreman_ansible/ansible_plugin_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "#{ForemanAnsible::Engine.root}/lib/foreman_ansible/version"
 
 module ForemanAnsible

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # This module takes the config reports stored in Foreman for Ansible and
   # modifies them to be properly presented in views
@@ -12,8 +14,8 @@ module ForemanAnsible
     ].freeze
 
     def ansible_module_name(log)
-      source_value = log.source.value
-      name = source_value.split(':')[0].strip if source_value.include?(':')
+      source_value = log.source&.value
+      name = source_value.split(':')[0].strip if source_value&.include?(':')
       name
     end
 
@@ -88,8 +90,8 @@ module ForemanAnsible
     def parsed_message_json(log)
       JSON.parse(log.message.value)
     rescue StandardError => e
-      logger.error e
-      false
+      Foreman::Logging.exception('Error while parsing ansible message json', e)
+      {}
     end
   end
 end

data/app/helpers/foreman_ansible/ansible_roles_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Small convenience to list all roles in the UI
   module AnsibleRolesHelper

data/app/helpers/foreman_ansible/hosts_helper_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Chained methods to extend the hosts menu with Ansible actions
   module HostsHelperExtensions

data/app/lib/actions/foreman_ansible/helpers/host_common.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Actions
   module ForemanAnsible
     module Helpers

data/app/lib/actions/foreman_ansible/helpers/play_roles_description.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Actions
   module ForemanAnsible
     module Helpers

data/app/lib/proxy_api/ansible.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyAPI
   # ProxyAPI for Ansible
   class Ansible < ::ProxyAPI::Resource
@@ -24,5 +26,19 @@ module ProxyAPI
     rescue *PROXY_ERRORS => e
       raise ProxyException.new(url, e, N_('Unable to get roles from Ansible'))
     end
+
+    def all_variables
+      parse(get('roles/variables'))
+    rescue *PROXY_ERRORS => e
+      raise ProxyException.new(url, e,
+                               N_('Unable to get roles/variables from Ansible'))
+    end
+
+    def variables(role)
+      parse(get("roles/#{role}/variables"))
+    rescue *PROXY_ERRORS => e
+      raise ProxyException.new(url, e,
+                               N_('Unable to get roles/variables from Ansible'))
+    end
   end
 end

data/app/models/ansible_role.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Simple model to store basic info about the Ansible role
 class AnsibleRole < ApplicationRecord
   audited
@@ -10,6 +12,9 @@ class AnsibleRole < ApplicationRecord
   has_many :hostgroup_ansible_roles
   has_many :hostgroups, :through => :hostgroup_ansible_roles,
                         :dependent => :destroy
+  has_many :ansible_variables, :inverse_of => :ansible_role,
+                               :dependent => :destroy,
+                               :class_name => 'AnsibleVariable'
 
   scoped_search :on => :name, :complete_value => true
   scoped_search :on => :updated_at

data/app/models/ansible_variable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Represents the variables used in Ansible to parameterize playbooks
+class AnsibleVariable < LookupKey
+  belongs_to :ansible_role, :inverse_of => :ansible_variables
+  validates :ansible_role, :presence => true
+  scoped_search :on => :key, :aliases => [:name], :complete_value => true
+  scoped_search :relation => :ansible_role, :on => :name,
+                :complete_value => true, :rename => :ansible_role
+
+  def ansible?
+    true
+  end
+
+  def self.humanize_class_name
+    'Ansible variable'
+  end
+
+  def editable_by_user?
+    AnsibleVariable.authorized(:edit_external_parameters).
+      where(:id => id).exists?
+  end
+end