foreman_ansible 4.0.3.5 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f5cb37ac21d410601d1f871a73f125511574ae218f6a488c865c45e64761c88
-  data.tar.gz: 4bbb6f29895b798715e7d5915d2370e56feefc3ba0ad67365bb03af40ca2dc93
+  metadata.gz: f38e865029b1349a0f9a61bf6cc5a57fc5421d4ea41ef57ed9d45d0d04fe4fd9
+  data.tar.gz: a63c7fc0d6e359ecd27283c9815c78ec3f6ff05e774e33c5bcaff5fdfde48ae7
 SHA512:
-  metadata.gz: ea3fd4b934442a52ae46cf71ec2931f67159da7df6906ffc99a7c4616e074d25ab3349021deddeef60258f781969979743ea1aa6eb97e0d575b1a9d912e41663
-  data.tar.gz: 39861b01ad80bac36159c3b6b3b243084f71f4567caa18dc35e9e02e87d92ca53ec27ec31ec467900c8b1aca7979ac0623314c90604bcae370caf3be92148eb6
+  metadata.gz: 94ca7682492e8648fd8b23f55cbe2fe1e13da17ff8853d1b196fd778282bf46f9a93f335175490c40be2a20198fdd3a3f6f3abccbb62b615fa9c5464279b0fd9
+  data.tar.gz: 9d976f8e4dccd761d9e4568e98a337704321658613aa01dd6d94335db668885c1c8d1c456aa53e56dd88865e2714d90185fc094647e63c28c5d84bac07410a9a

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

@@ -3,6 +3,11 @@ module Api
     class AnsibleInventoriesController < ::Api::V2::BaseController
       include ::Api::Version2
 
+      resource_description do
+        api_version 'v2'
+        api_base_url '/ansible/api'
+      end
+
       api :POST, '/ansible_inventories/hosts',
           N_('Show Ansible inventory for hosts')
       param :host_ids, Array, N_('IDs of hosts included in inventory'),
@@ -13,6 +18,10 @@ module Api
       param :host_ids, Array, N_('IDs of hosts included in inventory'),
             :required => true
 
+      def hosts
+        show_inventory :host_ids, :id
+      end
+
       api :POST, '/ansible_inventories/hostgroups',
           N_('Show Ansible inventory for hostgroups')
       param :hostgroup_ids, Array, N_('IDs of hostgroups included in inventory'),
@@ -23,10 +32,6 @@ module Api
       param :hostgroup_ids, Array, N_('IDs of hostgroups included in inventory'),
             :required => true
 
-      def hosts
-        show_inventory :host_ids, :id
-      end
-
       def hostgroups
         show_inventory :hostgroup_ids, :hostgroup_id
       end

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

@@ -67,7 +67,7 @@ module Api
         params.fetch(:role_names, [])
       end
 
-      # rubocop:disable DotPosition
+      # rubocop:disable Layout/DotPosition
       def find_proxy
         unless params[:proxy_id]
           msg = _('Smart proxy id is required')
@@ -76,7 +76,7 @@ module Api
         @proxy = SmartProxy.authorized(:view_smart_proxies)
                            .find(params[:proxy_id])
       end
-      # rubocop:enable DotPosition
+      # rubocop:enable Layout/DotPosition
 
       def create_importer
         @importer = ForemanAnsible::ApiRolesImporter.new(@proxy)

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

@@ -5,7 +5,6 @@ module Api
     # API controller for Ansible Variables
     class AnsibleVariablesController < ::Api::V2::BaseController
       include ::Api::Version2
-      include Foreman::Controller::Parameters::VariableLookupKey
       include Foreman::Controller::Parameters::AnsibleVariable
 
       resource_description do
@@ -65,7 +64,7 @@ module Api
       param_group :ansible_variable, :as => :update
 
       def update
-        @ansible_variable.update!(variable_lookup_key_params)
+        @ansible_variable.update!(ansible_variable_params)
         render 'api/v2/ansible_variables/show'
       end
 

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

@@ -12,7 +12,7 @@ module ForemanAnsible
 
         # Included blocks shouldn't be bound by length, as otherwise concerns
         # cannot extend the method properly.
