[pre-commit.ci] auto fixes from pre-commit.com hooks

pre-commit-ci[bot] · pre-commit-ci[bot] · commit 09f4d2776735 · 2025-07-14T19:53:52.000Z
for more information, see https://pre-commit.ci
diff --git a/GDPR.md b/GDPR.md
@@ -28,7 +28,6 @@ So, briefing:
 - For LIVE executions
   - No data is stored
 - For non-LIVE executions
-
   - `risu.json` in sosreport folder or the path you've defined with -o
   - `magui*.json` in the folder where you executed `magui`
 
diff --git a/doc/changelog.md b/doc/changelog.md
@@ -78,7 +78,6 @@ Several changes introduced recently:
 ### 2018-01-24
 
 - Faraday extension
-
   - Some files must be equal or different across sosreports, actually we do have `release` and `ceilometer-yaml` one that rely on this, but this is hard to mantain as each new file will require a new plugin for Risu plus a new plugin for Magui.
 
   - In order to simplify this a new extension has been created so adding a new file to monitor no longer requires new plugins for `risu` or `magui` but just creating a text file with some data within as documented on `risuclient/plugins/faraday/README.md`
diff --git a/doc/development/REVIEWER.md b/doc/development/REVIEWER.md
@@ -26,7 +26,6 @@ Below are some examples of things we do usually review:
 - Not mangle `RISU\_` variables (usually leftovers when testing without using the provided `env-for-debug.sh` variable)
 - Trailing spaces on lines or empty lines
 - Reuse as maximum code between Live and snapshot mode
-
   - Use TRAP to generate files we might see in Live and use vars for it, for example:
 
   ```sh
diff --git a/doc/development/magui-plugin-development.md b/doc/development/magui-plugin-development.md
@@ -12,7 +12,6 @@ Magui plugins should conform to the following standards:
 
 - Written in python and stored in the `maguiclient/plugins` folder following whatever desired hierarchy (for example, try to match Risu plugins structure for simplicity in filtering)
 - Implement some base functions keeping arguments and data returned as in others:
-
   - `init()`
     - Returns list of triggers (array with strings) (contains Risu plugin ID data to act on)
   - `run(data)`
@@ -21,7 +20,6 @@ Magui plugins should conform to the following standards:
     - Returns string with description of plugin
 
 - Plugins for Magui should refer to processing of Risu data for doing it's work
-
   - In order to do so, each Risu plugins has a unique UID calculated via md5sum via relative path and plugin name.
   - Results are then filtered to get the data for that plugin ID, for example:
 
diff --git a/doc/magui.md b/doc/magui.md
@@ -58,6 +58,7 @@ Check latest changes on [changelog](changelog.md)
     Linked script /home/iranzo/.local/bin/magui.py
   Done.
   ```
+
   - Pipsi will take care of installing a virtual environment and link to binary folder so you can call risu.py or magui.py directly
   - Remember that pypi package might not contain all the latests plugins features as the github repo one.
 - Container:
diff --git a/doc/plugins/core.md b/doc/plugins/core.md
@@ -26,7 +26,6 @@ Risu tests should conform to the following standards:
 
 - The test should return one of the following error codes to indicate
   the test result:
-
   - \$RC_OKAY -- success
   - \$RC_FAILED -- failure
   - \$RC_SKIPPED -- skipped
@@ -90,7 +89,6 @@ location of various files. To use this script you can source it at the top:
   systemctl list units file.
 
 - `iniparser` -- parses ini file and returns value in lowercase
-
   - Example:
     ```sh
     if [[ "$(iniparser $config_file DEFAULT debug)" == "true" ]]; then
@@ -99,21 +97,18 @@ location of various files. To use this script you can source it at the top:
     ```
 
 - `is_active $service` -- reports if service is active either based on live or snapshoot
-
   - Example:
     ```sh
     if is_active ntpd; then echo "NTP Running";fi
     ```
 
 - `is_required_file $file` -- continues if file exists or exits `$RC_SKIPPED` if doesn't
-
   - Example:
     ```sh
     is_required_file "${RISU_ROOT}/var/log/messages"
     ```
 
 - `discover_osp_version $openstack-nova-common-version_package` -- echos osp version based on `openstack-nova-common version`
-
   - Example:
     ```sh
     if [[ "$(discover_osp_version)" -eq "10" ]]; then echo "We're Newton";fi
@@ -126,21 +121,18 @@ location of various files. To use this script you can source it at the top:
     ```
 
 * `is_process $process` -- returns if process exists on the system
