V3: client can **see data** for an **app** usage event

There are differences between the model and the data presented; some
field names have changed.

| Model AppUsageEvent | Presenter      |
|---------------------|----------------|
| `parent_app_guid`   | `app.guid`     |
| `parent_app_name`   | `app.name`     |
| `app_guid`          | `process.guid` |

In other words, `app_guid` is NOT `app.guid`.

For now, service usage events have `null` for their data; this will be
addressed in a subsequent story.

[#172985876]

Co-authored-by: Reid Mitchell <rmitchell@pivotal.io>
Co-authored-by: Brian Cunnie <bcunnie@pivotal.io>

Author: reidmit

app/models/runtime/usage_event.rb

@@ -2,14 +2,68 @@ module VCAP::CloudController
   class UsageEvent < Sequel::Model(
     AppUsageEvent.select(
       Sequel.as('app', :type),
-      :guid,
+      :app_guid,
+      :app_name,
+      :buildpack_guid,
+      :buildpack_name,
       :created_at,
+      :guid,
+      :instance_count,
+      :memory_in_mb_per_instance,
+      :org_guid,
+      :parent_app_guid,
+      :parent_app_name,
+      :previous_instance_count,
+      :previous_memory_in_mb_per_instance,
+      :previous_state,
+      :process_type,
+      Sequel.as(nil, :service_broker_guid),
+      Sequel.as(nil, :service_broker_name),
+      Sequel.as(nil, :service_guid),
+      Sequel.as(nil, :service_instance_guid),
+      Sequel.as(nil, :service_instance_name),
+      Sequel.as(nil, :service_instance_type),
+      Sequel.as(nil, :service_label),
+      Sequel.as(nil, :service_plan_guid),
+      Sequel.as(nil, :service_plan_name),
+      :space_guid,
+      :space_name,
+      :state,
+      :task_guid,
+      :task_name,
       Sequel.as(:created_at, :updated_at)
     ).union(
       ServiceUsageEvent.select(
         Sequel.as('service', :type),
-        :guid,
+        Sequel.as(nil, :app_guid),
+        Sequel.as(nil, :app_name),
+        Sequel.as(nil, :buildpack_guid),
+        Sequel.as(nil, :buildpack_name),
         :created_at,
+        :guid,
+        Sequel.as(nil, :instance_count),
+        Sequel.as(nil, :memory_in_mb_per_instance),
+        :org_guid,
+        Sequel.as(nil, :parent_app_guid),
+        Sequel.as(nil, :parent_app_name),
+        Sequel.as(nil, :previous_instance_count),
+        Sequel.as(nil, :previous_memory_in_mb_per_instance),
+        Sequel.as(nil, :previous_state),
+        Sequel.as(nil, :process_type),
+        :service_broker_guid,
+        :service_broker_name,
+        :service_guid,
+        :service_instance_guid,
+        :service_instance_name,
+        :service_instance_type,
+        :service_label,
+        :service_plan_guid,
+        :service_plan_name,
+        :space_guid,
+        :space_name,
+        :state,
+        Sequel.as(nil, :task_guid),
+        Sequel.as(nil, :task_name),
         Sequel.as(:created_at, :updated_at)),
       all: true,
       from_self: false

app/presenters/v3/usage_event_presenter.rb

@@ -8,6 +8,7 @@ def to_hash
         created_at: usage_event.created_at,
         updated_at: usage_event.updated_at,
         type: usage_event.type,
+        data: build_data
       }
     end
 
@@ -16,5 +17,51 @@ def to_hash
     def usage_event
       @resource
     end
+
+    def build_data
+      if usage_event.type == 'app'
+        build_app_data
+      end
+    end
+
+    def build_app_data
+      {
+        state: {
+          current: usage_event.state,
+          previous: usage_event.previous_state,
+        },
+        app: {
+          guid: usage_event.parent_app_guid,
+          name: usage_event.parent_app_name,
+        },
+        process: {
+          guid: usage_event.app_guid,
+          type: usage_event.process_type,
+        },
+        space: {
+          guid: usage_event.space_guid,
+          name: usage_event.space_name,
+        },
+        organization: {
+          guid: usage_event.org_guid,
+        },
+        buildpack: {
+          guid: usage_event.buildpack_guid,
+          name: usage_event.buildpack_name,
+        },
+        task: {
+          guid: usage_event.task_guid,
+          name: usage_event.task_name,
+        },
+        memory_in_mb_per_instance: {
+          current: usage_event.memory_in_mb_per_instance,
+          previous: usage_event.previous_memory_in_mb_per_instance
+        },
+        instance_count: {
+          current: usage_event.instance_count,
+          previous: usage_event.previous_instance_count,
+        }
+      }
+    end
   end
 end

docs/v3/source/includes/api_resources/_usage_events.erb

@@ -3,14 +3,53 @@
   "guid": "a595fe2f-01ff-4965-a50c-290258ab8582",
   "created_at": "2020-05-28T16:41:23Z",
   "updated_at": "2020-05-28T16:41:26Z",
-  "type": "app"
+  "type": "app",
+  "data": {
+    "state": {
+      "current": "STARTED",
+      "previous": "STOPPED"
+    },
+    "app": {
+      "guid": "guid-f93250f7-7ef5-4b02-8d33-353919ce8358",
+      "name": "name-1982"
+    },
+    "process": {
+      "guid": "guid-e9d2d5a0-69a6-46ef-bac5-43f3ed177614",
+      "type": "type-1983"
+    },
+    "space": {
+      "guid": "guid-5e28f12f-9d80-473e-b826-537b148eb338",
+      "name": "name-1664"
+    },
+    "organization": {
+      "guid": "guid-036444f4-f2f5-4ea8-a353-e73330ca0f0a",
+      "name": "name-1665"
+    },
+    "buildpack": {
+      "guid": "guid-34916716-31d7-40c1-9afd-f312996c9654",
+      "name": "label-64"
+    },
+    "task": {
+      "guid": "guid-7cc11646-bf38-4f4e-b6e0-9581916a74d9",
+      "name": "name-2929"
+    },
+    "memory_in_mb_per_instance": {
+      "current": 512,
+      "previous": 256
+    },
+    "instance_count": {
+      "current": 10,
+      "previous": 5
+    }
+  }
 }
 <% end %>
 <% content_for :single_service_usage_event do %>
 {
   "guid": "c9976002-96f4-435a-888e-db1e1178df62",
   "created_at": "2020-05-28T12:34:56Z",
   "updated_at": "2020-05-28T12:34:56Z",
-  "type": "service"
+  "type": "service",
+  "data": null
 }
 <% end %>

…erimental_resources/usage_events/_get.md …ental_resources/usage_events/_get.md.erbdocs/v3/source/includes/experimental_resources/usage_events/_get.md renamed to docs/v3/source/includes/experimental_resources/usage_events/_get.md.erb docs/v3/source/includes/experimental_resources/usage_events/_get.md renamed to docs/v3/source/includes/experimental_resources/usage_events/_get.md.erb

@@ -18,12 +18,7 @@ Example Response
 HTTP/1.1 200 OK
 Content-Type: application/json
 
-{
-  "guid": "a595fe2f-01ff-4965-a50c-290258ab8582",
-  "created_at": "2020-05-28T16:41:23Z",
-  "updated_at": "2020-05-28T16:41:26Z",
-  "type": "app"
-}
+<%= yield_content :single_app_usage_event %>
 ```
 
 Retrieve a usage event.

spec/request/usage_events_spec.rb

@@ -9,7 +9,7 @@
     let(:org) { space.organization }
     let(:api_call) { lambda { |user_headers| get "/v3/usage_events/#{usage_event.guid}", nil, user_headers } }
 
-    context 'when the audit_event exists' do
+    context 'for an app usage event' do
       let(:usage_event) {
         VCAP::CloudController::AppUsageEvent.make
       }
@@ -20,6 +20,82 @@
           'created_at' => iso8601,
           'updated_at' => iso8601,
           'type' => 'app',
+          'data' => {
+            'state' => {
+              'current' => usage_event.state,
+              'previous' => nil
+            },
+            'app' => {
+              'guid' => usage_event.parent_app_guid,
+              'name' => usage_event.parent_app_name
+            },
+            'process' => {
+              'guid' => usage_event.app_guid,
+              'type' => usage_event.process_type,
+            },
+            'space' => {
+              'guid' => usage_event.space_guid,
+              'name' => usage_event.space_name
+            },
+            'organization' => {
+              'guid' => usage_event.org_guid
+            },
+            'buildpack' => {
+              'guid' => usage_event.buildpack_guid,
+              'name' => usage_event.buildpack_name
+            },
+            'task' => {
+              'guid' => nil,
+              'name' => nil
+            },
+            'memory_in_mb_per_instance' => {
+              'current' => usage_event.memory_in_mb_per_instance,
+              'previous' => nil
+            },
+            'instance_count' => {
+              'current' => usage_event.instance_count,
+              'previous' => nil
+            }
+          }
+
+        }
+      end
+
+      let(:expected_codes_and_responses) do
+        h = Hash.new(
+          code: 404,
+          response_object: []
+        )
+        h['admin'] = {
+          code: 200,
+          response_object: usage_event_json
+        }
+        h['admin_read_only'] = {
+          code: 200,
+          response_object: usage_event_json
+        }
+        h['global_auditor'] = {
+          code: 200,
+          response_object: usage_event_json
+        }
+        h.freeze
+      end
+
+      it_behaves_like 'permissions for single object endpoint', ALL_PERMISSIONS
+    end
+
+    context 'for a service usage event' do
+      let(:usage_event) {
+        VCAP::CloudController::ServiceUsageEvent.make
+      }
+
+      let(:usage_event_json) do
+        {
+          'guid' => usage_event.guid,
+          'created_at' => iso8601,
+          'updated_at' => iso8601,
+          'type' => 'service',
+          'data' => nil
         }
       end
 

spec/unit/presenters/v3/usage_event_presenter_spec.rb

@@ -16,8 +16,27 @@
         expect(result[:created_at]).to eq(usage_event.created_at)
         expect(result[:updated_at]).to eq(usage_event.updated_at)
         expect(result[:type]).to eq('app')
+        expect(result[:data][:state][:current]).to eq usage_event.state
+        expect(result[:data][:state][:previous]).to eq nil
+        expect(result[:data][:app][:guid]).to eq usage_event.parent_app_guid
+        expect(result[:data][:app][:name]).to eq usage_event.parent_app_name
+        expect(result[:data][:process][:guid]).to eq usage_event.app_guid
+        expect(result[:data][:process][:type]).to eq usage_event.process_type
+        expect(result[:data][:space][:guid]).to eq usage_event.space_guid
+        expect(result[:data][:space][:name]).to eq usage_event.space_name
+        expect(result[:data][:organization][:guid]).to eq usage_event.org_guid
+        expect(result[:data][:organization][:name]).to eq nil
+        expect(result[:data][:buildpack][:guid]).to eq usage_event.buildpack_guid
+        expect(result[:data][:buildpack][:name]).to eq usage_event.buildpack_name
+        expect(result[:data][:task][:guid]).to eq nil
+        expect(result[:data][:task][:name]).to eq nil
+        expect(result[:data][:memory_in_mb_per_instance][:current]).to eq usage_event.memory_in_mb_per_instance
+        expect(result[:data][:memory_in_mb_per_instance][:previous]).to eq nil
+        expect(result[:data][:instance_count][:current]).to eq usage_event.instance_count
+        expect(result[:data][:instance_count][:previous]).to eq nil
       end
     end
+
     context "when it's a service usage event" do
       let(:usage_event) { VCAP::CloudController::UsageEvent.find(guid: service_usage_event.guid) }
 
@@ -26,6 +45,7 @@
         expect(result[:created_at]).to eq(usage_event.created_at)
         expect(result[:updated_at]).to eq(usage_event.updated_at)
         expect(result[:type]).to eq('service')
+        expect(result[:data]).to be_nil
       end
     end
   end