foreman_ansible 11.2.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf610471f0b7c4357d630471f3f34f4d99f84d91060904ebc7baee85a0a26162
-  data.tar.gz: 1bf0b29be5c77f3942fd0ec3f1e00b22bdb9d4dc04deda4cb119763a25c1e042
+  metadata.gz: 9998a5428db095cc8f666b6676cf81f44bb1cb1f474c7d4dbcf566d659d6b855
+  data.tar.gz: e74626fb664cc93264f2723c3d888378f1ecb03e7efd85f0e5c9de2262a1578b
 SHA512:
-  metadata.gz: 16c9980e47104205c17326496bf12c2bbf3913db2c80155395b20f0b35f78e7d94c25ad763778431ad11b25ae894a1c5e4c92a14483efe769012fafcc1dbf084
-  data.tar.gz: cba6767ef45ff810159320b9351e89f9e984234364e9d2206aa72ec172d2dd5878111e2ff7febd058ae6ba9aa3642b31e9aad446997117dd799138699b0c5d1d
+  metadata.gz: 56a7e18a191e10a9b038a4a3d9dcd7938768fd92917ef34751c9a3c81bfe31ca26e018597e3ca0b2b16eb41ee28a0dbb0f7ca0b206f071d27cba19ca897c5b7e
+  data.tar.gz: 3449228e4b4f6c7b475b407f4b0a4521296ad21780a5eed62d709172ed1f49beaf3b85ea516db5a36cfa9190a9bfd0ed19fe350b0fff2d6626538489806e27ca

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

@@ -15,6 +15,7 @@ module ForemanAnsible
         # rubocop:disable Rails/LexicallyScopedActionFilter
         included do
           before_action :find_ansible_roles, :only => [:assign_ansible_roles]
+          before_action :find_hostgroup_ansible_role, :only => [:add_ansible_role, :remove_ansible_role]
 
           api :POST, '/hostgroups/:id/play_roles',
               N_('Runs all Ansible roles on a hostgroup')
@@ -64,6 +65,30 @@ module ForemanAnsible
             find_resource
             process_response @hostgroup.update(:ansible_roles => @ansible_roles)
           end
+
+          api :PUT, '/hostgroups/:id/ansible_roles',
+              N_('Directly add an Ansible role to a hostgroup')
+          param :id, :identifier, :required => true
+          param :ansible_role_id, :identifier,
+                N_('Ansible role to add to a hostgroup'),
+                :required => true
+
+          def add_ansible_role
+            process_response @hostgroup.ansible_roles << @ansible_role
+          rescue ActiveRecord::RecordInvalid => e
+            render_exception(e, :status => :unprocessable_entity)
+          end
+
+          api :DELETE, '/hostgroups/:id/ansible_roles/:ansible_role_id',
+              N_('Remove directly assigned Ansible role from a hostgroup')
+          param :id, :identifier, :required => true
+          param :ansible_role_id, :identifier,
+                N_('Ansible role to remove from a hostgroup'),
+                :required => true
+
+          def remove_ansible_role
+            process_response @hostgroup.ansible_roles.delete(@ansible_role)
+          end
         end
         # rubocop:enable Rails/LexicallyScopedActionFilter
 
@@ -87,6 +112,8 @@ module ForemanAnsible
           when 'play_roles', 'multiple_play_roles', 'ansible_roles',
                'assign_ansible_roles'
             :view
+          when 'add_ansible_role', 'remove_ansible_role'
+            :edit
           else
             super
           end

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

@@ -14,7 +14,9 @@ module ForemanAnsible
         # cannot extend the method properly.
         # rubocop:disable Rails/LexicallyScopedActionFilter
         included do
+          skip_before_action :find_resource, :only => [:add_ansible_role, :remove_ansible_role]
           before_action :find_ansible_roles, :only => [:assign_ansible_roles]
+          before_action :find_host_ansible_role, :only => [:add_ansible_role, :remove_ansible_role]
 
           def find_resource
             return true if params[:action] == 'multiple_play_roles'
@@ -64,6 +66,30 @@ module ForemanAnsible
           def assign_ansible_roles
             process_response @host.update(:ansible_roles => @ansible_roles)
           end
