foreman_ansible_director 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bfa5c13b50ecdad46dceeb00e2691c16c586e8060094b5fe21eb1b19ae0eb60
-  data.tar.gz: 12749d98c77fe7008baf803bdfcc627b428f82f1192da8f904602611dbbac9f6
+  metadata.gz: 20d1091937c1d76ecd26e040e861d757cc36110d28a60e74630b3cfb168db165
+  data.tar.gz: f1da955ee815b2f80233760544a9732daa44ca6713996b048f2f8b20d374b745
 SHA512:
-  metadata.gz: 8650021501539c07fc71f21cacaea22dae5abe0066b209354b9ae68b8bc2d802c7ea5440c55df65b3d53f5b218b67bcbdb7d88c9699cd6c2219bd46749c69e17
-  data.tar.gz: 5537935a1c0f62ca5a3465b7fc998bb713e8dd22a2fdfa193b5db14a6e1176367112268124f2bb879d139bd8740706e44d620347c60e40e251c6386975130efb
+  metadata.gz: b0a246ed2de42e751eac1f80e11b1fc10350a68b83babfcfceeed2df2a72cb76455f8d3094e18cafea12d973ba76d974586a561151fae60378bc9005e8d0b942
+  data.tar.gz: c13404a68266d31c7535b2658a10f8a67ee3a047cb1a817d1d475df981f2ac2461e48b9a2703b9f605a8ad9a3805c2ab80ff4a102ed420d30f505c45fb33aa51

data/app/controllers/foreman_ansible_director/api/v2/ansible_content_controller.rb

@@ -5,7 +5,9 @@ module ForemanAnsibleDirector
     module V2
       class AnsibleContentController < AnsibleDirectorApiController
         before_action :find_organization, only: %i[create_units]
-        before_action :find_optional_organization, only: %i[index]
+        # rubocop:disable Rails/LexicallyScopedActionFilter
+        before_action :find_optional_organization, only: %i[index auto_complete_search]
+        # rubocop:enable Rails/LexicallyScopedActionFilter
 
         resource_description { resource_id 'AD Ansible Content' }
 
@@ -72,14 +74,10 @@ module ForemanAnsibleDirector
         api :GET, '/v2/ansible_director/ansible_content', N_('List Ansible content units')
         param :organization_id, :number, desc: N_('Organization identifier'), required: false
         param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(::ForemanAnsibleDirector::ContentUnit)
         # endregion
         def index
-          scope = resource_scope_for_index
-          @ansible_content_units = if @organization
-                                     scope.where(organization_id: @organization.id)
-                                   else
-                                     scope
-                                   end
+          @ansible_content_units = resource_scope_for_index
         end
 
         # region ApiDoc: GET /api/v2/ansible_director/ansible_content/:content_unit_id/versions/:content_unit_version_id
@@ -146,6 +144,10 @@ module ForemanAnsibleDirector
           resource_class
         end
 
+        def resource_scope
+          organization_scoped_resource_scope
+        end
+
         private
 
         def destroy_params
@@ -165,11 +167,6 @@ module ForemanAnsibleDirector
         def resource_class
           ::ForemanAnsibleDirector::ContentUnit
         end
-
-        def index_relation
-          units = AnsibleContentUnit
-          units.where organization_id: (params[:organization_id] || @organization.id)
-        end
       end
     end
   end

data/app/controllers/foreman_ansible_director/api/v2/ansible_director_api_controller.rb

@@ -5,12 +5,41 @@ module ForemanAnsibleDirector
     module V2
       class AnsibleDirectorApiController < ::Api::V2::BaseController
         include ::Api::Version2
-        include ::Foreman::Controller::AutoCompleteSearch
+        include ::ForemanAnsibleDirector::Concerns::FilteredAutoCompleteSearch
 
         include ::ForemanAnsibleDirector::RequestCtx::RequestContextHelper
 
         around_action :attach_request_ctx
 
