foreman_ansible 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc4ac60019a9a765f9d6952ef2353dd4c67ddac3
-  data.tar.gz: 1cdc990b070ea857835c74822b021340640bac56
+  metadata.gz: 7394d81e94f7dd6bfda57b0a539adc09a1c068e0
+  data.tar.gz: 87475c40db6d3a594517de1443878ffe107b85f6
 SHA512:
-  metadata.gz: 6658351477f153ae2b6b42356ba9cb75515fbfeae8a8a40040e2c80d458b127adb2a2a37171b42dc54ca73b135cfd207aa804d190ad6a63df5b8ae8f211805b7
-  data.tar.gz: 20f1305a896c46529bc488044f3a3284feb09290845ecbdd333be2ad616473051aa2160cacca849656164bd8c91b654e063a35b4ad9a9edeaa2e257db37cee4c
+  metadata.gz: 48d0c08d791d3543d6cbf2341c6a3ed66ba9c0d4b9a8c9e5bbcc0344444ef9c8c94db91ae4b7bf193ef915c75d9162470877140c46cd9d3c44e110d3593d809b
+  data.tar.gz: 79df637cc5ce51f5f6d9ee40ae0587b18c4dc9f339ae0edd4d813dd97fcfe1965bc589d7c176fcabcbd202cd47d75a839695ed652a9636ff32e37175164e168b

data/Rakefile

@@ -4,37 +4,16 @@ begin
 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    = 'ForemanAnsible'
-  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
+Rake::TestTask.new("test:core") do |test|
+  test_dir = File.join(File.dirname(__FILE__), 'test/lib')
+  test.pattern = "#{test_dir}/**/*_test.rb"
+  test.libs << test_dir
+  test.verbose = false
+  test.warning = false
 end
 
-task :default => :test
-
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new

data/app/controllers/ansible_roles_controller.rb

@@ -0,0 +1,55 @@
+# 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]
+
+  def index
+    @ansible_roles = resource_base.search_for(params[:search],
+                                              :order => params[:order]).
+                     paginate(:page => params[:page],
+                              :per_page => params[:per_page])
+  end
+
+  def destroy
+    if @ansible_role.destroy
+      process_success
+    else
+      process_error
+    end
+  end
+
+  def import
+    changed = @importer.import!
+    if changed.values.all?(&:empty?)
+      notice no_changed_roles_message
+      redirect_to ansible_roles_path
+    else
+      render :locals => { :changed => changed }
+    end
+  end
+
+  def confirm_import
+    @importer.finish_import(params[:changed])
+    notice _('Import of roles successfully finished.')
+    redirect_to ansible_roles_path
+  end
+
+  private
+
+  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
+
+  def no_changed_roles_message
+    return _('No changes in roles detected.') unless @proxy.present?
+    _('No changes in roles detected on %s.') % @proxy.name
+  end
+end

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

@@ -0,0 +1,52 @@
+module Api
+  module V2
+    # API controller for Ansible Roles
+    class AnsibleRolesController < ::Api::V2::BaseController
+      include ::Api::Version2
+
+      before_action :find_resource, :only => [:show, :destroy]
+      before_action :find_proxy, :only => [:import, :obsolete]
+      before_action :create_importer, :only => [:import, :obsolete]
+
+      api :GET, '/ansible/ansible_roles/:id', N_('Show role')
+      param :id, :identifier, :required => true
+      def show
+      end
+
+      api :GET, '/ansible/ansible_roles', N_('List Ansible roles')
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      def index
+        @ansible_roles = resource_scope_for_index
+      end
+
+      api :DELETE, '/ansible/ansible_roles/:id', N_('Deletes Ansible role')
+      param :id, :identifier, :required => true
+      def destroy
+        process_response @ansible_role.destroy
+      end
+
+      api :POST, '/ansible/ansible_roles/import', N_('Import Ansible roles')
+      param :proxy, Hash, N_('Smart Proxy to import from')
+      def import
+        @imported = @importer.import!
+      end
+
+      api :POST, '/ansible/ansible_roles/obsolete', N_('Obsolete Ansible roles')
+      param :proxy, Hash, N_('Smart Proxy to import from')
+      def obsolete
+        @obsoleted = @importer.obsolete!
+      end
+
+      private
+
+      def find_proxy
+        return nil unless params[:proxy]
+        @proxy = SmartProxy.authorized(:view_smart_proxies).find(params[:proxy])
+      end
+
+      def create_importer
+        @importer = ForemanAnsible::ApiRolesImporter.new(@proxy)
+      end
+    end
+  end
+end

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

@@ -3,23 +3,24 @@ module ForemanAnsible
     # Extra methods to enforce Ansible roles on a host or multiple hosts
     module HostsControllerExtensions
       extend ActiveSupport::Concern
+      include ForemanTasks::Triggers
 
       def play_roles
         find_resource
