Add "Note" in the CLI if API has default query "limit=50" and update rule endpoint help

[humblearner]

Changes:

$ st2 rule list
+---------------------------------+--------+---------------------------------+---------+
| ref                             | pack   | description                     | enabled |
+---------------------------------+--------+---------------------------------+---------+
| github.deploy_pack_on_deploymen | github | Trigger an ST2 pack.install     | False   |
| t_event                         |        | when receiving a deployment     |         |
                ~~~~~~~~~~~~~~~~~~~~~~~
                ~~~~~~~~~~~~~~~~~~~~~~~
| st2cd.st2_pkg_test_stable_u16_e | st2cd  | Test stable packages            | True    |
| nterprise                       |        |                                 |         |
+---------------------------------+--------+---------------------------------+---------+
+-----------------------------------------------------------------------------------------+
| Note: Only first 50 results are displayed. Use -n/--last flag for more results, if any. |
+-----------------------------------------------------------------------------------------+

$ st2 rule list -h
usage: st2 rule list [-h] [-t TOKEN] [--api-key API_KEY] [-j] [-y]
                     [-a ATTR [ATTR ...]] [-w WIDTH [WIDTH ...]] [-n LAST]
                     [--iftt] [-p PACK] [-c ACTION] [-g TRIGGER]
                     [--enabled | --disabled]

Get the list of the 50 most recent rules.

optional arguments:
                ~~~~~~~~~~~~~~~~~~~~~~~
                ~~~~~~~~~~~~~~~~~~~~~~~
  -n LAST, --last LAST  List N most recent rules. Default is 50.

CLI Updated:

• rule
• execution
• triggerinstance
• trace
• rule_enforcement

Functionality:

• Dynamically display note (in stderr) if # of entries are greater than limit (default or set by -n flag).
• Only in (default) table format, not in json or yaml.

Addresses: #3488

[Kami]

LGTM, but we should also do the change @armab suggested aka printing out "there are more results" when using CLI in user-friendly (table) mode (we don't want to print that when using --json or --yaml flag).

[Kami]

Perhaps we should add changelog entry for this change.

[humblearner]

Yes, once all the changes are ok, I'll update the changelog.

[Kami]

Just curious why the inherit class change was needed.

[armab]

True, without explicit note that only first 50 results are showed up, - it's not user friendly and doesn't solve the confusion.
As said in #3488 to be consistent we need to check if all CLI commands have this feature as well.

[humblearner]

Besides rules, the default limit=50 is set for: rule_enforcement, execution, triggerinstance and trace. If above Note change is ok, then I'll add it to the above CLIs as well.

[Kami]

Yeah, that note works for me, but maybe we could also make it more dynamic and only display the note if there are in fact more results.

We could do that by utilizing X- headers returned by the API, bit it could also make it a bit more complex and require more refactoring, because headers and raw response objects are not available in those methods right now.

[Kami]

It looks like this is repeated in quite some places so eventually it will need some refactor, but it should be fine for now.

[Kami]

It looks like query is used in quite some places, were all the affected places updated?

https://gist.github.com/Kami/365f58a69f90594ce970dcd2c2069a8e

[humblearner]

Yes, I have updated all the places, where query was called. However, unit tests are not happy, as we are mocking the response w/o headers.

[Kami]

It looks like query method returns Noneif response doesn't contain X-Total header so thisint(count)` would fail.

So probably need to do something along the lines of and count is not None and int(count)...

[humblearner]

Agree, however, is it safe to assume if args.last is present X-Total-Count will be present in the header?

[Kami]

I believe so, but would need to confirm.

And perhaps better to be on the safe side :)

[Kami]

Minor API consistency thing - all other formatter class methods return a value instead of printing it so it would be better for this one to do that as well.

[Kami]

And perhaps, as @armab said earlier, maybe even print this note to stderr instead of stdout.

[Kami]

Missing line break at the end.

It would also be good if you could align note box table with actual content table (so it's the same number of columns / width).

[Kami]

It looks like it doesn't correctly handle a scenario where you pass in -n 1 for example but there are more results.

So this logic needs to be changed to handle that scenario as well.

[humblearner]

Hmm, it is working for me. If n > default limit then show the note, otherwise, just show the result.

$ st2 rule-enforcement list -n 1
+--------------------------+----------------------+----------------------+----------------------+----------------------+
| id                       | rule.ref             | trigger_instance_id  | execution_id         | enforced_at          |
+--------------------------+----------------------+----------------------+----------------------+----------------------+
| 5952ab31909a5027b65c037b | st2ci.st2_pkg_test_a | 5952ab30909a5027b65c | 5952ab30909a5027b65c | 2017-06-27T19:00:00. |
|                          | nd_promote_unstable_ | 036e                 | 037a                 | 858196Z              |
|                          | u16                  |                      |                      |                      |
+--------------------------+----------------------+----------------------+----------------------+----------------------+

$ st2 execution list -n 1
+--------------------------+------------+--------------+------------------------+------------------+---------------+
| id                       | action.ref | context.user | status                 | start_timestamp  | end_timestamp |
+--------------------------+------------+--------------+------------------------+------------------+---------------+
| 595467b3909a5015dab1c8b9 | core.local | stanley      | succeeded (1s elapsed) | Thu, 29 Jun 2017 | Thu, 29 Jun   |
|                          |            |              |                        | 02:36:35 UTC     | 2017 02:36:36 |
|                          |            |              |                        |                  | UTC           |
+--------------------------+------------+--------------+------------------------+------------------+---------------+

$ st2 trigger-instance list -n 1
+--------------------------+---------------------------+---------------------------+-----------+
| id                       | trigger                   | occurrence_time           | status    |
+--------------------------+---------------------------+---------------------------+-----------+
| 59546ab5909a5045fc0d0882 | core.st2.key_value_pair.c | Thu, 29 Jun 2017 02:49:25 | processed |
|                          | reate                     | UTC                       |           |
+--------------------------+---------------------------+---------------------------+-----------+

[armab]

Just #3514 #3488 is enough there, without "Reported by".

I think it's good idea to include "reported by" only if there was an external contribution.

[Kami]

I will test it and go ahead and merge it if everything look OK so it will end up in v2.3.1, but we really need to refactor and fix this global variable thing since it's not robust and could cause issues.

[Kami]

I'll go ahead and merge this so we can start testing changes for v2.3.1 release, but please look into getting rid of the global variable as soon as you get a chance.

[Kami]

@humblearner It would be great if you can also work on automated robot tests for this CLI functionality - so testing all the common scenarios + edge cases.

CLI is one of the places where we lack tests and regressions are easy to introduce so we should invest some time in more automated tests.