Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1247781 - hammer queries defaults to 1000 items per page
Summary: hammer queries defaults to 1000 items per page
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Hammer
Version: 6.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: Unspecified
Assignee: Martin Bacovsky
QA Contact: sthirugn@redhat.com
URL: http://projects.theforeman.org/issues...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-07-28 20:54 UTC by sthirugn@redhat.com
Modified: 2019-09-26 18:06 UTC (History)
11 users (show)

Fixed In Version: rubygem-hammer_cli-0.5.1.6-1,rubygem-hammer_cli_foreman-0.5.1.8-1
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-07-27 11:37:02 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)
hammer pagination (129.40 KB, image/png)
2016-05-20 07:42 UTC, Ondřej Pražák 		no flags Details
View All


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 14530 0 Normal Closed hammer queries defaults to 1000 items per page 2020-05-28 10:22:05 UTC
Red Hat Bugzilla 1154383 0 medium CLOSED [RFE] Ability to use user's default Org/Location in hammer CLI 2021-02-22 00:41:40 UTC

Internal Links: 1154383

Description sthirugn@redhat.com 2015-07-28 20:54:05 UTC 
Description of problem:
hammer queries default to 1000 items per page which makes hammer very slow 

Version-Release number of selected component (if applicable):
Sat 6.1 GA Snap 14

How reproducible:
Always

Steps to Reproduce:
# cat /etc/hammer/cli_config.yml 
:ui:
  :interactive: true
  :per_page: 20
  :history_file: '~/.foreman/history'

# enable/disable color output of logger in Clamp commands
:watch_plain: false

:log_dir: '~/.foreman/log'
:log_level: 'error'
:log_api_calls: false
#:log_owner: 'foreman'
#:log_group: 'foreman'
#:log_size: 5 #MB



# hammer -u admin -p changeme repository list --organization-id=3
---|-------------------------------------------------------|---------------------------------|--------------|--------------------------------------------------------------------
ID | NAME                                                  | PRODUCT                         | CONTENT TYPE | URL                                                                
---|-------------------------------------------------------|---------------------------------|--------------|--------------------------------------------------------------------
27 | Red Hat Enterprise Linux 5 Server RPMs x86_64 5Server | Red Hat Enterprise Linux Server | yum          | https://cdn.redhat.com/content/dist/rhel/server/5/5Server/x86_64/os
1  | Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server | Red Hat Enterprise Linux Server | yum          | https://cdn.redhat.com/content/dist/rhel/server/7/7Server/x86_64/os
---|-------------------------------------------------------|---------------------------------|--------------|--------------------------------------------------------------------

# time hammer -u admin -p changeme erratum list
....
....
-------------------------------------|----------------|-------------|---------------------------------------------------------------------------------

real	7m58.835s
user	7m32.086s
sys	0m0.266s


Actual results:
See above that the erratum list command took almost 8 minutes to finish

Expected results:
Pagination should work

Additional info:
Comment 1 sthirugn@redhat.com 2015-07-28 21:19:54 UTC 
Just to clarify, the command '# time hammer -u admin -p changeme erratum list' listed 1000 items but I was expecting to see first 20 items with options to search next.
Comment 3 Adam Price 2015-07-31 16:45:12 UTC 
this still respects the page and per_page options if passed in at the command line via --page and --per_page or when included in api requests.
Comment 4 Mike McCune 2015-07-31 16:48:09 UTC 
We actually changed this on purpose for 6.1 to turn of pagination by default:

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

the side effect is that some API calls can return a *lot* of data.

For 6.2 we can investigate a few options:

* Timing functions where hammer will indicate the call is taking a while and possibly returning lots of data. give the user a suggestion to CTRL+C and use the --per-page option

* Have APIs offer a default pagination with the requirement to use a param to indicate you want *all* results
Comment 9 Shimon Shtein 2016-03-16 14:11:23 UTC 
After https://github.com/theforeman/hammer-cli/pull/174 you can add a default option for pagination. You can even scope it to a specific resourse. I think it will cover both cases - if a user wants, he can add a pagination option, and the global default is full results.