-        RolePlayer.new(@host).play
-        notice(_('Ansible roles running on background: ') +
-               @host.ansible_roles.map(&:name).join(', '))
-        redirect_to :back
+        task = async_task(::Actions::ForemanAnsible::PlayHostRoles, @host)
+        redirect_to task
+      rescue Foreman::Exception => e
+        error e.message
+        redirect_to host_path(@host)
       end
 
       def multiple_play_roles
         find_multiple
-        @hosts.each do |host|
-          RolePlayer.new(host).play
-        end
-        notice(_('Ansible roles running on background for hosts: ') +
-               @hosts.map(&:name).join(', '))
-        redirect_to :hosts
+        task = async_task(::Actions::ForemanAnsible::PlayHostsRoles, @hosts)
+        redirect_to task
+      rescue Foreman::Exception => e
+        error e.message
+        redirect_to hosts_path
       end
 
       private

data/app/helpers/foreman_ansible/ansible_plugin_helper.rb

@@ -0,0 +1,8 @@
+module ForemanAnsible
+  # General helper for foreman_ansible
+  module AnsiblePluginHelper
+    def ansible_doc_url
+      'http://theforeman.org/plugins/foreman_ansible/1.x/index.html'
+    end
+  end
+end

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -12,10 +12,12 @@ module ForemanAnsible
 
     def ansible_module_message(log)
       paragraph_style = 'margin:0px;font-family:Menlo,Monaco,Consolas,monospace'
-      JSON.parse(log.message.value).except('invocation').map do |name, value|
-        next if value.blank?
-        "<p style=#{paragraph_style}>#{name}: #{value}</p>"
-      end.join.html_safe
+      safe_join(
+        JSON.parse(log.message.value).except('invocation').map do |name, value|
+          next if value.blank?
+          content_tag(:p, "#{name}: #{value}", :style => paragraph_style)
+        end
+      )
     end
 
     def ansible_report?(log)

data/app/helpers/foreman_ansible/ansible_roles_helper.rb

@@ -1,9 +1,23 @@
 module ForemanAnsible
   # Small convenience to list all roles in the UI
   module AnsibleRolesHelper
-    def ansible_roles
-      ForemanAnsible::RolesImporter.import!
-      AnsibleRole.all
+    def ansible_proxy_links(hash, classes = nil)
+      links = SmartProxy.with_features('Ansible').map do |proxy|
+        display_link_if_authorized(_('Import from %s') % proxy.name,
+                                   hash.merge(:proxy => proxy),
+                                   :class => classes)
+      end.flatten
+      links.unshift display_link_if_authorized(_('Import from Foreman host'),
+                                               hash,
+                                               :class => classes)
+    end
+
+    def ansible_proxy_import(hash)
+      select_action_button(_('Import'), {}, ansible_proxy_links(hash))
+    end
+
+    def import_time(role)
+      _('%s ago') % time_ago_in_words(role.updated_at)
     end
   end
 end

data/app/helpers/foreman_ansible/hosts_helper_extensions.rb

@@ -11,9 +11,10 @@ module ForemanAnsible
     def host_title_actions_with_run_ansible_roles(*args)
       button = link_to(
         icon_text('play', ' ' + _('Ansible roles'), :kind => 'fa'),
-        play_roles_ansible_host_path(:id => args.first.id),
+        play_roles_host_path(:id => args.first.id),
         :id => :ansible_roles_button,
-        :class => 'btn btn-default')
+        :class => 'btn btn-default'
+      )
       title_actions(button_group(button)) if args.first.ansible_roles.present?
       host_title_actions_without_run_ansible_roles(*args)
     end
@@ -21,7 +22,7 @@ module ForemanAnsible
     def multiple_actions_with_run_ansible_roles
       multiple_actions_without_run_ansible_roles +
         [[_('Play Ansible roles'),
-          multiple_play_roles_ansible_hosts_path,
+          multiple_play_roles_hosts_path,
           false]]
     end
   end

data/app/lib/actions/foreman_ansible/play_host_roles.rb

