Router modifies its own PYTHONPATH (sys.path)

[jiridanek]

Both skstat and skmanage need to import skupper_router_internal. This module is installed outside of the default PYTHONPATH, therefore the tools modify the path first (in running Python program it is accessed through sys.path) and then they perform the import.

skupper-router/tools/skmanage

Lines 27 to 28 in 662be06

	import skupper_router_site
	skupper_router_site.populate_pythonpath()

skupper-router/tools/skstat

Lines 26 to 27 in 8d37e0a

	import skupper_router_site
	skupper_router_site.populate_pythonpath()

@astitcher @kgiusti not sure if we want to really do something about it? Regarding RPMs, @ssorj suggested to put skupper_router_internal into a skupper-router-common RPM subpackage, which will be then depended upon by both -tools and the main (skrouterd) subpackages. In qpid dispatch RPMs (in fedora, etc.) this dependency is not captured. You can do

[jdanek@fedora ~]$ sudo dnf install qpid-dispatch-tools
Last metadata expiration check: 2:01:44 ago on Sat 30 Apr 2022 02:15:06 PM CEST.
Dependencies resolved.
=============================================================================================================================================================================
 Package                                          Architecture                        Version                                      Repository                           Size
=============================================================================================================================================================================
Installing:
 qpid-dispatch-tools                              noarch                              1.18.0-3.fc36                                fedora                               28 k
Installing dependencies:
 python3-qpid-proton                              x86_64                              0.37.0-1.fc36                                fedora                              466 k
 qpid-proton-c                                    x86_64                              0.37.0-1.fc36                                fedora                              281 k

Transaction Summary
=============================================================================================================================================================================
Install  3 Packages

Total download size: 774 k
Installed size: 3.6 M
Is this ok [y/N]: y
Downloading Packages:
(1/3): qpid-dispatch-tools-1.18.0-3.fc36.noarch.rpm                                                                                          173 kB/s |  28 kB     00:00    
(2/3): python3-qpid-proton-0.37.0-1.fc36.x86_64.rpm                                                                                          916 kB/s | 466 kB     00:00    
(3/3): qpid-proton-c-0.37.0-1.fc36.x86_64.rpm                                                                                                318 kB/s | 281 kB     00:00    
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Total                                                                                                                                        350 kB/s | 774 kB     00:02     
Running transaction check
Transaction check succeeded.
Running transaction test
Transaction test succeeded.
Running transaction
  Preparing        :                                                                                                                                                     1/1 
  Installing       : qpid-proton-c-0.37.0-1.fc36.x86_64                                                                                                                  1/3 
  Installing       : python3-qpid-proton-0.37.0-1.fc36.x86_64                                                                                                            2/3 
  Installing       : qpid-dispatch-tools-1.18.0-3.fc36.noarch                                                                                                            3/3 
  Running scriptlet: qpid-dispatch-tools-1.18.0-3.fc36.noarch                                                                                                            3/3 
  Verifying        : python3-qpid-proton-0.37.0-1.fc36.x86_64                                                                                                            1/3 
  Verifying        : qpid-dispatch-tools-1.18.0-3.fc36.noarch                                                                                                            2/3 
  Verifying        : qpid-proton-c-0.37.0-1.fc36.x86_64                                                                                                                  3/3 

Installed:
  python3-qpid-proton-0.37.0-1.fc36.x86_64                   qpid-dispatch-tools-1.18.0-3.fc36.noarch                   qpid-proton-c-0.37.0-1.fc36.x86_64                  

Complete!
[jdanek@fedora ~]$ qdmanage --help
Traceback (most recent call last):
  File "/usr/bin/qdmanage", line 27, in <module>
    import qpid_dispatch_site  # noqa: F401 # imported for side-effects (inserts to sys.path)
ModuleNotFoundError: No module named 'qpid_dispatch_site'

So, actually, there is a bug there for @mcressman, @kpvdr or irina, whoever manages the dispatch packages now.