-
   - Example:
     ```sh
     if is_process ntpd; then echo "NTP Running!";fi
     ```
 
 * `is_lineinfile $pattern $files` -- returns if pattern match is found in file
-
   - Example:
     ```sh
     if is_lineinfile "^debug[ \t]*=[ \t]*true" "$config_file"; then echo "Debug enabled."; fi
     ```
 
 * `is_required_containerized` -- continues if environment is containerized works only against OSP12 and later
-
   - Example:
     ```sh
     if is_required_containerized; then
@@ -149,7 +141,6 @@ location of various files. To use this script you can source it at the top:
     ```
 
 * `is_containerized` -- returns true or false if environment is containerized works only against OSP12 and later
-
   - Example:
     ```sh
     if is_containerized; then
@@ -160,15 +151,13 @@ location of various files. To use this script you can source it at the top:
     ```
 
 * `docker_runit` -- execute the command inside docker works only with docker
-
   - Example:
     ```sh
     # docker exec -i $(docker ps | grep rabbitmq-bundle | cut -d" " -f1) sh -c "rabbitmqctl report"
     docker_runit "rabbitmq-bundle" "rabbitmqctl report" | grep partitions
     ```
 
 * `discover_rhrelease` -- find RH Release number based on /etc/redhat-release code name
-
   - Example:
     ```sh
     if [[ $(discover_rhrelease) -eq "7" ]] ; then
@@ -184,22 +173,19 @@ location of various files. To use this script you can source it at the top:
     To early leave the script
 
 * `is_pkg $pkg` -- returns package version if installed on system (RHEL/Centos/Fedora | Debian)
-
   - Example:
     ```sh
     # is_pkg systat
     sos-3.2-15.el7.noarch
     ```
 
 * `is_required_pkg $pkg` -- continues if package is installed or exits with `$RC_SKIPPED` if required package is missing
-
   - Example:
     ```sh
     is_required_pkg sysstat
     ```
 
 * `is_pkg_over $pkg` -- Checks if provided package is over specific release
-
   - Example:
     ```sh
     if is_pkg_over dracut dracut-033-502; then  ## Note, version string is DISTRO dependent
@@ -216,15 +202,13 @@ location of various files. To use this script you can source it at the top:
     ```
 
 - `is_rpm $rpm` -- returns rpm name as installed on the system
-
   - Example:
     ```sh
     # is_rpm sos
     sos-3.2-15.el7.noarch
     ```
 
 - `is_dpkg $dpkg` -- returns dpkg version as installed on the system
-
   - Example:
     ```sh
     # is_dpkg libc6
@@ -240,7 +224,6 @@ location of various files. To use this script you can source it at the top:
 - `is_required_dpkg_over` -- Fallsback to `is_required_pkg_over $package` after forcing `dpkg` distro check.
 
 - `are_dates_diff_over` -- Checks if two dates are over X days in diff
-
   - Example:
     ```sh
     are_dates_diff_over 5 "2017-12-01 14:40" "2017-12-31 14:45"
diff --git a/doc/presentations/presentation-revealmd.md b/doc/presentations/presentation-revealmd.md
@@ -415,7 +415,6 @@ For additional questions, come to #risu on [Libera](https://libera.chat/) or ema
 <small>
 
 1. What sort of logic are scripts using to determine if the check is failed/ok or should be skipped
-
    - Exit status for commands like `grep`, etc
    - Check requirements to run, target environment and matching details
    - bash conditionals
@@ -438,7 +437,6 @@ Note:
 <small>
 
 1. What do I need to do if I want to add my scripts
-
    - Modify risu.py to define new path
    - Use include filter to add it
    - chmod +x the script in the plugins folder
@@ -461,7 +459,6 @@ Note:
 <small>
 
 1. What languages are supported for scripts?
-
    - bash, python, ruby
    - python, bash, c++
    - golang, perl
@@ -480,7 +477,6 @@ Note:
 <small>
 
 1. What are the valid return status for scripts?
-
    - RC_WARNING
    - RC_OKAY
    - RC_SKIPPED
diff --git a/doc/risu.md b/doc/risu.md
@@ -37,6 +37,7 @@ Check for plugins listing on [risuclient/plugins/](risuclient/plugins/)
     Linked script /home/iranzo/.local/bin/magui.py
   Done.
   ```
+
   - Pipsi will take care of installing a virtual environment and link to binary folder so you can call risu.py or magui.py directly
   - Remember that pypi package might not contain all the latests plugins features as the github repo one.
 - Container:
