Add compliances subcollection #742

d-m-u · 2020-02-19T12:32:51Z

Per the convo in the main gitter room last night about api support of compliances February 18, 2020 4:51 PM I thought I may as well go ahead and open this.

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

d-m-u · 2020-02-19T12:34:18Z

@abellotti any chance I could get you to take a real quick look, please? thanks.

chessbyte · 2020-02-19T14:29:11Z

@Real-Omar-Afifi want to try running with this PR to see if it gets you the info you want?

Fryguy · 2020-02-19T14:30:45Z

I think @Real-Omar-Afifi also need compliance_details, but this can be added as a start and that as a follow up.

Fryguy · 2020-02-19T14:31:02Z

app/controllers/api/vms_controller.rb

@@ -1,6 +1,7 @@
 module Api
  class VmsController < BaseController
    include Subcollections::Disks
+    include Subcollections::Compliances


~~Minor, but can you make alphabetical?~~ nvm...nothing else is alphabetical here for some reason.

yeah i was gonna do a follow-up for it

Fryguy · 2020-02-19T14:32:20Z

config/api.yml

+      :get:
+      - :name: read
+        :identifier:
+        - vm_show


compliances are technically on a bunch of different resources. @abellotti Is there a way to do an "OR" of identifiers? Not sure what the right identifiers are, but I usually go with whatever the UI does... @himdel ?

we can specify multiple identifiers (essentially the OR) via :identifiers instead of :identifier

Note, I'm more thinking of if this as a subcollection under other things than just vms.

There's a bunch of *_check_compliance features that the UI uses for the "Policy / Check Compliance of the last known configuration" toolbar button.

So, I guess instance_check_compliance, image_check_compliance, vm_check_compliance and miq_template_check_compliance here?

thanks, I'll get to miq_template_check_compliance in a follow-up

abellotti · 2020-02-19T17:11:11Z

This is great @d-m-u, thanks for adding the tests that exercises the attributes=compliance_details. 👍

abellotti · 2020-02-19T17:14:10Z

@d-m-u could you take care of the rubocop warnings ? Thanks.

config/api.yml

abellotti · 2020-02-20T21:44:06Z

@d-m-u try the following:

Move the subcollection action under the vms directly:

  :compliances_subcollection_actions:
    :get:
    - :name: get
      :identifier:
      - vm_show
      - vm_check_compliance

You can see such examples in the :vms: collection.

With this no need to class identify since it's per collection, and the :identifier: handles lists.

Thanks,
Alberto

miq-bot · 2020-02-20T21:47:11Z

Checked commit d-m-u@a62b5f3 with ruby 2.5.7, rubocop 0.69.0, haml-lint 0.20.0, and yamllint
3 files checked, 0 offenses detected
Everything looks fine. 🍰

chessbyte · 2020-02-20T21:59:53Z

config/api.yml

+    :description: Compliances
+    :options:
+    - :subcollection
+    :verbs: *g


what does the value *g mean?

the verb set that can be used on the subcollection, in this case just the get

higher-level that is like a "pointer" in YAML, and it means to insert the object referenced with the name "&g". g is defined here:

manageiq-api/config/api.yml

Lines 14 to 15 in a62b5f3

:g: &g

- :get

…e_details Add compliances subcollection (cherry picked from commit 309e538) Fixes https://bugzilla.redhat.com/show_bug.cgi?id=1806660

simaishi · 2020-02-24T17:23:58Z

Ivanchuk backport details:

$ git log -1
commit b5cecaef6fcd7d755fb76607b52f6004edfd743a
Author: Gregg Tanzillo <gtanzill@redhat.com>
Date:   Mon Feb 24 09:22:00 2020 -0500

    Merge pull request #742 from d-m-u/adding_subcollection_for_compliance_details

    Add compliances subcollection

    (cherry picked from commit 309e5380171fd3bc8c0b3739c2d04adf6f7e46c0)

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

miq-bot added the wip label Feb 19, 2020

d-m-u force-pushed the adding_subcollection_for_compliance_details branch 2 times, most recently from b9ff9c2 to 16db5df Compare February 19, 2020 13:10

Fryguy reviewed Feb 19, 2020

View reviewed changes

chessbyte added the enhancement label Feb 19, 2020

d-m-u force-pushed the adding_subcollection_for_compliance_details branch 2 times, most recently from 594c88e to f82ed6b Compare February 19, 2020 17:09

