License Management - support python modules not loaded via requirements.txt
Summary
Ticket (internal link) raised by customer reporting that the License Management pipeline item doesn't detect any licenses for modules loaded other than via requirements.txt
Customer is using setup.py
(stackoverflow)
Packages and their dependencies loaded this way don't show up on licenses page.
Currently License Finder only support parsing the requirements.txt
file for Python projects. There is currently an open issue in that project for adding support parsing setup.py.
Customer suggested the following workaround, noting:
- egg info could be generated via python instead of needing to parse it
- saved to a script that is called from SETUP_CMD
#!/bin/sh -x
# first install everything
pip install -r requirements.txt --prefer-binary
# now set up the extra stuff
python setup.py egg_info
python -c "from pkg_resources import Distribution, PathMetadata;dist = Distribution(metadata=PathMetadata('*.egg-info/.', '*.egg-info/.'));import os;print(os.linesep.join(str(r) for r in dist.requires()));" | tee -a requirements.txt
Steps to reproduce
(How one can reproduce the issue - this is very important)
Example Project
(If possible, please create an example project here on GitLab.com that exhibits the problematic behavior, and link to it here in the bug report)
(If you are using an older version of GitLab, this will also determine whether the bug is fixed in a more recent version)
What is the current bug behavior?
(What actually happens)
What is the expected correct behavior?
(What you should see instead)
Relevant logs and/or screenshots
(Paste any relevant logs - please use code blocks (```) to format console output, logs, and code as it's tough to read otherwise.)
Output of checks
(If you are reporting a bug on GitLab.com, write: This bug happens on GitLab.com)
Results of GitLab environment info
Expand for output related to GitLab environment info
(For installations with omnibus-gitlab package run and paste the output of:
sudo gitlab-rake gitlab:env:info
)(For installations from source run and paste the output of:
sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
)
Results of GitLab application Check
Expand for output related to the GitLab application check
(For installations with omnibus-gitlab package run and paste the output of:
sudo gitlab-rake gitlab:check SANITIZE=true
)(For installations from source run and paste the output of:
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production SANITIZE=true
)(we will only investigate if the tests are passing)
Possible fixes
(If you can, link to the line of code that might be responsible for the problem)