foreman_ansible 7.0.3 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a8c4f263992d803c31386bc301ce1e032c680ada845db8bf07e71162c003384
-  data.tar.gz: 628c7b6952499ef5dfe912370bec8d3e936926a004acf5b7693d7706fe461ea9
+  metadata.gz: 47b85dc5fe69b87ea05703f75380a2387deb64674755903ec03c3cb55dcc3bdb
+  data.tar.gz: ece7521c8b3f6da727abd6abad8be7384701a1598f6601dc5baf0b1f579931df
 SHA512:
-  metadata.gz: '09f3fd7b961edcb7abee1f6dd6de4fbf0bb80130668c39724d6c8658c2ca1570109ab6b7d172d2f9b963c6e4e5aebaa3280ebf199f9fe5ff86580ab1d8f06c7e'
-  data.tar.gz: 924b85ee81562a848c07417fd0788520c000292901f63ef45f8adbfc99ec32dae21858589c83688f461d19e49a4c6491801d53f611032a1c291ba941e9068133
+  metadata.gz: f72ecf4fc7949815787bd4b93c1da3ee7df5baf2c2266950ddc6bd01b701ae38559896ae45b11995fa3574c84f041e01d7caf41ba1e18ba4b9c0c2cea397b752
+  data.tar.gz: cee830b49ad5443db42d34e6e0910e0783b2d116f91b02745a8556e184b4e66535c3620b4e9c15b4329a35286d117df51a0bba3e7d7ae818ab1016a63636e61c

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Api
+  module V2
+    # API controller for Ansible Roles
+    class AnsiblePlaybooksController < ::Api::V2::BaseController
+      include ::Api::Version2
+      include ::ForemanAnsible::ProxyAPI
+
+      before_action :find_proxy, only: [:fetch, :sync]
+
+      resource_description do
+        api_version 'v2'
+        api_base_url '/ansible/api'
+      end
+
+      api :PUT, '/ansible_playbooks/sync', N_('Sync Ansible playbooks')
+      param :proxy_id, :identifier, :required => true, :desc => N_('Smart Proxy to sync from')
+      param :playbooks_names, Array, N_('Ansible  playbooks names to be synced')
+      def sync
+        @task = plan_ansible_sync(@proxy.id, playbooks_names)
+      end
+
+      api :GET, '/ansible_playbooks/fetch', N_('Fetch Ansible playbooks available to be synced')
+      param :proxy_id, :identifier, N_('Smart Proxy to fetch from'),
+            :required => true
+      def fetch
+        fetched = fetch_playbooks_names
+        render :json => { :results => { :playbooks_names => fetched } }
+      end
+
+      def action_permission
+        case params[:action]
+        when 'sync', 'fetch'
+          :import
+        else
+          super
+        end
+      end
+
+      def plan_ansible_sync(proxy_id, playbooks_names)
+        ForemanTasks.async_task(ImportPlaybooksJob::Async::SyncPlaybooks, proxy_id, playbooks_names)
+      end
+
+      private
+
+      def find_proxy
+        unless params[:proxy_id]
+          msg = _('Smart proxy id is required')
+          render_error('custom_error', :status => :unprocessable_entity, :locals => { :message => msg })
+          return false
+        end
+        @proxy = SmartProxy.find(params[:proxy_id])
+      end
+
+      def fetch_playbooks_names
+        proxy_api = find_proxy_api(@proxy)
+        proxy_api.playbooks_names if @proxy
+      end
+
+      def playbooks_names
+        params.fetch(:playbooks_names, [])
+      end
+    end
+  end
+end

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

@@ -46,7 +46,11 @@ module ForemanAnsible
             find_resource
             return unless @hostgroup
 
