aboutsummaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* [sosreport] log preset options in command line notationBryn M. Reeves2018-06-211-3/+4
| | | | | | | | Instead of using the "name=value" pretty printer to format the preset options for logging, use the SoSOptions.to_args() method to convert them to a list of command line style arguments. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [policies] handle ValueError in sos.policies.load_presets()Bryn M. Reeves2018-06-211-1/+5
| | | | | | | If we encounter a JSON error while loading a preset skip that file and continue to load any other valid preset files. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] handle OSError in XmlReport.report()Bryn M. Reeves2018-06-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | The XmlReport class in sos.sosreport traverses the list of plugins and prepares a report including each collected file. The access to the file is wrapped in an except block but the recent change to pycodestyle modified this from a 'naked' except into a 'except IOError' block. Attempting to open a non-existent path yields an IOError, however attempting to stat a non-existent path (or a dangling symlink without lstat()) yields OSError: # ln -s foo qux # cat qux cat: qux: No such file or directory >>> os.stat("/foo/qux") Traceback (most recent call last): File "<stdin>", line 1, in <module> OSError: [Errno 2] No such file or directory: '/foo/qux' Catch both exception classes in this method. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [plugin] clean up journal log_size handlingBryn M. Reeves2018-06-211-7/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [rpm] do not double escape characters in raw stringBryn M. Reeves2018-06-211-1/+1
| | | | | | | | When switching a Python string to a raw string escape sequences like "\\n" must have the first `\` stripped or the literal value will be taken when the string is used. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [policies/redhat] update Red Hat product presetsBryn M. Reeves2018-06-201-2/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] make log_size default match master (25)Bryn M. Reeves2018-06-201-1/+1
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] make -v/--verbosity use _arg_defaultsBryn M. Reeves2018-06-202-4/+8
| | | | | | | | Since the default for --verbosity must be set (to make it 0 rather than None), use the _arg_defaults[] dictionary since the value is not the default for the corresponding ArgumentParser action. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [policies] mark new user preset as not builtinBryn M. Reeves2018-06-201-0/+1
| | | | | | | | | | | | | | | | | The changes to prevent attempts to write builtin presets also prevent user presets from being written: # ./sosreport --batch --debug --profile system --add-preset qux2 sosreport (version 3.5) Could not add preset: Cannot write built-in preset This is because although we correctly clear pd.builtin on preset load, we do not clear the flag when initialising a new user preset from the command line. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] fix SoSOptions().__repr__()Bryn M. Reeves2018-06-201-9/+14
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] move options-to-args formatting into SoSOptions.to_args()Bryn M. Reeves2018-06-202-39/+52
| | | | | | | | | | | | | Move the formatting of SoSOptions into sosreport command line arguments from SoSReport.list_presets() into SoSOptions.to_args(). This allows the function to be simplified since it has access to the raw arguments rather than their string representation. The method returns a list of string '--argument value' pairs, and suppresses null, default and True argument values. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] use short option -v for verbosity in --list-presetsBryn M. Reeves2018-06-201-2/+10
| | | | | | | | | | | | | | | | | | The --verbosity arg is a bit awkward in preset listings as it is a count type. The literal value is 1, 2, or 3, but the user enters it by repeating either the short or long option. Ideally, a user should be able to paste the arguments from the --list-presets output into the terminal and use them as arguments to sosreport: using the long option for this is... verbose: "--verbosity --verbosity --verbosity". Special case this option and use the short version instead: "-vvv". name: vvverbose-debug description: options: --debug -vvv Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] simplify SoSOptions.merge()Bryn M. Reeves2018-06-201-2/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] make unknown --preset an error and display helpBryn M. Reeves2018-06-201-2/+9
| | | | | | | | If an unknown preset is given on the command line, display an error message and set self.opts.list_presets=True to show the list of available presets. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] concatenate list-typed args in SoSOptions.merge()Bryn M. Reeves2018-06-201-14/+23
| | | | | | | | | | | When merging options (e.g. to combine command line and preset arguments), concatenate list-typed argument values rather than overwriting the target list with the source value. This allows users to extend preset-defined arguments for options like --only-plugins and --profiles on the command line. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] remove deque() use from sosBryn M. Reeves2018-06-201-15/+13
| | | | | | | | | | | | The reasoning for the use of deques in sos.sosreport is lost to the mists of CVS, but may have had something to do with limitations in setting default values in old versions of optparse: nothing in the module appears to depend on deque-like behaviour at all. Pull it all out and replace them with plain lists. This simplifies JSON handling and option merging for these types. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] reformat sequence types in SoSOptions.__str__()Bryn M. Reeves2018-06-201-1/+13
| | | | | | | | | | | | | | | | | | | | | | When formatting a human readable string representation of an SoSOptions object, convert any sequence types (lists, tuples, or deques) into a human readable string. This gives output like: onlyplugins=foo,bar,baz,qux Rather than: onlyplugins=[u'foo', u'bar', u'baz', u'qux'] This is used by --list-presets to produce lists of preset options in command line notation: options: --batch, --build, --debug=1, --onlyplugins=kernel,logs, --verbosity=1 Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] beautify --list-presets outputBryn M. Reeves2018-06-201-5/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | Re-format the output of --list-presets to be more compact and readable: add labels for each field (name, description, notes, and options), right justify all field labels to 15 chars, and convert SoSOptions() string representations into command line argument notation. logs-only : A preset to only run the logs plugin opts: all_logs=False, batch=False, build=False, case_id=, chroot=auto, compression_type=auto, config_file=, debug=False, enableplugins=[], experimental=False, label=, list_plugins=False, list_presets=False, list_profiles=False, log_size=10, noplugins=[], noreport=False, onlyplugins=[], plugopts=[], preset=, profiles=deque([]), quiet=False, sysroot=None, tmp_dir=, usealloptions=False, verbosity=0, verify=False Vs.: name: logs-only description: A preset to only run the logs plugin options: --onlyplugins=logs Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] make --alloptions SoSOptions member matchBryn M. Reeves2018-06-202-6/+6
| | | | | | | | For hysterical raisins --alloptions maps to cmd_args.usealloptions rather than cmd_args.alloptions. Make the argument name and the options member name match. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] improve --list-preset argument filteringBryn M. Reeves2018-06-201-3/+2
| | | | | | | Preset arguments should not be included in presets: simplify the filtering to use lists of filtered argument names. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] improve preset argument filteringBryn M. Reeves2018-06-201-2/+2
| | | | | | | Preset arguments should not be included in presets: simplify the filtering to use lists of filtered argument names. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [policies] return None in find_preset() if preset not foundBryn M. Reeves2018-06-202-4/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] do not display {add,del}_preset in --list-presetsBryn M. Reeves2018-06-201-0/+8
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] add --add-preset and --del-presetBryn M. Reeves2018-06-202-6/+71
| | | | | | | | | Allow user-defined named presets, stored by default in the /var/lib/sos/presets directory. A description and note for user presets may be optionally spefified using the --desc/--description and --note options. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] add add_preset and del_preset to SoSOptionsBryn M. Reeves2018-06-201-5/+8
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] add SoSOptions.dict()Bryn M. Reeves2018-06-201-1/+15
| | | | | | | | | | | Add a method to convert an SoSOptions() instance into a dict: the keys of the dictionary are the argument names and the values are the current option values. Any argument with a deque() value is converted to a plain list prior to processing. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] replace hard-coded format tuple with list comprehensionBryn M. Reeves2018-06-201-8/+1
| | | | | | | | | | Instead of hard-coding a tuple for every member of SoSOptions (% (self.foo, self.bar, ...)), use a list comprehension on the existing _arg_names list to obtain the attribute values via getattr(). This avoids the need to maintain the tuple manually as options are added or removed. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] add --list-presetsBryn M. Reeves2018-06-202-3/+30
| | | | | | Add a command line option to list out presets and their options: Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [policies] add on-disk preset supportBryn M. Reeves2018-06-202-4/+111
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the ability for the Policy class to load presets in JSON format: a PresetDefaults object maps directly to the JSON file structure: the outer container is a dictionary whose keys are the names of the contained presets, and each preset may contain a "name", "desc", "note", and "opts" member. Methods are provided to load, write, delete, user presets, and to register policy-defined built-in presets: PresetDefaults.write() PresetDefaults.delete() Policy.register_presets() Policy.load_presets() policy.add_preset() policy.del_preset() The name is used to select a preset (in the same way as a policy defined preset), and the description and note give further information on the preset and its behaviour (for e.g. performance impact). The "opts" key maps to a further dictionary mapping sos argument names to their preset values. Loaded presets are added to the active policie's presets store and are available to the user via --preset. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] add automatic preset detection infrastructureBryn M. Reeves2018-06-203-3/+17
| | | | | | | | | | | | Add a new special value for the --preset argument, 'auto', which enables automatic detection of the preset identifier string by the policy class. A new method, probe_preset() is added which should be implemented by derived classes of Policy to return a ProductDefaults() object initialised appropriately for the running preset. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] apply preset defaults to command argumentsBryn M. Reeves2018-06-201-0/+15
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [policies/redhat] add RHEL preset definitionsBryn M. Reeves2018-06-201-2/+57
| | | | | | | | Add initial RHEL product family presets to the RHELPolicy class and implement automatic preset detection for known Red Hat products (RHEL, Satellite, and Atomic). Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [policies] add PresetDefaults infrastructureBryn M. Reeves2018-06-201-1/+61
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos,sosreport] add new SoSOptions.preset / --preset optionBryn M. Reeves2018-06-202-3/+6
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] add __str__ and __repr__ to SoSOptionsBryn M. Reeves2018-06-201-1/+31
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] make SoSOptions.profiles default an empty listBryn M. Reeves2018-06-201-1/+1
| | | | | | | | To be consistent with other deque()-typed arguments make the defined value of SoSOptions.profile be [] (this simplifies JSON encoding of the object). Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sos] alphabetise SoSOptions attribute listBryn M. Reeves2018-06-201-17/+17
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] move SoSOptions from sos.sosreport to sosBryn M. Reeves2018-06-202-87/+118
| | | | | | | | | The options object now needs to be referenced in both the main sosreport script, and the policy classes: move its definition from the sos.sosreport module to sos to avoid recursive import errors between sosreport and policy. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] add SoSOptions.merge()Bryn M. Reeves2018-06-201-3/+30
| | | | | | | | | | | Add a method to merge a pair of SoSOptions, replacing unset or default values with those from the source options (and optionally overwriting already set values). This will be used to allow the policy framework to define default command line behaviour for specific products. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] add command line defaults dictionaryBryn M. Reeves2018-06-201-16/+22
| | | | | | | Add a dictionary mapping all argument names with a non-zero default value to the appropriate default. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] make --debug a booleanBryn M. Reeves2018-06-201-2/+1
| | | | | | Debugging is either on or off: make the argument match the option. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] alphabetise argument listBryn M. Reeves2018-06-201-54/+54
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] simplify SoSOptionsBryn M. Reeves2018-06-201-457/+157
| | | | | | | | | | | Simplify the SoSOptions class by removing the wrapping of the command line options and individual property methods. This removes some validation for API users implemented via the property methods: this can be re-added later if required as the interface is formalised. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [Plugin] set size limits automaticallyBryn M. Reeves2018-06-202-0/+12
| | | | | | | | | | | If the caller does not specific an explicit size limit (or 0 to disable limits) automatically set the sizelimit argument for the add_copy_spec(), add_cmd_output(), and add_journal() methods to the value of the "log_size" option. Resolves: #1325 Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [Plugin] fix Plugin.add_journal() kwarg useBryn M. Reeves2018-06-201-3/+2
| | | | | | | The add_journal() method _must_ use explicit kwarg notation when calling the _add_cmd_output() helper. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [Plugin] fix Plugin.add_cmd_output() kwarg useBryn M. Reeves2018-06-201-3/+4
| | | | | | | The add_cmd_output() method _must_ use explicit kwarg notation when calling the _add_cmd_output() helper. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] Correct verbosity level when -v is not specifiedJake Hunsaker2018-06-201-2/+2
| | | | | | | | | | | | | | | | | Fixes an issue where verbosity would be set to 'None' rather than 0 in the event that a sosreport was run with options, when those options did not include -v at all. This meant that if any options were specified, a newline would be printed for each started plugin when instead we should still have been refreshing a single line. Related to this, the previous newline behavior was beneficial when running with --batch, so that behavior is maintained if --batch is specified. Resolves: #1355 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [global] Transition to pycodestyleJake Hunsaker2018-06-2039-74/+76
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The 'pep8' tool has been renamed to 'pycodestyle' to avoid confusion with pep8 the document. pep8 (the tool) will no longer be updated and as such we should transition to the new pycodestyle. This commit fixes a number of PEP8 issues with the new pycodestyle linter that has tests for new additions to PEP8 that the pep8 tool did not include. Most of these are exception handling fixes like: sos/plugins/logs.py:96:13: E722 do not use bare 'except' Which are relatively straight forward to address, by instead catching just the applicable exceptions, e.g. IOError, ValueError, etc... In cases where there were many possible exceptions or where the "bare 'except'" was a final catch-all, we now use 'except Exception' to catch anything from the base exception class. Another frequent correction was for escape sequencing, such as: sos/plugins/logs.py:48:15: W605 invalid escape sequence '\S' The solution for this is to mark these regex strings as raw strings, which is preferred by `re` as future releases of that module may/will become more strict in its parsing of regex strings. Resolves: #1344 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [elastic] handle cases when config file isnt presentPavel Moravec2018-06-201-11/+14
| | | | | | | | | Catch and log any exception and set port as string before concatenating it. Resolves: #1352 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [fibrechannel] do not attempt to list non-existent directoriesBryn M. Reeves2018-06-201-6/+4
| | | | | | | | | | | Use a list comprehension to both generate the list of paths to collect, and to filter out any directories in the standard list of fibrechannel paths that do not exist on the running system. Resolves: #1353 Related: #1341 Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
generated by cgit (git 2.34.1) at 2024-11-18 04:14:29 +0000