fix: Linting fixes, and code fixes

[Robin-Van-de-Merghel]

I went in a journey to understand the code. At the same time I tried to fix some linting and documentation problems.

Most changes are made by linters.

• Improved .pylintrc to maybe later have a stricter linting
• Few self.log.<logtype> were incorrect (wrong number of parameters), and didn't raise any error in python but did not print out as we desired
• Adding documentation in some functions (need a review in case I did not understand well):
  • pilotTools.py: pythonPathCheck, safe_listdir, ObjectLoader, getCommand, __checkSecurityDir
  • proxyTools.py: getVO (the others functions, I did not understand them well)
• Remove unused parameters:
  • pilotTools.py: CommandBase,
• Still some functions that have unused parameters, and I did not know if we needed them:
  • pilotCommands.py: _setNagiosOptions
  • pilotTools.py: debug, error, warn, info
• Changed __checkSecurityDir because I think it is not right to test two (or more) arbitraries folders coming from a configuration, before testing if the environment (for whaterver reason) has already a environment variable associated to it (also added at the same time __setSecurityDir)
• Remove empty test TestSimplePilotLogger (I did not see any use)

Previous pylint score: 5.42/10

New pylint score: 9.33/10

There are still errors like empty documentation. Others seems to come from python2/3 compatibility.

[fstagni]

?

[Robin-Van-de-Merghel]

The x name comes from the code itself: except Exception as x: (very general).

We can modify it so that exceptions are more precise.

Or modify it to:

    """Checks where python is located
    Raises:
        Error: In case there is an error while removing duplicates in the PYTHONPATH or for any other issue
    """

Or remove this part.

[fstagni]

I am for more precision

[Robin-Van-de-Merghel]

Ok, i'm working on it

[Robin-Van-de-Merghel]

I think it is better

Idk if we have to detail each error that can appear (OS, env, ...) with multiple catches

[fstagni]

I am not sure about this. Do the integration tests work?

[Robin-Van-de-Merghel]

First lines of pilotCommands.py, we have:

The constructor must call the superclass constructor with the PilotParams object and the command name as arguments, e.g.::

    class InstallDIRAC(CommandBase):

      def __init__(self, pilotParams):
        CommandBase.__init__(self, pilotParams, 'Install')
        ...

I guess this comment is wrong, because the name used is <commandClass>.__class__.__name__. And this is the only reference of using that second parameter dummy. All super(<CommandClass>, self).__init()__ use only one parameter.

I am trying to compare what I see (no call of this parameter) with what it does in a real integration test, but I need to configure it.

Note if we remove it, do the same in line 735.

[Robin-Van-de-Merghel]

I still need to fix bugs. I'm on it today.

[Robin-Van-de-Merghel]

One of my errors in the pytests is this one.

Recently they changed how they wanted to work with X509 for SSL requests: giving context instead of X509.

I doubt that it is retro-compatible, but I can't verify it right now on my setup (I have python2, but not cmvfs). If it is not it is an issue, and we have to fix the version of this module.

(The issue occurs here)

[fstagni]

Which of your changes in this PR triggers that pytest errors? As pytest is failing for all python versions here