Is it a valid workaround?
Comment 10 Brad Buckingham 2016-03-16 14:12:48 UTC 
Adding needinfo for Suresh based on comment #9
Comment 11 sthirugn@redhat.com 2016-03-16 14:25:30 UTC 
ACK for Comment 9 behavior.
Comment 13 Shimon Shtein 2016-03-16 16:48:44 UTC 
It should be. The related BZ is https://bugzilla.redhat.com/show_bug.cgi?id=1154383 which is in ON_QA state and included in SNAP1.
Comment 14 Brad Buckingham 2016-03-16 17:58:06 UTC 
Shimon, I chatted with Suresh in irc.  Since the behavior is addressed in the other BZ, we are going to move this one to ON_QA and he can run through verification.
Comment 15 sthirugn@redhat.com 2016-03-21 17:15:40 UTC 
This bug failed in Satellite 6.2.0-beta-snap4 due to the same reason mentioned in https://bugzilla.redhat.com/show_bug.cgi?id=1154383#c10
Comment 16 Shimon Shtein 2016-03-22 09:23:02 UTC 
Created an upstream PR to fix the issue, temporary workaround in https://bugzilla.redhat.com/show_bug.cgi?id=1154383
Comment 18 Mike McCune 2016-04-01 04:28:35 UTC 
this is solved via 1154383 and associated bugs, moving ON_QA
Comment 19 sthirugn@redhat.com 2016-04-01 19:28:37 UTC 
Failed in Satellite 6.2-beta-snap-6.  I don't see any per-page options supported.  Only organization_id, location_id are shown.


[root@sat6host ~] # hammer -u admin -p changeme defaults providers
---------|------------------------------|-------------------------------------------------------------
PROVIDER | SUPPORTED DEFAULTS           | DESCRIPTION                                                 
---------|------------------------------|-------------------------------------------------------------
foreman  | organization_id, location_id | Use the default organization and/or location from the server
---------|------------------------------|-------------------------------------------------------------

More test steps are also documented in https://bugzilla.redhat.com/show_bug.cgi?id=1154383#c19
Comment 21 Martin Bacovsky 2016-04-06 14:18:26 UTC 
Let sum up the status:

- there is a bug in hammer causing per_page from the config file is being ignored. That is IMO the primary reason for this BZ. PR is almost ready
- I can confirm the workaround Shimon suggested works:
 $ hanner defaults add --param-name per_page --param-value 3
 $ hammer template list
---|----------------------------|----------
ID | NAME                       | TYPE     
---|----------------------------|----------
7  | Alterator default          | provision
8  | Alterator default finish   | finish   
9  | Alterator default PXELinux | PXELinux 
---|----------------------------|----------

To improve UX I'm adding message with page/total to the incomplete listings
Comment 22 Martin Bacovsky 2016-04-07 14:13:11 UTC 
Created redmine issue http://projects.theforeman.org/issues/14530 from this bug
Comment 23 Bryan Kearney 2016-04-28 12:08:51 UTC 
Moving to POST since upstream bug http://projects.theforeman.org/issues/14530 has been closed
Comment 24 Ondřej Pražák 2016-05-20 07:42:14 UTC 
Created attachment 1159824 [details]
hammer pagination

I do not think this got cherrypicked right since the relevant code is missing (RHEL6, snap 12). Line 331 in hammer_cli_foreman/commands.rb should be:

https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman/commands.rb#L331

but is:
pagination_supported? && option_per_page.nil? && option_page.nil?

the screenshot provides more detailed info
Comment 26 Tomas Strachota 2016-05-27 08:02:18 UTC 
Verified with:
tfm-rubygem-hammer_cli-0.5.1.7-1.el7sat.noarch
tfm-rubygem-hammer_cli_foreman-0.5.1.8-1.el7sat.noarch

Hammer reflected on the per-page setting from config files.
Comment 27 Bryan Kearney 2016-07-27 11:37:02 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2016:1501
Note You need to log in before you can comment on or make changes to this bug.