Add alert actions api #13325

moolitayer · 2016-12-29T15:23:10Z

Adds retrieval and creation of alert_actions as a sub resource of alerts.

Route	Body
GET /api/alerts/:id/alert_actions/	[1]
GET /api/alerts/:id/alert_actions/:id	[2]
POST /api/alerts/:id/alert_actions/	[3]

[1] :
Response:

{
    "name": "alert_actions",
    "count": 3,
    "subcount": 3,
    "resources": [
        {
            "href": "http://localhost:3000/api/alerts/6/alert_actions/8"
        },
        {
            "href": "http://localhost:3000/api/alerts/6/alert_actions/9"
        },
        {
            "href": "http://localhost:3000/api/alerts/6/alert_actions/10"
        }
    ],
    "actions": [
        {
            "name": "create",
            "method": "post",
            "href": "http://localhost:3000/api/alerts/6/alert_actions"
        }
    ]
}

[2] :
Response:

{
    "href": "http://localhost:3000/api/alerts/6/alert_actions/9",
    "id": 9,
    "action_type": "assign",
    "user_id": 1,
    "assignee_id": 1,
    "miq_alert_status_id": 6,
    "created_at": "2017-01-22T12:29:29Z",
    "updated_at": "2017-01-22T12:29:29Z"
}

[3] :
Request:

{
  "action_type": "comment",
  "user_id": 1,
  "comment": "comment text"
}

Response:

{
    "results": [
        {
            "id": 11,
            "action_type": "comment",
            "user_id": 1,
            "comment": "comment text",
            "miq_alert_status_id": 6,
            "created_at": "2017-01-22T12:36:54Z",
            "updated_at": "2017-01-22T12:36:54Z"
        }
    ]
}

moolitayer · 2016-12-29T15:23:37Z

@miq-bot add_label wip, enhancement, api

moolitayer · 2017-01-11T13:50:18Z

@miq-bot remove_label wip

moolitayer · 2017-01-11T17:03:08Z

@abellotti can you start reviewing 530fdbb9e46ccc7734ded66aa05e8b5afb93c8c7 even though the dependent patch hasn't been merged yet?

It's critical to have all of those patches merged by the end of the week to have the API in place for the next week for other people's work

moolitayer · 2017-01-12T12:51:03Z

@abellotti PTAL

abellotti · 2017-01-12T16:29:17Z

Could you add a description entry showing the expected usage, i.e.

GET /api/alerts
GET /api/alerts/:id/alert_actions
POST /api/alerts/:id/alert_actions  with action names ...
...

It would help us to better review.

abellotti

comments above.

/cc @imtayadeway for more input. Thanks!!

abellotti · 2017-01-12T16:30:57Z

app/controllers/api/subcollections/alerts.rb

+  module Subcollections
+    module Alerts
+      def alerts_query_resource(object)
+        object.try(:miq_alert_statuses).to_a


could just be:

object.miq_alert_statuses || []

abellotti · 2017-01-12T16:39:20Z

config/api.yml

+       - :name: read
+         :identifier: alert_status_action_show_list
+       :post:
+       - :name: create


does it make sense to allow creates as both /api/alert_actions as well as /api/alerts/:id/alert_actions ? Doesn't the former need a relationship to the /api/alerts resource ?

Right, should be supported only for /api/alerts/:id/alert_actions now

abellotti · 2017-01-12T16:43:31Z

spec/requests/api/alert_actions_spec.rb

+    expect(response.parsed_body["results"].count).to eq(1)
+    expect(response.parsed_body["results"][0]).to include(specification)
+  end
+  # TODO: add tests for sub collection (only related for alert returned, id is ignored and taken from parent etc)


we'd need this test added too.

abellotti · 2017-01-12T16:44:03Z

spec/requests/api/alert_actions_spec.rb

+    run_post(alert_actions_url, specification)
+    expect(response).to have_http_status(:ok)
+    expect(response.parsed_body["results"].count).to eq(1)
+    expect(response.parsed_body["results"][0]).to include(specification)


32/33 could be a single expect.

abellotti · 2017-01-12T16:45:19Z

db/fixtures/miq_product_features.yml

+  - :name: Add
+    :description: Display Individual Alert Status
+    :feature_type: control
+    :identifier: alert_status_action_new


/cc @h-kataria need your 👀 on above miq_product_features.yml changes. Thanks!!

miq-bot · 2017-01-19T15:31:44Z

This pull request is not mergeable. Please rebase and repush.

moolitayer · 2017-01-22T17:01:48Z

/cc @h-kataria need your on above miq_product_features.yml changes. Thanks!!

@h-kataria could you please take a look at the product features for added here?
this is part of the API needed for "Monitor" added here does it make sense to have separate features?

@imtayadeway @abellotti addressed comments, and made some changes based on the review of #13025 can you take a look? Thanks

moolitayer · 2017-01-23T16:54:06Z

@imtayadeway @abellotti Please review, Feedback appriciated

imtayadeway · 2017-01-23T16:58:14Z

app/controllers/api/subcollections/alert_actions.rb

+  module Subcollections
+    module AlertActions
+      def alert_actions_query_resource(object)
+        MiqAlertStatusAction.where(:miq_alert_status_id => object.id)


Do alert statuses not have alert status actions? i.e. something like object.miq_alert_status_actions?

Sure, will change

imtayadeway · 2017-01-23T16:59:05Z

app/controllers/api/subcollections/alert_actions.rb

+      end
+
+      def alert_actions_create_resource(object, type, _id, data)
+        data['miq_alert_status_id'] = object.id


This is changing the data that's passed into this method - perhaps you could dup the data before you do this?

Maybe using merge would be cleaner?

imtayadeway · 2017-01-23T17:25:15Z

spec/requests/api/alerts_spec.rb

+      api_basic_authorize subcollection_action_identifier(:alerts, :alert_actions, :create, :post)
+      run_post(actions_subcollection_url, attributes)
+      expect(response).to have_http_status(:ok)
+      alert_action = MiqAlertStatusAction.find(response.parsed_body["results"].first["id"])


Are the attributes not sent back in the response? Can you not put the expectation on those?

moolitayer · 2017-01-23T19:32:58Z

@imtayadeway addressed comments, thanks

imtayadeway · 2017-01-23T19:38:56Z

spec/requests/api/alerts_spec.rb

+      api_basic_authorize subcollection_action_identifier(:alerts, :alert_actions, :create, :post)
+      run_post(actions_subcollection_url, attributes)
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body["results"].first).to have_attributes(attributes)


This is fine, but in the case that it breaks you may get a NoMethodError on nil, instead of a diff. So it may be better to write these and others like it something like:

expected = { "results" => [ a_hash_including(attributes) ] } expected(response.parsed_body). to include(expected)

imtayadeway · 2017-01-23T19:39:48Z

spec/requests/api/alerts_spec.rb

+        "comment"     => "comment text",
+      )
+      expect(response).to have_http_status(:bad_request)
+      expect(response.parsed_body["error"]["message"]).to eq(


There's a helper that you can use here that will better handle the case outlined above:

expect(response).to have_error_with_message("Failed etc...")

imtayadeway · 2017-01-23T19:42:42Z

@moolitayer this looks good, just some minor nits about tests. @abellotti any thoughts?

moolitayer · 2017-01-23T19:59:37Z

Thanks @imtayadeway!
Addressed comments, @abellotti please review

Good night 🌔 💤

abellotti

looks good, other than the user reference support, minor changes needed. Thanks!!

abellotti · 2017-01-23T21:44:37Z

app/controllers/api/subcollections/alert_actions.rb

+        )
+        if alert_action.invalid?
+          raise BadRequestError, "Failed to add a new alert action resource" \
+                                 " - #{alert_action.errors.full_messages.join(', ')}"


would prefer:

raise BadRequestError, "Failed to add a new alert action resource - #{alert_action.errors.full_messages.join(', ')}"

should still be good rubucop line length limit-wise.

abellotti · 2017-01-23T21:45:05Z

spec/requests/api/alerts_spec.rb

+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it "creats an alert action under an alert" do


creats -> creates

abellotti · 2017-01-23T21:47:39Z

spec/requests/api/alerts_spec.rb

