[WIP] Add WidgetSet endpoint

[lpichler]

Fixes #953

This adds WidgetSet endpoint with CRUD.

LIST

GET /api/widget_sets
=>
{
    "name": "widget_sets",
    "count": 8,
    "subcount": 8,
    "pages": 1,
    "resources": [
        {
            "href": "http://localhost:3090/api/widget_sets/155"
        },
        {
            "href": "http://localhost:3090/api/widget_sets/161"
        },
        {
            "href": "http://localhost:3090/api/widget_sets/162"
        },
        {
            "href": "http://localhost:3090/api/widget_sets/168"
        },
        {
            "href": "http://localhost:3090/api/widget_sets/170"
        },
        {
            "href": "http://localhost:3090/api/widget_sets/152"
        },
        {
            "href": "http://localhost:3090/api/widget_sets/153"
        },
        {
            "href": "http://localhost:3090/api/widget_sets/154"
        }
    ],
    "actions": [
        {
            "name": "query",
            "method": "post",
            "href": "http://localhost:3090/api/widget_sets"
        },
        {
            "name": "create",
            "method": "post",
            "href": "http://localhost:3090/api/widget_sets"
        },
        {
            "name": "edit",
            "method": "post",
            "href": "http://localhost:3090/api/widget_sets"
        },
        {
            "name": "delete",
            "method": "post",
            "href": "http://localhost:3090/api/widget_sets"
        },
        {
            "name": "copy",
            "method": "post",
            "href": "http://localhost:3090/api/widget_sets"
        },
        {
            "name": "delete",
            "method": "delete",
            "href": "http://localhost:3090/api/widget_sets"
        }
    ],
    "links": {
        "self": "http://localhost:3090/api/widget_sets?offset=0",
        "first": "http://localhost:3090/api/widget_sets?offset=0",
        "last": "http://localhost:3090/api/widget_sets?offset=0"
    }
}

CREATE:

POST /api/widget_sets
{
    "name": "V",
    "description": "a",
    "set_data": { "col1": [7, 22, 20] },
    "group"   : {"id" : 1} # or href
}
=>
 {
    "results": [
        {
            "href": "http://localhost:3090/api/widget_sets/167",
            "id": "167",
            "name": "V",
            "description": "a",
            "set_type": "MiqWidgetSet",
            "created_on": "2020-12-09T15:29:35Z",
            "updated_on": "2020-12-09T15:29:35Z",
            "guid": "847f3d4f-9ccf-4049-9b60-d40a3d755bbd",
            "read_only": null,
            "set_data": {
                "col1": [
                    7,
                    22,
                    20
                ],
                "col2": [],
                "col3": [],
                "reset_upon_login": false,
                "locked": false
            },
            "mode": null,
            "owner_type": "MiqGroup",
            "owner_id": "1",
            "userid": null,
            "group_id": "1"
        }
    ]
}

EDIT:

POST /api/widget_sets/1
{
   "action" : "edit",
   "resource" : {
        "description": "testaa",
        "set_data": { "col1": [7, 22, 20] }
   } 
}

COPY

POST /api/widget_sets/167
{
   "action" : "copy",
   "resource" : {
        "name" : "ddd",
        "description": "testaa",
        "set_data": { "col1": [7, 22, 20] }
   } 
}
=>
{
    "success": true,
    "message": "Dashboard ddd successfully created.",
    "href": "http://localhost:3090/api/widget_sets/167"
}

DELETE

POST /api/widget_sets/167
{
   "action" : "delete"
}
=>

{
    "success": true,
    "message": "Dashboard Vd has been successfully deleted.",
    "href": "http://localhost:3090/api/widget_sets/169"
}

Links

Requires:

• Add validations for MiqWidgetSet manageiq#20890 - Validations
• Improvements for MiqWidgetSet model manageiq#20972

[skateman]

@lpichler we also need an endpoint for copying I think

https://github.com/ManageIQ/manageiq-ui-classic/blob/master/app/controllers/report_controller/dashboards.rb#L61

[lpichler]

@lpichler we also need an endpoint for copying I think

https://github.com/ManageIQ/manageiq-ui-classic/blob/master/app/controllers/report_controller/dashboards.rb#L61

It could be done by with create action but I can add it to simplify copy action.

[skateman]

@lpichler as there's a separate method on the model for copying, I'd rather expose it than simulate it with a create...

[Fryguy]

I'm not sure I like all of this in the API...feels like a lot of the setup should be in the model as class methods. @agrare @abellotti Thoughts? Is this a pattern we do elsewhere?

[Fryguy]

Anything that's not exposed to a route should be moved into a private method.

[Fryguy]

Like this stuff should be model validations...not in the API.

[Fryguy]

Also should be a model validation.

[abellotti]

Agreed, API does not raise any ArgumentErrors today, those come from the model.

[lpichler]

I'm not sure I like all of this in the API...feels like a lot of the setup should be in the model as class methods. @agrare @abellotti Thoughts? Is this a pattern we do elsewhere?

Yes, this is exactly what I wanted to discuss - I am not against, I wanted to see opinions from others.
This is common that there is lot of validations of various kinds in controllers and when we are creating API endpoints we have to decide if validations should go to in API or to model level(and we can rely that data in db are already valid ).

cc @kbrock

[abellotti]

I'm confused with this, is the API defining a structure beyond the basic MiqWidgetSet ? It almost feels we need a new subclass of MiqWidgetSet in the model for what we're building/managing here and move most of this logic in there.

[lpichler]

@miq-bot cross-repo-tests ManageIQ/manageiq#20890

[miq-bot]

Checked commit lpichler@4dea6a4 with ruby 2.6.3, rubocop 0.82.0, haml-lint 0.35.0, and yamllint
2 files checked, 4 offenses detected

app/controllers/api/widget_sets_controller.rb

• ❗ - Line 14, Col 29 - Naming/MethodParameterName - Method parameter must be at least 3 characters long.
• ❗ - Line 20, Col 31 - Naming/MethodParameterName - Method parameter must be at least 3 characters long.
• ❗ - Line 32, Col 29 - Naming/MethodParameterName - Method parameter must be at least 3 characters long.
• ❗ - Line 6, Col 31 - Naming/MethodParameterName - Method parameter must be at least 3 characters long.

[abellotti]

with 'read_only' here, does this mean the API can create read_only widget sets and cannot delete them ? I usually think of read_only as set to true for some system seeded resources.

[abellotti]

needs a bulk query test. can be added in spec/requests/collections_spec.rb

[miq-bot]

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

[kavyanekkalapu]

@jrafanie This is needed for Overview/Reports/Dashboards -> Copy Selected Dashboard Missing endpoint for manipulating with dashboards form. Right now we are using miqajaxmethod as we don't have api.