foreman_ansible 1.5.2 → 2.0.0

data/app/services/foreman_ansible/inventory_creator.rb

@@ -16,13 +16,18 @@ module ForemanAnsible
     # more advanced cases). Therefore we have only the 'all' group
     # with all hosts.
     def to_hash
-      { 'all' => { 'hosts' => hosts.map(&:fqdn) },
+      hosts = @hosts.map do |h|
+        RemoteExecutionProvider.find_ip_or_hostname(h)
+      end
+      { 'all' => { 'hosts' => hosts },
         '_meta' => { 'hostvars' => hosts_vars } }
     end
 
     def hosts_vars
       hosts.reduce({}) do |hash, host|
-        hash.update(host.fqdn => host_vars(host))
+        hash.update(
+          RemoteExecutionProvider.find_ip_or_hostname(host) => host_vars(host)
+        )
       end
     end
 

data/app/services/foreman_ansible/proxy_selector.rb

@@ -3,6 +3,12 @@ module ForemanAnsible
   class ProxySelector < ::ForemanTasks::ProxySelector
     def available_proxies(host)
       proxies = {}
+      if host.execution_interface && host.execution_interface.subnet
+        proxies[:subnet] = host.
+                           execution_interface.
+                           subnet.
+                           remote_execution_proxies.with_features(provider)
+      end
       proxies[:fallback] = host.smart_proxies.with_features('Ansible')
       proxies[:global] = proxy_scope(host).authorized.with_features('Ansible')
       proxies

data/app/services/foreman_ansible/ui_roles_importer.rb

@@ -11,6 +11,7 @@ module ForemanAnsible
       delete_old_roles changes['obsolete'] if changes['obsolete']
     end
 
+    # rubocop:disable Performance/HashEachMethods
     def create_new_roles(changes)
       changes.values.each do |new_role|
         ::AnsibleRole.create(JSON.parse(new_role))
@@ -22,5 +23,6 @@ module ForemanAnsible
         ::AnsibleRole.find(JSON.parse(old_role)['id']).destroy
       end
     end
+    # rubocop:enable Performance/HashEachMethods
   end
 end

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

@@ -1,7 +1,6 @@
 <% title _("Ansible Roles") %>
 
-<% title_actions ansible_proxy_import(hash_for_import_ansible_roles_path),
-  documentation_button('#4.1ImportingRoles', :root_url => ansible_doc_url) %>
+<% title_actions ansible_proxy_import(hash_for_import_ansible_roles_path) %>
 
 <table class="<%= table_css_classes 'table-fixed' %>">
   <thead>

data/app/views/foreman_ansible/ansible_roles/_hostgroup_ansible_roles_button.erb

@@ -1,13 +1,14 @@
 <%=
-  play_roles = if hostgroup.all_ansible_roles.empty?
-    "<a title='No Roles assigned' href=\"#\">#{_('Play Roles')}</a>".html_safe
-  else
-    display_link_if_authorized(_('Play Roles'),   hash_for_play_roles_hostgroup_path(:id => hostgroup),   :'data-no-turbolink' => true)
-  end
-
+if hostgroup.all_ansible_roles.empty?
   action_buttons(
               display_link_if_authorized(_('Nest'),    hash_for_nest_hostgroup_path(:id => hostgroup)),
               display_link_if_authorized(_('Clone'),   hash_for_clone_hostgroup_path(:id => hostgroup)),
-              play_roles,
               display_delete_if_authorized(hash_for_hostgroup_path(:id => hostgroup).merge(:auth_object => hostgroup, :authorizer => authorizer), :data => { :confirm => warning_message(hostgroup) }))
+else
+  action_buttons(
+              display_link_if_authorized(_('Nest'),    hash_for_nest_hostgroup_path(:id => hostgroup)),
+              display_link_if_authorized(_('Clone'),   hash_for_clone_hostgroup_path(:id => hostgroup)),
+              display_link_if_authorized(_('Play Roles'),   hash_for_play_roles_hostgroup_path(:id => hostgroup),   :'data-no-turbolink' => true),
+              display_delete_if_authorized(hash_for_hostgroup_path(:id => hostgroup).merge(:auth_object => hostgroup, :authorizer => authorizer), :data => { :confirm => warning_message(hostgroup) }))
+end
 %>

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

@@ -0,0 +1,17 @@
+<%#
+kind: job_template
+name: Ansible Roles - Ansible Default
+job_category: Ansible Playbook
+description_format: 'Run Ansible roles for host'
+feature: ansible_run_host
+provider_type: Ansible
+%>
+
+---
+- hosts: <%= @host.name %>
+  tasks:
+    - debug: msg=These are the parameters "{{ foreman_params }}"
+  roles:
+    <% if @host.all_ansible_roles.present? -%>
+    - <%= @host.all_ansible_roles.map { |role| role.name.strip }.join("\n    - ") %>
+    <% end -%>

data/config/routes.rb

@@ -61,3 +61,4 @@ Rails.application.routes.draw do
     end
   end
 end
+# rubocop:enable BlockLength

data/db/migrate/20160705082036_create_ansible_role.rb

@@ -1,5 +1,5 @@
 # Creates simple model of Ansible Role
-class CreateAnsibleRole < ActiveRecord::Migration
+class CreateAnsibleRole < ActiveRecord::Migration[4.2]
   def change
     create_table :ansible_roles do |t|
       t.string :name, :null => false, :limit => 255, :unique => true

data/db/migrate/20160706074540_create_join_table_hosts_ansible_roles.rb

@@ -1,5 +1,5 @@
 # Defines the relation between Host and AnsibleRole
-class CreateJoinTableHostsAnsibleRoles < ActiveRecord::Migration
+class CreateJoinTableHostsAnsibleRoles < ActiveRecord::Migration[4.2]
   def change
     create_join_table :ansible_roles, :hosts do |t|
       t.index [:host_id, :ansible_role_id]

data/db/migrate/20160707195442_create_host_ansible_roles.rb

@@ -1,5 +1,5 @@
 # Renames join table between Host and Ansible Roles
-class CreateHostAnsibleRoles < ActiveRecord::Migration
+class CreateHostAnsibleRoles < ActiveRecord::Migration[4.2]
   def change
     rename_table :ansible_roles_hosts, :host_ansible_roles
     add_column :host_ansible_roles, :id, :primary_key

data/db/migrate/20160729094457_add_columns_to_ansible_role.rb

@@ -1,5 +1,5 @@
 # to keep track of when the roles were imported
-class AddColumnsToAnsibleRole < ActiveRecord::Migration
+class AddColumnsToAnsibleRole < ActiveRecord::Migration[4.2]
   def up
     add_column :ansible_roles, :created_at, :datetime, :default => Time.now.utc
     add_column :ansible_roles, :updated_at, :datetime, :default => Time.now.utc

data/db/migrate/20160802153302_create_join_table_hostgroup_ansible_roles.rb

@@ -1,10 +1,11 @@
 # Defines the relation between Hostgroup and AnsibleRole
 # rubocop:disable Metrics/LineLength
-class CreateJoinTableHostgroupAnsibleRoles < ActiveRecord::Migration
+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/20160805094233_add_primary_key_hostgroup_ansible_roles.rb

@@ -1,5 +1,5 @@
 # Adds primary key to join table between Hostgroup and Ansible Role
-class AddPrimaryKeyHostgroupAnsibleRoles < ActiveRecord::Migration
+class AddPrimaryKeyHostgroupAnsibleRoles < ActiveRecord::Migration[4.2]
   def change
     add_column :hostgroup_ansible_roles, :id, :primary_key
   end

data/db/migrate/20161122154057_automatically_set_role_timestamps.rb

@@ -1,5 +1,5 @@
 # Creation and updates timestamps for Ansible Roles
-class AutomaticallySetRoleTimestamps < ActiveRecord::Migration
+class AutomaticallySetRoleTimestamps < ActiveRecord::Migration[4.2]
   def up
     change_column :ansible_roles, :created_at, :datetime, :null => true,
                                                           :default => nil

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

@@ -0,0 +1,20 @@
+User.as_anonymous_admin do
+  if Rails.env.test? || File.basename($0) == 'rake'
+    # If this file tries to import a template with a REX feature in a SeedsTest,
+    # it will fail - the REX feature isn't registered on SeedsTest because
+    # DatabaseCleaner truncates the db before every test.
+    # During db:seed, we also want to know the feature is registered before
+    # seeding the template
+    ForemanAnsible::Engine.register_rex_feature
+  end
+  JobTemplate.without_auditing do
+    Dir[File.join("#{ForemanAnsible::Engine.root}/app/views/foreman_ansible/"\
+                  'job_templates/**/*.erb')].each do |template|
+      sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
+      JobTemplate.import_raw!(File.read(template),
+                              :default => true,
+                              :locked => true,
+                              :update => sync)
+    end
+  end
+end

data/lib/foreman_ansible/engine.rb

@@ -2,10 +2,10 @@ require 'deface'
 require 'fast_gettext'
 require 'gettext_i18n_rails'
 require 'foreman_ansible_core'
+require 'foreman_ansible/remote_execution'
 
 module ForemanAnsible
   # This engine connects ForemanAnsible with Foreman core
-  # rubocop:disable ClassLength
   class Engine < ::Rails::Engine
     engine_name 'foreman_ansible'
 
@@ -31,58 +31,8 @@ module ForemanAnsible
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
 
-    # rubocop:disable BlockLength
     initializer 'foreman_ansible.register_plugin', :before => :finisher_hook do
-      Foreman::Plugin.register :foreman_ansible do
-        requires_foreman '>= 1.15'
-
-        security_block :foreman_ansible do
-          permission :play_roles_on_host,
-                     { :hosts => [:play_roles, :multiple_play_roles],
-                       :'api/v2/hosts' => [:play_roles,
-                                           :multiple_play_roles] },
-                     :resource_type => 'Host'
-          permission :play_roles_on_hostgroup,
-                     { :hostgroups => [:play_roles],
-                       :'api/v2/hostgroups' => [:play_roles,
-                                                :multiple_play_roles] },
-                     :resource_type => 'Hostgroup'
-          permission :view_ansible_roles,
-                     { :ansible_roles => [:index],
-                       :'api/v2/ansible_roles' => [:index, :show] },
-                     :resource_type => 'AnsibleRole'
-          permission :destroy_ansible_roles,
-                     { :ansible_roles => [:destroy],
-                       :'api/v2/ansible_roles' => [:destroy, :obsolete] },
-                     :resource_type => 'AnsibleRole'
-          permission :import_ansible_roles,
-                     { :ansible_roles => [:import, :confirm_import],
-                       :'api/v2/ansible_roles' => [:import] },
-                     :resource_type => 'AnsibleRole'
-        end
-
-        role 'Ansible Roles Manager',
-             [:play_roles_on_host, :play_roles_on_hostgroup,
-              :view_ansible_roles, :destroy_ansible_roles,
-              :import_ansible_roles]
-
-        add_all_permissions_to_default_roles
-
-        role_assignment_params = { :ansible_role_ids => [],
-                                   :ansible_roles => [] }
-        parameter_filter Host::Managed, role_assignment_params
-        parameter_filter Hostgroup, role_assignment_params
-
-        divider :top_menu, :caption => N_('Ansible'), :parent => :configure_menu
-        menu :top_menu, :ansible_roles,
-             :caption => N_('Roles'),
-             :url_hash => { :controller => :ansible_roles, :action => :index },
-             :parent => :configure_menu
-
-        apipie_documented_controllers [
-          "#{ForemanAnsible::Engine.root}/app/controllers/api/v2/*.rb"
-        ]
-      end
+      require 'foreman_ansible/register'
     end
 
     initializer('foreman_ansible.require_dynflow',
@@ -117,6 +67,7 @@ module ForemanAnsible
       Apipie.configuration.checksum_path += ['/foreman_ansible/api/']
     end
 
+    # rubocop:disable BlockLength
     config.to_prepare do
       begin
         foreman_version = ::Foreman::Version.new
@@ -146,9 +97,16 @@ module ForemanAnsible
         ::Api::V2::HostgroupsController.send(
           :include, ForemanAnsible::Api::V2::HostgroupsControllerExtensions
         )
-      rescue => e
+      rescue StandardError => e
         Rails.logger.warn "Foreman Ansible: skipping engine hook (#{e})"
       end
     end
+    # rubocop:enable BlockLength
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanAnsible::Engine.load_seed
+      end
+    end
   end
 end

data/lib/foreman_ansible/register.rb

@@ -0,0 +1,52 @@
+# rubocop:disable BlockLength
+Foreman::Plugin.register :foreman_ansible do
+  requires_foreman '>= 1.16'
+
+  security_block :foreman_ansible do
+    permission :play_roles_on_host,
+               { :hosts => [:play_roles, :multiple_play_roles],
+                 :'api/v2/hosts' => [:play_roles,
+                                     :multiple_play_roles] },
+               :resource_type => 'Host'
+    permission :play_roles_on_hostgroup,
+               { :hostgroups => [:play_roles],
+                 :'api/v2/hostgroups' => [:play_roles,
+                                          :multiple_play_roles] },
+               :resource_type => 'Hostgroup'
+    permission :view_ansible_roles,
+               { :ansible_roles => [:index],
+                 :'api/v2/ansible_roles' => [:index, :show] },
+               :resource_type => 'AnsibleRole'
+    permission :destroy_ansible_roles,
+               { :ansible_roles => [:destroy],
+                 :'api/v2/ansible_roles' => [:destroy, :obsolete] },
+               :resource_type => 'AnsibleRole'
+    permission :import_ansible_roles,
+               { :ansible_roles => [:import, :confirm_import],
+                 :'api/v2/ansible_roles' => [:import] },
+               :resource_type => 'AnsibleRole'
+  end
+
+  role 'Ansible Roles Manager',
+       [:play_roles_on_host, :play_roles_on_hostgroup,
+        :view_ansible_roles, :destroy_ansible_roles,
+        :import_ansible_roles]
+
+  add_all_permissions_to_default_roles
+
+  role_assignment_params = { :ansible_role_ids => [],
+                             :ansible_roles => [] }
+  parameter_filter Host::Managed, role_assignment_params
+  parameter_filter Hostgroup, role_assignment_params
+
+  divider :top_menu, :caption => N_('Ansible'), :parent => :configure_menu
+  menu :top_menu, :ansible_roles,
+       :caption => N_('Roles'),
+       :url_hash => { :controller => :ansible_roles, :action => :index },
+       :parent => :configure_menu
+
+  apipie_documented_controllers [
+    "#{ForemanAnsible::Engine.root}/app/controllers/api/v2/*.rb"
+  ]
+end
+# rubocop:enable BlockLength

data/lib/foreman_ansible/remote_execution.rb

@@ -0,0 +1,22 @@
+require 'foreman_remote_execution'
+
+module ForemanAnsible
+  # Dependencies related with the remote execution plugin
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      RemoteExecutionProvider.register(
+        :Ansible,
+        ForemanAnsible::AnsibleProvider
+      )
+    end
+
+    def self.register_rex_feature
+      RemoteExecutionFeature.register(
+        :ansible_run_host,
+        N_('Ansible: Run host roles'),
+        :description => N_('Runs an Ansible playbook which contains all'\
+                           ' the roles defined for a host')
+      )
+    end
+  end
+end

data/lib/foreman_ansible/version.rb

@@ -2,5 +2,5 @@
 # This way other parts of Foreman can just call ForemanAnsible::VERSION
 # and detect what version the plugin is running.
 module ForemanAnsible
-  VERSION = '1.5.2'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/test/factories/ansible_proxy.rb

@@ -1,4 +1,4 @@
-FactoryGirl.modify do
+FactoryBot.modify do
   factory :smart_proxy do
     trait :with_ansible do
       features { [::Feature.find_or_create_by(:name => 'Ansible')] }

data/test/factories/ansible_roles.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :ansible_role do
     sequence(:name) { |n| "ansible_role_#{n}" }
   end

data/test/functional/ansible_roles_controller_test.rb

@@ -2,14 +2,16 @@ require 'test_plugin_helper'
 # functional tests for AnsibleRolesController
 class AnsibleRolesControllerTest < ActionController::TestCase
   setup do
-    @role = FactoryGirl.create(:ansible_role)
+    @role = FactoryBot.create(:ansible_role)
   end
 
   basic_index_test
 
   test 'should destroy role' do
     assert_difference('AnsibleRole.count', -1) do
-      delete :destroy, { :id => @role.id }, set_session_user
+      delete :destroy,
+             :params => { :id => @role.id },
+             :session => set_session_user
     end
     assert_redirected_to ansible_roles_url
   end

data/test/functional/api/v2/ansible_roles_controller_test.rb

@@ -5,18 +5,20 @@ module Api
     # Tests for the controller to CRUD Ansible Roles
     class AnsibleRolesControllerTest < ActionController::TestCase
       setup do
-        @role = FactoryGirl.create(:ansible_role)
+        @role = FactoryBot.create(:ansible_role)
       end
 
       test 'should get index' do
-        get :index, {}, set_session_user
+        get :index, :session => set_session_user
         response = JSON.parse(@response.body)
         refute_empty response['results']
         assert_response :success
       end
 
       test 'should destroy' do
-        delete :destroy, { :id => @role.id }, set_session_user
+        delete :destroy,
+               :params => { :id => @role.id },
+               :session => set_session_user
         assert_response :ok
         refute AnsibleRole.exists?(@role.id)
       end

data/test/functional/api/v2/hostgroups_controller_test.rb

@@ -5,46 +5,38 @@ module Api
   module V2
     # Tests for the extra methods to play roles on Hostgroup
     class HostgroupsControllerTest < ActionController::TestCase
-      include ::Dynflow::Testing
-
       setup do
-        @host1 = FactoryGirl.create(:host, :with_hostgroup)
-        @host2 = FactoryGirl.create(:host, :with_hostgroup)
-      end
-
-      after do
-        ::ForemanTasks::Task::DynflowTask.all.each do |task|
-          task.destroy
-          task.delete
-        end
+        @host1 = FactoryBot.create(:host, :with_hostgroup)
+        @host2 = FactoryBot.create(:host, :with_hostgroup)
       end
 
       test 'should return an not_found due to non-existent host_id' do
-        post :play_roles, :id => 'non-existent'
+        post :play_roles, :params => { :id => 'non-existent' }
         response = JSON.parse(@response.body)
         refute_empty response
         assert_response :not_found
       end
 
       test 'should trigger task on host group' do
-        post :play_roles, :id => @host1.hostgroup.id
+        load File.join(ForemanAnsible::Engine.root,
+                       '/db/seeds.d/75_job_templates.rb')
+        ::JobInvocationComposer.any_instance.expects(:trigger!).returns(true)
+        target = @host1
+        post :play_roles, :params => { :id => target.hostgroup.id }
         response = JSON.parse(@response.body)
-
-        assert response['message']['foreman_tasks'].key?('id'),
-               'task id not contained in response'
-        assert_equal response['message']['hostgroup']['name'],
-                     @host1.hostgroup.name,
-                     'host group name not contained in response'
-        assert_response :success
+        assert_job_invocation_is_ok(response, target.id)
       end
 
       test 'should trigger two host group tasks' do
-        post :multiple_play_roles,
-             :hostgroup_names => [@host1.hostgroup.name, @host2.hostgroup.name]
+        load File.join(ForemanAnsible::Engine.root,
+                       '/db/seeds.d/75_job_templates.rb')
+        ::JobInvocationComposer.any_instance.expects(:trigger!).returns(true)
+        target = [@host1, @host2]
+        post :multiple_play_roles, :params => {
+          :hostgroup_ids => target.map(&:hostgroup_id)
+        }
         response = JSON.parse(@response.body)
-
-        assert response['message'].length == 2, 'should trigger two tasks'
-        assert_response :success
+        assert_job_invocation_is_ok(response, target.map(&:id))
       end
     end
   end