Merge pull request #233 from eclarizio/dialog_refresh_targets

Specify a target and resource when refreshing a dialog field
(cherry picked from commit d56b2a6)

https://bugzilla.redhat.com/show_bug.cgi?id=1520678

app/controllers/api/service_dialogs_controller.rb

@@ -16,7 +16,7 @@ def refresh_dialog_fields_resource(type, id = nil, data = nil)
     end
 
     def fetch_service_dialogs_content(resource)
-      target, resource_action = validate_dialog_content_params
+      target, resource_action = validate_dialog_content_params(params)
       resource.content(target, resource_action, true)
     end
 
@@ -49,8 +49,9 @@ def copy_resource(type, id, data)
 
     private
 
-    def validate_dialog_content_params
-      return unless CONTENT_PARAMS.detect { |param| params.include?(param) }
+    def validate_dialog_content_params(params, required = false)
+      return unless CONTENT_PARAMS.detect { |param| params.include?(param) } || required
+
       raise BadRequestError, "Must specify all of #{CONTENT_PARAMS.join(',')}" unless (CONTENT_PARAMS - params.keys).count.zero?
       target_type = params['target_type'].pluralize.to_sym
       target = resource_search(params['target_id'], target_type, collection_class(target_type))
@@ -62,26 +63,33 @@ def set_additional_attributes
       @additional_attributes = %w(content) if attribute_selection == "all"
     end
 
-    def refresh_dialog_fields_service_dialog(service_dialog, data)
+    def refresh_dialog_fields_service_dialog(dialog, data)
       data ||= {}
       dialog_fields = Hash(data["dialog_fields"])
       refresh_fields = data["fields"]
       return action_result(false, "Must specify fields to refresh") if refresh_fields.blank?
 
-      define_service_dialog_fields(service_dialog, dialog_fields)
+      service_dialog = define_service_dialog(dialog_fields, data)
+
+      if service_dialog.id != dialog.id
+        return action_result(
+          false,
+          "Dialog from resource action and requested refresh dialog must be the same dialog"
+        )
+      end
 
       refresh_dialog_fields_action(service_dialog, refresh_fields, service_dialog_ident(service_dialog))
     rescue => err
       action_result(false, err.to_s)
     end
 
-    def define_service_dialog_fields(service_dialog, dialog_fields)
-      ident = service_dialog_ident(service_dialog)
-      dialog_fields.each do |key, value|
-        dialog_field = service_dialog.field(key)
-        raise BadRequestError, "Dialog field #{key} specified does not exist in #{ident}" if dialog_field.nil?
-        dialog_field.value = value
-      end
+    def define_service_dialog(dialog_fields, data)
+      target, resource_action = validate_dialog_content_params(data, true)
+
+      workflow = ResourceActionWorkflow.new({}, User.current_user, resource_action, :target => target)
+
+      dialog_fields.each { |key, value| workflow.set_value(key, value) }
+      workflow.dialog
     end
 
     def service_dialog_ident(service_dialog)

spec/requests/service_dialogs_spec.rb

@@ -63,7 +63,7 @@
       expect_result_to_have_keys(%w(content))
     end
 
-    it "requires both target_id, target_type, and resource_action" do
+    it "requires all of target_id, target_type, and resource_action" do
       api_basic_authorize action_identifier(:service_dialogs, :read, :resource_actions, :get)
 
       get(api_service_dialog_url(nil, dialog1), :params => { :target_id => 'id' })
@@ -360,16 +360,74 @@ def init_dialog
       api_basic_authorize action_identifier(:service_dialogs, :refresh_dialog_fields)
       init_dialog
 
-      post(api_service_dialog_url(nil, dialog1), :params => gen_request(:refresh_dialog_fields, "fields" => %w(bad_field)))
-
+      post(api_service_dialog_url(nil, dialog1), :params => gen_request(
+        :refresh_dialog_fields,
+        "fields"             => %w(bad_field),
+        "resource_action_id" => ra1.id,
+        "target_id"          => template.id,
+        "target_type"        => "service_template"
+      ))
       expect_single_action_result(:success => false, :message => /unknown dialog field bad_field/i)
     end
 
+    it "requires all of resource_action_id, target_id, and target_type" do
+      api_basic_authorize action_identifier(:service_dialogs, :refresh_dialog_fields)
+      init_dialog
+
+      post(api_service_dialog_url(nil, dialog1), :params => gen_request(
+        :refresh_dialog_fields,
+        "fields" => %w(text1)
+      ))
+
+      expect_single_action_result(:success => false, :message => a_string_including('Must specify all of'))
+    end
+
+    it "requires that the resource action returns the same dialog as the dialog that we are requesting refresh of" do
+      api_basic_authorize action_identifier(:service_dialogs, :refresh_dialog_fields)
+      init_dialog
+
+      post(api_service_dialog_url(nil, dialog1), :params => gen_request(
+        :refresh_dialog_fields,
+        "fields"             => %w(text1),
+        "resource_action_id" => ra2.id,
+        "target_id"          => template.id,
+        "target_type"        => "service_template"
+      ))
+
+      expect_single_action_result(:success => false, :message => a_string_including('must be the same dialog'))
+    end
+
+    it "supports refresh when passing in resource_action_id, target_id, and target_type" do
+      api_basic_authorize action_identifier(:service_dialogs, :refresh_dialog_fields)
+      init_dialog
+
+      post(api_service_dialog_url(nil, dialog1), :params => gen_request(
+        :refresh_dialog_fields,
+        "fields"             => %w(text1),
+        "resource_action_id" => ra1.id,
+        "target_id"          => template.id,
+        "target_type"        => "service_template"
+      ))
+
+      expect(response.parsed_body).to include(
+        "success" => true,
+        "message" => a_string_matching(/refreshing dialog fields/i),
+        "href"    => api_service_dialog_url(nil, dialog1),
+        "result"  => hash_including("text1")
+      )
+    end
+
     it "supports refresh dialog fields of valid fields" do
       api_basic_authorize action_identifier(:service_dialogs, :refresh_dialog_fields)
       init_dialog
 
-      post(api_service_dialog_url(nil, dialog1), :params => gen_request(:refresh_dialog_fields, "fields" => %w(text1)))
+      post(api_service_dialog_url(nil, dialog1), :params => gen_request(
+        :refresh_dialog_fields,
+        "fields"             => %w(text1),
+        "resource_action_id" => ra1.id,
+        "target_id"          => template.id,
+        "target_type"        => "service_template"
+      ))
 
       expect(response.parsed_body).to include(
         "success" => true,