Upstream rebase

.cirrus.yml

@@ -35,7 +35,7 @@ env:
     UBUNTU_PRIOR_IMAGE_NAME: "ubuntu-2204-jammy-v20240501"
     UBUNTU_PRIOR2_IMAGE_NAME: "ubuntu-2004-focal-v20240426"
     UBUNTU_PRIOR3_IMAGE_NAME: "ubuntu-1804-bionic-v20240116a"
-    UBUNTU_SNAP_IMAGE_NAME: "ubuntu-2204-jammy-v20240501"
+    UBUNTU_SNAP_IMAGE_NAME: "ubuntu-2404-noble-amd64-v20240423"
     UBUNTU_DEVEL_FAMILY_NAME: "ubuntu-2410-amd64"
 
     # Curl-command prefix for downloading task artifacts, simply add the
@@ -56,6 +56,7 @@ gcp_credentials: ENCRYPTED[!77d4c8251094346c41db63cb05eba2ff98eaff04e58c5d0e2a8e
 
 # Run a simple lint on the community cluster
 flake8_task:
+    skip: &man-changes-include "changesIncludeOnly('man/*')"
     alias: "flake8_test"
     name: "Flake8 linting test"
     container:
@@ -66,6 +67,7 @@ flake8_task:
     flake_script: tox -e flake8
 
 pylint_task:
+    skip: *man-changes-include
     alias: "pylint_test"
     name: "pylint linting test"
     container:
@@ -77,6 +79,7 @@ pylint_task:
 # breaks/changes in common modules. This is not meant to check any of the actual
 # collections or archive integrity.
 py_break_task:
+    skip: *man-changes-include
     alias: "py_break"
     name: "Breakage test python-$PY_VERSION"
     container:
@@ -92,6 +95,7 @@ py_break_task:
 
 # Make sure a user can manually build an rpm from the checkout
 rpm_build_task:
+    skip: *man-changes-include
     alias: "rpm_build"
     name: "rpm Build From Checkout - ${BUILD_NAME}"
     gce_instance: &standardvm
@@ -130,6 +134,7 @@ rpm_build_task:
 
 # Make sure a user can manually build a deb from the checkout
 deb_build_task:
+    skip: *man-changes-include
     alias: "deb_build"
     name: "deb Build From Checkout"
     gce_instance:
@@ -151,6 +156,7 @@ deb_build_task:
 
 # Make sure a user can manually build a snap from the checkout
 snap_build_task:
+    skip: *man-changes-include
     alias: "snap_build"
     name: "snap Build From Checkout"
     gce_instance:
@@ -175,6 +181,7 @@ snap_build_task:
 
 # Run the stage one (no mocking) tests across all distros on GCP
 report_stageone_task:
+    skip: *man-changes-include
     alias: "stageone_report"
     name: "Report Stage One - $BUILD_NAME"
     depends_on:
@@ -251,6 +258,7 @@ report_stageone_task:
             path: "sos-fail-logs.tar"
 
 report_stageone_daily_task:
+    skip: *man-changes-include
     alias: "stageone_daily_report"
     name: "Report Stage One - ${UBUNTU_DEVEL_FAMILY_NAME}"
     allow_failures: true
@@ -271,6 +279,7 @@ report_stageone_daily_task:
 
 # IFF the stage one tests all pass, then run stage two for latest distros
 report_stagetwo_task:
+    skip: *man-changes-include
     alias: "stagetwo_report"
     name: "Report Stage Two - $BUILD_NAME"
     depends_on: stageone_report
@@ -296,6 +305,7 @@ report_stagetwo_task:
         log_artifacts: *logs
 
 report_stagetwo_daily_task:
+    skip: *man-changes-include
     alias: "stagetwo_daily_report"
     name: "Report Stage Two - ${UBUNTU_DEVEL_FAMILY_NAME}"
     allow_failures: true

debian/changelog

@@ -1,3 +1,9 @@
+doca-sosreport (4.8.1) noble; urgency=medium
+
+  * rebase on top of 4.8.1 upstream
+
+ -- Michael Filanov <[email protected]>  Thu, 24 Nov 2024 14:40:01 +0100
+
 doca-sosreport (4.8.0-1) unstable; urgency=low
 
   * replace sosreport with doca-sosreport

debian/copyright

@@ -3,21 +3,23 @@ Upstream-Name: sosreport
 Upstream-Contact: Jake Hunsaker <[email protected]>
 Source: https://github.com/sosreport/sos
 
-License: GPL-2+
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or (at
- your option) any later version.
+Files: *
+Copyright: (C) 2012-2017 Bryn M. Reeves
+  (C) 2007-2024 Red Hat, Inc.
+  (C) 2012-2024 Canonical Ltd.
+License: GPL-2
+
+License: GPL-2
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; version 2.
  .
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ This application is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  General Public License for more details.
  .
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301,
  USA.
- .
- On Debian systems, the complete text of the GNU General Public
- License, version 2, can be found in /usr/share/common-licenses/GPL-2.

docs/conf.py

@@ -21,7 +21,6 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.abspath('..'))
-import sos
 
 
 # -- General configuration ------------------------------------------------