d-m-u changed the title ~~[WIP] Add compliances subcollection~~ Add compliances subcollection Feb 19, 2020

abellotti approved these changes Feb 19, 2020

View reviewed changes

miq-bot removed the wip label Feb 19, 2020

d-m-u force-pushed the adding_subcollection_for_compliance_details branch 2 times, most recently from fe35a59 to 2f3e190 Compare February 20, 2020 20:02

Fryguy reviewed Feb 20, 2020

View reviewed changes

config/api.yml Outdated Show resolved Hide resolved

d-m-u force-pushed the adding_subcollection_for_compliance_details branch from 2f3e190 to 23f0ceb Compare February 20, 2020 20:54

Add compliances subcollection

a62b5f3

d-m-u force-pushed the adding_subcollection_for_compliance_details branch from 23f0ceb to a62b5f3 Compare February 20, 2020 21:46

chessbyte reviewed Feb 20, 2020

View reviewed changes

chessbyte added the ivanchuk/yes label Feb 23, 2020

gtanzillo self-assigned this Feb 24, 2020

gtanzillo added this to the Sprint 131 Ending Mar 2, 2020 milestone Feb 24, 2020

gtanzillo merged commit 309e538 into ManageIQ:master Feb 24, 2020

d-m-u deleted the adding_subcollection_for_compliance_details branch February 24, 2020 14:44

simaishi pushed a commit that referenced this pull request Feb 24, 2020

Merge pull request #742 from d-m-u/adding_subcollection_for_complianc…

b5cecae

…e_details Add compliances subcollection (cherry picked from commit 309e538) Fixes https://bugzilla.redhat.com/show_bug.cgi?id=1806660

simaishi added ivanchuk/backported and removed ivanchuk/yes labels Feb 24, 2020

abellotti mentioned this pull request Mar 19, 2020

[IVANCHUK] Changelog Ivanchuk-4 #779

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add compliances subcollection #742

Add compliances subcollection #742

d-m-u commented Feb 19, 2020 •

edited by simaishi

Loading

d-m-u commented Feb 19, 2020

chessbyte commented Feb 19, 2020

Fryguy commented Feb 19, 2020

Fryguy Feb 19, 2020 •

edited

Loading

d-m-u Feb 19, 2020

Fryguy Feb 19, 2020

abellotti Feb 19, 2020

Fryguy Feb 19, 2020 •

edited

Loading

himdel Feb 19, 2020

d-m-u Feb 20, 2020

abellotti commented Feb 19, 2020

abellotti commented Feb 19, 2020

abellotti commented Feb 20, 2020

miq-bot commented Feb 20, 2020

chessbyte Feb 20, 2020

d-m-u Feb 20, 2020

Fryguy Feb 21, 2020 •

edited

Loading

simaishi commented Feb 24, 2020

Add compliances subcollection #742

Add compliances subcollection #742

Conversation

d-m-u commented Feb 19, 2020 • edited by simaishi Loading

d-m-u commented Feb 19, 2020

chessbyte commented Feb 19, 2020

Fryguy commented Feb 19, 2020

Fryguy Feb 19, 2020 • edited Loading

Choose a reason for hiding this comment

d-m-u Feb 19, 2020

Choose a reason for hiding this comment

Fryguy Feb 19, 2020

Choose a reason for hiding this comment

abellotti Feb 19, 2020

Choose a reason for hiding this comment

Fryguy Feb 19, 2020 • edited Loading

Choose a reason for hiding this comment

himdel Feb 19, 2020

Choose a reason for hiding this comment

d-m-u Feb 20, 2020

Choose a reason for hiding this comment

abellotti commented Feb 19, 2020

abellotti commented Feb 19, 2020

abellotti commented Feb 20, 2020

miq-bot commented Feb 20, 2020

chessbyte Feb 20, 2020

Choose a reason for hiding this comment

d-m-u Feb 20, 2020

Choose a reason for hiding this comment

Fryguy Feb 21, 2020 • edited Loading

Choose a reason for hiding this comment

simaishi commented Feb 24, 2020

d-m-u commented Feb 19, 2020 •

edited by simaishi

Loading

Fryguy Feb 19, 2020 •

edited

Loading

Fryguy Feb 19, 2020 •

edited

Loading

Fryguy Feb 21, 2020 •

edited

Loading