+        rescue_from StandardError do |error|
+          @ctx.add_error(::ForemanAnsibleDirector::Issues::Errors::InternalError.new(
+            exception: error,
+            coincidence_id: @ctx.coincidence_id
+          ))
+          render_default_response
+          # Re-raise the exception to get a traceback in the log
+          raise error
+        end
+
+        rescue_from ActiveRecord::RecordNotFound do |error|
+          @ctx.add_error(::ForemanAnsibleDirector::Issues::Errors::RecordNotFound.new(exception: error))
+          render_default_response
+        end
+
+        rescue_from ActionController::ParameterMissing do |error|
+          @ctx.add_error(::ForemanAnsibleDirector::Issues::Errors::ParameterMissingError.new(exception: error))
+          render_default_response
+        end
+
+        rescue_from Psych::SyntaxError do |error|
+          @ctx.add_error(::ForemanAnsibleDirector::Issues::Errors::InvalidYamlError.new(exception: error))
+          render_default_response
+        end
+
+        rescue_from ::ForemanAnsibleDirector::Issues::CriticalErrorException do |_|
+          render_default_response
+        end
+
         def attach_request_ctx
           ::ForemanAnsibleDirector::RequestCtx::RequestContext.with_context(
             ::ForemanAnsibleDirector::RequestCtx::RequestContext.new(request.request_id)
@@ -20,8 +49,13 @@ module ForemanAnsibleDirector
           end
         end
 
+        def render_default_response
+          return if performed?
+          render template: 'foreman_ansible_director/api/v2/common/response', status: @ctx.response_status_code
+        end
+
         def find_organization
-          @organization = Organization.current || find_optional_organization
+          @organization = find_optional_organization || Organization.current
           if @organization.nil?
             render_error(
               'custom_error',
@@ -34,6 +68,29 @@ module ForemanAnsibleDirector
           @organization
         end
 
+        def organization_scoped_resource_scope(scope = resource_class.all)
+          return scope.none if User.current.blank?
+          organization = @organization || Organization.current
+          if organization.nil?
+            if User.current.admin?
+              scope
+            else
+              scope.where(organization_id: User.current.my_organizations)
+            end
+          else
+            scope.where(organization_id: organization.id)
+          end
+        end
+
+        def action_permission
+          case params[:action]
+          when 'auto_complete_search'
+            :view
+          else
+            super
+          end
+        end
+
         private
 
         def organization_id_keys
@@ -50,7 +107,7 @@ module ForemanAnsibleDirector
 
           @organization = get_organization(org_id)
           if @organization.nil?
-            render_error('custom_error', status: :unprocessable_entity,
+            render_error('custom_error', status: :not_found,
                           locals: { message: "Couldn't find organization #{org_id}" })
           end
           @organization

data/app/controllers/foreman_ansible_director/api/v2/ansible_variable_bindings_controller.rb

@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+
+module ForemanAnsibleDirector
+  module Api
+    module V2
+      class AnsibleVariableBindingsController < AnsibleDirectorApiController
+        before_action :find_resource, only: %w[show destroy update_full update_partial]
+        before_action :find_variable, only: [:index_for_variable]
+
+        before_action :find_organization, only: %i[create]
+        # rubocop:disable Rails/LexicallyScopedActionFilter
+        before_action :find_optional_organization, only: %i[index_for_variable auto_complete_search]
+        # rubocop:enable Rails/LexicallyScopedActionFilter
+        resource_description { resource_id 'AD Ansible Variable Bindings' }
+
+        def index_for_variable
+        end
+
+        # region ApiDoc: GET /api/v2/ansible_director/ansible_variables/bindings/:id
+        api :GET, '/v2/ansible_director/ansible_variables/bindings/:id', N_('Show details of a variable binding')
+        param :id, :number, desc: N_('Variable binding identifier'), required: true
+        # endregion
+        def show
+        end
+
+        # region ApiDoc: POST /api/v2/ansible_director/ansible_variables/bindings
+        api :POST, '/api/v2/ansible_director/ansible_variables/bindings', N_('Create a variable binding')
+        param :organization_id, :number, desc: N_('Organization identifier'), required: true
+        param :ansible_variable_binding, Hash, desc: N_('Variable binding definition'), required: true do
+          param :variable_name,
+            String,
+            desc: N_('Name of the Ansible variable to bind.'),
+            example: 'ntp_server',
+            required: true
+          param :data_type,
+            %w[string integer boolean float array dictionary],
+            desc: N_('Data type of the variable.'),
+            example: 'string',
+            required: true
+          param :raw_value,
+            String,
+            desc: N_('Value of the variable (must be valid YAML for any type).'),
+            example: "---\ntime.example.com",
+            required: true
+          param :assignable_type,
+            %w[ForemanAnsibleDirector::AnsibleCollectionRole ForemanAnsibleDirector::AnsibleRole],
+            desc: N_('Type of the assignable ForemanAnsibleDirector::(AnsibleCollectionRole | AnsibleRole).'),
+            required: true
+          param :assignable_namespace,
+            String,
+            desc: N_('Namespace of the assignable.'),
+            example: 'my_namespace',
+            required: true
+          param :assignable_name,
+            String,
+            desc: N_('Name of the assignable.'),
+            example: 'my_collection',
+            required: true
+          param :assignable_role_name,
+            String,
+            desc: N_('Name of the role within the collection (required for AnsibleCollectionRole).'),
+            example: 'my_role',
+            required: false
+          param :target,
+            String,
+            desc: N_('Target type for the binding (host | hostgroup).'),
+            example: 'host',
+            required: true
+          param :target_id,
+            :number,
+            desc: N_('ID of the target entity.'),
+            example: 1,
+            required: true
+        end
+        # TRANSLATORS: ApiDoc, do not translate!
+        example <<~EXAMPLE
+          {
+            "organization_id": 1,
+            "ansible_variable_binding": {
+              "variable_name": "ntp_server",
+              "data_type": "string",
+              "raw_value": "---\\ntime.example.com",
+              "assignable_type": "ForemanAnsibleDirector::AnsibleCollectionRole",
+              "assignable_namespace": "my_namespace",
+              "assignable_name": "my_collection",
+              "assignable_role_name": "my_role",
+              "target": "host",
+              "target_id": 1
+            }
+          }
+        EXAMPLE
+        # endregion
+        def create
+          binding_params = variable_binding_create_params
+          validate_yaml! variable_binding_create_params[:raw_value]
+
+          target = ::ForemanAnsibleDirector::AssignmentService.find_target(
+            target_type: binding_params[:target],
+            target_id: binding_params[:target_id]
+          )
+
+          @created_binding = ::ForemanAnsibleDirector::VariableBindingService.create_variable_binding(
+            variable_name: binding_params[:variable_name],
+            data_type: binding_params[:data_type],
+            raw_value: binding_params[:raw_value],
+            target: target,
+            assignable_type: binding_params[:assignable_type],
+            assignable_namespace: binding_params[:assignable_namespace],
+            assignable_name: binding_params[:assignable_name],
+            assignable_role_name: binding_params[:assignable_role_name],
+            organization_id: @organization.id
+          )
+        end
+
+        # region ApiDoc: PUT /api/v2/ansible_director/ansible_variables/bindings/:id
+        api :PUT, '/v2/ansible_director/ansible_variables/bindings/:id', N_('Update a variable binding')
+        description <<~DESC
+          Replace an entire variable binding. All binding attributes have to be provided. To update only a subset of+
+          arguments, consider using PATCH.
+        DESC
+        param :ansible_variable_binding, Hash, desc: N_('Variable binding updates'), required: true do
+          param :variable_name,
+            String,
+            desc: N_('Name of the Ansible variable to bind.'),
+            example: 'ntp_server',
+            required: true
+          param :data_type,
+            %w[string integer boolean float array dictionary],
+            desc: N_('Data type of the variable.'),
+            example: 'string',
+            required: true
+          param :raw_value,
+            String,
+            desc: N_('Value of the variable (must be valid YAML for any type).'),
+            example: '---\\ntime.example.com',
+            required: true
+          param :assignable_type,
+            %w[ForemanAnsibleDirector::AnsibleCollectionRole ForemanAnsibleDirector::AnsibleRole],
+            desc: N_('Type of the assignable ForemanAnsibleDirector::(AnsibleCollectionRole | AnsibleRole).'),
+            required: true
+          param :assignable_namespace,
+            String,
+            desc: N_('Namespace of the assignable.'),
+            example: 'my_namespace',
+            required: true
+          param :assignable_name,
+            String,
+            desc: N_('Name of the assignable.'),
+            example: 'my_collection',
+            required: true
+          param :assignable_role_name,
+            String,
+            desc: N_('Name of the role within the collection (required for AnsibleCollectionRole).'),
+            example: 'my_role',
+            required: false
+          param :target,
+            String,
+            desc: N_('Target type for the binding (host | hostgroup).'),
+            example: 'host',
+            required: true
+          param :target_id,
+            :number,
+            desc: N_('ID of the target entity.'),
+            example: 1,
+            required: true
+        end
+        # TRANSLATORS: ApiDoc, do not translate!
+        example <<~EXAMPLE
+          {
+            "ansible_variable_binding": {
+              "data_type": "string",
+              "raw_value": "---\\ntime.example.com",
+              "variable_name": "ntp_server",
+              "assignable_type": "ForemanAnsibleDirector::AnsibleCollectionRole",
+              "assignable_namespace": "my_namespace",
+              "assignable_name": "my_collection",
+              "assignable_role_name": "my_role",
+              "target": "host",
+              "target_id": 1
+            }
+          }
+        EXAMPLE
+        # endregion
+        def update_full
+          variable_binding_params = variable_binding_full_params
+          validate_yaml! variable_binding_full_params[:raw_value]
+
+          ::ForemanAnsibleDirector::VariableBindingService.edit_variable_binding(
+            variable_binding: @ansible_variable_binding,
+            **variable_binding_params
+          )
+        end
+
+        # region ApiDoc: PATCH /api/v2/ansible_director/ansible_variables/bindings/:id
+        api :PATCH, '/api/v2/ansible_director/ansible_variables/bindings/:id', N_('Partially update a variable binding')
+        description <<~DESC
+          Partially update an Ansible variable binding. To update every binding attribute, consider using PUT, which
+          informs you of missing attributes.
+        DESC
+        param :ansible_variable_binding, Hash, desc: N_('Variable binding updates'), required: true do
+          param :variable_name,
+            String,
+            desc: N_('Name of the Ansible variable to bind.'),
+            example: 'ntp_server',
+            required: false
+          param :data_type,
+            %w[string integer boolean float array dictionary],
+            desc: N_('Data type of the variable.'),
+            required: false
+          param :raw_value,
+            String,
+            desc: N_('Value of the variable (must be valid YAML for any type).'),
+            example: "---\ntime.example.com",
+            required: false
+          param :assignable_type,
+            %w[ForemanAnsibleDirector::AnsibleCollectionRole ForemanAnsibleDirector::AnsibleRole],
+            desc: N_('Type of the assignable ForemanAnsibleDirector::(AnsibleCollectionRole | AnsibleRole).'),
+            example: 'ForemanAnsibleDirector::AnsibleCollectionRole',
+            required: false
+          param :assignable_namespace,
+            String,
+            desc: N_('Namespace of the assignable.'),
+            example: 'my_namespace',
+            required: false
+          param :assignable_name,
+            String,
+            desc: N_('Name of the assignable.'),
+            example: 'my_collection',
+            required: false
+          param :assignable_role_name,
+            String,
+            desc: N_('Name of the role within the collection (required for AnsibleCollectionRole).'),
+            example: 'my_role',
+            required: false
+          param :target,
+            String,
+            desc: N_('Target type for the binding (host | hostgroup).'),
+            example: 'host',
+            required: false
+          param :target_id,
+            :number,
+            desc: N_('ID of the target entity.'),
+            example: 1,
+            required: false
+        end
+        # TRANSLATORS: ApiDoc, do not translate!
+        example <<~EXAMPLE
+          {
+            "ansible_variable_binding": {
+              "raw_value": "---\\nnew-time.example.com"
+            }
+          }
+        EXAMPLE
+        # endregion
+        def update_partial
+          variable_binding_params = variable_binding_partial_params
+          validate_yaml! variable_binding_partial_params[:raw_value]
+
+          ::ForemanAnsibleDirector::VariableBindingService.edit_variable_binding(
+            variable_binding: @ansible_variable_binding,
+            **variable_binding_params
+          )
+        end
+
+        # region ApiDoc: DELETE /api/v2/ansible_director/ansible_variables/bindings/:id
+        api :DELETE, '/api/v2/ansible_director/ansible_variables/bindings/:id', N_('Delete a variable binding')
+        param :id, :number, desc: N_('Variable Binding identifier'), required: true
+        # endregion
+        def destroy
+          ::ForemanAnsibleDirector::VariableBindingService.destroy_variable_binding(@ansible_variable_binding)
+        end
+
+        def resource_class
+          ::ForemanAnsibleDirector::AnsibleVariableBinding
+        end
+
+        def resource_scope
+          organization_scoped_resource_scope
+        end
+
+        private
+
+        def find_variable
+          @ansible_variable = ::ForemanAnsibleDirector::AnsibleVariable.find_by!(id: params[:id])
+        end
+
+        def base_params
+          root_node = params.require(:ansible_variable_binding)
+          root_node.permit(
+            :data_type,
+            :raw_value,
+            :assignable_namespace,
+            :assignable_name,
+            :assignable_role_name,
+            :assignable_type,
+            :variable_name,
+            :target,
+            :target_id
+          )
+        end
+
+        def variable_binding_create_params
+          root_node = base_params
+          {
+            **variable_binding_full_params,
+            assignable_namespace: root_node.require(:assignable_namespace),
+            assignable_name: root_node.require(:assignable_name),
+            assignable_role_name: if params[:assignable_type] == 'ForemanAnsibleDirector::AnsibleCollectionRole'
+                                    root_node.require(:assignable_role_name)
+                                  else
+                                    root_node[:assignable_role_name]
+                                  end,
+            assignable_type: root_node.require(:assignable_type),
+            target: params[:target] || root_node.require(:target),
+            target_id: params[:target_id] || root_node.require(:target_id),
+          }
+        end
+
+        def variable_binding_full_params
+          root_node = base_params
+          {
+            data_type: root_node.require(:data_type),
+            raw_value: root_node.require(:raw_value),
+            variable_name: root_node.require(:variable_name),
+          }
+        end
+
+        def variable_binding_partial_params
+          root_node = base_params
+          {
+            data_type: root_node[:data_type],
+            raw_value: root_node[:raw_value],
+            variable_name: root_node[:variable_name],
+          }.compact
+        end
+
+        def validate_yaml!(string)
+          YAML.safe_load(string)
+        end
+
+        def controller_permission
+          'ansible_director_variable_overrides'
+        end
+      end
+    end
+  end
+end