@@ -0,0 +1,56 @@
+module Actions
+  module ForemanAnsible
+    # Actions that initiaztes the playbook run for roles assigned to
+    # the host. It doest that either locally or via a proxy when available.
+    class PlayHostRoles < Actions::EntryAction
+      include ::Actions::Helpers::WithContinuousOutput
+      include ::Actions::Helpers::WithDelegatedAction
+
+      def plan(host, proxy_selector = ::ForemanAnsible::ProxySelector.new)
+        input[:host] = { :id => host.id, :name => host.fqdn }
+        proxy = proxy_selector.determine_proxy(host)
+        inventory_creator = ::ForemanAnsible::InventoryCreator.new([host])
+        role_names = host.all_ansible_roles.map(&:name)
+        playbook_creator = ::ForemanAnsible::PlaybookCreator.new(role_names)
+        plan_delegated_action(proxy, ::ForemanAnsibleCore::Actions::RunPlaybook,
+                              :inventory => inventory_creator.to_hash.to_json,
+                              :playbook => playbook_creator.roles_playbook)
+        plan_self
+      end
+
+      def finalize
+        if delegated_output[:exit_status].to_s != '0'
+          error! _('Playbook execution failed')
+        end
+      end
+
+      def rescue_strategy
+        ::Dynflow::Action::Rescue::Fail
+      end
+
+      def humanized_input
+        _('on host %{name}') % { :name => input.fetch(:host, {})[:name] }
+      end
+
+      def humanized_name
+        _('Play Ansible roles')
+      end
+
+      def humanized_output
+        continuous_output.humanize
+      end
+
+      def continuous_output_providers
+        super << self
+      end
+
+      def fill_continuous_output(continuous_output)
+        delegated_output.fetch('result', []).each do |raw_output|
+          continuous_output.add_raw_output(raw_output)
+        end
+      rescue => e
+        continuous_output.add_exception(_('Error loading data from proxy'), e)
+      end
+    end
+  end
+end

data/app/lib/actions/foreman_ansible/play_hosts_roles.rb

@@ -0,0 +1,26 @@
+module Actions
+  module ForemanAnsible
+    # Bulk action for running ansible roles
+    class PlayHostsRoles < Actions::ActionWithSubPlans
+      def plan(hosts)
+        plan_self(:host_ids => hosts.map(&:id))
+      end
+
+      def create_sub_plans
+        proxy_selector = ::ForemanAnsible::ProxySelector.new
+        input[:host_ids].map do |host_id|
+          host = Host.find(host_id)
+          trigger(PlayHostRoles, host, proxy_selector)
+        end
+      end
+
+      def rescue_strategy
+        ::Dynflow::Action::Rescue::Fail
+      end
+
+      def humanized_name
+        _('Bulk play Ansible roles')
+      end
+    end
+  end
+end

data/app/lib/proxy_api/ansible.rb

@@ -0,0 +1,28 @@
+module ProxyAPI
+  # ProxyAPI for Ansible
+  class Ansible < ::ProxyAPI::Resource
+    def initialize(args)
+      @url = args[:url] + '/ansible/'
+      super args
+    end
+
+    PROXY_ERRORS = [
+      Errno::ECONNREFUSED,
+      SocketError,
+      Timeout::Error,
+      Errno::EINVAL,
+      Errno::ECONNRESET,
+      EOFError,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      RestClient::ResourceNotFound
+    ].freeze
+
+    def roles
+      parse(get('roles'))
+    rescue *PROXY_ERRORS => e
+      raise ProxyException.new(url, e, N_('Unable to get roles from Ansible'))
+    end
+  end
+end

data/app/models/ansible_role.rb

@@ -1,6 +1,14 @@
 # Simple model to store basic info about the Ansible role
 class AnsibleRole < ActiveRecord::Base
+  include Authorizable
+
+  self.include_root_in_json = false
   validates :name, :presence => true, :uniqueness => true
   has_many :host_ansible_roles
   has_many_hosts :through => :host_ansible_roles, :dependent => :destroy
+  has_many :hostgroup_ansible_roles
+  has_many :hostgroups, :through => :hostgroup_ansible_roles,
+                        :dependent => :destroy
+
+  scoped_search :on => :name, :complete_value => true
 end

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

@@ -0,0 +1,13 @@
+module ForemanAnsible
+  # Define common behaviors between models that have many Ansible roles,
+  # currently Host and Hostgroup. Takes care of inheritance, etc...
+  module HasManyAnsibleRoles
+    extend ActiveSupport::Concern
+
+    included do
+      def all_ansible_roles
+        (ansible_roles + inherited_ansible_roles).uniq
+      end
+    end
+  end
+end

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

@@ -7,8 +7,12 @@ module ForemanAnsible
       has_many :host_ansible_roles, :foreign_key => :host_id
       has_many :ansible_roles, :through => :host_ansible_roles,
                                :dependent => :destroy
+      include ForemanAnsible::HasManyAnsibleRoles
 
-      attr_accessible :ansible_role_ids, :ansible_roles
+      def inherited_ansible_roles
+        return [] unless hostgroup
+        hostgroup.all_ansible_roles
+      end
     end
   end
 end

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

@@ -0,0 +1,19 @@
+module ForemanAnsible
+  # Relations to make Hostgroup 'have' ansible roles
+  module HostgroupExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :hostgroup_ansible_roles, :foreign_key => :hostgroup_id
+      has_many :ansible_roles, :through => :hostgroup_ansible_roles,
+                               :dependent => :destroy
+      include ForemanAnsible::HasManyAnsibleRoles
+
+      def inherited_ansible_roles
+        ancestors.reduce([]) do |roles, hostgroup|
+          roles + hostgroup.ansible_roles
+        end.uniq
+      end
+    end
+  end
+end