+      user = FactoryGirl.create(:user)
+      attributes = {
+        "action_type" => "comment",
+        "user_id"     => user.id,


should support user reference signatures in addition to user_id,

i.e. support:

"user" : { "id" : ### }

as well as:

"user" : { "href" : "http://localhost:3000/api/users/###" }

and the related tests for both additional signatures.

OK I Hope I understood. I should not accept a parameter named user_id anymore?

keep support for user_id as you do today (that's what is sent to the model), but the API should support the user reference and generate the user_id accordingly, see what was done for arbitration_rules creation for specifying arbitration_profile (we define the arbitration_profile_id if the arbitration_profile reference is specified, using parse_id) https://github.com/ManageIQ/manageiq/pull/13525/files

Thanks for the clarification.

Now that I think about it

the user should always be the current user

your comment should be applied on assignee_id

user_id === who created this action
assignee_id === assignment target, if this is an assignment action

I'm working on it, let me know if that does not make sense

if user_id is always who created this action, why is it passed in below as part of attributes in the run_post (line 102). Maybe it should not and the API forces it to be User.current_user.id before sending to model ?

That is should be the situation now. I wrote a test to show a user_id is always ignored in favor of the current user ("creates an alert action on the current user")

abellotti · 2017-01-23T21:52:50Z

spec/requests/api/alerts_spec.rb

+        "subcount"  => 1,
+        "resources" => [
+          {
+            "href" => "http://www.example.com/api/alerts/#{alert.id}/alert_actions/#{alert_action.id}"


would prefer:

"resources" = [ { "href" => a_string_matching("#{alerts_url(alert.id)}/alert_actions/#{alert_action.id}") }

including the ones in the alerts_spec.rb, but those can be a different PR.

abellotti · 2017-01-23T21:55:01Z

spec/requests/api/alerts_spec.rb

+      run_get("#{actions_subcollection_url}/#{alert_action.id}")
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body).to have_attributes(
+        "href"        => "http://www.example.com/api/alerts/#{alert.id}/alert_actions/#{alert_action.id}",


same as above, would prefer the a_string_matching, leveraging alerts_url.

moolitayer · 2017-01-24T16:40:49Z

@abellotti addressed comments, added tests for the new functionalities
(assignee can be refrenced by either id or href, user value should be ignored and always set to the current user)
please take a look

miq-bot · 2017-01-24T16:57:35Z

Checked commit moolitayer@6bb0bf1 with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
4 files checked, 1 offense detected

spec/requests/api/alerts_spec.rb

❗ - Line 48, Col 3 - Metrics/BlockLength - Block has too many lines. [131/25]

abellotti · 2017-01-24T20:42:49Z

LGTM!! Thanks @moolitayer for the API Enhancement.

moolitayer · 2017-01-24T21:16:10Z

Awesome @abellotti @imtayadeway Thanks for reviewing & improving my work

chessbyte added the wip label Jan 3, 2017

miq-bot added api enhancement labels Jan 5, 2017

moolitayer changed the title ~~[WIP] Add alert actions api~~ Add alert actions api Jan 11, 2017

chessbyte removed the wip label Jan 12, 2017

chessbyte assigned abellotti Jan 12, 2017

abellotti requested review from abellotti and imtayadeway January 12, 2017 16:28

abellotti reviewed Jan 12, 2017

View reviewed changes

miq-bot added the unmergeable label Jan 19, 2017

moolitayer force-pushed the alert_actions_api branch from 530fdbb to 94ece40 Compare January 22, 2017 16:57

miq-bot removed the unmergeable label Jan 22, 2017

moolitayer force-pushed the alert_actions_api branch from 94ece40 to 1865e5d Compare January 23, 2017 14:00

moolitayer closed this Jan 23, 2017

moolitayer reopened this Jan 23, 2017

imtayadeway reviewed Jan 23, 2017

View reviewed changes

moolitayer force-pushed the alert_actions_api branch from 1865e5d to d0f36e2 Compare January 23, 2017 19:32

imtayadeway reviewed Jan 23, 2017

View reviewed changes

moolitayer force-pushed the alert_actions_api branch 2 times, most recently from 260c760 to b5c1c0e Compare January 23, 2017 19:57

abellotti reviewed Jan 23, 2017

View reviewed changes

moolitayer force-pushed the alert_actions_api branch from b5c1c0e to 9829f53 Compare January 24, 2017 16:38

Add alert statuses actions api

6bb0bf1

moolitayer force-pushed the alert_actions_api branch from 9829f53 to 6bb0bf1 Compare January 24, 2017 16:53

moolitayer mentioned this pull request Jan 24, 2017

Fix string comparison in test #13641

Merged

abellotti merged commit 1d00c06 into ManageIQ:master Jan 24, 2017

abellotti added this to the Sprint 53 Ending Jan 30, 2017 milestone Jan 24, 2017

Add alert actions api #13325

Add alert actions api #13325

Conversation

moolitayer commented Dec 29, 2016 • edited Loading

moolitayer commented Dec 29, 2016

moolitayer commented Jan 11, 2017

moolitayer commented Jan 11, 2017

moolitayer commented Jan 12, 2017

abellotti commented Jan 12, 2017

abellotti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miq-bot commented Jan 19, 2017

moolitayer commented Jan 22, 2017 • edited Loading

moolitayer commented Jan 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moolitayer commented Jan 23, 2017 • edited Loading

imtayadeway Jan 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imtayadeway commented Jan 23, 2017

moolitayer commented Jan 23, 2017

abellotti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moolitayer Jan 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moolitayer commented Jan 24, 2017 • edited Loading

miq-bot commented Jan 24, 2017

abellotti commented Jan 24, 2017

moolitayer commented Jan 24, 2017

moolitayer commented Dec 29, 2016 •

edited

Loading

moolitayer commented Jan 22, 2017 •

edited

Loading

moolitayer commented Jan 23, 2017 •

edited

Loading

imtayadeway Jan 23, 2017 •

edited

Loading

moolitayer Jan 24, 2017 •

edited

Loading

moolitayer commented Jan 24, 2017 •

edited

Loading