Add setup.py to project.
Add a setup.py for the gerritbot project. This incorporates openstack.common.setup/version as well for versioning. This change also adds a tox.ini file and its lists of dependencies to gerritbot: pyyaml, python-daemon and python-irclib. Change-Id: Id9204a1ad452c8aa3c5ec5b697db4dd835e46405
This commit is contained in:
parent
98d4bbf5ef
commit
b2be72e69d
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
.tox
|
||||||
|
build/*
|
||||||
|
*.pyc
|
8
MANIFEST.in
Normal file
8
MANIFEST.in
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
include gerritbot/versioninfo
|
||||||
|
include AUTHORS
|
||||||
|
include ChangeLog
|
||||||
|
|
||||||
|
exclude .gitignore
|
||||||
|
exclude .gitreview
|
||||||
|
|
||||||
|
global-exclude *.pyc
|
0
gerritbot/__init__.py
Normal file
0
gerritbot/__init__.py
Normal file
@ -29,7 +29,7 @@ openstack-dev:
|
|||||||
- master
|
- master
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import ircbot
|
import irc.bot
|
||||||
import time
|
import time
|
||||||
import subprocess
|
import subprocess
|
||||||
import threading
|
import threading
|
||||||
@ -38,14 +38,24 @@ import json
|
|||||||
import sys
|
import sys
|
||||||
import os
|
import os
|
||||||
import ConfigParser
|
import ConfigParser
|
||||||
import daemon, daemon.pidlockfile
|
import daemon
|
||||||
import traceback
|
import traceback
|
||||||
import yaml
|
import yaml
|
||||||
|
|
||||||
class GerritBot(ircbot.SingleServerIRCBot):
|
try:
|
||||||
|
import daemon.pidlockfile
|
||||||
|
pid_file_module = daemon.pidlockfile
|
||||||
|
except:
|
||||||
|
# as of python-daemon 1.6 it doesn't bundle pidlockfile anymore
|
||||||
|
# instead it depends on lockfile-0.9.1
|
||||||
|
import daemon.pidfile
|
||||||
|
pid_file_module = daemon.pidfile
|
||||||
|
|
||||||
|
|
||||||
|
class GerritBot(irc.bot.SingleServerIRCBot):
|
||||||
def __init__(self, channels, nickname, password, server, port=6667):
|
def __init__(self, channels, nickname, password, server, port=6667):
|
||||||
ircbot.SingleServerIRCBot.__init__(self,
|
irc.bot.SingleServerIRCBot.__init__(self,
|
||||||
[(server, port)],
|
[(server, port)],
|
||||||
nickname, nickname)
|
nickname, nickname)
|
||||||
self.channel_list = channels
|
self.channel_list = channels
|
||||||
self.nickname = nickname
|
self.nickname = nickname
|
||||||
@ -60,7 +70,7 @@ class GerritBot(ircbot.SingleServerIRCBot):
|
|||||||
c.nick(self.nickname)
|
c.nick(self.nickname)
|
||||||
|
|
||||||
def on_welcome(self, c, e):
|
def on_welcome(self, c, e):
|
||||||
c.privmsg("nickserv", "identify %s "% self.password)
|
c.privmsg("nickserv", "identify %s " % self.password)
|
||||||
for channel in self.channel_list:
|
for channel in self.channel_list:
|
||||||
c.join(channel)
|
c.join(channel)
|
||||||
|
|
||||||
@ -68,6 +78,7 @@ class GerritBot(ircbot.SingleServerIRCBot):
|
|||||||
self.connection.privmsg(channel, msg)
|
self.connection.privmsg(channel, msg)
|
||||||
time.sleep(0.5)
|
time.sleep(0.5)
|
||||||
|
|
||||||
|
|
||||||
class Gerrit(threading.Thread):
|
class Gerrit(threading.Thread):
|
||||||
def __init__(self, ircbot, channel_config,
|
def __init__(self, ircbot, channel_config,
|
||||||
username, keyfile, server, port=29418):
|
username, keyfile, server, port=29418):
|
||||||
@ -86,7 +97,7 @@ class Gerrit(threading.Thread):
|
|||||||
'-i', self.keyfile,
|
'-i', self.keyfile,
|
||||||
'-l', self.username, self.server,
|
'-l', self.username, self.server,
|
||||||
'gerrit', 'stream-events'],
|
'gerrit', 'stream-events'],
|
||||||
bufsize=1,
|
bufsize=1,
|
||||||
stdin=None,
|
stdin=None,
|
||||||
stdout=subprocess.PIPE,
|
stdout=subprocess.PIPE,
|
||||||
stderr=None,
|
stderr=None,
|
||||||
@ -118,7 +129,7 @@ class Gerrit(threading.Thread):
|
|||||||
data['change']['subject'],
|
data['change']['subject'],
|
||||||
data['change']['url'])
|
data['change']['url'])
|
||||||
self.ircbot.send(channel, msg)
|
self.ircbot.send(channel, msg)
|
||||||
|
|
||||||
for approval in data.get('approvals', []):
|
for approval in data.get('approvals', []):
|
||||||
if (approval['type'] == 'VRIF' and approval['value'] == '-2' and
|
if (approval['type'] == 'VRIF' and approval['value'] == '-2' and
|
||||||
channel in self.channel_config.events.get(
|
channel in self.channel_config.events.get(
|
||||||
@ -189,7 +200,7 @@ class Gerrit(threading.Thread):
|
|||||||
self._read()
|
self._read()
|
||||||
else:
|
else:
|
||||||
raise Exception("event on ssh connection")
|
raise Exception("event on ssh connection")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
try:
|
try:
|
||||||
if not self.proc:
|
if not self.proc:
|
||||||
@ -204,14 +215,15 @@ class Gerrit(threading.Thread):
|
|||||||
time.sleep(5)
|
time.sleep(5)
|
||||||
while True:
|
while True:
|
||||||
self._run()
|
self._run()
|
||||||
|
|
||||||
|
|
||||||
class ChannelConfig(object):
|
class ChannelConfig(object):
|
||||||
def __init__(self, data):
|
def __init__(self, data):
|
||||||
self.data = data
|
self.data = data
|
||||||
keys = data.keys()
|
keys = data.keys()
|
||||||
for key in keys:
|
for key in keys:
|
||||||
if key[0] != '#':
|
if key[0] != '#':
|
||||||
data['#'+key] = data.pop(key)
|
data['#' + key] = data.pop(key)
|
||||||
self.channels = data.keys()
|
self.channels = data.keys()
|
||||||
self.projects = {}
|
self.projects = {}
|
||||||
self.events = {}
|
self.events = {}
|
||||||
@ -230,8 +242,9 @@ class ChannelConfig(object):
|
|||||||
branch_set.add(channel)
|
branch_set.add(channel)
|
||||||
self.branches[branch] = branch_set
|
self.branches[branch] = branch_set
|
||||||
|
|
||||||
|
|
||||||
def _main():
|
def _main():
|
||||||
config=ConfigParser.ConfigParser()
|
config = ConfigParser.ConfigParser()
|
||||||
config.read(sys.argv[1])
|
config.read(sys.argv[1])
|
||||||
|
|
||||||
fp = config.get('ircbot', 'channel_config')
|
fp = config.get('ircbot', 'channel_config')
|
||||||
@ -249,7 +262,7 @@ def _main():
|
|||||||
config.get('ircbot', 'pass'),
|
config.get('ircbot', 'pass'),
|
||||||
config.get('ircbot', 'server'),
|
config.get('ircbot', 'server'),
|
||||||
config.getint('ircbot', 'port'))
|
config.getint('ircbot', 'port'))
|
||||||
g = Gerrit(bot,
|
g = Gerrit(bot,
|
||||||
channel_config,
|
channel_config,
|
||||||
config.get('gerrit', 'user'),
|
config.get('gerrit', 'user'),
|
||||||
config.get('gerrit', 'key'),
|
config.get('gerrit', 'key'),
|
||||||
@ -258,12 +271,13 @@ def _main():
|
|||||||
g.start()
|
g.start()
|
||||||
bot.start()
|
bot.start()
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
if len(sys.argv) != 2:
|
if len(sys.argv) != 2:
|
||||||
print "Usage: %s CONFIGFILE" % sys.argv[0]
|
print "Usage: %s CONFIGFILE" % sys.argv[0]
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
pid = daemon.pidlockfile.TimeoutPIDLockFile(
|
pid = pid_file_module.TimeoutPIDLockFile(
|
||||||
"/var/run/gerritbot/gerritbot.pid", 10)
|
"/var/run/gerritbot/gerritbot.pid", 10)
|
||||||
with daemon.DaemonContext(pidfile=pid):
|
with daemon.DaemonContext(pidfile=pid):
|
||||||
_main()
|
_main()
|
0
gerritbot/openstack/__init__.py
Normal file
0
gerritbot/openstack/__init__.py
Normal file
0
gerritbot/openstack/common/__init__.py
Normal file
0
gerritbot/openstack/common/__init__.py
Normal file
351
gerritbot/openstack/common/setup.py
Normal file
351
gerritbot/openstack/common/setup.py
Normal file
@ -0,0 +1,351 @@
|
|||||||
|
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
||||||
|
|
||||||
|
# Copyright 2011 OpenStack LLC.
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
"""
|
||||||
|
Utilities with minimum-depends for use in setup.py
|
||||||
|
"""
|
||||||
|
|
||||||
|
import datetime
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from setuptools.command import sdist
|
||||||
|
|
||||||
|
|
||||||
|
def parse_mailmap(mailmap='.mailmap'):
|
||||||
|
mapping = {}
|
||||||
|
if os.path.exists(mailmap):
|
||||||
|
fp = open(mailmap, 'r')
|
||||||
|
for l in fp:
|
||||||
|
l = l.strip()
|
||||||
|
if not l.startswith('#') and ' ' in l:
|
||||||
|
canonical_email, alias = [x for x in l.split(' ')
|
||||||
|
if x.startswith('<')]
|
||||||
|
mapping[alias] = canonical_email
|
||||||
|
return mapping
|
||||||
|
|
||||||
|
|
||||||
|
def canonicalize_emails(changelog, mapping):
|
||||||
|
"""Takes in a string and an email alias mapping and replaces all
|
||||||
|
instances of the aliases in the string with their real email.
|
||||||
|
"""
|
||||||
|
for alias, email in mapping.iteritems():
|
||||||
|
changelog = changelog.replace(alias, email)
|
||||||
|
return changelog
|
||||||
|
|
||||||
|
|
||||||
|
# Get requirements from the first file that exists
|
||||||
|
def get_reqs_from_files(requirements_files):
|
||||||
|
reqs_in = []
|
||||||
|
for requirements_file in requirements_files:
|
||||||
|
if os.path.exists(requirements_file):
|
||||||
|
return open(requirements_file, 'r').read().split('\n')
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
def parse_requirements(requirements_files=['requirements.txt',
|
||||||
|
'tools/pip-requires']):
|
||||||
|
requirements = []
|
||||||
|
for line in get_reqs_from_files(requirements_files):
|
||||||
|
# For the requirements list, we need to inject only the portion
|
||||||
|
# after egg= so that distutils knows the package it's looking for
|
||||||
|
# such as:
|
||||||
|
# -e git://github.com/openstack/nova/master#egg=nova
|
||||||
|
if re.match(r'\s*-e\s+', line):
|
||||||
|
requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1',
|
||||||
|
line))
|
||||||
|
# such as:
|
||||||
|
# http://github.com/openstack/nova/zipball/master#egg=nova
|
||||||
|
elif re.match(r'\s*https?:', line):
|
||||||
|
requirements.append(re.sub(r'\s*https?:.*#egg=(.*)$', r'\1',
|
||||||
|
line))
|
||||||
|
# -f lines are for index locations, and don't get used here
|
||||||
|
elif re.match(r'\s*-f\s+', line):
|
||||||
|
pass
|
||||||
|
# argparse is part of the standard library starting with 2.7
|
||||||
|
# adding it to the requirements list screws distro installs
|
||||||
|
elif line == 'argparse' and sys.version_info >= (2, 7):
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
requirements.append(line)
|
||||||
|
|
||||||
|
return requirements
|
||||||
|
|
||||||
|
|
||||||
|
def parse_dependency_links(requirements_files=['requirements.txt',
|
||||||
|
'tools/pip-requires']):
|
||||||
|
dependency_links = []
|
||||||
|
# dependency_links inject alternate locations to find packages listed
|
||||||
|
# in requirements
|
||||||
|
for line in get_reqs_from_files(requirements_files):
|
||||||
|
# skip comments and blank lines
|
||||||
|
if re.match(r'(\s*#)|(\s*$)', line):
|
||||||
|
continue
|
||||||
|
# lines with -e or -f need the whole line, minus the flag
|
||||||
|
if re.match(r'\s*-[ef]\s+', line):
|
||||||
|
dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line))
|
||||||
|
# lines that are only urls can go in unmolested
|
||||||
|
elif re.match(r'\s*https?:', line):
|
||||||
|
dependency_links.append(line)
|
||||||
|
return dependency_links
|
||||||
|
|
||||||
|
|
||||||
|
def write_requirements():
|
||||||
|
venv = os.environ.get('VIRTUAL_ENV', None)
|
||||||
|
if venv is not None:
|
||||||
|
with open("requirements.txt", "w") as req_file:
|
||||||
|
output = subprocess.Popen(["pip", "-E", venv, "freeze", "-l"],
|
||||||
|
stdout=subprocess.PIPE)
|
||||||
|
requirements = output.communicate()[0].strip()
|
||||||
|
req_file.write(requirements)
|
||||||
|
|
||||||
|
|
||||||
|
def _run_shell_command(cmd):
|
||||||
|
output = subprocess.Popen(["/bin/sh", "-c", cmd],
|
||||||
|
stdout=subprocess.PIPE)
|
||||||
|
out = output.communicate()
|
||||||
|
if len(out) == 0:
|
||||||
|
return None
|
||||||
|
if len(out[0].strip()) == 0:
|
||||||
|
return None
|
||||||
|
return out[0].strip()
|
||||||
|
|
||||||
|
|
||||||
|
def _get_git_next_version_suffix(branch_name):
|
||||||
|
datestamp = datetime.datetime.now().strftime('%Y%m%d')
|
||||||
|
if branch_name == 'milestone-proposed':
|
||||||
|
revno_prefix = "r"
|
||||||
|
else:
|
||||||
|
revno_prefix = ""
|
||||||
|
_run_shell_command("git fetch origin +refs/meta/*:refs/remotes/meta/*")
|
||||||
|
milestone_cmd = "git show meta/openstack/release:%s" % branch_name
|
||||||
|
milestonever = _run_shell_command(milestone_cmd)
|
||||||
|
if not milestonever:
|
||||||
|
milestonever = ""
|
||||||
|
post_version = _get_git_post_version()
|
||||||
|
# post version should look like:
|
||||||
|
# 0.1.1.4.gcc9e28a
|
||||||
|
# where the bit after the last . is the short sha, and the bit between
|
||||||
|
# the last and second to last is the revno count
|
||||||
|
(revno, sha) = post_version.split(".")[-2:]
|
||||||
|
first_half = "%(milestonever)s~%(datestamp)s" % locals()
|
||||||
|
second_half = "%(revno_prefix)s%(revno)s.%(sha)s" % locals()
|
||||||
|
return ".".join((first_half, second_half))
|
||||||
|
|
||||||
|
|
||||||
|
def _get_git_current_tag():
|
||||||
|
return _run_shell_command("git tag --contains HEAD")
|
||||||
|
|
||||||
|
|
||||||
|
def _get_git_tag_info():
|
||||||
|
return _run_shell_command("git describe --tags")
|
||||||
|
|
||||||
|
|
||||||
|
def _get_git_post_version():
|
||||||
|
current_tag = _get_git_current_tag()
|
||||||
|
if current_tag is not None:
|
||||||
|
return current_tag
|
||||||
|
else:
|
||||||
|
tag_info = _get_git_tag_info()
|
||||||
|
if tag_info is None:
|
||||||
|
base_version = "0.0"
|
||||||
|
cmd = "git --no-pager log --oneline"
|
||||||
|
out = _run_shell_command(cmd)
|
||||||
|
revno = len(out.split("\n"))
|
||||||
|
sha = _run_shell_command("git describe --always")
|
||||||
|
else:
|
||||||
|
tag_infos = tag_info.split("-")
|
||||||
|
base_version = "-".join(tag_infos[:-2])
|
||||||
|
(revno, sha) = tag_infos[-2:]
|
||||||
|
return "%s.%s.%s" % (base_version, revno, sha)
|
||||||
|
|
||||||
|
|
||||||
|
def write_git_changelog():
|
||||||
|
"""Write a changelog based on the git changelog."""
|
||||||
|
if os.path.isdir('.git'):
|
||||||
|
git_log_cmd = 'git log --stat'
|
||||||
|
changelog = _run_shell_command(git_log_cmd)
|
||||||
|
mailmap = parse_mailmap()
|
||||||
|
with open("ChangeLog", "w") as changelog_file:
|
||||||
|
changelog_file.write(canonicalize_emails(changelog, mailmap))
|
||||||
|
|
||||||
|
|
||||||
|
def generate_authors():
|
||||||
|
"""Create AUTHORS file using git commits."""
|
||||||
|
jenkins_email = 'jenkins@review.openstack.org'
|
||||||
|
old_authors = 'AUTHORS.in'
|
||||||
|
new_authors = 'AUTHORS'
|
||||||
|
if os.path.isdir('.git'):
|
||||||
|
# don't include jenkins email address in AUTHORS file
|
||||||
|
git_log_cmd = ("git log --format='%aN <%aE>' | sort -u | "
|
||||||
|
"grep -v " + jenkins_email)
|
||||||
|
changelog = _run_shell_command(git_log_cmd)
|
||||||
|
mailmap = parse_mailmap()
|
||||||
|
with open(new_authors, 'w') as new_authors_fh:
|
||||||
|
new_authors_fh.write(canonicalize_emails(changelog, mailmap))
|
||||||
|
if os.path.exists(old_authors):
|
||||||
|
with open(old_authors, "r") as old_authors_fh:
|
||||||
|
new_authors_fh.write('\n' + old_authors_fh.read())
|
||||||
|
|
||||||
|
_rst_template = """%(heading)s
|
||||||
|
%(underline)s
|
||||||
|
|
||||||
|
.. automodule:: %(module)s
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def read_versioninfo(project):
|
||||||
|
"""Read the versioninfo file. If it doesn't exist, we're in a github
|
||||||
|
zipball, and there's really no way to know what version we really
|
||||||
|
are, but that should be ok, because the utility of that should be
|
||||||
|
just about nil if this code path is in use in the first place."""
|
||||||
|
versioninfo_path = os.path.join(project, 'versioninfo')
|
||||||
|
if os.path.exists(versioninfo_path):
|
||||||
|
with open(versioninfo_path, 'r') as vinfo:
|
||||||
|
version = vinfo.read().strip()
|
||||||
|
else:
|
||||||
|
version = "0.0.0"
|
||||||
|
return version
|
||||||
|
|
||||||
|
|
||||||
|
def write_versioninfo(project, version):
|
||||||
|
"""Write a simple file containing the version of the package."""
|
||||||
|
open(os.path.join(project, 'versioninfo'), 'w').write("%s\n" % version)
|
||||||
|
|
||||||
|
|
||||||
|
def get_cmdclass():
|
||||||
|
"""Return dict of commands to run from setup.py."""
|
||||||
|
|
||||||
|
cmdclass = dict()
|
||||||
|
|
||||||
|
def _find_modules(arg, dirname, files):
|
||||||
|
for filename in files:
|
||||||
|
if filename.endswith('.py') and filename != '__init__.py':
|
||||||
|
arg["%s.%s" % (dirname.replace('/', '.'),
|
||||||
|
filename[:-3])] = True
|
||||||
|
|
||||||
|
class LocalSDist(sdist.sdist):
|
||||||
|
"""Builds the ChangeLog and Authors files from VC first."""
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
write_git_changelog()
|
||||||
|
generate_authors()
|
||||||
|
# sdist.sdist is an old style class, can't use super()
|
||||||
|
sdist.sdist.run(self)
|
||||||
|
|
||||||
|
cmdclass['sdist'] = LocalSDist
|
||||||
|
|
||||||
|
# If Sphinx is installed on the box running setup.py,
|
||||||
|
# enable setup.py to build the documentation, otherwise,
|
||||||
|
# just ignore it
|
||||||
|
try:
|
||||||
|
from sphinx.setup_command import BuildDoc
|
||||||
|
|
||||||
|
class LocalBuildDoc(BuildDoc):
|
||||||
|
def generate_autoindex(self):
|
||||||
|
print "**Autodocumenting from %s" % os.path.abspath(os.curdir)
|
||||||
|
modules = {}
|
||||||
|
option_dict = self.distribution.get_option_dict('build_sphinx')
|
||||||
|
source_dir = os.path.join(option_dict['source_dir'][1], 'api')
|
||||||
|
if not os.path.exists(source_dir):
|
||||||
|
os.makedirs(source_dir)
|
||||||
|
for pkg in self.distribution.packages:
|
||||||
|
if '.' not in pkg:
|
||||||
|
os.path.walk(pkg, _find_modules, modules)
|
||||||
|
module_list = modules.keys()
|
||||||
|
module_list.sort()
|
||||||
|
autoindex_filename = os.path.join(source_dir, 'autoindex.rst')
|
||||||
|
with open(autoindex_filename, 'w') as autoindex:
|
||||||
|
autoindex.write(""".. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
""")
|
||||||
|
for module in module_list:
|
||||||
|
output_filename = os.path.join(source_dir,
|
||||||
|
"%s.rst" % module)
|
||||||
|
heading = "The :mod:`%s` Module" % module
|
||||||
|
underline = "=" * len(heading)
|
||||||
|
values = dict(module=module, heading=heading,
|
||||||
|
underline=underline)
|
||||||
|
|
||||||
|
print "Generating %s" % output_filename
|
||||||
|
with open(output_filename, 'w') as output_file:
|
||||||
|
output_file.write(_rst_template % values)
|
||||||
|
autoindex.write(" %s.rst\n" % module)
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
if not os.getenv('SPHINX_DEBUG'):
|
||||||
|
self.generate_autoindex()
|
||||||
|
|
||||||
|
for builder in ['html', 'man']:
|
||||||
|
self.builder = builder
|
||||||
|
self.finalize_options()
|
||||||
|
self.project = self.distribution.get_name()
|
||||||
|
self.version = self.distribution.get_version()
|
||||||
|
self.release = self.distribution.get_version()
|
||||||
|
BuildDoc.run(self)
|
||||||
|
cmdclass['build_sphinx'] = LocalBuildDoc
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return cmdclass
|
||||||
|
|
||||||
|
|
||||||
|
def get_git_branchname():
|
||||||
|
for branch in _run_shell_command("git branch --color=never").split("\n"):
|
||||||
|
if branch.startswith('*'):
|
||||||
|
_branch_name = branch.split()[1].strip()
|
||||||
|
if _branch_name == "(no":
|
||||||
|
_branch_name = "no-branch"
|
||||||
|
return _branch_name
|
||||||
|
|
||||||
|
|
||||||
|
def get_pre_version(projectname, base_version):
|
||||||
|
"""Return a version which is leading up to a version that will
|
||||||
|
be released in the future."""
|
||||||
|
if os.path.isdir('.git'):
|
||||||
|
current_tag = _get_git_current_tag()
|
||||||
|
if current_tag is not None:
|
||||||
|
version = current_tag
|
||||||
|
else:
|
||||||
|
branch_name = os.getenv('BRANCHNAME',
|
||||||
|
os.getenv('GERRIT_REFNAME',
|
||||||
|
get_git_branchname()))
|
||||||
|
version_suffix = _get_git_next_version_suffix(branch_name)
|
||||||
|
version = "%s~%s" % (base_version, version_suffix)
|
||||||
|
write_versioninfo(projectname, version)
|
||||||
|
return version
|
||||||
|
else:
|
||||||
|
version = read_versioninfo(projectname)
|
||||||
|
return version
|
||||||
|
|
||||||
|
|
||||||
|
def get_post_version(projectname):
|
||||||
|
"""Return a version which is equal to the tag that's on the current
|
||||||
|
revision if there is one, or tag plus number of additional revisions
|
||||||
|
if the current revision has no tag."""
|
||||||
|
|
||||||
|
if os.path.isdir('.git'):
|
||||||
|
version = _get_git_post_version()
|
||||||
|
write_versioninfo(projectname, version)
|
||||||
|
return version
|
||||||
|
return read_versioninfo(projectname)
|
149
gerritbot/openstack/common/version.py
Normal file
149
gerritbot/openstack/common/version.py
Normal file
@ -0,0 +1,149 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
"""
|
||||||
|
Utilities for consuming the auto-generated versioninfo files.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import datetime
|
||||||
|
import pkg_resources
|
||||||
|
import os
|
||||||
|
|
||||||
|
import setup
|
||||||
|
|
||||||
|
|
||||||
|
class _deferred_version_string(object):
|
||||||
|
"""Internal helper class which provides delayed version calculation."""
|
||||||
|
def __init__(self, version_info, prefix):
|
||||||
|
self.version_info = version_info
|
||||||
|
self.prefix = prefix
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return "%s%s" % (self.prefix, self.version_info.version_string())
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return "%s%s" % (self.prefix, self.version_info.version_string())
|
||||||
|
|
||||||
|
|
||||||
|
class VersionInfo(object):
|
||||||
|
|
||||||
|
def __init__(self, package, python_package=None, pre_version=None):
|
||||||
|
"""Object that understands versioning for a package
|
||||||
|
:param package: name of the top level python namespace. For glance,
|
||||||
|
this would be "glance" for python-glanceclient, it
|
||||||
|
would be "glanceclient"
|
||||||
|
:param python_package: optional name of the project name. For
|
||||||
|
glance this can be left unset. For
|
||||||
|
python-glanceclient, this would be
|
||||||
|
"python-glanceclient"
|
||||||
|
:param pre_version: optional version that the project is working to
|
||||||
|
"""
|
||||||
|
self.package = package
|
||||||
|
if python_package is None:
|
||||||
|
self.python_package = package
|
||||||
|
else:
|
||||||
|
self.python_package = python_package
|
||||||
|
self.pre_version = pre_version
|
||||||
|
self.version = None
|
||||||
|
|
||||||
|
def _generate_version(self):
|
||||||
|
"""Defer to the openstack.common.setup routines for making a
|
||||||
|
version from git."""
|
||||||
|
if self.pre_version is None:
|
||||||
|
return setup.get_post_version(self.python_package)
|
||||||
|
else:
|
||||||
|
return setup.get_pre_version(self.python_package, self.pre_version)
|
||||||
|
|
||||||
|
def _newer_version(self, pending_version):
|
||||||
|
"""Check to see if we're working with a stale version or not.
|
||||||
|
We expect a version string that either looks like:
|
||||||
|
2012.2~f3~20120708.10.4426392
|
||||||
|
which is an unreleased version of a pre-version, or:
|
||||||
|
0.1.1.4.gcc9e28a
|
||||||
|
which is an unreleased version of a post-version, or:
|
||||||
|
0.1.1
|
||||||
|
Which is a release and which should match tag.
|
||||||
|
For now, if we have a date-embedded version, check to see if it's
|
||||||
|
old, and if so re-generate. Otherwise, just deal with it.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
version_date = int(self.version.split("~")[-1].split('.')[0])
|
||||||
|
if version_date < int(datetime.date.today().strftime('%Y%m%d')):
|
||||||
|
return self._generate_version()
|
||||||
|
else:
|
||||||
|
return pending_version
|
||||||
|
except Exception:
|
||||||
|
return pending_version
|
||||||
|
|
||||||
|
def version_string_with_vcs(self, always=False):
|
||||||
|
"""Return the full version of the package including suffixes indicating
|
||||||
|
VCS status.
|
||||||
|
|
||||||
|
For instance, if we are working towards the 2012.2 release,
|
||||||
|
canonical_version_string should return 2012.2 if this is a final
|
||||||
|
release, or else something like 2012.2~f1~20120705.20 if it's not.
|
||||||
|
|
||||||
|
:param always: if true, skip all version caching
|
||||||
|
"""
|
||||||
|
if always:
|
||||||
|
self.version = self._generate_version()
|
||||||
|
|
||||||
|
if self.version is None:
|
||||||
|
|
||||||
|
requirement = pkg_resources.Requirement.parse(self.python_package)
|
||||||
|
versioninfo = "%s/versioninfo" % self.package
|
||||||
|
try:
|
||||||
|
raw_version = pkg_resources.resource_string(requirement,
|
||||||
|
versioninfo)
|
||||||
|
self.version = self._newer_version(raw_version.strip())
|
||||||
|
except (IOError, pkg_resources.DistributionNotFound):
|
||||||
|
self.version = self._generate_version()
|
||||||
|
|
||||||
|
return self.version
|
||||||
|
|
||||||
|
def canonical_version_string(self, always=False):
|
||||||
|
"""Return the simple version of the package excluding any suffixes.
|
||||||
|
|
||||||
|
For instance, if we are working towards the 2012.2 release,
|
||||||
|
canonical_version_string should return 2012.2 in all cases.
|
||||||
|
|
||||||
|
:param always: if true, skip all version caching
|
||||||
|
"""
|
||||||
|
return self.version_string_with_vcs(always).split('~')[0]
|
||||||
|
|
||||||
|
def version_string(self, always=False):
|
||||||
|
"""Return the base version of the package.
|
||||||
|
|
||||||
|
For instance, if we are working towards the 2012.2 release,
|
||||||
|
version_string should return 2012.2 if this is a final release, or
|
||||||
|
2012.2-dev if it is not.
|
||||||
|
|
||||||
|
:param always: if true, skip all version caching
|
||||||
|
"""
|
||||||
|
version_parts = self.version_string_with_vcs(always).split('~')
|
||||||
|
if len(version_parts) == 1:
|
||||||
|
return version_parts[0]
|
||||||
|
else:
|
||||||
|
return '%s-dev' % (version_parts[0],)
|
||||||
|
|
||||||
|
def deferred_version_string(self, prefix=""):
|
||||||
|
"""Generate an object which will expand in a string context to
|
||||||
|
the results of version_string(). We do this so that don't
|
||||||
|
call into pkg_resources every time we start up a program when
|
||||||
|
passing version information into the CONF constructor, but
|
||||||
|
rather only do the calculation when and if a version is requested
|
||||||
|
"""
|
||||||
|
return _deferred_version_string(self, prefix)
|
20
gerritbot/version.py
Normal file
20
gerritbot/version.py
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
||||||
|
|
||||||
|
# Copyright 2011 OpenStack LLC
|
||||||
|
# Copyright 2012 Hewlett-Packard 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.
|
||||||
|
|
||||||
|
from gerritbot.openstack.common import version as common_version
|
||||||
|
|
||||||
|
version_info = common_version.VersionInfo('gerritbot')
|
7
openstack-common.conf
Normal file
7
openstack-common.conf
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
[DEFAULT]
|
||||||
|
|
||||||
|
# The list of modules to copy from openstack-common
|
||||||
|
modules=setup,version
|
||||||
|
|
||||||
|
# The base module to hold the copy of openstack.common
|
||||||
|
base=gerritbot
|
15
setup.cfg
Normal file
15
setup.cfg
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
[nosetests]
|
||||||
|
cover-package = gerritbot
|
||||||
|
cover-html = true
|
||||||
|
cover-erase = true
|
||||||
|
cover-inclusive = true
|
||||||
|
verbosity=2
|
||||||
|
detailed-errors=1
|
||||||
|
|
||||||
|
[build_sphinx]
|
||||||
|
source-dir = doc/source
|
||||||
|
build-dir = doc/build
|
||||||
|
all_files = 1
|
||||||
|
|
||||||
|
[upload_sphinx]
|
||||||
|
upload-dir = doc/build/html
|
56
setup.py
Normal file
56
setup.py
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
# Copyright 2011 OpenStack, LLC
|
||||||
|
# Copyright 2012 Hewlett-Packard 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 setuptools
|
||||||
|
|
||||||
|
|
||||||
|
from gerritbot.openstack.common import setup
|
||||||
|
from gerritbot.version import version_info as version
|
||||||
|
|
||||||
|
requires = setup.parse_requirements()
|
||||||
|
tests_require = setup.parse_requirements(['tools/test-requires'])
|
||||||
|
depend_links = setup.parse_dependency_links()
|
||||||
|
|
||||||
|
|
||||||
|
def read_file(file_name):
|
||||||
|
return open(os.path.join(os.path.dirname(__file__), file_name)).read()
|
||||||
|
|
||||||
|
|
||||||
|
setuptools.setup(
|
||||||
|
name="gerritbot",
|
||||||
|
version=version.canonical_version_string(always=True),
|
||||||
|
author='Hewlett-Packard Development Company, L.P.',
|
||||||
|
author_email='openstack@lists.launchpad.net',
|
||||||
|
description="Client library for OpenStack Nova API.",
|
||||||
|
license="Apache License, Version 2.0",
|
||||||
|
url="https://github.com/openstack-ci/gerritbot",
|
||||||
|
packages=setuptools.find_packages(exclude=['tests', 'tests.*']),
|
||||||
|
include_package_data=True,
|
||||||
|
setup_requires=['setuptools_git>=0.4'],
|
||||||
|
cmdclass=setup.get_cmdclass(),
|
||||||
|
install_requires=requires,
|
||||||
|
dependency_links=depend_links,
|
||||||
|
tests_require=tests_require,
|
||||||
|
test_suite="nose.collector",
|
||||||
|
classifiers=[
|
||||||
|
"Environment :: Console",
|
||||||
|
"Intended Audience :: Developers",
|
||||||
|
"Intended Audience :: Information Technology",
|
||||||
|
"License :: OSI Approved :: Apache Software License",
|
||||||
|
"Operating System :: OS Independent",
|
||||||
|
"Programming Language :: Python"
|
||||||
|
]
|
||||||
|
)
|
3
tools/pip-requires
Normal file
3
tools/pip-requires
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
pyyaml
|
||||||
|
python-daemon
|
||||||
|
irc
|
10
tools/test-requires
Normal file
10
tools/test-requires
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
distribute>=0.6.24
|
||||||
|
|
||||||
|
mock
|
||||||
|
nose
|
||||||
|
nose-exclude
|
||||||
|
nosexcover
|
||||||
|
openstack.nose_plugin
|
||||||
|
pep8==1.1
|
||||||
|
sphinx>=1.1.2
|
||||||
|
unittest2
|
29
tox.ini
Normal file
29
tox.ini
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py26,py27,pep8
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
setenv = VIRTUAL_ENV={envdir}
|
||||||
|
NOSE_WITH_OPENSTACK=1
|
||||||
|
NOSE_OPENSTACK_COLOR=1
|
||||||
|
NOSE_OPENSTACK_RED=0.05
|
||||||
|
NOSE_OPENSTACK_YELLOW=0.025
|
||||||
|
NOSE_OPENSTACK_SHOW_ELAPSED=1
|
||||||
|
NOSE_OPENSTACK_STDOUT=1
|
||||||
|
sitepackages=True
|
||||||
|
deps = -r{toxinidir}/tools/pip-requires
|
||||||
|
-r{toxinidir}/tools/test-requires
|
||||||
|
commands = nosetests {posargs}
|
||||||
|
|
||||||
|
[testenv:pep8]
|
||||||
|
deps = pep8==1.1
|
||||||
|
commands = pep8 --repeat --show-source --exclude=.venv,.tox,dist,doc,*.egg .
|
||||||
|
|
||||||
|
[testenv:cover]
|
||||||
|
setenv = NOSE_WITH_COVERAGE=1
|
||||||
|
|
||||||
|
[testenv:pyflakes]
|
||||||
|
deps = pyflakes
|
||||||
|
commands = pyflakes gerritbot/bot.py gerritbot/version.py setup.py
|
||||||
|
|
||||||
|
[testenv:venv]
|
||||||
|
commands = {posargs}
|
Loading…
x
Reference in New Issue
Block a user