foreman_ansible 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93abbabed7119b4567e837415bee3a5e25a043b9267499cdfa6b45e27d1352d4
-  data.tar.gz: 5f7a23457ea9bd84adcb6ff1769e7c8d679e4dd907cd0fe43798fad55002b560
+  metadata.gz: 3ee1b4acb26925c919a3d2b3c8b9efe6bd355dc603d896d642a0150d9364f86b
+  data.tar.gz: b5fb045a0cfddf957c238f311b29f97a56b0b5fc91999b56ca25ee3f4c0eeda4
 SHA512:
-  metadata.gz: 3cd8e665ed9e8d157664596130d6ece62f05921fa7073ce3e901716378ebddcf5855b082a79a3d0c8df65382fdb68d905938ad1d4f9541b5af5d88918770d78f
-  data.tar.gz: 2b558e206a05a33726c73d1b367eece0a74e7f0eaaa6fe8f7a2a339097471b6d3a5500abdbacdbc18bc51d9f305972c71d3255a2fd28733d9875781df6046834
+  metadata.gz: 529107a643fb300fc1755a3efe8bbb1bb94b726c822c93f568e3001d2acc71658499343952bce1191ca2e142d1abc3548525a3fdfbde2c8fe1a2f645923b366c
+  data.tar.gz: 2874526de96c18b4aafd6fcaa29006c1d910ccb0e87b1f3326d64312c510cc496fc4e49fd176fafb3f465bded12a2b9c26768dfc0833b628c1538659279cd6a6

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/models/ansible_role.rb

@@ -28,6 +28,12 @@ class AnsibleRole < ApplicationRecord
   scoped_search :relation => :hostgroups,
                 :on => :name, :rename => :hostgroup, :only_explicit => true
 
+  apipie :class, "A class representing #{model_name.human} object" do
+    name 'Ansible role'
+    refs 'AnsibleRole'
+    sections only: %w[all additional]
+    property :name, String, desc: 'Returns name of the ansible role'
+  end
   # Methods to be allowed in any template with safemode enabled
   class Jail < Safemode::Jail
     allow :name

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

@@ -67,6 +67,11 @@ end
 
 module Host
   class Managed
+    apipie :class do
+      property :all_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns all ansible roles assigned to the host, both its own and inherited'
+      property :ansible_roles, array_of: 'AnsibleRole', desc: 'Returns ansible roles assigned to the host'
+      property :inherited_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns inherited ansible roles assigned to the host'
+    end
     # Methods to be allowed in any template with safemode enabled
     class Jail < Safemode::Jail
       allow :all_ansible_roles, :ansible_roles, :inherited_ansible_roles

data/app/models/foreman_ansible/ansible_provider.rb

@@ -36,7 +36,7 @@ if defined? ForemanRemoteExecution
             'per-host' => {
               host.name => {
                 'ansible_ssh_pass' => rex_ssh_password(host),
-                'ansible_sudo_pass' => rex_sudo_password(host)
+                'ansible_become_password' => rex_effective_user_password(host)
               }
             }
           }
@@ -46,8 +46,8 @@ if defined? ForemanRemoteExecution
           host_setting(host, 'remote_execution_ssh_password')
         end
 
-        def rex_sudo_password(host)
-          host_setting(host, 'remote_execution_sudo_password')
+        def rex_effective_user_password(host)
+          host_setting(host, 'remote_execution_effective_user_password')
         end
 
         def host_setting(host, setting)
@@ -62,6 +62,18 @@ if defined? ForemanRemoteExecution
           'ansible-runner'
         end
 
+        def proxy_action_class
+          'ForemanAnsibleCore::TaskLauncher::Playbook::PlaybookRunnerAction'
+        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

@@ -78,7 +78,7 @@ 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')
           )
         ]

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/ansible_report_importer.rb

@@ -9,7 +9,7 @@ module ForemanAnsible
     included do
       def host
         hostname = name.downcase
-        if AnsibleReportScanner.ansible_report?(raw['logs']) &&
+        if AnsibleReportScanner.ansible_report?(raw) &&
            IPAddress.valid?(hostname) &&
            Nic::Interface.find_by(:ip => hostname)
           @host = Nic::Interface.find_by(:ip => hostname).host

data/app/services/foreman_ansible/ansible_report_scanner.rb

@@ -5,14 +5,17 @@ module ForemanAnsible
   # sets the origin of the report to 'Ansible'
   class AnsibleReportScanner
     class << self
-      def scan(report, logs)
-        if (is_ansible = ansible_report?(logs))
-          report.origin = 'Ansible'
-        end
-        is_ansible
+      def add_reporter_data(report, raw); end
+
+      def identify_origin(raw)
+        'Ansible' if ansible_report?(raw)
+      end
+
+      def ansible_report?(raw)
+        raw['reporter'] == 'ansible' || ansible_legacy_report?(raw['logs'])
       end
 
