VMs/Snapshots API CRD

[imtayadeway]

Here's a naive implementation of the Snapshots API, which I'm submitting for early feedback.

@abellotti I'll work on making the implementation more nuanced (i.e. error handling, etc...), but would you like to go over the high-level design together?

Adds CRD actions for snapshots of VMs

Addresses https://bugzilla.redhat.com/show_bug.cgi?id=1399526

@miq-bot add-label api, wip
@miq-bot assign @abellotti

Examples

index

GET http://localhost:3000/api/vms/1000000002002/snapshots
Authorization: Basic YWRtaW46c21hcnR2bQ==

{
  "actions": [
    {
      "href": "http://localhost:3000/api/vms/1000000002002/snapshots",
      "method": "post",
      "name": "create"
    }
  ],
  "resources": [
    {
      "href": "http://localhost:3000/api/vms/1000000002002/snapshots/1000000005471"
    }
  ],
  "subcount": 1,
  "count": 187,
  "name": "snapshots"
}

show

GET http://localhost:3000/api/vms/1000000002002/snapshots/1000000005471
Authorization: Basic YWRtaW46c21hcnR2bQ==

{
  "actions": [
    {
      "href": "http://localhost:3000/api/vms/1000000002002/snapshots/1000000005471",
      "method": "post",
      "name": "delete"
    },
    {
      "href": "http://localhost:3000/api/vms/1000000002002/snapshots/1000000005471",
      "method": "delete",
      "name": "delete"
    }
  ],
  "uid_ems": "00517423-dfb3-411d-915d-79eeaa85df9f",
  "vm_or_template_id": 1000000002002,
  "updated_on": "2014-11-24T12:14:26Z",
  "created_on": "2014-11-19T21:17:51Z",
  "disks": [],
  "create_time": "2014-11-19T21:21:31Z",
  "current": 1,
  "description": "Active VM",
  "name": "Active VM",
  "uid": "00517423-dfb3-411d-915d-79eeaa85df9f",
  "id": 1000000005471,
  "href": "http://localhost:3000/api/vms/1000000002002/snapshots/1000000005471"
}

create

happy path

POST http://localhost:3000/api/vms/1000000002158/snapshots
Authorization: Basic YWRtaW46c21hcnR2bQ==

{
  "name": "Tim's snapshot"
}

{
  "results": [
    {
      "task_href": "http://localhost:3000/api/tasks/1000000340680",
      "task_id": 1000000340680,
      "message": "Creating snapshot for ManageIQ::Providers::Vmware::InfraManager::Vm id: 1000000002158 name: test-2.demo.inec.as",
      "success": true
    }
  ]
}

GET http://localhost:3000/api/tasks/1000000340680
Authorization: Basic YWRtaW46c21hcnR2bQ==

{
  "updated_on": "2017-01-24T21:52:54Z",
  "created_on": "2017-01-24T21:52:53Z",
  "userid": "admin",
  "message": "Task completed successfully",
  "status": "Ok",
  "state": "Finished",
  "name": "summary",
  "id": 1000000340680,
  "href": "http://localhost:3000/api/tasks/1000000340680"
}

unhappy path

POST http://localhost:3000/api/vms/1000000002002/snapshots
Authorization: Basic YWRtaW46c21hcnR2bQ==

{
  "name": "Tim's snapshot"
}

{
  "results": [
    {
      "message": "Create Snapshot operation not supported for Redhat VM",
      "success": false
    }
  ]
}

destroy

happy path

unhappy path

[imtayadeway]

@abellotti do you know if the create_time is intended to be set by the user as a required field?

[imtayadeway]

@abellotti bit confused by this behavior. "edit" will return /api/snapshots/:id (which does not exist), while "create" will return /api/vms/:vm_id/snapshots/:id. Any thoughts?

[abellotti]

would prefer if good path is all protected by rescue:

i.e.

  def ...
    validation = parent.validate_create_snapshot
    raise validation[:message] unless validation[:available]
    ... do the queuing work
    action_result(true, ...)
  rescue => err
    action_result(false, err.to_s)
  end

[abellotti]

also, instead of parent.id for the successful return, would be useful to have something similar to vm_ident(), maybe something like '#{ctype} id: #{parent.id} name: #{parent.name}'

[abellotti]

same rescue structure suggestion as above.

[abellotti]

"desc" ? maybe "Deleting snapshot #{id} for ..." same parent signature as above.

[imtayadeway]

WIP 😄

[imtayadeway]

@miq-bot rm-label wip

[imtayadeway]

@miq-bot add-label enhancement

[abellotti]

Looks good @imtayadeway

minor comment change and short of the rubocop changes and tests against physical vm, I'm good with this 🎵

[abellotti]

Maybe update to "POST /api/vms/:c_id/snapshots with delete action" just to clarify that this is not a URL signature (i.e. supporting ?action=delete parameter on POSTs).

[imtayadeway]

Good find!

[miq-bot]

Checked commits imtayadeway/manageiq@7e47625~...522d039 with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
4 files checked, 0 offenses detected
Everything looks good. 🍪

[abellotti]

LGTM!! 🎵