Add request logs subcollection API

app/controllers/api/requests_controller.rb

@@ -3,6 +3,7 @@ class RequestsController < BaseController
     include Api::Mixins::ResourceCancel
     include Api::Mixins::ResourceApproveDeny
     include Subcollections::RequestTasks
+    include Subcollections::RequestLogs
 
     def create_resource(type, _id, data)
       assert_id_not_specified(data, type)

app/controllers/api/subcollections/request_logs.rb

@@ -0,0 +1,10 @@
+module Api
+  module Subcollections
+    module RequestLogs
+      def request_logs_query_resource(object)
+        klass = collection_class(:request_logs)
+        object ? klass.where(:resource_id => object.id) : {}
+      end
+    end
+  end
+end

config/api.yml

@@ -842,10 +842,10 @@
         :identifier: cloud_volume_delete
       - :name: safe_delete
         :identifier: cloud_volume_safe_delete
-      - :name: assign_tags
-        :identifier: cloud_volume_tag
-      - :name: unassign_tags
-        :identifier: cloud_volume_tag
+      # - :name: assign_tags
+      #   :identifier: cloud_volume_tag
+      # - :name: unassign_tags
+      #   :identifier: cloud_volume_tag
     :resource_actions:
       :get:
       - :name: read
@@ -3249,6 +3249,20 @@
       :post:
       - :name: delete
         :identifier: saved_report_delete
+  :request_logs:
+    :description: Request Logs
+    :options:
+    - :subcollection
+    :verbs: *g
+    :klass: RequestLog
+    :subcollection_actions:
+      :get:
+      - :name: read
+        :identifier: miq_request_show
+    :subresource_actions:
+      :get:
+      - :name: read
+        :identifier: miq_request_show
   :request_tasks:
     :description: Request Tasks
     :options:
@@ -3291,6 +3305,7 @@
     :klass: MiqRequest
     :subcollections:
     - :request_tasks
+    - :request_logs
     :collection_actions:
       :get:
       - :name: read

spec/requests/request_logs_spec.rb

@@ -0,0 +1,66 @@
+RSpec.describe "Request Logs API" do
+  let(:template) { FactoryBot.create(:service_template) }
+
+  let(:request) do
+    FactoryBot.create(:service_template_provision_request,
+                       :requester   => @user,
+                       :source_id   => template.id,
+                       :source_type => template.class.name)
+  end
+
+  context "Logs subcollection" do
+
+    it "is forbidden without appropriate role" do
+      api_basic_authorize
+
+      get("#{api_request_url(nil, request)}/request_logs")
+
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it "returns request logs for a request" do
+      FactoryBot.create(:request_log, :resource => request, :severity => "INFO",  :message => "Request created")
+      FactoryBot.create(:request_log, :resource => request, :severity => "INFO",  :message => "Request processed")
+      api_basic_authorize subcollection_action_identifier(:requests, :request_logs, :read, :get)
+
+      get("#{api_request_url(nil, request)}/request_logs")
+
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body).to include(
+        "name"     => "request_logs",
+        "count"    => 2,
+        "subcount" => 2
+      )
+    end
+
+    it "does not return logs from another request" do
+      other_request = FactoryBot.create(:service_template_provision_request,
+                                         :requester   => @user,
+                                         :source_id   => template.id,
+                                         :source_type => template.class.name)
+      FactoryBot.create(:request_log, :resource => other_request, :message => "Other request log")
+      api_basic_authorize subcollection_action_identifier(:requests, :request_logs, :read, :get)
+
+      get("#{api_request_url(nil, request)}/request_logs")
+
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body["resources"]).to be_empty
+      expect(response.parsed_body["subcount"]).to eq(0)
+
+    end
+
+    it "returns the correct attributes" do
+      log = FactoryBot.create(:request_log, :resource => request, :severity => "WARN", :message => "Something happened")
+      api_basic_authorize subcollection_action_identifier(:requests, :request_logs, :read, :get)
+
+      get("#{api_request_url(nil, request)}/request_logs/#{log.id}")
+
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body).to include(
+        "id"       => log.id.to_s,
+        "severity" => "WARN",
+        "message"  => "Something happened"
+      )
+    end
+  end
+end