-      def ansible_report?(logs)
+      def ansible_legacy_report?(logs)
         return false if logs.blank?
         logs.any? do |log|
           log['log'].fetch('messages', {}).

data/app/services/foreman_ansible/operating_system_parser.rb

@@ -62,7 +62,7 @@ module ForemanAnsible
     end
 
     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:

data/app/services/foreman_ansible/renderer_methods.rb

@@ -4,7 +4,18 @@ module ForemanAnsible
   # Macro to fetch RH Insights plan playbook
   module RendererMethods
     extend ActiveSupport::Concern
+    extend ApipieDSL::Module
 
+    apipie :class, 'Macros related to Ansible playbooks' do
+      name 'Ansible'
+      sections only: %w[all jobs]
+    end
+
+    apipie :method, 'Returns Insights maintenance plan for host' do
+      required :plan_id, String, desc: 'The playbook for the rule coming from insights'
+      optional :organization_id, Integer, desc: 'The Foreman organization associated with the Insights account', default: 'Current organization ID'
+      returns String, desc: 'Insights maintenance plan for host'
+    end
     def insights_remediation(plan_id, organization_id = Organization.current.id)
       return "$INSIGHTS_REMEDIATION[#{plan_id}, #{organization_id}]" if preview?
 

data/app/services/foreman_ansible/variables_importer.rb

@@ -48,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/ansible_roles_-_ansible_default.erb

@@ -15,7 +15,10 @@ model: JobTemplate
     - name: Display all parameters known for the Foreman host
       debug:
         var: foreman
-  roles:
-<%- if @host.all_ansible_roles.present? -%>
-<%=   @host.all_ansible_roles.map { |role| "    - #{role.name.strip}" }.join("\n") %>
-<%- end -%>
+  tasks:
+    - name: Apply roles
+      include_role:
+        name: "{{ role }}"
+      loop: "{{ foreman_ansible_roles }}"
+      loop_control:
+        loop_var: role

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

@@ -0,0 +1,74 @@
+<%#
+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: Maintenance Operations
+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:
+      <%- whitelist_option = if input('whitelist_options').present?
+                               "--whitelist=#{input('whitelist_options')}"
+                             end -%>
+      - name: Upgrade Capsule server using satellite-maintain
+        shell: satellite-maintain upgrade run --assumeyes --target-version=<%= input('target_version') %> <%= whitelist_option %>
+        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/app/views/foreman_ansible/job_templates/configure_cloud_connector_-_ansible_default.erb

@@ -0,0 +1,36 @@
+<%#
+name: Configure Cloud Connector
+snippet: false
+template_inputs:
+- name: satellite_user
+  required: true
+  input_type: user
+  advanced: false
+  value_type: plain
+  hidden_value: false
+- name: satellite_password
+  required: true
+  input_type: user
+  advanced: false
+  value_type: plain
+  hidden_value: true
+- name: http_proxy
+  required: false
+  input_type: user
+  advanced: true
+  value_type: plain
+  hidden_value: false
+  description: You can specify a HTTP proxy address that should be used for Cloud Connector connection to the cloud.redhat.com. Note that it must be HTTP proxy, not HTTPS. The tunelling of SSL (secured web socket connection) in SSL (HTTPS proxy) is currently unsupported.
+model: JobTemplate
+job_category: Maintenance Operations
+description_format: "%{template_name}"
+provider_type: Ansible
+kind: job_template
+%>
+
+---
+- hosts: all
+  vars:
+    satellite_url: "<%= foreman_server_url %>"
+  roles:
+    - project-receptor.satellite_receptor_installer

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

@@ -18,7 +18,7 @@ model: JobTemplate
 ---
 - hosts: all
   tasks:
-    - command: |
+    - shell: |
         echo <%= input('action') %> host && sleep 3
         <%= case input('action')
           when 'restart'

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

@@ -18,4 +18,8 @@ model: JobTemplate
 - hosts: all
   tasks:
     - command: |
-        puppet agent --onetime --no-usecacheonfailure --no-daemonize <%= input("puppet_options") %>
+        puppet agent --onetime --no-usecacheonfailure --no-daemonize <%= input("puppet_options") -%>
+<% if @host.operatingsystem.family == 'Debian' -%>
+      environment:
+        PATH: "/opt/puppetlabs/bin:{{ (ansible_env|default({})).PATH|default('') }}"
+<% end -%>

data/config/routes.rb

@@ -72,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

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

@@ -71,32 +71,29 @@ module ForemanAnsible
     end
 
     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
 
     rake_tasks do