-        # rubocop:disable BlockLength, Rails/LexicallyScopedActionFilter
+        # rubocop:disable Rails/LexicallyScopedActionFilter
         included do
           before_action :find_ansible_roles, :only => [:assign_ansible_roles]
 
@@ -61,7 +61,7 @@ module ForemanAnsible
             process_response @hostgroup.update(:ansible_roles => @ansible_roles)
           end
         end
-        # rubocop:enable BlockLength, Rails/LexicallyScopedActionFilter
+        # rubocop:enable Rails/LexicallyScopedActionFilter
 
         private
 

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

@@ -12,7 +12,7 @@ module ForemanAnsible
 
         # Included blocks shouldn't be bound by length, as otherwise concerns
         # cannot extend the method properly.
-        # rubocop:disable BlockLength, Rails/LexicallyScopedActionFilter
+        # rubocop:disable Rails/LexicallyScopedActionFilter
         included do
           before_action :find_ansible_roles, :only => [:assign_ansible_roles]
 
@@ -63,7 +63,7 @@ module ForemanAnsible
             process_response @host.update(:ansible_roles => @ansible_roles)
           end
         end
-        # rubocop:enable BlockLength, Rails/LexicallyScopedActionFilter
+        # rubocop:enable Rails/LexicallyScopedActionFilter
 
         private
 

data/app/models/concerns/foreman_ansible/host_managed_extensions.rb

@@ -4,7 +4,6 @@ require 'ipaddress'
 module ForemanAnsible
   # Relations to make Host::Managed 'have' ansible roles
   module HostManagedExtensions
-    # rubocop:disable Metrics/BlockLength
     def self.prepended(base)
       base.instance_eval do
         include ::ForemanAnsible::Concerns::JobInvocationHelper
@@ -30,7 +29,6 @@ module ForemanAnsible
 
     # This one should be fixed, disabled for the moment as we're
     # in a rush to get the release out
-    # rubocop:disable Metrics/AbcSize
     def play_ansible_roles
       return true unless ansible_roles.present? ||
                          inherited_ansible_roles.present?
@@ -47,13 +45,11 @@ module ForemanAnsible
       logger.info("Error running Ansible roles on #{self} before_provision: "\
                   "#{e.message}")
     end
-    # rubocop:enable Metrics/AbcSize
 
     def all_ansible_roles
       (ansible_roles + inherited_ansible_roles).uniq
     end
 
-    # rubocop:enable Metrics/BlockLength
     # Class methods we may need to override or add
     module ClassMethods
       def import_host(*args)

data/app/models/foreman_ansible/ansible_provider.rb

@@ -62,6 +62,14 @@ if defined? ForemanRemoteExecution
           'ansible-runner'
         end
 
+        def required_proxy_selector_for(template)
+          if template.remote_execution_features.where(:label => 'ansible_run_capsule_upgrade').any?
+            ::DefaultProxyProxySelector.new
+          else
+            super
+          end
+        end
+
         private
 
         def ansible_command?(template)

data/app/models/setting/ansible.rb

@@ -7,8 +7,6 @@ class Setting
       # It would be more disadvantages than advantages to split up
       # default_settings into multiple methods, this way it's already very
       # manageable.
-      # rubocop:disable AbcSize
-      # rubocop:disable MethodLength
       def default_settings
         [
           set(
@@ -80,13 +78,11 @@ class Setting
             'ansible_inventory_template',
             N_('Foreman will use this template to schedule the report '\
                'with Ansible inventory'),
-            'Ansible Inventory',
+            'Ansible - Ansible Inventory',
             N_('Default Ansible inventory report template')
           )
         ]
       end
-      # rubocop:enable AbcSize
-      # rubocop:enable MethodLength
 
       def load_defaults
         Setting::BLANK_ATTRS.push('ansible_ssh_private_key_file')

data/app/services/foreman_ansible/ansible_info.rb

@@ -10,7 +10,7 @@ module ForemanAnsible
 
       variables.each_with_object({}) do |var, memo|
         value = values[var]
-        memo[var.key] = value if value
+        memo[var.key] = value unless value.nil?
         memo
       end
     end

data/app/services/foreman_ansible/insights_notification_builder.rb

