[Bug bunsen/25090] New: [v1.0] improved command line args parsing

[Bug bunsen/25090] New: [v1.0] improved command line args parsing

[me at serhei dot io]

https://sourceware.org/bugzilla/show_bug.cgi?id=25090

            Bug ID: 25090
           Summary: [v1.0] improved command line args parsing
           Product: bunsen
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: bunsen
          Assignee: bunsen at sourceware dot org
          Reporter: me at serhei dot io
  Target Milestone: ---

Example command line interface to support:

+list_runs [[project=]<tag>] [verbose=yes|no] [pretty=yes|no]
[sort=[least_]recent] [restrict=<num>]

Need to apply this to the existing analysis scripts.

-- 
You are receiving this mail because:
You are the assignee for the bug.

[Bug bunsen/25090] [v1.0] improved command line args parsing

[me at serhei dot io]

https://sourceware.org/bugzilla/show_bug.cgi?id=25090

Serhei Makarov <me at serhei dot io> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|---                         |FIXED

--- Comment #1 from Serhei Makarov <me at serhei dot io> ---
A list of commonly recurring command line options (to guide future script
development). Perhaps put in future documentation:

- source_repo: project source code (e.g. to obtain a list of commits)
- branch: branch in source_repo to analyze
- project: restrict analysis to testruns tagged <project> (e.g. project=gdb)
- key: restrict analysis to testcases containing <key> (TODO: matching glob
<key>, see PR25349)
- baseline: baseline commit/run to compare against
- latest: commit/run to compare
- sort: recent/least_recent
- restrict: restrict output to N objects
- pretty: where available, pretty=html enables HTML output, pretty=no enables
JSON output
- compact: where available, for pretty=html enables a more compact view
- verbose

Incomplete list of options for log importing:

- raw_logs: collection of raw log files to import
- rebuild: rebuild entire repository (TODO: parse all files again and update
metadata, see PR25075)

-- 
You are receiving this mail because:
You are the assignee for the bug.

[Bug bunsen/25090] [v1.0] improved command line args parsing

[me at serhei dot io]

https://sourceware.org/bugzilla/show_bug.cgi?id=25090

Serhei Makarov <me at serhei dot io> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |REOPENED
         Resolution|FIXED                       |---

--- Comment #2 from Serhei Makarov <me at serhei dot io> ---
A better format for specifying args would be, e.g.:

#!/usr/bin/env python3
from common.cmdline_args import default_args
info='''Walk the history of the specified branch (default master) of the Git
repo source_repo. For every commit, compare testruns under specified
project with testruns for the parent commit. Print a summary of how
test results change for testcases whose name contains the specified
substring <key>.'''
cmdline_args=default_args+[
  ('project', None, 'tags', 'restrict to testruns under <tags>'),
  ('key', None, 'glob', 'restrict to testcases matching <glob>'),
  ('source_repo', None, 'path', 'scan commits from source_repo'),
  ('branch', 'master', 'name', 'scan commits in branch <name>'),
]

A more informative usage message can then be generated from this data.

-- 
You are receiving this mail because:
You are the assignee for the bug.

[Bug bunsen/25090] Improve & standardize command line args parsing

[serhei at serhei dot io]

https://sourceware.org/bugzilla/show_bug.cgi?id=25090

Serhei Makarov <serhei at serhei dot io> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
            Summary|[v1.0] improved command     |Improve & standardize
                   |line args parsing           |command line args parsing
           Assignee|bunsen at sourceware dot org       |serhei at serhei dot io
                 CC|                            |bunsen at sourceware dot org

--- Comment #3 from Serhei Makarov <serhei at serhei dot io> ---
This is still a concern for the new master branch. The current code is limited
to standard argparser functionality. At a bare minimum, the scripts should be
able to accept arguments from the command line or from a configuration file, or
a combination of both.

There are also a number of 'standard' arguments around querying/formatting
which tend to cause code duplication. This could be solved either with library
code or by factoring scripts more carefully into separate pipeline steps.

-- 
You are receiving this mail because:
You are on the CC list for the bug.
You are the assignee for the bug.