@@ -52,16 +51,16 @@
 
 # General information about the project.
 project = 'SoS'
-copyright = '2014, Bryn Reeves'
+project_copyright = '2014, Bryn Reeves'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '4.7.2'
+version = '4.8.1'
 # The full version, including alpha/beta/rc tags.
-release = '4.7.2'
+release = '4.8.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

man/en/sos-clean.1

@@ -1,6 +1,6 @@
-.TH SOS CLEAN 1 "Thu May 21 2020"
+.TH SOS_CLEAN 1 "Thu May 21 2020"
 .SH NAME
-sos clean - Obfuscate sensitive data from one or more sos reports
+sos_clean, sos_mask \- Obfuscate sensitive data from one or more sos reports
 .SH SYNOPSIS
 .B sos clean TARGET [options]
     [\-\-domains]

man/en/sos-collect.1

@@ -1,7 +1,7 @@
-.TH SOS COLLECT 1 "April 2020"
+.TH SOS_COLLECT 1 "April 2020"
 
 .SH NAME
-sos collect \- Collect sos reports from multiple (cluster) nodes
+sos_collect \- Collect sos reports from multiple (cluster) nodes
 .SH SYNOPSIS
 .B sos collect
     [\-a|\-\-all\-options]

man/en/sos-help.1

@@ -1,6 +1,6 @@
-.TH SOS HELP 1 "Fri Nov 05 2021"
+.TH SOS_HELP 1 "Fri Nov 05 2021"
 .SH NAME
-sos help - get detailed help information on sos commands and components
+sos_help \- get detailed help information on sos commands and components
 .SH SYNOPSIS
 .B sos help TOPIC
 

man/en/sos-report.1

@@ -1,6 +1,6 @@
-.TH SOS REPORT 1 "Mon Mar 25 2013"
+.TH SOS_REPORT 1 "Mon Mar 25 2013"
 .SH NAME
-sos report \- Collect and package diagnostic and support data
+sos_report \- Collect and package diagnostic and support data
 .SH SYNOPSIS
 .B sos report
           [-l|--list-plugins]\fR
@@ -313,7 +313,7 @@ a timeout for a specific plugin, use the 'timeout' plugin option available to
 all plugins - e.g. '-k logs.timeout=600'.
 
 The plugin-specific timeout option will override this option. For example, using