+
+          api :PUT, '/hosts/:id/ansible_roles',
+              N_('Directly add an Ansible role to a host')
+          param :id, :identifier, :required => true
+          param :ansible_role_id, :identifier,
+                N_('Ansible role to add to a host'),
+                :required => true
+
+          def add_ansible_role
+            process_response @host.ansible_roles << @ansible_role
+          rescue ActiveRecord::RecordInvalid => e
+            render_exception(e, :status => :unprocessable_entity)
+          end
+
+          api :DELETE, '/hosts/:id/ansible_roles/:ansible_role_id',
+              N_('Remove directly assigned Ansible role from a host')
+          param :id, :identifier, :required => true
+          param :ansible_role_id, :identifier,
+                N_('Ansible role to remove from a host'),
+                :required => true
+
+          def remove_ansible_role
+            process_response @host.ansible_roles.delete(@ansible_role)
+          end
         end
         # rubocop:enable Rails/LexicallyScopedActionFilter
 
@@ -74,6 +100,8 @@ module ForemanAnsible
           when 'play_roles', 'multiple_play_roles', 'ansible_roles',
                'assign_ansible_roles'
             :view
+          when 'add_ansible_role', 'remove_ansible_role'
+            :edit
           else
             super
           end

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

@@ -12,6 +12,26 @@ module ForemanAnsible
       rescue ActiveRecord::RecordNotFound => e
         not_found(e.message)
       end
+
+      def find_ansible_role
+        @ansible_role = AnsibleRole.authorized(:view_ansible_roles).find(params[:ansible_role_id])
+      rescue ActiveRecord::RecordNotFound => e
+        not_found(e.message)
+      end
+
+      def find_host_ansible_role
+        find_ansible_role
+        @host = Host.authorized(:view_hosts).find(params[:id])
+      rescue ActiveRecord::RecordNotFound => e
+        not_found(e.message)
+      end
+
+      def find_hostgroup_ansible_role
+        find_ansible_role
+        @hostgroup = Hostgroup.authorized(:view_hostgroups).find(params[:id])
+      rescue ActiveRecord::RecordNotFound => e
+        not_found(e.message)
+      end
     end
   end
 end

data/config/routes.rb

@@ -13,6 +13,8 @@ Rails.application.routes.draw do
             post :play_roles
             get :ansible_roles
             post :assign_ansible_roles
+            put :ansible_roles, :to => 'hosts#add_ansible_role'
+            delete 'ansible_roles/:ansible_role_id', :to => 'hosts#remove_ansible_role', :constraints => { id: %r{[^\/]+} }
           end
           collection do
             post :multiple_play_roles
@@ -23,6 +25,8 @@ Rails.application.routes.draw do
             post :play_roles
             get :ansible_roles
             post :assign_ansible_roles
+            put :ansible_roles, :to => 'hostgroups#add_ansible_role'
+            delete 'ansible_roles/:ansible_role_id', :to => 'hostgroups#remove_ansible_role', :constraints => { id: %r{[^\/]+} }
           end
           collection do
             post :multiple_play_roles

data/lib/foreman_ansible/engine.rb

@@ -19,14 +19,6 @@ module ForemanAnsible
     config.autoload_paths += Dir["#{config.root}/app/views"]
     config.autoload_paths += Dir["#{config.root}/app/lib"]
 
-    initializer 'foreman_ansible.register_gettext',
-                :after => :load_config_initializers do
-      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
-      locale_domain = 'foreman_ansible'
-
-      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
-    end
-
     initializer 'foreman_ansible.register_plugin', :before => :finisher_hook do
       require 'foreman_ansible/register'
     end

data/lib/foreman_ansible/register.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 Foreman::Plugin.register :foreman_ansible do
-  requires_foreman '>= 3.6'
+  requires_foreman '>= 3.7'
+  register_gettext
 
   settings do
     category :ansible, N_('Ansible') do
@@ -151,10 +152,10 @@ Foreman::Plugin.register :foreman_ansible do
                  :'api/v2/ansible_inventories' => [:hostgroups] },
                :resource_type => 'Hostgroup'
     permission :edit_hosts,
-               { :'api/v2/hosts' => [:assign_ansible_roles] },
+               { :'api/v2/hosts' => [:assign_ansible_roles, :add_ansible_role, :remove_ansible_role] },
                :resource_type => 'Host'
     permission :edit_hostgroups,
-               { :'api/v2/hostgroups' => [:assign_ansible_roles] },
+               { :'api/v2/hostgroups' => [:assign_ansible_roles, :add_ansible_role, :remove_ansible_role] },
                :resource_type => 'Hostgroup'
     permission :generate_ansible_inventory,
                { :'api/v2/ansible_inventories' => [:schedule] }

