search

aquasecurity / kube-hunter

Hunt for security weaknesses in Kubernetes clusters
Apache License 2.0
4.65k stars 578 forks source link

packaging issue: deployment of tests #537

Open noraj opened 1 year ago

noraj commented 1 year ago

What happened

The issue is that the setup.py is deploying the tests folder under the root python path and not under this package one.

So it's end up under /usr/lib/python3.11/site-packages/tests rather than /usr/lib/python3.11/site-packages/kube-hunter/tests and so conflicts with other packages having the same issue.

Anyway usually test are not shipped in a release package so the easiest would just to remove them. Else they should be deployed in the children directory.

It's explained in ArchLinux packaging guidelines for Python: https://wiki.archlinux.org/title/Python_package_guidelines#Test_directory_in_site-package

Expected behavior

No file deployed on the root python path.

noraj commented 1 year ago

Usually this fix in setup.py is enough:

-packages=find_packages(),
+packages=find_packages(exclude=["tests*"]),

But this method is not used here, so I won't PR as I don't know what's required to exclude the tests folder in this case.