feat: Rename files

Change-Id: I1b6dc21408812586480b6c12aaff70fb6c6d6ec2

Author: iranzo

.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,6 +3,6 @@ name: Feature request
 about: Suggest an idea for this project
 ---
 
-**What are you missing in citellus?**
+**What are you missing in Risu?**
 
 **Additional info**

.github/labels.yml

@@ -5,8 +5,8 @@ repo:
 documentation:
   - doc/**/*
 
-citellus:
-  - citellusclient/**/*
+risu:
+  - risuclient/**/*
 
 magui:
   - maguiclient/**/*

.github/workflows/python-package.yml

@@ -46,7 +46,7 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest --cov-report=xml --cov=citellusclient --cov=maguiclient
+        pytest --cov-report=xml --cov=risuclient --cov=maguiclient
 
     - name: Upload coverage to Codecov
       uses: codecov/[email protected]

.releaserc.json

@@ -1,6 +1,6 @@
 {
   "branch": "master",
-  "repositoryUrl": "[email protected]:citellusorg/citellus.git",
+  "repositoryUrl": "[email protected]:risuorg/risu.git",
   "tagFormat": "${version}",
   "plugins": [
     "@semantic-release/commit-analyzer",

CHANGELOG.md

@@ -1,47 +1,47 @@
-# [1.5.0](https://github.com/citellusorg/citellus/compare/1.4.0...1.5.0) (2021-05-03)
+# [1.5.0](https://github.com/risuorg/risu/compare/1.4.0...1.5.0) (2021-05-03)
 
 ### Features
 
-- **citellus.html:** match window title with report name ([f18aad9](https://github.com/citellusorg/citellus/commit/f18aad9f0e6582f6deb1190dda1bc98152a6028b))
+- **risu.html:** match window title with report name ([f18aad9](https://github.com/risuorg/risu/commit/f18aad9f0e6582f6deb1190dda1bc98152a6028b))
 
-# [1.4.0](https://github.com/citellusorg/citellus/compare/1.3.3...1.4.0) (2021-05-03)
+# [1.4.0](https://github.com/risuorg/risu/compare/1.3.3...1.4.0) (2021-05-03)
 
 ### Features
 
-- **shell.py:** search for configuration file in current directory automatically ([2379374](https://github.com/citellusorg/citellus/commit/2379374ea86869ae5b458add35604a4cf33a992a))
+- **shell.py:** search for configuration file in current directory automatically ([2379374](https://github.com/risuorg/risu/commit/2379374ea86869ae5b458add35604a4cf33a992a))
 
-## [1.3.3](https://github.com/citellusorg/citellus/compare/1.3.2...1.3.3) (2021-04-21)
+## [1.3.3](https://github.com/risuorg/risu/compare/1.3.2...1.3.3) (2021-04-21)
 
 ### Bug Fixes
 
-- **nagios.py:** unknown is defined as RC 3 ([0ae7617](https://github.com/citellusorg/citellus/commit/0ae7617357d9e4cab3bf45f9523ea207169c8863))
+- **nagios.py:** unknown is defined as RC 3 ([0ae7617](https://github.com/risuorg/risu/commit/0ae7617357d9e4cab3bf45f9523ea207169c8863))
 
-## [1.3.2](https://github.com/citellusorg/citellus/compare/1.3.1...1.3.2) (2021-04-21)
+## [1.3.2](https://github.com/risuorg/risu/compare/1.3.1...1.3.2) (2021-04-21)
 
 ### Bug Fixes
 
-- **nagios.py:** Also consider UKNOWN as SKIPPED ([6ca49dd](https://github.com/citellusorg/citellus/commit/6ca49dd2df7a75e1f4fff0318fa8a6c29a8739d6))
+- **nagios.py:** Also consider UKNOWN as SKIPPED ([6ca49dd](https://github.com/risuorg/risu/commit/6ca49dd2df7a75e1f4fff0318fa8a6c29a8739d6))
 
-## [1.3.1](https://github.com/citellusorg/citellus/compare/1.3.0...1.3.1) (2021-04-21)
+## [1.3.1](https://github.com/risuorg/risu/compare/1.3.0...1.3.1) (2021-04-21)
 
 ### Bug Fixes
 
-- **nagios.py:** Also process WARNING as RC_INFO for Nagios plugins ([f38efce](https://github.com/citellusorg/citellus/commit/f38efce9a13961d3b9c967390df2846e4cffc6cb))
+- **nagios.py:** Also process WARNING as RC_INFO for Nagios plugins ([f38efce](https://github.com/risuorg/risu/commit/f38efce9a13961d3b9c967390df2846e4cffc6cb))
 
-# [1.3.0](https://github.com/citellusorg/citellus/compare/1.2.0...1.3.0) (2021-04-20)
+# [1.3.0](https://github.com/risuorg/risu/compare/1.2.0...1.3.0) (2021-04-20)
 
 ### Features
 
-- **citellus.html:** Use html file name for finding the json data ([69246dd](https://github.com/citellusorg/citellus/commit/69246dde55f6204bb9ea9a79d0a83f36200fc3f4))
+- **risu.html:** Use html file name for finding the json data ([69246dd](https://github.com/risuorg/risu/commit/69246dde55f6204bb9ea9a79d0a83f36200fc3f4))
 
-# [1.2.0](https://github.com/citellusorg/citellus/compare/1.1.1...1.2.0) (2021-04-20)
+# [1.2.0](https://github.com/risuorg/risu/compare/1.1.1...1.2.0) (2021-04-20)
 
 ### Features
 
-- **nagios.py:** Add Nagios extension to process shell scripts with standard return codes 0/1/2 ([1d2776a](https://github.com/citellusorg/citellus/commit/1d2776ae4fab4c825ee8a2f35e53bbdc0e9ec4c4))
+- **nagios.py:** Add Nagios extension to process shell scripts with standard return codes 0/1/2 ([1d2776a](https://github.com/risuorg/risu/commit/1d2776ae4fab4c825ee8a2f35e53bbdc0e9ec4c4))
 
-## [1.1.1](https://github.com/citellusorg/citellus/compare/1.1.0...1.1.1) (2020-10-18)
+## [1.1.1](https://github.com/risuorg/risu/compare/1.1.0...1.1.1) (2020-10-18)
 
 ### Bug Fixes
 
-- **release.yml:** use automation via GHA for release process ([9011813](https://github.com/citellusorg/citellus/commit/901181398adfed12e78d0e550f71ab79f4aaafd1))
+- **release.yml:** use automation via GHA for release process ([9011813](https://github.com/risuorg/risu/commit/901181398adfed12e78d0e550f71ab79f4aaafd1))

CONTRIBUTING.md

@@ -0,0 +1,131 @@
+**Table of contents**
+
+<!-- TOC depthFrom:1 insertAnchor:false orderedList:false -->
+
+- [How to file a bug report](#how-to-file-a-bug-report)
+- [How to contribute code](#how-to-contribute-code)
+- [How to write tests](#how-to-write-tests)
+- [How to debug your test](#how-to-debug-your-test)
+
+<!-- /TOC -->
+
+## How to file a bug report
+
+If you have any suggestions for improvements please do not hesitate to
+open an [issue](https://github.com/risuorg/risu/issues/new).
+
+## How to contribute code
+
+We encourage you to contribute new plugins. Use Pull Requests to provide your contributions to the repo.
+
+[gerrithub]: https://gerrithub.io/
+
+1.  Clone the risu repository:
+    `git clone https://github.com/risuorg/risu`
+2.  Install pre-commit (from pipsi for example) and prepare the hook:
+    `pre-commit install`
+3.  Check out a branch in which to make your changes:
+    `git checkout -b "your-new-branch"`
+4.  Edit your files and validate with tox:
+    `tox # this will check the changes for some errors`
+    NOTE: tox will run python 2.7, pep8 and python 3.5 tests, if your environment lacks for example python 3.5, do execute tox -l to see the available tests and skip that one, for example:
+
+    ```sh
+    tox -e pep8
+    tox -e py27  # We're skipping tox -e py35 which is also invoked by default when tox is executed without arguments.
+    ```
+
+    In this way, errors that might be relevant to the test environment can be skipped. For example this one reported at issue tracker as [104](https://github.com/risuorg/risu/issues/104))
+
+5.  Update your local repository:
+    `git add $modified_files git commit`
+
+        For the message, please use a short line with the fix and the subject like `[plugins][openstack][nova] Check nova configuration XXX`
+
+        If the commit fixes a github open issue, also use `Closes #$ISSUEID` so github automatically closes it once merged referencing the commit.
+
+6.  Submit your changes for review:
+
+    `git push`
+
+7.  Then, use repository Pull-Request method to request the change to be incorporated/reviewed
+
+        git-review
+
+Then wait for your changes to be reviewed. It is common for reviewers
+to request changes; when this happens:
+
+1.  Edit your files and revalidate with tox:
+
+        tox # this will check the new changes for some errors
+
+2.  Update your existing commit. Do not create a new commit! We want to get each new PR into one commit.
+
+        git add $modified_files
+        git commit --amend
+
+3.  Resubmit the change:
+
+        git push --force
+
+4) Once the new plugin has been submitted you'll see some GitHub actions feedback (similars to the ones that you run with `tox`)
+
+## How to write tests
+
+Please refer to the
+[templates](https://github.com/risuorg/risu/tree/master/doc/templates)
+folder for examples.
+
+Specially remember about the headers:
+
+```
+# long_name: plug long name for webui
+# description: plug description
+# bugzilla: bz url
+# priority: 0<>1000 for likelihood to break your environment if this test reports fail
+# kb: url-to-kbase
+```
+
+That are used by Risu to fill json metadata.
+
+If you want to contribute also Unittests for your plugins, check [TESTING.md](TESTING.md)
+
+For contributing translations check [i18n.md](i18n.md)
+
+## How to debug your test
+
+We've included a file named `env-for.debug.sh` in the root folder of Risu repo that allows to be sourced and later execute your script.
+
+This environment file will define the standard variables Risu does use like:
+
+- RC_OKAY
+- RC_FAILED
+- RC_SKIPPED
+- RC_INFO
+- TEXTDOMAIN
+- TEXTOMAINDIR
+- RISU_BASE
+- RISU_LIVE
+- RISU_ROOT
+
+And will preload the common-functions
+
+The way to use it is:
+
+```sh
+. ~/risu/env-for-debug.sh
+```
+
+Then you can debug your script with:
+
+```
+sh -x /path/to/your/plugin.sh
+```
+
+Or test individual functions output like:
+
+```
+is_rpm qemu-kvm-rhev
+```
+
+Please, do note that as some functions do 'exit' or 'return' for example executing `is_rpm_over` will exit the active shell, so beware!!

CONTRIBUTING.md

@@ -1,16 +1,16 @@
 # Based on https://github.com/RHsyseng/container-rhel-examples/blob/master/starter-rhel-atomic/Dockerfile
 FROM registry.centos.org/centos/centos7-atomic:latest
-MAINTAINER Citellus developers <citellus _AT_ googlegroups.com>
+MAINTAINER Risu developers <risuorg _AT_ googlegroups.com>
 
-LABEL name="citellus/citellus" \
-      maintainer="citellus _AT_ googlegroups.com.com" \
-      vendor="Citellus" \
+LABEL name="risu/risu" \
+      maintainer="risuorg _AT_ googlegroups.com.com" \
+      vendor="Risu" \
       version="1.0.0" \
       release="1" \
       summary="System configuration validation program" \
-      description="Citellus is a program that should help with system configuration validation on either live system or any sort of snapshot of the filesystem."
+      description="Risu is a program that should help with system configuration validation on either live system or any sort of snapshot of the filesystem."
 
-ENV USER_NAME=citellus \
+ENV USER_NAME=risu \
     USER_UID=10001
 
 # Required for useradd command and pip
@@ -31,13 +31,13 @@ RUN PRERREQ_PKGS="shadow-utils \
 
 RUN pip install --upgrade pip --no-cache-dir && \
     pip install --upgrade pbr --no-cache-dir && \
-    pip install --upgrade citellus --no-cache-dir && \
+    pip install --upgrade risu --no-cache-dir && \
     mkdir -p /data && \
     chmod -R u+x /data && \
     chown -R ${USER_UID}:0 /data && \
     chmod -R g=u /data
 
 USER 10001
 VOLUME /data
-ENTRYPOINT ["/usr/bin/citellus.py"]
+ENTRYPOINT ["/usr/bin/risu.py"]
 CMD ["-h"]

Dockerfile

@@ -10,28 +10,28 @@
 
 GDPR <https://www.eugdpr.org/> is a Regulation created to safeguard private data access, rectification, removal, etc.
 
-Citellus or Magui processes the information already in your sosreports (which you can clean using tools like [SosCleaner](https://github.com/RedHatGov/soscleaner)) and stores in the same folder where the sosreport has been uncompressed.
+Risu or Magui processes the information already in your sosreports (which you can clean using tools like [SosCleaner](https://github.com/RedHatGov/soscleaner)) and stores in the same folder where the sosreport has been uncompressed.
 
-If the sosreport contains data under the scope of GDPR, the generated files by Citellus or Magui (`citellus.json` or `magui-*.json`) might contain excerpts of that data (but unlikely as we do output information on the error found, not the actual line that triggered it).
+If the sosreport contains data under the scope of GDPR, the generated files by Risu or Magui (`risu.json` or `magui-*.json`) might contain excerpts of that data (but unlikely as we do output information on the error found, not the actual line that triggered it).
 
-Also remember, that, when running Citellus or Magui:
+Also remember, that, when running Risu or Magui:
 
-- You're downloading Citellus/Magui to your system and execute locally
+- You're downloading Risu/Magui to your system and execute locally
 - You're using a sealed container against the folder you define
 
 Such as, the system where it's executed will contain forementioned files that should be removed.
 
-In case of remote execution in Magui, a temporary folder with the contents of those files is available at `/tmp/citellus.json` for each host that was added and a local (for the executing host) folder named `/tmp/citellus/hostrun/` will contain the files transferred from remote systems to local one.
+In case of remote execution in Magui, a temporary folder with the contents of those files is available at `/tmp/risu.json` for each host that was added and a local (for the executing host) folder named `/tmp/risu/hostrun/` will contain the files transferred from remote systems to local one.
 
 So, briefing:
 
 - For LIVE executions
   - No data is stored
 - For non-LIVE executions
 
-  - `citellus.json` in sosreport folder or the path you've defined with -o
+  - `risu.json` in sosreport folder or the path you've defined with -o
   - `magui*.json` in the folder where you executed `magui`
 
 - When using Magui's ansible host file for remote execution, additionally:
-  - `/tmp/citellus.json` on remote hosts
-  - `/tmp/citellus` folder on calling host
+  - `/tmp/risu.json` on remote hosts
+  - `/tmp/risu` folder on calling host

GDPR.md

@@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    Citellus is a program that performs SOSreport Health Validation
+    Risu is a program that performs SOSreport Health Validation
     Copyright (C) 2017   Robin Cernin ([email protected])
 
     This program is free software: you can redistribute it and/or modify