Expose MiqEvent/EmsEvent group/levels in event stream OPTIONS #1099

jrafanie · 2021-11-10T23:21:30Z

Part of #1090

Depends on:

Add timeline_options to expose event_streams OPTIONS to the API manageiq#21552
Fix group level and names for miq event manageiq#21569
Write some tests once core PR is done.

OPTIONS http://localhost:3000/api/event_streams

RESPONSE:

{
    "attributes": [
        "availability_zone_id",
        "chain_id",
        "container_group_id",
        "container_group_name",
        "container_id",
        "container_name",
        "container_namespace",
        "container_node_id",
        "container_node_name",
        "container_replicator_id",
        "container_replicator_name",
        "created_on",
        "dest_ems_cluster_id",
        "dest_ems_cluster_name",
        "dest_ems_cluster_uid",
        "dest_host_id",
        "dest_host_name",
        "dest_vm_ems_ref",
        "dest_vm_location",
        "dest_vm_name",
        "dest_vm_or_template_id",
        "ems_cluster_id",
        "ems_cluster_name",
        "ems_cluster_uid",
        "ems_id",
        "ems_ref",
        "event_type",
        "full_data",
        "generating_ems_id",
        "group_id",
        "host_id",
        "host_name",
        "id",
        "is_task",
        "message",
        "physical_chassis_id",
        "physical_server_id",
        "physical_switch_id",
        "source",
        "target_id",
        "target_type",
        "tenant_id",
        "timestamp",
        "type",
        "user_id",
        "username",
        "vm_ems_ref",
        "vm_location",
        "vm_name",
        "vm_or_template_id"
    ],
    "virtual_attributes": [
        "group",
        "group_level",
        "group_name",
        "href_slug",
        "region_description",
        "region_number"
    ],
    "relationships": [
        "availability_zone",
        "container_group",
        "container_node",
        "container_replicator",
        "dest_host",
        "dest_miq_template",
        "dest_vm",
        "dest_vm_or_template",
        "ext_management_system",
        "generating_ems",
        "host",
        "miq_template",
        "physical_chassis",
        "physical_server",
        "physical_switch",
        "service",
        "target",
        "vm",
        "vm_or_template"
    ],
    "subcollections": [],
    "data": {
        "timeline_events": {
            "EmsEvent": {
                "description": "Management Events",
                "group_names": {
                    "other": "Other",
                    "addition": "Creation/Addition",
                    "configuration": "Configuration/Reconfiguration",
                    "console": "Console Activity",
                    "deletion": "Deletion/Removal",
                    "general": "General Activity",
                    "import_export": "Import/Export",
                    "migration": "Migration/Vmotion",
                    "network": "Network",
                    "power": "Power Activity",
                    "snapshot": "Snapshot Activity",
                    "status": "Status",
                    "storage": "Storage",
                    "update": "Update",
                    "firmware": "Firmware",
                    "devices": "Devices",
                    "login": "Login",
                    "security": "Security"
                },
                "group_levels": {
                    "critical": "Critical",
                    "detail": "Detail",
                    "warning": "Warning"
                }
            },
            "MiqEvent": {
                "description": "Policy Events",
                "group_names": {
                    "other": "Other",
                    "ems_operations": "Provider Operation",
                    "host_operations": "Host Operation",
                    "compliance": "Compliance",
                    "tags": "Company Tag",
                    "vm_operational": "VM Operation",
                    "vm_configurational": "VM Configuration",
                    "vm_process": "VM Lifecycle",
                    "service_process": "Service Lifecycle",
                    "orchestration_process": "Orchestration Lifecycle",
                    "storage_operational": "Datastore Operation",
                    "container_operations": "Container Operation",
                    "physical_server_operations": "Physical Server Operation",
                    "evm_operations": "Appliance Operation",
                    "middleware_operations": "Middleware Operation",
                    "auth_validation": "Authentication Validation (Provider)",
                    "authentication": "Authentication Validation"
                },
                "group_levels": {
                    "success": "Success",
                    "failure": "Failure",
                    "detail": "Detail"
                }
            }
        }
    }
}

Fryguy · 2021-11-11T15:58:37Z

@jrafanie I'm wondering if we should nest these options one more level under data. That is, if we need to add something else to OPTIONS in the future, the root of the data payload is taken. Maybe:

      "data": {
-         "EmsEvent": {
+         "event_groups": {
+             "EmsEvent": {

(not sure on the name event_groups...we can debate that)

Not sure if the "data" nesting belongs here or in the backend PR. I feel like the backend method should return the hash startng at the "EmsEvent" level, but the API should be the one that constructs the data/event_groups levels

jrafanie · 2021-11-11T22:44:02Z

Not sure if the "data" nesting belongs here or in the backend PR. I feel like the backend method should return the hash startng at the "EmsEvent" level, but the API should be the one that constructs the data/event_groups levels

I agree. I'll nest this in this PR. I like timeline_events as it summarizes the data below it...

    "data": {
        "timeline_events": {
            "EmsEvent": {
                "description": "Management Events",
                "group_names": {
                    "addition": "Creation/Addition",
                    ...
                    "security": "Security"
                },
                "group_levels": {
                    "critical": "Critical",
                    "detail": "Detail",
                    "warning": "Warning"
                }
            },
            "MiqEvent": {
                "description": "Policy Events",
                "group_names": {
                    "ems_operations": "Provider Operation",
                    ...
                    "authentication": "Authentication Validation"
                },
                "group_levels": {
                    "success": "Success",
                    "failure": "Failure"
                }
            }
        }
    }

Fryguy · 2021-11-22T15:11:24Z

Core PR is merged.

app/controllers/api/event_streams_controller.rb

spec/requests/event_streams_spec.rb

The 'data' key in the response body can be simple or complex. You can now opt-out of generic data validation in the complex case by not providing the data. This lets you manually validate the data in the specs that know what part of the structure is important, while retaining the rest of the options expectations.

jrafanie · 2021-11-22T21:21:18Z

spec/requests/event_streams_spec.rb

+      expect(body["data"].keys).to eq(["timeline_events"])
+      expect(body["data"]["timeline_events"].keys.sort).to eq(%w[EmsEvent MiqEvent])
+      expect(body["data"]["timeline_events"]["EmsEvent"].keys.sort).to eq(%w[description group_levels group_names])
+      expect(body["data"]["timeline_events"]["EmsEvent"]["group_names"].keys.sort).to include("addition", "other")


There's no need to test for all of them, just one from the event_handling and the default one "other"

jrafanie · 2021-11-22T21:21:26Z

spec/requests/event_streams_spec.rb

+      expect(body["data"]["timeline_events"]["EmsEvent"]["group_levels"].keys.sort).to eq(%w[critical detail warning])
+
+      expect(body["data"]["timeline_events"]["MiqEvent"].keys.sort).to eq(%w[description group_levels group_names])
+      expect(body["data"]["timeline_events"]["MiqEvent"]["group_names"].keys.sort).to include("auth_validation", "other")


same as above

jrafanie · 2021-11-22T21:22:04Z

spec/requests/querying_spec.rb

@@ -966,7 +966,7 @@ def create_vms_by_name(names)
  describe 'OPTIONS /api/vms' do
    it 'returns the options information' do
      options(api_vms_url)
-      expect_options_results(:vms)
+      expect_options_results(:vms, {})


Previously, this method defaulted to {} so we need to change the one caller that wasn't providing a hash and expected it to be defaulted.

The timeline_events key in the response body 'data' field contains information on the type of events, their descriptions, group levels, group names, etc. Currently, we only support EmsEvent and MiqEvent from event_streams. Part of ManageIQ#1090

miq-bot · 2021-11-22T21:26:38Z

Checked commits jrafanie/manageiq-api@73bcdc2~...83c6c48 with ruby 2.6.3, rubocop 1.13.0, haml-lint 0.35.0, and yamllint
4 files checked, 0 offenses detected
Everything looks fine. 👍

jrafanie added the enhancement label Nov 10, 2021

jrafanie requested a review from bdunne as a code owner November 10, 2021 23:21

jrafanie assigned Fryguy Nov 10, 2021

miq-bot added the wip label Nov 10, 2021

jrafanie force-pushed the event_stream_options_for_api branch from f20fdc5 to 415c536 Compare November 10, 2021 23:24

jrafanie force-pushed the event_stream_options_for_api branch from 415c536 to 1cb57f3 Compare November 11, 2021 22:26

jrafanie force-pushed the event_stream_options_for_api branch 2 times, most recently from 689b0b5 to cc071d5 Compare November 17, 2021 14:45

jrafanie changed the title ~~[WIP] Expose MiqEvent/EmsEvent group/levels in event stream OPTIONS~~ Expose MiqEvent/EmsEvent group/levels in event stream OPTIONS Nov 17, 2021

jrafanie removed the wip label Nov 17, 2021

This was referenced Nov 17, 2021

Api for timeline charts. #1090

Open

Fix group level and names for miq event ManageIQ/manageiq#21569

Merged

Fryguy reviewed Nov 22, 2021

View reviewed changes

app/controllers/api/event_streams_controller.rb Show resolved Hide resolved

Fryguy reviewed Nov 22, 2021

View reviewed changes

spec/requests/event_streams_spec.rb Outdated Show resolved Hide resolved

Fryguy closed this Nov 22, 2021

Fryguy reopened this Nov 22, 2021

jrafanie force-pushed the event_stream_options_for_api branch 3 times, most recently from 761478c to 7a2c6de Compare November 22, 2021 21:19

jrafanie commented Nov 22, 2021

View reviewed changes

jrafanie force-pushed the event_stream_options_for_api branch from 7a2c6de to 83c6c48 Compare November 22, 2021 21:24

Fryguy approved these changes Nov 22, 2021

View reviewed changes

Fryguy merged commit 298f098 into ManageIQ:master Nov 22, 2021

jrafanie deleted the event_stream_options_for_api branch November 22, 2021 21:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose MiqEvent/EmsEvent group/levels in event stream OPTIONS #1099

Expose MiqEvent/EmsEvent group/levels in event stream OPTIONS #1099

jrafanie commented Nov 10, 2021 •

edited

Loading

Fryguy commented Nov 11, 2021 •

edited

Loading

jrafanie commented Nov 11, 2021

Fryguy commented Nov 22, 2021

jrafanie Nov 22, 2021

jrafanie Nov 22, 2021

jrafanie Nov 22, 2021

miq-bot commented Nov 22, 2021

Expose MiqEvent/EmsEvent group/levels in event stream OPTIONS #1099

Expose MiqEvent/EmsEvent group/levels in event stream OPTIONS #1099

Conversation

jrafanie commented Nov 10, 2021 • edited Loading

Fryguy commented Nov 11, 2021 • edited Loading

jrafanie commented Nov 11, 2021

Fryguy commented Nov 22, 2021

jrafanie Nov 22, 2021

Choose a reason for hiding this comment

jrafanie Nov 22, 2021

Choose a reason for hiding this comment

jrafanie Nov 22, 2021

Choose a reason for hiding this comment

miq-bot commented Nov 22, 2021

jrafanie commented Nov 10, 2021 •

edited

Loading

Fryguy commented Nov 11, 2021 •

edited

Loading