-            @ansible_roles = @hostgroup.all_ansible_roles
+            @inherited_ansible_roles = @hostgroup.inherited_ansible_roles
+            @directly_assigned_roles = @hostgroup.ansible_roles
+            @ansible_roles = (
+              @directly_assigned_roles + @inherited_ansible_roles + @hostgroup.host_ansible_roles
+            ).uniq
           end
 
           api :POST, '/hostgroups/:id/assign_ansible_roles',

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

@@ -49,7 +49,9 @@ module ForemanAnsible
           def ansible_roles
             return unless @host
 
-            @ansible_roles = @host.all_ansible_roles
+            @inherited_ansible_roles = @host.inherited_ansible_roles
+            @directly_assigned_roles = @host.ansible_roles
+            @ansible_roles = (@directly_assigned_roles + @inherited_ansible_roles).uniq
           end
 
           api :POST, '/hosts/:id/assign_ansible_roles',

data/app/graphql/presenters/ansible_role_presenter.rb

@@ -4,6 +4,10 @@ module Presenters
 
     delegate :id, :name, :association, :to => :ansible_role
 
+    def self.graphql_type
+      'Types::InheritedAnsibleRole'
+    end
+
     def initialize(ansible_role, inherited)
       @ansible_role = ansible_role
       @inherited = inherited

data/app/graphql/types/ansible_role.rb

@@ -6,5 +6,6 @@ module Types
 
     field :name, String, :null => false
     field :path, resolver: Resolvers::AnsibleRole::Path
+    has_many :ansible_variables, ::Types::AnsibleVariable
   end
 end

data/app/graphql/types/inherited_ansible_role.rb

@@ -2,6 +2,10 @@ module Types
   class InheritedAnsibleRole < ::Types::AnsibleRole
     field :inherited, Boolean, :null => false
 
+    def self.record_for(object)
+      object.ansible_role
+    end
+
     def object_class
       object.ansible_role.class
     end

data/app/helpers/foreman_ansible/hosts_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  module HostsHelper
+    def ansible_hosts_multiple_actions
+      return [] unless User.current.can?(:create_job_invocations) &&
+                       User.current.can?(:play_roles_on_host)
+
+      [{ action: [_('Run all Ansible roles'),
+                  multiple_play_roles_hosts_path,
+                  false], priority: 1000 }]
+    end
+
+    def ansible_roles_present?(host)
+      host.ansible_roles.present? ||
+        host.inherited_ansible_roles.present?
+    end
+  end
+end

data/app/jobs/sync_playbooks.rb

@@ -0,0 +1,25 @@
+module ImportPlaybooksJob
+  module Async
+    class SyncPlaybooks < ::Actions::EntryAction
+      def plan(proxy_id, playbooks_names)
+        plan_self(proxy_id: proxy_id, playbooks_names: playbooks_names)
+      end
+
+      def run
+        playbooks_importer = ForemanAnsible::PlaybooksImporter.new(proxy)
+        output[:result] = playbooks_importer.import_playbooks(playbooks_names)
+        ForemanAnsible::ImportPlaybooksSuccessNotification.deliver!(task)
+      rescue StandardError => e
+        ForemanAnsible::ImportPlaybooksErrorNotification.new(e, task).deliver!
+      end
+
+      def proxy
+        SmartProxy.find(input[:proxy_id])
+      end
+
+      def playbooks_names
+        input[:playbooks_names]
+      end
+    end
+  end
+end

data/app/lib/proxy_api/ansible.rb

@@ -40,5 +40,18 @@ module ProxyAPI
       raise ProxyException.new(url, e,
                                N_('Unable to get roles/variables from Ansible'))
     end
+
+    def playbooks_names
+      parse(get('playbooks_names'))
+    rescue *PROXY_ERRORS => e
+      raise ProxyException.new(url, e, N_('Unable to get playbook\'s names from Ansible'))
+    end
+
+    def playbooks(playbooks_names = [])
+      playbooks_names = playbooks_names.join(',')
+      parse(get("playbooks/#{playbooks_names}"))
+    rescue *PROXY_ERRORS => e
+      raise ProxyException.new(url, e, N_('Unable to get playbooks from Ansible'))
+    end
   end
 end

