Initial pass at creating dedicated fixture

Start process of separating the code around building
git repos easily into a dedicate git fixture to make
it easier to reuse across testing applications and
scripts that interact with Git.

Change-Id: I5b39f8d52beca848adb20d646c26d91c4b977b92
This commit is contained in:
Darragh Bailey 2018-03-10 11:17:45 +00:00 committed by Darragh Bailey
parent ee5bed4bf5
commit 20f8c0c471
8 changed files with 731 additions and 0 deletions

107
.gitignore vendored Normal file
View File

@ -0,0 +1,107 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
# auto-generated files by pbr
AUTHORS

11
DESCRIPTION Normal file
View File

@ -0,0 +1,11 @@
- What is fixtures-git?
It is a small library that can be used with fixtures
(https://pypi.python.org/pypi/fixtures) to quickly build git
repositories from a list defined in python (typically loaded from a
yaml file) to be used to test behaviour of python tools that use git.
While it's common to isolate code from other tools, given git's speed
and sometimes difficultly in being sure as to what would be the exact
behaviour, it is much more robust to use functional tests to test with
git repositories examples instead of trying to mock git's behaviour.

175
LICENSE Normal file
View File

@ -0,0 +1,175 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

344
fixtures_git/__init__.py Normal file
View File

@ -0,0 +1,344 @@
# Copyright (c) 2013-2016 Hewlett-Packard Enterprise Development Company, L.P.
#
# 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.
import os
import re
import shutil
import tempfile
import fixtures
import git
import loremipsum
__all__ = [
'GitFixture'
]
def _get_node_to_pick(node):
m = re.search(r'(.*)(\d+)$', node)
if m:
# get copy of a another change
node_number = int(m.group(2)) - 1
node_name = m.group(1)
if node_number > 0:
node_name += str(node_number)
return node_name
return None
_NOT_VISITED = 0
_VISITED = 1
_FINISHED = 2
def reverse_toposort(data):
# convert to dict for linear lookup times when returning
data = dict(data)
# keep track of nodes visited and processed
# by checking if a child has been visited before but not processed you
# can detect a back edge and abort since the graph is not acyclic
visited = dict()
# DFS algorithm with customization to handle use of '=' notation for merge
# commits and also the additional dependency for cherry-picking
nodes_to_visit = []
for i in data.keys():
if i not in visited:
nodes_to_visit.append(i)
while nodes_to_visit:
node = nodes_to_visit.pop()
if visited.get(node) is _VISITED:
# already visited so just return it with it's deps
yield (node, data[node])
visited[node] = _FINISHED
continue
elif visited.get(node) is _FINISHED:
continue
visited[node] = _VISITED
nodes_to_visit.append(node)
# special case for cherry-picking changes
c_node = _get_node_to_pick(node)
if c_node and c_node not in visited:
nodes_to_visit.append(c_node)
for d in data[node]:
r_d = d.strip('=')
if r_d not in visited:
nodes_to_visit.append(r_d)
else:
# if we've already visited a dep but not processed it,
# then we have a back edge of some kind
if visited[r_d] is _VISITED:
message = ("Graph is not acyclic: %s is a dependency "
"of %s, but has been visited without being "
"processed before it." % (r_d, node))
raise RuntimeError(message)
class GitTree(object):
def __init__(self, gitrepo, tree, branches):
self.graph = {}
self.gitrepo = gitrepo
self.repo = gitrepo.repo
self._build_git_tree(tree, branches)
def _commit(self, node):
p_node = _get_node_to_pick(node)
if p_node:
self.repo.git.cherry_pick(self.graph[p_node], x=True)
else:
# standard commit
self.gitrepo.add_commits(1, ref="HEAD",
message_prefix="[%s]" % node)
def _merge_commit(self, node, parents):
# merge commits
parent_nodes = [p.lstrip("=") for p in parents]
commits = [str(self.graph[p]) for p in parent_nodes[1:]]
if any([p.startswith("=") for p in parents]):
# special merge commit using inverse of 'ours' by
# emptying the current index and then reading in any
# trees of the nodes prefixed with '='
use = [str(self.graph[p.lstrip("=")])
for p in parents if p.startswith("=")]
try:
self.repo.git.merge(*commits, s="ours", no_commit=True)
except git.exc.GitCommandError as exc:
if 'refusing to merge unrelated histories' in exc.stderr:
self.repo.git.merge(*commits, s="ours", no_commit=True,
allow_unrelated_histories=True)
else:
raise
self.repo.git.read_tree(empty=True)
self.repo.git.read_tree(empty=True)
self.repo.git.read_tree(*use, u=True, reset=True)
elif len(commits) < 2:
# standard merge
try:
self.repo.git.merge(*commits, no_commit=True)
except git.exc.GitCommandError as exc:
if 'refusing to merge unrelated histories' in exc.stderr:
self.repo.git.merge(*commits, no_commit=True,
allow_unrelated_histories=True)
else:
raise
else:
# multi-branch merge, git is not great at handling
# merging multiple orphaned branches
try:
self.repo.git.merge(*commits, s="ours", no_commit=True)
except git.exc.GitCommandError as exc:
if 'refusing to merge unrelated histories' in exc.stderr:
self.repo.git.merge(*commits, s="ours", no_commit=True,
allow_unrelated_histories=True)
else:
raise
self.repo.git.read_tree(empty=True)
self.repo.git.read_tree("HEAD", *commits)
self.repo.git.checkout("--", ".")
self.repo.git.commit(m="[%s] Merging %s into %s" %
(node, ",".join(parent_nodes[1:]),
parent_nodes[0]))
self.repo.git.clean(f=True, d=True, x=True)
def _build_git_tree(self, graph_def, branches=[]):
"""Helper function to build a git repository from a graph definition
of nodes and their parent nodes. A list of branches may be provided
where each element has two members corresponding to the name and the
target node it references.
Supports unordered graphs, only requirement is that there is a commit
defined with no parents, which will become the root commit.
Root commits can specified by an empty list as the second member:
('NodeA', [])
Merge commits are specified by multiple nodes:
('NodeMerge', ['Node1', 'Node2'])
As the import subcommand to git-upstream supports a special merge
commit that ignores all previous history from the other tree being
merged in using the 'ours' strategy. You specify this by defining
a parent node as '=<Node>'. The resulting merge commit contains just
the contents of the tree from the specified parent while still
recording the parents.
Following will result in a merge commit 'C', with parents 'P1' and
'P2', but will have the same tree as 'P1'.
('C', ['=P1', 'P2'])
The tree building code can handle a graph definition being out of
order but will fail to find certain circular dependencies and may
result in an infinite loop.
Examples:
[('A', []), ('B', ['A']), ('C', ['B'])]
[('A', []), ('C', ['B']), ('B', ['A'])]
"""
# require that graphs must have at least 1 node with no
# parents, which is a root commit in git
if not any([True for _, parents in graph_def if not parents]):
assert("No root commit defined in test graph")
for node, parents in reverse_toposort(graph_def):
if not parents:
# root commit
self.repo.git.symbolic_ref("HEAD", "refs/heads/%s" % node)
self.repo.git.rm(".", r=True, cached=True,
with_exceptions=False)
self.repo.git.clean(f=True, d=True, x=True)
self.gitrepo.add_commits(1, ref="HEAD",
message_prefix="[%s]" % node)
# only explicitly listed branches should exist afterwards
self.repo.git.checkout(self.repo.commit())
self.repo.git.branch(node, D=True)
else:
# checkout the dependent node
self.repo.git.checkout(self.graph[parents[0].lstrip('=')])
if len(parents) > 1:
# merge commits
self._merge_commit(node, parents)
else:
self._commit(node)
self.graph[node] = self.repo.commit()
for name, node in branches:
self.repo.git.branch(name, str(self.graph[node]), f=True)
# return to master
self.repo.git.checkout("master")
def commits_from_nodes(self, nodes=[]):
return [self.graph[n] for n in nodes]
class GitFixture(fixtures.Fixture):
"""Create a git repo in which to operate.
By default creates an empty git repository under a temporary
directory and deletes it after use.
It accepts options to automatically define a git repository
layout based on list of commits setting the given branches to
the relevant node once built.
:ivar graph: Iterable describing the tree of git commits to create.
:ivar branches: Dict of node to branch names to set once finished.
:ivar path: Custom path to use, otherwise will create a temporary
directory to use and set the 'path' attribute to it.
:ivar user: Dict describing a user to use for commits, defaults
to 'Example User <user@example.com>',
:ivar clean_on_exit: Control whether to delete the tempoary path
once complete, defaults to 'True', but is ignored if 'path'
is provided.
"""
def __init__(self, graph=None, branches=None, path=None, user=None,
clean_on_exit=True):
# set attributes for use
self.path = path
self.gittree = None
self.repo = None
# internal attributes
self._graph = graph or []
self._branches = branches or []
self._user = {
'name': 'Example User',
'email': 'user@example.com',
}
self._user.update(user or {})
self._clean_on_exit = clean_on_exit
def _setUp(self):
self._file_list = set()
if not self.path:
tempdir = self.useFixture(fixtures.TempDir())
self.path = os.path.join(tempdir.path, 'git')
if self._clean_on_exit is True:
self.addCleanup(shutil.rmtree, tempdir.path)
os.mkdir(self.path)
g = git.Git(self.path)
g.init()
self.repo = git.Repo(self.path)
self.repo.git.config('user.email', self._user['email'])
self.repo.git.config('user.name', self._user['name'])
self.repo.git.commit(m="Initialize empty repo", allow_empty=True)
if self._graph:
self.gittree = GitTree(self, self._graph, self._branches)
def _create_file(self):
contents = "\n\n".join(loremipsum.get_paragraphs(3))
# always want to ensure the files added to the repo are unique no
# matter which branch they are added to, as otherwise there may
# be conflicts caused by replaying local changes and performing
# merges
while True:
tmpfile = tempfile.NamedTemporaryFile(
dir=self.repo.working_dir, delete=False)
if tmpfile.name not in self._file_list:
self._file_list.add(tmpfile.name)
break
# case where same filename in use on a different branch
tmpfile.close()
os.remove(tmpfile.name)
tmpfile.write(contents.encode('utf-8'))
tmpfile.close()
return tmpfile.name
def _create_file_commit(self, change_id=None, message_prefix=None):
filename = self._create_file()
self.repo.git.add(filename)
message = "Adding %s" % os.path.basename(filename)
if message_prefix:
message = "%s %s" % (message_prefix, message)
if change_id:
message = message + "\n\nChange-Id: %s" % change_id
self.repo.git.commit(m=message)
def add_commits(self, num=1, ref="HEAD", change_ids=[],
message_prefix=None):
"""Create the given number of commits using generated files"""
if ref != "HEAD":
self.repo.git.checkout(ref)
num = max(num, len(change_ids))
ids = list(change_ids) + [None] * (num - len(change_ids))
for x in range(num):
self._create_file_commit(
change_id=ids[x], message_prefix=message_prefix)

3
requirements.txt Normal file
View File

@ -0,0 +1,3 @@
fixtures
GitPython
loremipsum

36
setup.cfg Normal file
View File

@ -0,0 +1,36 @@
[metadata]
name = fixtures-git
author = Darragh Bailey
author-email = dbailey@hpe.com
home-page = https://pypi.python.org/pypi/fixtures-git
summary = unittest fixture to help testing with git repositories
description-file = DESCRIPTION
license = Apache License (2.0)
keywords = fixtures git
classifiers =
Programming Language :: Python :: 2
Programming Language :: Python :: 3
Programming Language :: Python
Development Status :: 4 - Beta
Environment :: Console
Environment :: OpenStack
Intended Audience :: Developers
Intended Audience :: Information Technology
License :: OSI Approved :: Apache Software License
Operating System :: OS Independent
[bdist_wheel]
universal=1
[pbr]
skip_changelog = True
[files]
packages =
fixtures_git
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
builders = html

23
setup.py Normal file
View File

@ -0,0 +1,23 @@
#!/usr/bin/env python
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
# Copyright (c) 2018 Hewlett Packard Enterprise Company LP
#
# 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.
import setuptools
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

32
tox.ini Normal file
View File

@ -0,0 +1,32 @@
[tox]
minversion = 1.8
skipsdist = True
envlist = pep8,py35,py34,py27
skip_missing_interpreters = True
[testenv]
usedevelop = True
install_command = pip install -U {opts} {packages}
deps = -r{toxinidir}/requirements.txt
commands =
python setup.py test
[testenv:pep8]
commands = flake8
[testenv:cover]
commands =
python setup.py test --coverage --coverage-package-name=fixtures_git
coverage report
[testenv:docs]
commands =
python setup.py build_sphinx {posargs}
[testenv:venv]
commands = {posargs}
[flake8]
ignore=H236,H40
show-source = True
exclude = .venv,.tox,dist,doc,build,*.egg