Adding support for a format_attributes parameter

[abellotti]

Adding support for a format_attributes parameter with syntax:

  format_attributes=attr1=format1,attr2=format2,attr3=format3,....

Implementation to support an stdout virtual attribute on orchestration_stacks with optional attribute rendering as follows:

  GET /api/services/:id/orchestration_stacks
      ?expand=resources
      &attributes=stdout
      &format_attributes=stdout=raw

[abellotti]

This is an alternate approach to #14389 which sticks to querying the orchestration stack and not implementing POST actions to fetching virtual attributes.

Initial thought was to us providing a virtual attribute in the model for each stdout format provided by AnsibleTower, simply a wrapper call to fetching stdout from the provider with a given parameter, not too much code to add to model each time. No change to API for each, just the model.

With this approach, we're leveraging the virtual attribute accessor mechanism of the API, plus introducing a format_attributes= parameter which allows us to simply pass the specified format down to the generic (get_stdout or whatever it gets named) method in the model that's simply sent over to the provider. No additional code in API or model needed for every format they introduce in the future.

Other general concerns include:

• since we're synchronous in API, time for provider to render that stdout for us, we don't want to be blocked too long.
• size of the stdout we're passing through the layers.

/cc @jntullo @gmcculloug @bzwei @Fryguy

[abellotti]

/cc @gtanzillo @gmcculloug updated as per meeting today, also added specs.

[miq-bot]

Some comments on commits abellotti/manageiq@0653eaf~...d0701b9

spec/requests/api/services_spec.rb

• ⚠️ - 665 - Detected allow_any_instance_of. This RSpec method is highly discouraged, please only use when absolutely necessary.
• ⚠️ - 679 - Detected allow_any_instance_of. This RSpec method is highly discouraged, please only use when absolutely necessary.

[miq-bot]

Checked commits abellotti/manageiq@0653eaf~...d0701b9 with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
5 files checked, 0 offenses detected
Everything looks good. 🏆

[gtanzillo]

👍