data/app/services/foreman_ansible/import_playbooks_error_notification.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  class ImportPlaybooksErrorNotification < ::UINotifications::Base
+    private
+
+    def initialize(error, task)
+      @job_error = error
+      @subject = task
+    end
+
+    def create
+      ::Notification.create!(
+        :audience => Notification::AUDIENCE_USER,
+        :notification_blueprint => blueprint,
+        :initiator => initiator,
+        :message => message,
+        :subject => subject,
+        :actions => {
+          :links => links
+        }
+      )
+    end
+
+    def blueprint
+      name = 'Sync_playbooks_failed'
+      @blueprint ||= NotificationBlueprint.unscoped.find_by(:name => name)
+    end
+
+    def message
+      _("Failed to import playbooks Due to: #{@job_error}")
+    end
+
+    def links
+      [{ :href => Rails.application.routes.url_helpers.foreman_tasks_task_path(:id => subject.id), :title => N_('Task Details') }]
+    end
+  end
+end

data/app/services/foreman_ansible/import_playbooks_success_notification.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  class ImportPlaybooksSuccessNotification < ::UINotifications::Base
+    private
+
+    def create
+      ::Notification.create!(
+        :audience => Notification::AUDIENCE_USER,
+        :notification_blueprint => blueprint,
+        :initiator => initiator,
+        :message => message,
+        :subject => subject,
+        :actions => {
+          :links => links
+        }
+      )
+    end
+
+    def blueprint
+      name = 'Sync_playbooks_successfully'
+      @blueprint ||= NotificationBlueprint.unscoped.find_by(:name => name)
+    end
+
+    def message
+      blueprint.message
+    end
+
+    def links
+      [{ :href => Rails.application.routes.url_helpers.foreman_tasks_task_path(:id => subject.id), :title => N_('Task Details') }]
+    end
+  end
+end

data/app/services/foreman_ansible/playbooks_importer.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  # Imports playbooks from smart proxy
+  class PlaybooksImporter
+    include ::ForemanAnsible::ProxyAPI
+    delegate :playbooks, :playbooks_names, :to => :proxy_api
+
+    def initialize(proxy = nil)
+      @ansible_proxy = proxy
+    end
+
+    def import_playbooks(playbooks_names)
+      playbooks = playbooks(playbooks_names)
+      result = { created: {}, updated: {} }
+      playbooks.each do |playbook|
+        parsed_playbook = parse_playbook playbook
+        job_template_id = JobTemplate.where(name: parsed_playbook[:name]).pick(:id)
+        if job_template_id.present?
+          updated = update_job_template(job_template_id, parsed_playbook)
+          result[:updated].merge!(updated) unless updated.nil?
+        else
+          result[:created].merge!(create_job_template(parsed_playbook))
+        end
+      end
+      result
+    end
+
+    def parse_playbook(playbook)
+      content = playbook['playbooks_content']
+      {
+        name: playbook['name'],
+        playbook_content: metadata(playbook['name']) + content,
+        vars: get_vars(content)
+      }
+    end
+
+    def metadata(playbook_name)
+      <<~END_HEREDOC
+        <%#
+          name: #{playbook_name}
+          snippet: false
+          job_category: Ansible Playbook - Imported
+          provider_type: Ansible
+          kind: job_template
+          model: JobTemplate
+        %>
+      END_HEREDOC
+    end
+
+    def get_vars(playbook_content)
+      YAML.safe_load(playbook_content).map { |play| play['vars'] }
+    end
+
+    def create_job_template(playbook)
+      job_template = JobTemplate.create(name: playbook[:name], template: playbook[:playbook_content], job_category: 'Ansible Playbook - Imported', provider_type: 'Ansible')
+      # TODO: Add support for creating template inputs
+      job_template.organizations = Organization.unscoped.all
+      job_template.locations = Location.unscoped.all
+      job_template.save
+      { job_template.id => job_template.name }
+    end
+
+    def update_job_template(job_template_id, playbook)
+      # TODO: Add support for updating template inputs
+      inputs = []
+      job_template = JobTemplate.find(job_template_id)
+      should_update = !playbook[:playbook_content].eql?(job_template.template)
+      job_template.template = playbook[:playbook_content] if should_update
+      { job_template.id => job_template.name } unless inputs.empty? && !should_update
+    end
+  end
+end

