390 lines
15 KiB
Python
390 lines
15 KiB
Python
# Copyright (c) 2011 OpenStack Foundation
|
|
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
from __future__ import print_function
|
|
|
|
import os
|
|
import sys
|
|
import tempfile
|
|
|
|
try:
|
|
import cStringIO as io
|
|
BytesIO = io.StringIO
|
|
except ImportError:
|
|
import io
|
|
BytesIO = io.BytesIO
|
|
|
|
import fixtures
|
|
import testscenarios
|
|
|
|
from pbr import git
|
|
from pbr import options
|
|
from pbr import packaging
|
|
from pbr.tests import base
|
|
|
|
|
|
class SkipFileWrites(base.BaseTestCase):
|
|
|
|
scenarios = [
|
|
('changelog_option_true',
|
|
dict(option_key='skip_changelog', option_value='True',
|
|
env_key='SKIP_WRITE_GIT_CHANGELOG', env_value=None,
|
|
pkg_func=git.write_git_changelog, filename='ChangeLog')),
|
|
('changelog_option_false',
|
|
dict(option_key='skip_changelog', option_value='False',
|
|
env_key='SKIP_WRITE_GIT_CHANGELOG', env_value=None,
|
|
pkg_func=git.write_git_changelog, filename='ChangeLog')),
|
|
('changelog_env_true',
|
|
dict(option_key='skip_changelog', option_value='False',
|
|
env_key='SKIP_WRITE_GIT_CHANGELOG', env_value='True',
|
|
pkg_func=git.write_git_changelog, filename='ChangeLog')),
|
|
('changelog_both_true',
|
|
dict(option_key='skip_changelog', option_value='True',
|
|
env_key='SKIP_WRITE_GIT_CHANGELOG', env_value='True',
|
|
pkg_func=git.write_git_changelog, filename='ChangeLog')),
|
|
('authors_option_true',
|
|
dict(option_key='skip_authors', option_value='True',
|
|
env_key='SKIP_GENERATE_AUTHORS', env_value=None,
|
|
pkg_func=git.generate_authors, filename='AUTHORS')),
|
|
('authors_option_false',
|
|
dict(option_key='skip_authors', option_value='False',
|
|
env_key='SKIP_GENERATE_AUTHORS', env_value=None,
|
|
pkg_func=git.generate_authors, filename='AUTHORS')),
|
|
('authors_env_true',
|
|
dict(option_key='skip_authors', option_value='False',
|
|
env_key='SKIP_GENERATE_AUTHORS', env_value='True',
|
|
pkg_func=git.generate_authors, filename='AUTHORS')),
|
|
('authors_both_true',
|
|
dict(option_key='skip_authors', option_value='True',
|
|
env_key='SKIP_GENERATE_AUTHORS', env_value='True',
|
|
pkg_func=git.generate_authors, filename='AUTHORS')),
|
|
]
|
|
|
|
def setUp(self):
|
|
super(SkipFileWrites, self).setUp()
|
|
self.temp_path = self.useFixture(fixtures.TempDir()).path
|
|
self.root_dir = os.path.abspath(os.path.curdir)
|
|
self.git_dir = os.path.join(self.root_dir, ".git")
|
|
if not os.path.exists(self.git_dir):
|
|
self.skipTest("%s is missing; skipping git-related checks"
|
|
% self.git_dir)
|
|
return
|
|
self.filename = os.path.join(self.temp_path, self.filename)
|
|
self.option_dict = dict()
|
|
if self.option_key is not None:
|
|
self.option_dict[self.option_key] = ('setup.cfg',
|
|
self.option_value)
|
|
self.useFixture(
|
|
fixtures.EnvironmentVariable(self.env_key, self.env_value))
|
|
|
|
def test_skip(self):
|
|
self.pkg_func(git_dir=self.git_dir,
|
|
dest_dir=self.temp_path,
|
|
option_dict=self.option_dict)
|
|
self.assertEqual(
|
|
not os.path.exists(self.filename),
|
|
(self.option_value.lower() in options.TRUE_VALUES
|
|
or self.env_value is not None))
|
|
|
|
_changelog_content = """04316fe (review/monty_taylor/27519) Make python
|
|
378261a Add an integration test script.
|
|
3c373ac (HEAD, tag: 2013.2.rc2, tag: 2013.2, milestone-proposed) Merge "Lib
|
|
182feb3 (tag: 0.5.17) Fix pip invocation for old versions of pip.
|
|
fa4f46e (tag: 0.5.16) Remove explicit depend on distribute.
|
|
d1c53dd Use pip instead of easy_install for installation.
|
|
a793ea1 Merge "Skip git-checkout related tests when .git is missing"
|
|
6c27ce7 Skip git-checkout related tests when .git is missing
|
|
04984a5 Refactor hooks file.
|
|
a65e8ee (tag: 0.5.14, tag: 0.5.13) Remove jinja pin.
|
|
"""
|
|
|
|
|
|
class GitLogsTest(base.BaseTestCase):
|
|
|
|
def setUp(self):
|
|
super(GitLogsTest, self).setUp()
|
|
self.temp_path = self.useFixture(fixtures.TempDir()).path
|
|
self.root_dir = os.path.abspath(os.path.curdir)
|
|
self.git_dir = os.path.join(self.root_dir, ".git")
|
|
self.useFixture(
|
|
fixtures.EnvironmentVariable('SKIP_GENERATE_AUTHORS'))
|
|
self.useFixture(
|
|
fixtures.EnvironmentVariable('SKIP_WRITE_GIT_CHANGELOG'))
|
|
|
|
def test_write_git_changelog(self):
|
|
self.useFixture(fixtures.FakePopen(lambda _: {
|
|
"stdout": BytesIO(_changelog_content.encode('utf-8'))
|
|
}))
|
|
|
|
git.write_git_changelog(git_dir=self.git_dir,
|
|
dest_dir=self.temp_path)
|
|
|
|
with open(os.path.join(self.temp_path, "ChangeLog"), "r") as ch_fh:
|
|
changelog_contents = ch_fh.read()
|
|
self.assertIn("2013.2", changelog_contents)
|
|
self.assertIn("0.5.17", changelog_contents)
|
|
self.assertIn("------", changelog_contents)
|
|
self.assertIn("Refactor hooks file", changelog_contents)
|
|
self.assertNotIn("Refactor hooks file.", changelog_contents)
|
|
self.assertNotIn("182feb3", changelog_contents)
|
|
self.assertNotIn("review/monty_taylor/27519", changelog_contents)
|
|
self.assertNotIn("0.5.13", changelog_contents)
|
|
self.assertNotIn('Merge "', changelog_contents)
|
|
|
|
def test_generate_authors(self):
|
|
author_old = u"Foo Foo <email@foo.com>"
|
|
author_new = u"Bar Bar <email@bar.com>"
|
|
co_author = u"Foo Bar <foo@bar.com>"
|
|
co_author_by = u"Co-authored-by: " + co_author
|
|
|
|
git_log_cmd = (
|
|
"git --git-dir=%s log --format=%%aN <%%aE>"
|
|
% self.git_dir)
|
|
git_co_log_cmd = ("git --git-dir=%s log" % self.git_dir)
|
|
git_top_level = "git rev-parse --show-toplevel"
|
|
cmd_map = {
|
|
git_log_cmd: author_new,
|
|
git_co_log_cmd: co_author_by,
|
|
git_top_level: self.root_dir,
|
|
}
|
|
|
|
exist_files = [self.git_dir,
|
|
os.path.join(self.temp_path, "AUTHORS.in")]
|
|
self.useFixture(fixtures.MonkeyPatch(
|
|
"os.path.exists",
|
|
lambda path: os.path.abspath(path) in exist_files))
|
|
|
|
def _fake_run_shell_command(cmd, **kwargs):
|
|
return cmd_map[" ".join(cmd)]
|
|
|
|
self.useFixture(fixtures.MonkeyPatch(
|
|
"pbr.git._run_shell_command",
|
|
_fake_run_shell_command))
|
|
|
|
with open(os.path.join(self.temp_path, "AUTHORS.in"), "w") as auth_fh:
|
|
auth_fh.write("%s\n" % author_old)
|
|
|
|
git.generate_authors(git_dir=self.git_dir,
|
|
dest_dir=self.temp_path)
|
|
|
|
with open(os.path.join(self.temp_path, "AUTHORS"), "r") as auth_fh:
|
|
authors = auth_fh.read()
|
|
self.assertTrue(author_old in authors)
|
|
self.assertTrue(author_new in authors)
|
|
self.assertTrue(co_author in authors)
|
|
|
|
|
|
class BuildSphinxTest(base.BaseTestCase):
|
|
|
|
scenarios = [
|
|
('true_autodoc_caps',
|
|
dict(has_opt=True, autodoc='True', has_autodoc=True)),
|
|
('true_autodoc_caps_with_excludes',
|
|
dict(has_opt=True, autodoc='True', has_autodoc=True,
|
|
excludes="fake_package.fake_private_module\n"
|
|
"fake_package.unknown_module")),
|
|
('true_autodoc_lower',
|
|
dict(has_opt=True, autodoc='true', has_autodoc=True)),
|
|
('false_autodoc',
|
|
dict(has_opt=True, autodoc='False', has_autodoc=False)),
|
|
('no_autodoc',
|
|
dict(has_opt=False, autodoc='False', has_autodoc=False)),
|
|
]
|
|
|
|
def setUp(self):
|
|
super(BuildSphinxTest, self).setUp()
|
|
|
|
self.useFixture(fixtures.MonkeyPatch(
|
|
"sphinx.setup_command.BuildDoc.run", lambda self: None))
|
|
from distutils import dist
|
|
self.distr = dist.Distribution()
|
|
self.distr.packages = ("fake_package",)
|
|
self.distr.command_options["build_sphinx"] = {
|
|
"source_dir": ["a", "."]}
|
|
pkg_fixture = fixtures.PythonPackage(
|
|
"fake_package", [("fake_module.py", b""),
|
|
("fake_private_module.py", b"")])
|
|
self.useFixture(pkg_fixture)
|
|
self.useFixture(base.DiveDir(pkg_fixture.base))
|
|
self.distr.command_options["pbr"] = {}
|
|
if hasattr(self, "excludes"):
|
|
self.distr.command_options["pbr"]["autodoc_exclude_modules"] = (
|
|
'setup.cfg',
|
|
"fake_package.fake_private_module\n"
|
|
"fake_package.unknown_module")
|
|
if self.has_opt:
|
|
options = self.distr.command_options["pbr"]
|
|
options["autodoc_index_modules"] = ('setup.cfg', self.autodoc)
|
|
|
|
def test_build_doc(self):
|
|
build_doc = packaging.LocalBuildDoc(self.distr)
|
|
build_doc.run()
|
|
|
|
self.assertTrue(
|
|
os.path.exists("api/autoindex.rst") == self.has_autodoc)
|
|
self.assertTrue(
|
|
os.path.exists(
|
|
"api/fake_package.fake_module.rst") == self.has_autodoc)
|
|
if not self.has_autodoc or hasattr(self, "excludes"):
|
|
assertion = self.assertFalse
|
|
else:
|
|
assertion = self.assertTrue
|
|
assertion(
|
|
os.path.exists(
|
|
"api/fake_package.fake_private_module.rst"))
|
|
|
|
def test_builders_config(self):
|
|
build_doc = packaging.LocalBuildDoc(self.distr)
|
|
build_doc.finalize_options()
|
|
|
|
self.assertEqual(2, len(build_doc.builders))
|
|
self.assertIn('html', build_doc.builders)
|
|
self.assertIn('man', build_doc.builders)
|
|
|
|
build_doc = packaging.LocalBuildDoc(self.distr)
|
|
build_doc.builders = ''
|
|
build_doc.finalize_options()
|
|
|
|
self.assertEqual('', build_doc.builders)
|
|
|
|
build_doc = packaging.LocalBuildDoc(self.distr)
|
|
build_doc.builders = 'man'
|
|
build_doc.finalize_options()
|
|
|
|
self.assertEqual(1, len(build_doc.builders))
|
|
self.assertIn('man', build_doc.builders)
|
|
|
|
build_doc = packaging.LocalBuildDoc(self.distr)
|
|
build_doc.builders = 'html,man,doctest'
|
|
build_doc.finalize_options()
|
|
|
|
self.assertIn('html', build_doc.builders)
|
|
self.assertIn('man', build_doc.builders)
|
|
self.assertIn('doctest', build_doc.builders)
|
|
|
|
|
|
class ParseRequirementsTest(base.BaseTestCase):
|
|
|
|
def setUp(self):
|
|
super(ParseRequirementsTest, self).setUp()
|
|
(fd, self.tmp_file) = tempfile.mkstemp(prefix='openstack',
|
|
suffix='.setup')
|
|
|
|
def test_parse_requirements_normal(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("foo\nbar")
|
|
self.assertEqual(['foo', 'bar'],
|
|
packaging.parse_requirements([self.tmp_file]))
|
|
|
|
def test_parse_requirements_with_git_egg_url(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("-e git://foo.com/zipball#egg=bar")
|
|
self.assertEqual(['bar'],
|
|
packaging.parse_requirements([self.tmp_file]))
|
|
|
|
def test_parse_requirements_with_versioned_git_egg_url(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("-e git://foo.com/zipball#egg=bar-1.2.4")
|
|
self.assertEqual(['bar>=1.2.4'],
|
|
packaging.parse_requirements([self.tmp_file]))
|
|
|
|
def test_parse_requirements_with_http_egg_url(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("https://foo.com/zipball#egg=bar")
|
|
self.assertEqual(['bar'],
|
|
packaging.parse_requirements([self.tmp_file]))
|
|
|
|
def test_parse_requirements_with_versioned_http_egg_url(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("https://foo.com/zipball#egg=bar-4.2.1")
|
|
self.assertEqual(['bar>=4.2.1'],
|
|
packaging.parse_requirements([self.tmp_file]))
|
|
|
|
def test_parse_requirements_removes_index_lines(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("-f foobar")
|
|
self.assertEqual([], packaging.parse_requirements([self.tmp_file]))
|
|
|
|
def test_parse_requirements_override_with_env(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("foo\nbar")
|
|
self.useFixture(
|
|
fixtures.EnvironmentVariable('PBR_REQUIREMENTS_FILES',
|
|
self.tmp_file))
|
|
self.assertEqual(['foo', 'bar'],
|
|
packaging.parse_requirements())
|
|
|
|
def test_parse_requirements_override_with_env_multiple_files(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("foo\nbar")
|
|
self.useFixture(
|
|
fixtures.EnvironmentVariable('PBR_REQUIREMENTS_FILES',
|
|
"no-such-file," + self.tmp_file))
|
|
self.assertEqual(['foo', 'bar'],
|
|
packaging.parse_requirements())
|
|
|
|
def test_get_requirement_from_file_empty(self):
|
|
actual = packaging.get_reqs_from_files([])
|
|
self.assertEqual([], actual)
|
|
|
|
def test_parse_requirements_with_comments(self):
|
|
with open(self.tmp_file, 'w') as fh:
|
|
fh.write("# this is a comment\nfoobar\n# and another one\nfoobaz")
|
|
self.assertEqual(['foobar', 'foobaz'],
|
|
packaging.parse_requirements([self.tmp_file]))
|
|
|
|
def test_parse_requirements_python_version(self):
|
|
with open("requirements-py%d.txt" % sys.version_info[0],
|
|
"w") as fh:
|
|
fh.write("# this is a comment\nfoobar\n# and another one\nfoobaz")
|
|
self.assertEqual(['foobar', 'foobaz'],
|
|
packaging.parse_requirements())
|
|
|
|
def test_parse_requirements_right_python_version(self):
|
|
with open("requirements-py1.txt", "w") as fh:
|
|
fh.write("thisisatrap")
|
|
with open("requirements-py%d.txt" % sys.version_info[0],
|
|
"w") as fh:
|
|
fh.write("# this is a comment\nfoobar\n# and another one\nfoobaz")
|
|
self.assertEqual(['foobar', 'foobaz'],
|
|
packaging.parse_requirements())
|
|
|
|
|
|
class ParseDependencyLinksTest(base.BaseTestCase):
|
|
|
|
def setUp(self):
|
|
super(ParseDependencyLinksTest, self).setUp()
|
|
(fd, self.tmp_file) = tempfile.mkstemp(prefix="openstack",
|
|
suffix=".setup")
|
|
|
|
def test_parse_dependency_normal(self):
|
|
with open(self.tmp_file, "w") as fh:
|
|
fh.write("http://test.com\n")
|
|
self.assertEqual(
|
|
["http://test.com"],
|
|
packaging.parse_dependency_links([self.tmp_file]))
|
|
|
|
def test_parse_dependency_with_git_egg_url(self):
|
|
with open(self.tmp_file, "w") as fh:
|
|
fh.write("-e git://foo.com/zipball#egg=bar")
|
|
self.assertEqual(
|
|
["git://foo.com/zipball#egg=bar"],
|
|
packaging.parse_dependency_links([self.tmp_file]))
|
|
|
|
|
|
def load_tests(loader, in_tests, pattern):
|
|
return testscenarios.load_tests_apply_scenarios(loader, in_tests, pattern)
|