data/lib/foreman_ansible/version.rb

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

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

@@ -63,6 +63,32 @@ module Api
         assert_response :success
         assert_equal assigns('hostgroup').ansible_roles, [@ansible_role2, @ansible_role1]
       end
+
+      test 'should append a role to a hostgroup with a correct ordering' do
+        hostgroup = FactoryBot.create(:hostgroup,
+                                      :ansible_role_ids => [@ansible_role1.id])
+        post :add_ansible_role,
+             :params => {
+               :id => hostgroup.id,
+               :ansible_role_id => [@ansible_role2.id]
+             },
+             :session => set_session_user
+        assert_response 201
+        assert_equal assigns('hostgroup').ansible_roles, [@ansible_role1, @ansible_role2]
+      end
+
+      test 'should remove only specified roles from a hostgroup' do
+        hostgroup = FactoryBot.create(:hostgroup,
+                                      :ansible_role_ids => [@ansible_role2.id, @ansible_role1.id])
+        delete :remove_ansible_role,
+               :params => {
+                 :id => hostgroup.id,
+                 :ansible_role_id => [@ansible_role2.id]
+               },
+               :session => set_session_user
+        assert_response :success
+        assert_equal assigns('hostgroup').ansible_roles, [@ansible_role1]
+      end
     end
   end
 end

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

@@ -9,6 +9,7 @@ module Api
       setup do
         @ansible_role1 = FactoryBot.create(:ansible_role)
         @ansible_role2 = FactoryBot.create(:ansible_role)
+        @ansible_role3 = FactoryBot.create(:ansible_role)
         @host1 = FactoryBot.create(:host)
         @host2 = FactoryBot.create(:host)
         @host3 = FactoryBot.create(:host)
@@ -87,6 +88,34 @@ module Api
         assert_response :success
         assert_equal assigns('host').ansible_roles, [@ansible_role2, @ansible_role1]
       end
+
+      test 'should append a role to a host with a correct ordering' do
+        host = FactoryBot.create(:host,
+                                 :managed => false,
+                                 :ansible_role_ids => [@ansible_role3.id])
+        post :add_ansible_role,
+             :params => {
+               :id => host.id,
+               :ansible_role_id => @ansible_role2.id
+             },
+             :session => set_session_user
+        assert_response 201
+        assert_equal assigns('host').ansible_roles, [@ansible_role3, @ansible_role2]
+      end
+
+      test 'should remove only specified roles from a host' do
+        host = FactoryBot.create(:host,
+                                 :managed => false,
+                                 :ansible_role_ids => [@ansible_role3.id, @ansible_role2.id, @ansible_role1.id])
+        delete :remove_ansible_role,
+               :params => {
+                 :id => host.id,
+                 :ansible_role_id => [@ansible_role2.id]
+               },
+               :session => set_session_user
+        assert_response :success
+        assert_equal assigns('host').ansible_roles, [@ansible_role3, @ansible_role1]
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 11.2.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_list
@@ -56,16 +56,22 @@ dependencies:
   name: foreman-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 description: Ansible integration with Foreman
 email:
 - elobatocs@gmail.com
@@ -489,9 +495,9 @@ test_files:
 - test/functional/api/v2/ansible_playbooks_controller_test.rb
 - test/functional/api/v2/ansible_roles_controller_test.rb
 - test/functional/api/v2/ansible_variables_controller_test.rb
+- test/functional/api/v2/ansible_inventories_controller_test.rb
 - test/functional/api/v2/hostgroups_controller_test.rb
 - test/functional/api/v2/hosts_controller_test.rb
-- test/functional/api/v2/ansible_inventories_controller_test.rb
 - test/functional/hosts_controller_test.rb
 - test/functional/ui_ansible_roles_controller_test.rb
 - test/graphql/mutations/hosts/assign_ansible_roles_mutation_test.rb
@@ -500,9 +506,9 @@ test_files:
 - test/test_plugin_helper.rb
 - test/unit/ansible_role_test.rb
 - test/unit/ansible_variable_test.rb
-- test/unit/concerns/config_reports_extensions_test.rb
 - test/unit/concerns/host_managed_extensions_test.rb
 - test/unit/concerns/hostgroup_extensions_test.rb
+- test/unit/concerns/config_reports_extensions_test.rb
 - test/unit/helpers/ansible_reports_helper_test.rb
 - test/unit/host_ansible_role_test.rb
 - test/unit/hostgroup_ansible_role_test.rb