requirements/update.py
Sean Dague f7fbf480da one global-requirements.txt to rule them all
... and in the darkness bind them.

This moves the contents of requirements.txt and
test-requirements.txt to a single file, global-requirements.txt.
This means that regardless of whether a requirement is in
either file it will get checked. This massively simplifies the
checking and upgrading of req and test-req files.

This also adds in a unit testing framework for the update.py
script to ensure it does what we think it does. This is
accomplished by making a fake tree with a set of req and test-req
files, running update.py, and ensuring the updates were made
that we expected. It includes testing for the oslo url case,
as well as test-requires.

Change-Id: Ib9b86ade4cb8317509e218aec31f32e5d08f4035
2013-08-02 13:13:57 -04:00

118 lines
3.1 KiB
Python

# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright 2012 OpenStack, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
r"""
A simple script to update the requirements files from a global set of
allowable requirements.
The script can be called like this:
$> python update.py ../myproj
Any requirements listed in the target files will have their versions
updated to match the global requirements. Requirements not in the global
files will be dropped.
"""
import os
import os.path
import sys
from pip import req
def _parse_pip(pip):
install_require = req.InstallRequirement.from_line(pip)
if install_require.editable:
return pip
elif install_require.url:
return pip
else:
return install_require.req.key
def _pass_through(pip):
return (not pip or
pip.startswith('#') or
pip.startswith('http://tarballs.openstack.org/') or
pip.startswith('-e') or
pip.startswith('-f'))
def _parse_reqs(filename):
reqs = dict()
pip_requires = open(filename, "r").readlines()
for pip in pip_requires:
pip = pip.strip()
if _pass_through(pip):
continue
reqs[_parse_pip(pip)] = pip
return reqs
def _sync_requirements_file(source_reqs, dest_path):
dest_reqs = []
with open(dest_path, 'r') as dest_reqs_file:
dest_reqs = dest_reqs_file.readlines()
print "Syncing %s" % dest_path
with open(dest_path, 'w') as new_reqs:
for old_line in dest_reqs:
old_require = old_line.strip()
if _pass_through(old_require):
new_reqs.write(old_line)
continue
old_pip = _parse_pip(old_require.lower())
# Special cases:
# projects need to align pep8 version on their own time
if "pep8" in old_pip:
new_reqs.write(old_line)
continue
if old_pip in source_reqs:
new_reqs.write("%s\n" % source_reqs[old_pip])
def _copy_requires(source_path, dest_dir):
"""Copy requirements files."""
source_reqs = _parse_reqs(source_path)
target_files = (
'requirements.txt', 'tools/pip-requires',
'test-requirements.txt', 'tools/test-requires')
for dest in target_files:
dest_path = os.path.join(dest_dir, dest)
if os.path.exists(dest_path):
print "_sync_requirements_file(%s, %s)" % (source_reqs, dest_path)
_sync_requirements_file(source_reqs, dest_path)
def main(argv):
_copy_requires('global-requirements.txt', argv[0])
if __name__ == "__main__":
main(sys.argv[1:])