documentation bug/ unittest mis-match: unittest assume global installation

certtools / intelmq

IntelMQ is a solution for IT security teams for collecting and processing security feeds using a message queuing protocol.

https://docs.intelmq.org/latest/

GNU Affero General Public License v3.0

977 stars 297 forks source link

Open aaronkaplan opened 1 year ago

aaronkaplan commented 1 year ago

Going through and testing the documentation, I noticed that the unittest discover instructions assume that we have a global installation.

If we follow the Developer guide, we might end up with a .venv installation. (following: https://intelmq.readthedocs.io/en/develop/dev/guide.html)

Result:

(.venv) aaron@bee:/opt/dev_intelmq$ sudo -u intelmq python3 -m unittest discover
sudo: unknown user intelmq

sebix commented 3 months ago

The docs already say, right above the code that you pasted and executed:

For virtual environment installation, please activate it and omit the sudo -u from examples below: