Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement the ability to parse setup.py requirements #182

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion pyup/requirements.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ def __init__(self, path, content, sha=None):
self._is_valid = None

def __str__(self):
return "RequirementFile(path='{path}', sha='{sha}', content='{content}')".format(
return "{klass}(path='{path}', sha='{sha}', content='{content}')".format(
klass=self.__class__.__name__,
path=self.path,
content=self.content[:30] + "[truncated]" if len(self.content) > 30 else self.content,
sha=self.sha
Expand Down Expand Up @@ -229,6 +230,34 @@ def get_requirement_class(self): # pragma: no cover
return Requirement


class SetupPyFile(RequirementFile):
def _parse(self):
self._requirements, self._other_files = [], []

Klass = self.get_requirement_class()

def setup(*args, **kwargs):
reqs = kwargs.get('install_requires', []) + kwargs.get('tests_require', [])

for num, line in enumerate(reqs):
req = Klass.parse(line, num)

if req.package:
self._requirements.append(req)

try:
module = __import__('setuptools')
except ImportError:
module = __import__('distutils.core')

old_setup = module.setup
module.setup = setup

exec(self.content, globals())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm afraid we can't to that as it allows to execute arbitrary python :(

The code runs on pyup.io and if someone crafts a setup.py that runs some malicious python code, he/she can basically take over the service.


module.setup = old_setup


class Requirement(object):
def __init__(self, name, specs, hashCmp, line, lineno, extras):
self.name = name
Expand Down
42 changes: 41 additions & 1 deletion tests/test_requirements.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from unittest import TestCase
from pyup.requirements import Requirement
from mock import patch, PropertyMock, Mock
from pyup.requirements import RequirementFile, RequirementsBundle
from pyup.requirements import RequirementFile, RequirementsBundle, SetupPyFile
from .test_package import package_factory
from .test_pullrequest import pullrequest_factory
import requests_mock
Expand Down Expand Up @@ -891,3 +891,43 @@ def test_requirements(self):
[r for r in reqs.requirements]
)


class SetupPyFileTestCase(TestCase):
def setUp(self):
with open(os.path.join(os.path.dirname(__file__), '..', 'setup.py')) as f:
self.content = f.read()

def test_parse(self):
assertion = AssertionError('setup function should not have been called')
requirements = [
"requests",
"pygithub",
"click",
"tqdm",
"pyyaml",
"hashin",
] + [
"requests-mock",
"mock",
"flake8"
]

req = SetupPyFile('setup.py', self.content)

def req_requirements():
return sorted(r.name for r in req.requirements)

try:
with patch('setuptools.setup', side_effect=assertion):
self.assertListEqual(req_requirements(), sorted(requirements))
except ImportError:
pass
else:
return

with patch('distutils.core.setup', side_effect=assertion):
self.assertListEqual(req_requirements(), sorted(requirements))

def test_str(self):
req = SetupPyFile('setup.py', self.content)
self.assertEqual(str(req), "SetupPyFile(path='setup.py', sha='None', content='#!/usr/bin/env python\n# -*- co[truncated]')")