data/app/services/foreman_ansible/proxy_api.rb

@@ -8,16 +8,15 @@ module ForemanAnsible
     included do
       attr_reader :ansible_proxy
 
-      def find_proxy_api
+      def find_proxy_api(ansible_proxy)
         if ansible_proxy.blank?
           raise ::Foreman::Exception.new(N_('Proxy not found'))
         end
-        @proxy_api = ::ProxyAPI::Ansible.new(:url => ansible_proxy.url)
+        ::ProxyAPI::Ansible.new(:url => ansible_proxy.url)
       end
 
       def proxy_api
-        return @proxy_api if @proxy_api
-        find_proxy_api
+        @proxy_api ||= find_proxy_api(ansible_proxy)
       end
     end
   end

data/app/services/foreman_ansible/variables_importer.rb

@@ -31,14 +31,12 @@ module ForemanAnsible
     end
 
     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)
-        end.select(&:present?).flatten.compact
-      )
+      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)
+      end.select(&:present?).flatten.compact)
     end
 
     def import_variables_roles(roles)
@@ -96,7 +94,9 @@ module ForemanAnsible
       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[:obsolete] = AnsibleVariable.where.not(id: persisted.pluck(:id)).
+                           where.not(imported: false)
+
       changes
     end
 

data/app/views/ansible_roles/index.html.erb

@@ -9,6 +9,7 @@
       <th class="col-md-6"><%= sort :name, :as => s_("Role|Name") %></th>
       <th class="col-md-2"><%= _("Hostgroups") %></th>
       <th class="col-md-2"><%= _("Hosts") %></th>
+      <th class="col-md-2"><%= _("Variables") %></th>
       <th class="col-md-2"><%= sort :updated_at, :as => _("Imported at") %></th>
       <th class="col-md-2"><%= _("Actions") %></th>
     </tr>
@@ -19,6 +20,7 @@
         <td class="ellipsis"><%= role.name %></td>
         <td class="ellipsis"><%= role.hostgroups.count %></td>
         <td class="ellipsis"><%= link_to role.hosts.count, hosts_path(:search => "ansible_role = #{role.name}")%></td>
+        <td class="ellipsis"><%= link_to(role.ansible_variables.count, ansible_variables_path(:search => "ansible_role = #{role}")) %></td>
         <td class="ellipsis"><%= import_time role %></td>
         <td>
           <%

data/app/views/api/v2/ansible_playbooks/sync.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @task
+
+attributes :id, :action, :state, :result, :start_at

data/app/views/api/v2/hostgroups/ansible_roles.json.rabl

@@ -2,4 +2,12 @@
 
 collection @ansible_roles
 
-attributes :id, :name, :created_at, :updated_at
+extends 'api/v2/ansible_roles/show'
+
+node :inherited do |role|
+  @inherited_ansible_roles.include?(role)
+end
+
+node :directly_assigned do |role|
+  @directly_assigned_roles.include?(role)
+end

data/app/views/api/v2/hosts/ansible_roles.json.rabl

@@ -2,4 +2,12 @@
 
 collection @ansible_roles
 
-attributes :id, :name, :created_at, :updated_at
+extends 'api/v2/ansible_roles/show'
+
+node :inherited do |role|
+  @inherited_ansible_roles.include?(role)
+end
+
+node :directly_assigned do |role|
+  @directly_assigned_roles.include?(role)
+end

