def search(
query: dict,
operation: str = None,
url: str = urljoin(config.INDEX_URL, 'pypi'),
) -> Dict[str, Any]:
'''Search PyPI for packages.'''
index = PackageIndex(url=url)
return index.search({k: v
for k, v in query.items() if v is not None},
operation)
def validate_requirements(request):
""" Verifies that a group of packages (with specific versions) exists on PyPI."""
reqs = request.GET.get("requirements", None)
reqs = json.loads(reqs)
index = PackageIndex()
results = {"errors": []}
for req in reqs:
name = req["name"]
version = req["version"]
search_params = {"name": name, "version": version}
search_results = index.search(search_params)
if len(search_results) == 0:
results["errors"].append(name)
return JsonResponse(results)
def search_package(request):
""" Full-text search of a package name in PyPI."""
name = request.GET.get("name", None)
if not name:
return JsonResponse({"error": "Please provide a name to search"})
search_params = {"name": name}
version = request.GET.get("version", None)
if version:
search_params["version"] = version
index = PackageIndex()
search_results = index.search(search_params)
results = {"search": name, "results": []}
for item in search_results:
results["results"].append(item)
return JsonResponse(results)
class PackageIndexTestCase(DistlibTestCase):
run_test_server = True
test_server_url = 'http://localhost:%s/' % TEST_SERVER_PORT
@classmethod
def setUpClass(cls):
if cls.run_test_server:
cls.server = None
server_script = os.path.join(HERE, 'pypi-server-standalone.py')
if not os.path.exists(server_script):
logger.debug('test server not available - some tests '
'will be skipped.')
return
pwdfn = os.path.join(HERE, 'passwords')
if not os.path.exists(pwdfn): # pragma: no cover
with open(pwdfn, 'w') as f:
f.write('test:secret\n')
pkgdir = os.path.join(HERE, 'packages')
if not os.path.isdir(pkgdir): # pragma: no cover
os.mkdir(pkgdir)
fd, cls.sinkfile = tempfile.mkstemp(suffix='.log',
prefix='distlib-pypi-')
os.close(fd)
cls.sink = sink = open(cls.sinkfile, 'w')
cmd = [
sys.executable, 'pypi-server-standalone.py', '--interface',
'127.0.0.1', '--port', TEST_SERVER_PORT, '-P', 'passwords',
'packages'
]
cls.server = subprocess.Popen(cmd,
stdout=sink,
stderr=sink,
cwd=HERE)
# wait for the server to start up
response = None
tries = 20
timeout = 0.5
count = 0
while response is None:
try:
count += 1
time.sleep(timeout)
response = urlopen(cls.test_server_url)
if response.getcode() != 200:
response = None
break
# In case some other server is listening on the same port ...
# need to check the actual response for pypiserver-specific content
data = response.read()
if b'Welcome to pypiserver!' not in data:
response = None
break
except URLError:
if count < tries:
pass
else:
break
if response is None or cls.server.poll() is not None:
logger.warning('PyPI test server could not be run')
cls.server = None
cls.sink.close()
os.remove(cls.sinkfile)
@classmethod
def tearDownClass(cls):
if cls.run_test_server:
if cls.server and cls.server.returncode is None:
cls.server.kill()
cls.server.wait()
cls.sink.close()
try:
os.remove(cls.sinkfile)
except:
logger.warning('Unable to remove test file %s',
cls.sinkfile)
def setUp(self):
if not self.run_test_server:
self.index = PackageIndex()
else:
self.index = PackageIndex(self.test_server_url)
self.index.username = '******'
self.index.password = '******'
def load_package_metadata(self, path):
result = None
for bn in (METADATA_FILENAME, 'package.json'):
fn = os.path.join(path, bn)
if os.path.exists(fn):
with codecs.open(fn, 'r', 'utf-8') as jf:
result = json.load(jf)
break
if not result:
raise ValueError('neither %s nor package.json '
'found in %s' % (METADATA_FILENAME, fn))
if bn == 'package.json':
result = result.get('index-metadata', {})
if result.get('metadata_version') != '2.0':
raise ValueError('Not a valid file: %s' % fn)
return result
def check_pypi_server_available(self):
if self.run_test_server and not self.server: # pragma: no cover
raise unittest.SkipTest('test server not available')
def check_testdist_available(self):
self.index.check_credentials()
self.username = self.index.username.replace('-', '_')
self.dist_project = '%s_testdist' % self.username
self.dist_version = '0.1'
self.testdir = '%s-%s' % (self.dist_project, self.dist_version)
destdir = os.path.join(HERE, self.testdir)
if not os.path.isdir(destdir): # pragma: no cover
srcdir = os.path.join(HERE, 'testdist-0.1')
shutil.copytree(srcdir, destdir)
for fn in os.listdir(destdir):
fn = os.path.join(destdir, fn)
if os.path.isfile(fn):
with codecs.open(fn, 'r', 'utf-8') as f:
data = f.read()
data = data.format(username=self.username)
with codecs.open(fn, 'w', 'utf-8') as f:
f.write(data)
zip_data = zip_dir(destdir).getvalue()
zip_name = destdir + '.zip'
with open(zip_name, 'wb') as f:
f.write(zip_data)
@unittest.skip('The PyPI API changed, so this test is temporarily skipped')
def test_register(self):
"Test registration"
self.check_pypi_server_available()
self.check_testdist_available()
d = os.path.join(HERE, self.testdir)
data = self.load_package_metadata(d)
md = Metadata()
self.assertRaises(MetadataMissingError, self.index.register, md)
md.name = self.dist_project
self.assertRaises(MetadataMissingError, self.index.register, md)
md.version = data['version']
md.summary = data['summary']
response = self.index.register(md)
self.assertEqual(response.code, 200)
def remove_package(self, name, version):
"""
Remove package. Only works with test server; PyPI would require
some scraping to get CSRF tokens into the request.
"""
d = {
':action': 'remove_pkg',
'name': name,
'version': version,
'submit_remove': 'Remove',
'submit_ok': 'OK',
}
self.index.check_credentials()
request = self.index.encode_request(d.items(), [])
try:
response = self.index.send_request(request)
except HTTPError as e:
if e.getcode() != 404:
raise
@unittest.skip('The PyPI API changed, so this test is temporarily skipped')
def test_upload(self):
"Test upload"
self.check_pypi_server_available()
self.check_testdist_available()
if self.run_test_server:
self.remove_package(self.dist_project, self.dist_version)
d = os.path.join(HERE, self.testdir)
data = self.load_package_metadata(d)
md = Metadata(mapping=data)
self.index.gpg_home = os.path.join(HERE, 'keys')
try:
zip_name = os.path.join(HERE, '%s.zip' % self.testdir)
self.assertRaises(DistlibException, self.index.upload_file, md,
'random-' + zip_name, 'Test User', 'tuser')
response = self.index.upload_file(md, zip_name, 'Test User',
'tuser')
self.assertEqual(response.code, 200)
if self.run_test_server:
fn = os.path.join(HERE, 'packages', os.path.basename(zip_name))
self.assertTrue(os.path.exists(fn))
except HTTPError as e:
# Treat as success if it already exists
if e.getcode() != 400 or 'already exists' not in e.msg:
raise
def test_upload_documentation(self):
"Test upload of documentation"
raise unittest.SkipTest('Skipped, as pythonhosted.org is being '
'de-emphasised and this functionality may '
'no longer be available')
self.check_pypi_server_available()
self.check_testdist_available()
d = os.path.join(HERE, self.testdir)
data = self.load_package_metadata(d)
md = Metadata(mapping=data)
d = os.path.join(d, 'doc')
# Non-existent directory
self.assertRaises(DistlibException, self.index.upload_documentation,
md, d + '-random')
# Directory with no index.html
self.assertRaises(DistlibException, self.index.upload_documentation,
md, HERE)
response = self.index.upload_documentation(md, d)
self.assertEqual(response.code, 200)
if not self.run_test_server:
url = 'http://packages.python.org/%s/' % self.dist_project
response = urlopen(url)
self.assertEqual(response.code, 200)
data = response.read()
expected = b'This is dummy documentation'
self.assertIn(expected, data)
def test_verify_signature(self):
if not self.index.gpg: # pragma: no cover
raise unittest.SkipTest('gpg not available')
sig_file = os.path.join(HERE, 'good.bin.asc')
good_file = os.path.join(HERE, 'good.bin')
bad_file = os.path.join(HERE, 'bad.bin')
gpg = self.index.gpg
self.index.gpg = None
self.assertRaises(DistlibException, self.index.verify_signature,
sig_file, good_file)
self.index.gpg = gpg
# Not pointing to keycd tests
self.assertRaises(DistlibException, self.index.verify_signature,
sig_file, good_file)
self.index.gpg_home = os.path.join(HERE, 'keys')
self.assertTrue(self.index.verify_signature(sig_file, good_file))
self.assertFalse(self.index.verify_signature(sig_file, bad_file))
def test_invalid(self):
self.assertRaises(DistlibException, PackageIndex,
'ftp://ftp.python.org/')
self.index.username = None
self.assertRaises(DistlibException, self.index.check_credentials)
@unittest.skipIf(PYPIRC is None or os.path.exists(PYPIRC),
'because $HOME/.pypirc is unavailable for use')
def test_save_configuration(self):
try:
self.index.save_configuration()
self.assertTrue(os.path.exists(PYPIRC))
finally:
os.remove(PYPIRC)
if ssl:
def make_https_server(self, certfile):
server = HTTPSServerThread(certfile)
flag = threading.Event()
server.start(flag)
flag.wait()
def cleanup():
server.stop()
server.join()
self.addCleanup(cleanup)
return server
def test_ssl_verification(self):
certfile = os.path.join(HERE, 'keycert.pem')
server = self.make_https_server(certfile)
url = 'https://*****:*****@unittest.skipIf('SKIP_ONLINE' in os.environ, 'Skipping online test')
@unittest.skipUnless(ssl, 'SSL required for this test.')
@unittest.skipIf(True, 'skipping due to temporary changes in PyPI')
def test_search(self):
self.index = PackageIndex()
result = self.index.search({'name': 'tatterdemalion'})
self.assertEqual(len(result), 1)
result = self.index.search({'name': 'ragamuff'})
if result:
msg = 'got an unexpected result: %s' % result
else:
msg = None
self.assertEqual(len(result), 0, msg)
from git import *
from pony.orm import *
from distlib.index import PackageIndex
from natsort import natsorted
from .__version__ import __version__
# ----------------------------------------------------------------------------
try:
index = PackageIndex()
info = index.search('agda-pkg')
versions = natsorted([e["version"] for e in info if e["name"] == "agda-pkg"])
if len(versions) > 0:
lastversion = versions[-1]
msg = "Your Agda-Pkg version is {cversion}, however version {lversion} is available.\n" + \
"Consider upgrading via 'pip install --upgrade agda-pkg'."
msg = msg.format(cversion = __version__ , lversion = lastversion)
orden = [lastversion, __version__]
if orden != natsorted(orden):
click.echo(click.style(msg, fg='yellow', bold=True))
# Check if the index is updated.
from .config import REPO
class PackageIndexTestCase(unittest.TestCase):
run_test_server = True
test_server_url = 'http://localhost:8080/'
@classmethod
def setUpClass(cls):
if cls.run_test_server:
cls.server = None
server_script = os.path.join(HERE, 'pypi-server-standalone.py')
if not os.path.exists(server_script):
logger.debug('test server not available - some tests '
'will be skipped.')
return
pwdfn = os.path.join(HERE, 'passwords')
if not os.path.exists(pwdfn): # pragma: no cover
with open(pwdfn, 'w') as f:
f.write('test:secret\n')
pkgdir = os.path.join(HERE, 'packages')
if not os.path.isdir(pkgdir): # pragma: no cover
os.mkdir(pkgdir)
cls.sink = sink = open(os.devnull, 'w')
cmd = [sys.executable, 'pypi-server-standalone.py',
'-P', 'passwords', 'packages']
cls.server = subprocess.Popen(cmd, stdout=sink, stderr=sink,
cwd=HERE)
# wait for the server to start up
response = None
while response is None:
try:
response = urlopen(cls.test_server_url)
except URLError:
pass
@classmethod
def tearDownClass(cls):
if cls.run_test_server:
if cls.server and cls.server.returncode is None:
cls.server.kill()
cls.sink.close()
def setUp(self):
if not self.run_test_server:
self.index = PackageIndex()
else:
self.index = PackageIndex(self.test_server_url)
self.index.username = '******'
self.index.password = '******'
def load_package_metadata(self, path):
result = None
for bn in (METADATA_FILENAME, 'package.json'):
fn = os.path.join(path, bn)
if os.path.exists(fn):
with codecs.open(fn, 'r', 'utf-8') as jf:
result = json.load(jf)
break
if not result:
raise ValueError('neither %s nor package.json '
'found in %s' % (METADATA_FILENAME, fn))
if bn == 'package.json':
result = result.get('index-metadata', {})
if result.get('metadata_version') != '2.0':
raise ValueError('Not a valid file: %s' % fn)
return result
def check_pypi_server_available(self):
if self.run_test_server and not self.server: # pragma: no cover
raise unittest.SkipTest('test server not available')
def check_testdist_available(self):
self.index.check_credentials()
self.username = self.index.username.replace('-', '_')
self.dist_project = '%s_testdist' % self.username
self.dist_version = '0.1'
self.testdir = '%s-%s' % (self.dist_project, self.dist_version)
destdir = os.path.join(HERE, self.testdir)
if not os.path.isdir(destdir): # pragma: no cover
srcdir = os.path.join(HERE, 'testdist-0.1')
shutil.copytree(srcdir, destdir)
for fn in os.listdir(destdir):
fn = os.path.join(destdir, fn)
if os.path.isfile(fn):
with codecs.open(fn, 'r', 'utf-8') as f:
data = f.read()
data = data.format(username=self.username)
with codecs.open(fn, 'w', 'utf-8') as f:
f.write(data)
zip_data = zip_dir(destdir).getvalue()
zip_name = destdir + '.zip'
with open(zip_name, 'wb') as f:
f.write(zip_data)
def test_register(self):
"Test registration"
self.check_pypi_server_available()
self.check_testdist_available()
d = os.path.join(HERE, self.testdir)
data = self.load_package_metadata(d)
md = Metadata()
self.assertRaises(MetadataMissingError, self.index.register, md)
md.name = self.dist_project
self.assertRaises(MetadataMissingError, self.index.register, md)
md.version = data['version']
md.summary = data['summary']
response = self.index.register(md)
self.assertEqual(response.code, 200)
def remove_package(self, name, version):
"""
Remove package. Only works with test server; PyPI would require
some scraping to get CSRF tokens into the request.
"""
d = {
':action': 'remove_pkg',
'name': name,
'version': version,
'submit_remove': 'Remove',
'submit_ok': 'OK',
}
self.index.check_credentials()
request = self.index.encode_request(d.items(), [])
try:
response = self.index.send_request(request)
except HTTPError as e:
if e.getcode() != 404:
raise
def test_upload(self):
"Test upload"
self.check_pypi_server_available()
self.check_testdist_available()
if self.run_test_server:
self.remove_package(self.dist_project, self.dist_version)
d = os.path.join(HERE, self.testdir)
data = self.load_package_metadata(d)
md = Metadata(mapping=data)
self.index.gpg_home = os.path.join(HERE, 'keys')
try:
zip_name = os.path.join(HERE, '%s.zip' % self.testdir)
self.assertRaises(DistlibException, self.index.upload_file, md,
'random-' + zip_name, 'Test User', 'tuser')
response = self.index.upload_file(md, zip_name,
'Test User', 'tuser')
self.assertEqual(response.code, 200)
if self.run_test_server:
fn = os.path.join(HERE, 'packages', os.path.basename(zip_name))
self.assertTrue(os.path.exists(fn))
except HTTPError as e:
# Treat as success if it already exists
if e.getcode() != 400 or 'already exists' not in e.msg:
raise
def test_upload_documentation(self):
"Test upload of documentation"
raise unittest.SkipTest('Skipped, as pythonhosted.org is being '
'de-emphasised and this functionality may '
'no longer be available')
self.check_pypi_server_available()
self.check_testdist_available()
d = os.path.join(HERE, self.testdir)
data = self.load_package_metadata(d)
md = Metadata(mapping=data)
d = os.path.join(d, 'doc')
# Non-existent directory
self.assertRaises(DistlibException, self.index.upload_documentation,
md, d+'-random')
# Directory with no index.html
self.assertRaises(DistlibException, self.index.upload_documentation,
md, HERE)
response = self.index.upload_documentation(md, d)
self.assertEqual(response.code, 200)
if not self.run_test_server:
url = 'http://packages.python.org/%s/' % self.dist_project
response = urlopen(url)
self.assertEqual(response.code, 200)
data = response.read()
expected = b'This is dummy documentation'
self.assertIn(expected, data)
def test_verify_signature(self):
if not self.index.gpg: # pragma: no cover
raise unittest.SkipTest('gpg not available')
sig_file = os.path.join(HERE, 'good.bin.asc')
good_file = os.path.join(HERE, 'good.bin')
bad_file = os.path.join(HERE, 'bad.bin')
gpg = self.index.gpg
self.index.gpg = None
self.assertRaises(DistlibException, self.index.verify_signature,
sig_file, good_file)
self.index.gpg = gpg
# Not pointing to keycd tests
self.assertRaises(DistlibException, self.index.verify_signature,
sig_file, good_file)
self.index.gpg_home = os.path.join(HERE, 'keys')
self.assertTrue(self.index.verify_signature(sig_file, good_file))
self.assertFalse(self.index.verify_signature(sig_file, bad_file))
def test_invalid(self):
self.assertRaises(DistlibException, PackageIndex,
'ftp://ftp.python.org/')
self.index.username = None
self.assertRaises(DistlibException, self.index.check_credentials)
@unittest.skipIf(PYPIRC is None or os.path.exists(PYPIRC),
'because $HOME/.pypirc is unavailable for use')
def test_save_configuration(self):
try:
self.index.save_configuration()
self.assertTrue(os.path.exists(PYPIRC))
finally:
os.remove(PYPIRC)
def make_https_server(self, certfile):
server = HTTPSServerThread(certfile)
flag = threading.Event()
server.start(flag)
flag.wait()
def cleanup():
server.stop()
server.join()
self.addCleanup(cleanup)
return server
def test_ssl_verification(self):
certfile = os.path.join(HERE, 'keycert.pem')
server = self.make_https_server(certfile)
url = 'https://*****:*****@unittest.skipIf('SKIP_ONLINE' in os.environ, 'Skipping online test')
def test_search(self):
self.index = PackageIndex()
result = self.index.search({'name': 'tatterdema'})
self.assertEqual(len(result), 1)
result = self.index.search({'name': 'ragamuff'})
self.assertEqual(len(result), 0)