@@ -3,9 +3,7 @@
 module ForemanAnsible
   # A class that builds custom notificaton for REX job if it's insights
   # remediation feature
-  # rubocop:disable LineLength
   class InsightsNotificationBuilder < ::UINotifications::RemoteExecutionJobs::BaseJobFinish
-    # rubocop:enable LineLength
     def deliver!
       ::Notification.create!(
         :audience => Notification::AUDIENCE_USER,

data/app/services/foreman_ansible/operating_system_parser.rb

@@ -45,7 +45,6 @@ module ForemanAnsible
       facts[:ansible_distribution_release]
     end
 
-    # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity
     def os_major
       if os_name == 'Debian' &&
          facts[:ansible_distribution_major_version][%r{\/sid}i]
@@ -56,16 +55,14 @@ module ForemanAnsible
           (facts[:version].split('R')[0] if os_name == 'junos')
       end
     end
-    # rubocop:enable AbcSize, CyclomaticComplexity, PerceivedComplexity
 
     def os_release
       facts[:ansible_distribution_version] ||
         facts[:ansible_lsb] && facts[:ansible_lsb]['release']
     end
 
-    # rubocop:disable AbcSize
     def os_minor
-      _, minor = (os_release&.split('.', 2)) ||
+      _, minor = os_release&.split('.', 2) ||
                  (facts[:version].split('R') if os_name == 'junos')
       # Until Foreman supports os.minor as something that's not a number,
       # we should remove the extra dots in the version. E.g:
@@ -87,7 +84,6 @@ module ForemanAnsible
           facts[:ansible_lsb] && facts[:ansible_lsb]['id']
       end
     end
-    # rubocop:enable AbcSize
 
     def os_description
       if facts[:ansible_os_family] == 'Windows'

data/app/services/foreman_ansible/variables_importer.rb

@@ -29,6 +29,7 @@ module ForemanAnsible
     def import_variables(role_variables, new_roles)
       detect_changes(
         role_variables.map do |role_name, variables|
+          next if variables.blank?
           role = import_new_role(role_name, new_roles)
           next if role.blank?
           initialize_variables(variables, role)
@@ -47,22 +48,21 @@ module ForemanAnsible
     def initialize_variables(variables, role)
       variables.map do |variable_name, variable_default|
         variable = AnsibleVariable.find_or_initialize_by(
-          :key => variable_name
+          :key => variable_name,
+          :ansible_role_id => role.id
         )
-        if variable.new_record?
-          variable.assign_attributes(:default_value => variable_default,
-                                     :key_type => infer_key_type(variable_default),
-                                     :imported => true)
-        end
-        variable.ansible_role = role
+        variable.assign_attributes(:default_value => variable_default,
+                                   :key_type => infer_key_type(variable_default))
+        variable.imported = true if variable.new_record?
         variable.valid? ? variable : nil
       end
     end
 
     def detect_changes(imported)
       changes = {}.with_indifferent_access
-      persisted, changes[:new] = imported.partition { |role| role.id.present? }
-      changes[:update], _old = persisted.partition(&:changed?)
+      persisted, changes[:new] = imported.partition { |var| var.id.present? }
+      changed, _old = persisted.partition(&:changed?)
+      _overriden, changes[:update] = changed.partition(&:override?)
       changes[:obsolete] = AnsibleVariable.where.not(:id => persisted.pluck(:id), :imported => false)
       changes
     end

data/app/views/ansible_variables/_fields.erb

@@ -15,7 +15,7 @@
         ) %>
 
     <% version = Foreman::Version.new %>
-    <% if version.major.to_i >= 1 && version.minor.to_i >= 22 %>
+    <% if version.major.to_i > 1 || version.minor.to_i >= 22 %>
       <%= param_type_selector(f, false, :onchange => 'keyTypeChange(this)', :disabled => !f.object.override) %>
     <% else %>
       <%= param_type_selector(f, :onchange => 'keyTypeChange(this)', :disabled => !f.object.override) %>

data/app/views/foreman_ansible/job_templates/capsule_upgrade_-_ansible_default.erb

@@ -0,0 +1,71 @@
+<%#
+name: Capsule Upgrade Playbook
+snippet: false
+template_inputs:
+- name: target_version
+  required: true
+  input_type: user
+  advanced: false
+  value_type: plain
+  hidden_value: false
+- name: whitelist_options
+  required: false
+  input_type: user
+  advanced: false
+  value_type: plain
+  hidden_value: false
+model: JobTemplate
+job_category: Ansible Playbook
+description_format: "%{template_name}"
+provider_type: Ansible
+kind: job_template
+feature: ansible_run_capsule_upgrade
+%>
+
+---
+- hosts: all
+  tasks:
+    - name: Gather the rpm package facts
+      package_facts:
+        manager: auto
+
+    - name: Fail if the target server is a Satellite server
+      fail:
+        msg: "This playbook cannot be executed on a Satellite server. Use only on a Capsule server."
+      when: "'satellite' in ansible_facts.packages"
+
+    - name: Install satellite-maintain if not present
+      package:
+        name: rubygem-foreman_maintain
+        state: present
+      when: "'rubygem-foreman_maintain' not in ansible_facts.packages"
+
+    - block:
+      - name: Upgrade Capsule server using satellite-maintain
+        shell: satellite-maintain upgrade run --assumeyes --target-version=<%= input('target_version') %> --whitelist="<%= input('whitelist_options') %>"
+        register: result
+
+      - name: Re-Gather the rpm package facts after the upgrade
+        package_facts:
+          manager: auto
+
+      - name: satellite-maintain upgrade return code is zero
+        debug:
+          msg: "Success! Capsule server upgrade completed. Current version of Capsule server server is {{ ansible_facts.packages['satellite-capsule'][0]['version'] }}."
+
+      rescue:
+        - name: Print satellite-maintain output
+          debug:
+            var: result
+
+        - name: Grep top 10 Error messages from /var/log/foreman-installer/capsule.log
+          shell: grep '^\[ERROR' /var/log/foreman-installer/capsule.log | head -n10
+          register: output_grep
+
+        - name: Print grepped Error messages
+          debug:
+            var: output_grep.stdout_lines
+
+        - name: satellite-maintain upgrade return code is non-zero
+          fail:
+            msg: "Failed! Capsule server upgrade failed. See /var/log/foreman-installer/capsule.log in the Capsule server for more information"

data/config/routes.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable BlockLength
 Rails.application.routes.draw do
   namespace :api do
     scope '(:apiv)',
@@ -73,7 +72,7 @@ Rails.application.routes.draw do
             :module => :v2,
             :defaults => { :apiv => 'v2' },
             :apiv => /v1|v2/,
-            :constraints => ApiConstraints.new(:version => 2) do
+            :constraints => ApiConstraints.new(:version => 2, :default => true) do
         resources :ansible_roles, :only => [:show, :index, :destroy] do
           collection do
             put :import
@@ -104,4 +103,3 @@ Rails.application.routes.draw do
     end
   end
 end
-# rubocop:enable BlockLength

data/db/migrate/20160802153302_create_join_table_hostgroup_ansible_roles.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 # Defines the relation between Hostgroup and AnsibleRole
-# rubocop:disable Metrics/LineLength
 class CreateJoinTableHostgroupAnsibleRoles < ActiveRecord::Migration[4.2]
   def change
     create_join_table :hostgroup, :ansible_roles, :table_name => 'hostgroup_ansible_roles' do |t|
       t.index [:hostgroup_id, :ansible_role_id], :name => 'index_ansible_roles_hostgroup_on_hostgroup_id_and_role_id'
       t.index [:ansible_role_id, :hostgroup_id], :name => 'index_ansible_roles_hostgroup_on_role_id_and_hostgroup_id'
-      # rubocop:enable Metrics/LineLength
     end
   end
 end

data/db/migrate/20200421201839_update_ansible_inv_template_name.rb

@@ -0,0 +1,9 @@
+class UpdateAnsibleInvTemplateName < ActiveRecord::Migration[5.2]
+  def up
+    Setting.where(:name => 'ansible_inventory_template').update_all(:default => 'Ansible - Ansible Inventory')
+  end
+  
+  def down
+    Setting.where(:name => 'ansible_inventory_template').update_all(:default => 'Ansible Inventory')
+  end
+end

data/db/seeds.d/75_job_templates.rb

@@ -18,7 +18,7 @@ User.as_anonymous_admin do
         sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
         template = JobTemplate.import_raw!(File.read(template),
                                            :default => true,
-                                           :locked => true,
+                                           :lock => true,
                                            :update => sync)
         template.organizations = organizations if template.present?
         template.locations = locations if template.present?

data/lib/foreman_ansible/engine.rb

@@ -70,36 +70,31 @@ module ForemanAnsible
       Apipie.configuration.checksum_path += ['/foreman_ansible/api/']
     end
 
-    # rubocop:disable BlockLength
     config.to_prepare do
-      begin
-        foreman_version = ::Foreman::Version.new
-        if Rails.env.test? ||
-           foreman_version.major.to_i == 1 && foreman_version.minor.to_i < 13
-          ::FactImporter.register_fact_importer(:ansible,
-                                                ForemanAnsible::FactImporter)
-        else
-          ::FactImporter.register_fact_importer(
-            :ansible,
-            ForemanAnsible::StructuredFactImporter
-          )
-        end
-        ::FactParser.register_fact_parser(:ansible, ForemanAnsible::FactParser)
-        ::Host::Managed.prepend ForemanAnsible::HostManagedExtensions
-        ::Hostgroup.include ForemanAnsible::HostgroupExtensions
-        ::HostsHelper.include ForemanAnsible::HostsHelperExtensions
-        ::HostsController.include ForemanAnsible::Concerns::HostsControllerExtensions
-        ::Api::V2::HostsController.include ForemanAnsible::Api::V2::HostsControllerExtensions
-        ::Api::V2::HostsController.include ForemanAnsible::Api::V2::HostsParamGroupExtensions
-        ::HostgroupsController.include ForemanAnsible::Concerns::HostgroupsControllerExtensions
-        ::Api::V2::HostgroupsController.include ForemanAnsible::Api::V2::HostgroupsControllerExtensions
-        ::Api::V2::HostgroupsController.include ForemanAnsible::Api::V2::HostgroupsParamGroupExtensions
-        ::ConfigReportImporter.include ForemanAnsible::AnsibleReportImporter
-      rescue StandardError => e
-        Rails.logger.warn "Foreman Ansible: skipping engine hook (#{e})"
+      foreman_version = ::Foreman::Version.new
+      if Rails.env.test? ||
+         foreman_version.major.to_i == 1 && foreman_version.minor.to_i < 13
+        ::Foreman::Plugin.fact_importer_registry.register(:ansible, ForemanAnsible::FactImporter)
+      else
+        ::Foreman::Plugin.fact_importer_registry.register(
+          :ansible,
+          ForemanAnsible::StructuredFactImporter
+        )
       end
+      ::FactParser.register_fact_parser(:ansible, ForemanAnsible::FactParser)
+      ::Host::Managed.prepend ForemanAnsible::HostManagedExtensions
+      ::Hostgroup.include ForemanAnsible::HostgroupExtensions
+      ::HostsHelper.include ForemanAnsible::HostsHelperExtensions
+      ::HostsController.include ForemanAnsible::Concerns::HostsControllerExtensions
+      ::Api::V2::HostsController.include ForemanAnsible::Api::V2::HostsControllerExtensions
+      ::Api::V2::HostsController.include ForemanAnsible::Api::V2::HostsParamGroupExtensions
+      ::HostgroupsController.include ForemanAnsible::Concerns::HostgroupsControllerExtensions
+      ::Api::V2::HostgroupsController.include ForemanAnsible::Api::V2::HostgroupsControllerExtensions
+      ::Api::V2::HostgroupsController.include ForemanAnsible::Api::V2::HostgroupsParamGroupExtensions
+      ::ConfigReportImporter.include ForemanAnsible::AnsibleReportImporter
+    rescue StandardError => e
+      Rails.logger.warn "Foreman Ansible: skipping engine hook (#{e})"
     end
-    # rubocop:enable BlockLength
 
     rake_tasks do
       Rake::Task['db:seed'].enhance do