Added include_attributes and exclude_attributes to GET /api/v1/executions/{id}

[nmaludy]

Previously GET /api/v1/executions/{id} did not have the include_attributes or exclude_attributes query parameters, meaning it couldn't filter the output of large executions. This PR adds that ability.

@Kami are any other modifications necessary?

TODO

• Tests

[nmaludy]

FYI just found a bug in router.py was throwing an exception:

2019-01-14 22:03:51,896 140229294134928 ERROR error_handling [-] API call failed: local variable 'item' referenced before assignment
Traceback (most recent call last):
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2common/middleware/error_handling.py", line 47, in __call__
    return self.app(environ, start_response)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2common/middleware/streaming.py", line 48, in __call__
    return self.app(environ, start_response)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2common/router.py", line 600, in as_wsgi
    resp = self(req)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2common/router.py", line 554, in __call__
    exclude_attributes=exclude_attributes)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2common/router.py", line 677, in _process_response
    result = process_item(item)
UnboundLocalError: local variable 'item' referenced before assignment (_exception_data={},_exception_class='UnboundLocalError',_exception_message="local variable 'item' referenced before assignment")

Looks like that was a copy/paste error and should have been result = process_item(data) instead.

[Kami]

Good catch. It looks we don't have test case for this scenario? :)

[Kami]

Besides that and test case for handling of those attributes it looks good to me 👍

I believe we already have a pattern for include and exclude attributes test cases. We might not just have one for "get one" API endpoints yet.

[Kami]

Thanks for opening this.

Can you please also add a changelog entry?

[nmaludy]

Please don't merge this yet

I found a least one bug in st2client where it's using ?include_attributes already, but doesn't ask for all of the attributes that it needs.

So far i've found the following is broken:

• st2 execution get xxx

Traceback (most recent call last):
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2client/shell.py", line 402, in run
    func(args)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2client/commands/resource.py", line 48, in decorate
    return func(*args, **kwargs)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2client/commands/action.py", line 1203, in run_and_print
    return self._print_execution_details(execution=execution, args=args, **kwargs)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2client/commands/action.py", line 338, in _print_execution_details
    runner_type = execution.action.get('runner_type', 'unknown')
AttributeError: 'Execution' object has no attribute 'action'

[nmaludy]

Latest commit should address the st2client issues

[Kami]

It looks like some CLI tests are failing. I didn't have time to dig in yet (if it's related to this change or not).

EDIT: End to end tests are failing as well so it looks like a legit issues.

[Kami]

I pushed a small change and I believe this should now work correctly.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
0 out of 2 committers have signed the CLA.

❌ Kami
❌ nmaludy
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[Kami]

The diff got really large and messy so I needed to rebase this on top of master and force push to get it sorted out.