data/app/views/foreman_ansible/job_templates/ansible_roles_-_install_from_git.erb

@@ -23,6 +23,9 @@ model: JobTemplate
 ---
 - hosts: all
   tasks:
-    - command: git clone <%= input('git_repository') %> <%= input('location') %>
+    - git:
+        repo: "<%= input('git_repository') %>"
+        dest: "<%= input('location') %>"
       register: out
+
     - debug: var=out

data/app/views/foreman_ansible/job_templates/ansible_windows_updates.erb

@@ -0,0 +1,160 @@
+<%#
+name: Manage Windows Updates - Ansible Default
+snippet: false
+template_inputs:
+- name: reject_list
+  required: false
+  input_type: user
+  description: "A list of update titles or KB numbers that can be used to specify
+    which updates are to be excluded from installation.\r\nIf an available update
+    does match one of the entries, then it is skipped and not installed.\r\nEach entry
+    can either be the KB article or Update title as a regex according to the PowerShell
+    regex rules."
+  advanced: false
+- name: category_names
+  required: false
+  input_type: user
+  description: "A scalar or list of categories to install updates from. To get the
+    list of categories, run the module with state=searched. The category must be the
+    full category string, but is case insensitive.\r\nSome possible categories are
+    Application, Connectors, Critical Updates, Definition Updates, Developer Kits,
+    Feature Packs, Guidance, Security Updates, Service Packs, Tools, Update Rollups
+    and Updates.\r\n\r\nDefault is '[\"CriticalUpdates\", \"SecurityUpdates\", \"UpdateRollups\"]'"
+  advanced: false
+- name: log_path
+  required: false
+  input_type: user
+  description: If set, win_updates will append update progress to the specified file.
+    The directory must already exist.
+  advanced: false
+- name: reboot
+  required: false
+  input_type: user
+  description: "Ansible will automatically reboot the remote host if it is required
+    and continue to install updates after the reboot.\r\nThis can be used instead
+    of using a win_reboot task after this one and ensures all updates for that category
+    is installed in one go.\r\nAsync does not work when reboot=true.\r\n\r\nDefault
+    is 'false'"
+  options: "false\r\ntrue"
+  advanced: false
+- name: reboot_timeout
+  required: false
+  input_type: user
+  description: "The time in seconds to wait until the host is back online from a reboot.\r\nThis
+    is only used if reboot=true and a reboot is required.\r\n\r\nDefault is '1200'"
+  advanced: false
+- name: server_selection
+  required: false
+  input_type: user
+  description: "Defines the Windows Update source catalog.\r\ndefault Use the default
+    search source. For many systems default is set to the Microsoft Windows Update
+    catalog. Systems participating in Windows Server Update Services (WSUS), Systems
+    Center Configuration Manager (SCCM), or similar corporate update server environments
+    may default to those managed update sources instead of the Windows Update catalog.\r\nmanaged_server
+    Use a managed server catalog. For environments utilizing Windows Server Update
+    Services (WSUS), Systems Center Configuration Manager (SCCM), or similar corporate
+    update servers, this option selects the defined corporate update source.\r\nwindows_update
+    Use the Microsoft Windows Update catalog.\r\n\r\nDefault is 'default'"
+  options: "default\r\nmanaged_server\r\nwindows_update"
+  advanced: false
+- name: state
+  required: false
+  input_type: user
+  description: "Controls whether found updates are downloaded or installed or listed\r\nThis
+    module also supports Ansible check mode, which has the same effect as setting
+    state=searched\r\n\r\nDefault is 'searched'"
+  options: "installed\r\nsearched\r\ndownloaded"
+  advanced: false
+- name: use_scheduled_task
+  required: false
+  input_type: user
+  description: "Will not auto elevate the remote process with become and use a scheduled
+    task instead.\r\nSet this to true when using this module with async on Server
+    2008, 2008 R2, or Windows 7, or on Server 2008 that is not authenticated with
+    basic or credssp.\r\nCan also be set to true on newer hosts where become does
+    not work due to further privilege restrictions from the OS defaults."
+  options: "false\r\ntrue"
+  advanced: false
+- name: whitelist
+  required: false
+  input_type: user
+  description: "A list of update titles or KB numbers that can be used to specify
+    which updates are to be searched or installed.\r\nIf an available update does
+    not match one of the entries, then it is skipped and not installed.\r\nEach entry
+    can either be the KB article or Update title as a regex according to the PowerShell
+    regex rules.\r\nThe whitelist is only validated on updates that were found based
+    on category_names. It will not force the module to install an update if it was
+    not in the category specified."
+  advanced: false
+model: JobTemplate
+job_category: Ansible Playbook
+provider_type: Ansible
+kind: job_template
+organizations:
+- My_Organization
+locations:
+- My_Location
+%>
+
+- hosts: all
+  vars:
+    updates: []
+    <% if input('state').blank? %>
+    state: searched
+    <% else %>
+    state: <%= input('state') %>
+    <% end %>
+
+  tasks:
+    - name: "{{ state | replace('ed','') | capitalize }} Windows Updates"
+      win_updates:
+        <% unless input('reject_list').blank? %>
+        blacklist: <%= input('reject_list') %>
+        <% end -%>
+        <% if input('category_names').blank? %>
+        category_names: ["CriticalUpdates", "SecurityUpdates", "UpdateRollups"]
+        <% else %>
+        category_names: <%= input('category_names') %>
+        <% end %>
+        <% unless input('log_path').blank? %>
+        log_path: <%= input('log_path') %>
+        <% end -%>
+        <% if input('reboot').blank? %>
+        reboot: false
+        <% else %>
+        reboot: <%= input('reboot') %>
+        <% end %>
+        <% if input('reboot_timeout').blank? %>
+        reboot_timeout: 1200
+        <% else %>
+        reboot_timeout: <%= input('reboot_timeout') %>
+        <% end -%>
+        <% if input('server_selection').blank? %>
+        server_selection: default
+        <% else %>
+        server_selection: <%= input('server_selection') %>
+        <% end %>
+        state: "{{ state }}"
+        <% if input('use_scheduled_task').blank? %>
+        use_scheduled_task: false
+        <% else %>
+        use_scheduled_task: <%= input('use_scheduled_task') %>
+        <% end %>
+        <% if !input('whitelist').blank? %>
+        whitelist: <%= input('whitelist') %>
+        <% end -%>
+
+      register: found_updates
+      
+    - name: "Get all {{ state }} updates"
+      set_fact:
+        updates: "{{ updates + [ current_update ] }}"
+      vars:
+        current_update: "{{ item.value.title  }}"
+      loop: "{{ found_updates.updates | dict2items }}"
+      no_log: true
+
+    - name: "List {{ state }} Windows Updates"
+      debug: 
+        msg: "{{ item }}"
+      loop: "{{ updates }}"

data/config/routes.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  match '/ansible/hostgroups' => 'react#index', :via => [:get]
-  match '/ansible/hostgroups/*page' => 'react#index', :via => [:get]
-
   namespace :api, defaults: { format: 'json' } do
     scope '(:apiv)',
           :module => :v2,
@@ -85,6 +82,13 @@ Rails.application.routes.draw do
           end
         end
 
+        resources :ansible_playbooks, :only => [] do
+          collection do
+            get :fetch
+            put :sync
+          end
+        end
+
         resources :ansible_variables, :only => [:show, :index, :destroy, :update, :create] do
           collection do
             put :import
@@ -106,4 +110,7 @@ Rails.application.routes.draw do
       end
     end
   end
+
+  match '/ansible/hostgroups' => 'react#index', :via => [:get]
+  match '/ansible/hostgroups/*page' => 'react#index', :via => [:get]
 end