-\'--plugin-timeout=60 -k logs.timeout=600\' will set a timeout of 600 seconds for
+\(aq--plugin-timeout=60 -k logs.timeout=600' will set a timeout of 600 seconds for
 the logs plugin and 60 seconds for all other enabled plugins.
 .TP
 .B \--cmd-timeout TIMEOUT
@@ -382,7 +382,7 @@ to prevent sos report working dir to consume all free disk space. No plugin data
 is available at the end.
 
 Plugins will be collected sequentially, size of collected files and commands outputs
-will be calculated and the plugin files will be immediatelly deleted prior execution
+will be calculated and the plugin files will be immediately deleted prior execution
 of the next plugin. This still can consume whole free disk space, though.
 
 Please note, size estimations may not be accurate for highly utilized systems due to

plugins_overview.py

@@ -27,7 +27,6 @@
 PLUGDIR = 'sos/report/plugins'
 
 plugs_data = {}     # the map of all plugins data to collect
-plugcontent = ''    # content of plugin file just being processed
 
 
 # method to parse an item of a_s_c/a_c_o/.. methods
@@ -42,11 +41,11 @@ def add_valid_item(dest, item):
             return
 
 
-# method to find in `plugcontent` all items of given method (a_c_s/a_c_o/..)
+# method to find all items of given method (a_c_s/a_c_o/..) in plugin content,
 # split by comma; add each valid item to the `dest` list
-def add_all_items(method, dest, wrapopen=r'\(', wrapclose=r'\)'):
+def add_all_items(method, dest, plugfd, wrapopen=r'\(', wrapclose=r'\)'):
     regexp = f"{method}{wrapopen}(.*?){wrapclose}"
-    for match in re.findall(regexp, plugcontent,
+    for match in re.findall(regexp, plugfd,
                             flags=re.MULTILINE | re.DOTALL):
         # tuple of distros ended by either (class|from|import)
         if isinstance(match, tuple):
@@ -90,30 +89,32 @@ def add_all_items(method, dest, wrapopen=r'\(', wrapclose=r'\)'):
             'journals': [],
             'env': [],
     }
-    plugcontent = open(
-        os.path.join(PLUGDIR, plugfile)).read().replace('\n', '')
-    add_all_items(
-        "from sos.report.plugins import ",
-        plugs_data[plugname]['distros'],
-        wrapopen='',
-        wrapclose='(class|from|import)'
-    )
-    add_all_items("profiles = ", plugs_data[plugname]['profiles'], wrapopen='')
-    add_all_items("packages = ", plugs_data[plugname]['packages'], wrapopen='')
-    add_all_items("add_copy_spec", plugs_data[plugname]['copyspecs'])
-    add_all_items("add_forbidden_path", plugs_data[plugname]['forbidden'])
-    add_all_items("add_cmd_output", plugs_data[plugname]['commands'])
-    add_all_items("collect_cmd_output", plugs_data[plugname]['commands'])
-    add_all_items("add_service_status", plugs_data[plugname]['service_status'])
-    add_all_items("add_journal", plugs_data[plugname]['journals'])
-    add_all_items("add_env_var", plugs_data[plugname]['env'])
+    with open(os.path.join(PLUGDIR, plugfile),
+              encoding='utf-8').read().replace('\n', '') as pfd:
+        add_all_items(
+            "from sos.report.plugins import ", plugs_data[plugname]['distros'],
+            pfd, wrapopen='', wrapclose='(class|from|import)'
+        )
+        add_all_items("profiles = ", plugs_data[plugname]['profiles'],
+                      pfd, wrapopen='')
+        add_all_items("packages = ", plugs_data[plugname]['packages'],
+                      pfd, wrapopen='')
+        add_all_items("add_copy_spec", plugs_data[plugname]['copyspecs'], pfd)
+        add_all_items("add_forbidden_path",
+                      plugs_data[plugname]['forbidden'], pfd)
+        add_all_items("add_cmd_output", plugs_data[plugname]['commands'], pfd)
+        add_all_items("collect_cmd_output",
+                      plugs_data[plugname]['commands'], pfd)
+        add_all_items("add_service_status",
+                      plugs_data[plugname]['service_status'], pfd)
+        add_all_items("add_journal", plugs_data[plugname]['journals'], pfd)
+        add_all_items("add_env_var", plugs_data[plugname]['env'], pfd)
 
 # print output; if "csv" is cmdline argument, print in CSV format, else JSON
 if (len(sys.argv) > 1) and (sys.argv[1] == "csv"):
     print("plugin;url;distros;profiles;packages;copyspecs;forbidden;commands;"
           "service_status;journals;env_vars")
-    for plugname in plugs_data.keys():
-        plugin = plugs_data[plugname]
+    for plugname, plugin in plugs_data.items():
         # determine max number of lines - usually
         # "max(len(copyspec),len(commands))"
         # ignore 'sourcecode' key as it

pylintrc

@@ -33,65 +33,14 @@ disable=
     R0913, # too-many-arguments
     R0914, # too-many-locals
     R0915, # too-many-statements
+    R0917, # too-many-positional-arguments
     R1702, # too-many-nested-blocks
     W0201, # attribute-defined-outside-init
     W0511, # fixme
     ###################### VV things we should fix VV
-    W0613, # unused-argument
-    W0612, # unused-variable
-    R1705, # no-else-return
     W0719, # broad-exception-raised
     W1203, # logging-fstring-interpolation
-    W1406, # redundant-u-string-prefix
-    R1732, # consider-using-with
-    W1514, # unspecified-encoding
-    W0107, # unnecessary-pass
     W0718, # broad-exception-caught
     W0102, # dangerous-default-value
-    C0325, # superfluous-parens
-    E1111, # assignment-from-no-return
-    R1714, # consider-using-in
-    C0206, # consider-using-dict-items
-    W0221, # arguments-differ
-    R1711, # useless-return
-    R1720, # no-else-raise
-    R0205, # useless-object-inheritance
-    W3101, # missing-timeout
-    C0201, # consider-iterating-dictionary
-    R1719, # simplifiable-if-expression
-    W1201, # logging-not-lazy
-    W0707, # raise-missing-from
-    W0237, # arguments-renamed
-    E0606, # possibly-used-before-assignment
-    R1724, # no-else-continue
-    R1729, # use-a-generator
-    C0117, # unnecessary-negation
-    W0622, # redefined-builtin
     W0212, # protected-access
-    R1728, # consider-using-generator
-    R1710, # inconsistent-return-statements
-    C1802, # use-implicit-booleaness-not-len
-    W0706, # try-except-raise
-    C1803, # use-implicit-booleaness-not-comparison
-    W0231, # super-init-not-called
-    C0123, # unidiomatic-typecheck
-    C0207, # use-maxsplit-arg
-    C2801, # unnecessary-dunder-call
-    E0203, # access-member-before-definition
-    E0611, # no-name-in-module
-    E0702, # raising-bad-type
-    E1101, # no-member
-    E1135, # unsupported-membership-test
-    R1703, # simplifiable-if-statement
-    R1718, # consider-using-set-comprehension
-    R1721, # unnecessary-comprehension
-    R1722, # consider-using-sys-exit
-    W0105, # pointless-string-statement
-    W0108, # unnecessary-lambda
-    W0222, # signature-differs
-    W0223, # abstract-method
-    W0246, # useless-parent-delegation
-    W0621, # redefined-outer-name
-    W0640, # cell-var-from-loop
     W1509, # subprocess-popen-preexec-fn
-    W4701, # modified-iterating-list

snap/snapcraft.yaml

@@ -5,12 +5,12 @@ description: |
   primarily aimed at Linux distributions and other UNIX-like operating
   systems.
 grade: stable
-base: core22
+base: core24
 confinement: classic
 adopt-info: sos
-license: GPL-2.0-or-later
+license: GPL-2.0-only
 environment:
-  PYTHONPATH: ${SNAP}/lib/python3.10/site-packages:${SNAP}/usr/lib/python3/dist-packages:${PYTHONPATH}
+  PYTHONPATH: ${SNAP}/lib/python3.12/site-packages:${SNAP}/usr/lib/python3/dist-packages:${PYTHONPATH}
 
 parts:
   sos:
@@ -24,13 +24,12 @@ parts:
     build-packages:
       - git
       - python3
-      - snapcraft
       - gettext
       - python3-venv
     stage-packages:
-      - python3.10-minimal
-      - libpython3.10-minimal
-      - libpython3.10-stdlib
+      - python3.12-minimal
+      - libpython3.12-minimal
+      - libpython3.12-stdlib
     python-packages:
       - pip
       - setuptools