Added tool to build a complete Elasticsearch release.
This tool builds a release and runs several checks to make sure the release is in a reasonable shape (smoke test). From a top level perspective it runs the following steps: * clean the build environment `mvn clean` * check if a Java 6 JDK is available * run the tests with network and local * generates the checksums for the binary packages * uploads the binary packages to Amazon S3 * runs a 'mvn deploy' to publish the maven artifacts The script will create an intermediate branch from a given 'release branch' updates all versions based on the version we are currently releasing. Updates the 'pom.xml' file as well as the 'Version.java' class. Once this is done it commits the changes and rebase with the branch we want to release from, merges the changes from the intermediate branch and pushes to the given remote repository including the release tag.
This commit is contained in:
Simon Willnauer
parent
5474cffe8f
commit
35f33c4bbc
|
|
@ -0,0 +1,370 @@
|
|||
# Licensed to ElasticSearch and Shay Banon under one or more
|
||||
# contributor license agreements. See the NOTICE file distributed with
|
||||
# this work for additional information regarding copyright ownership.
|
||||
# The ASF licenses this file to You 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 re
|
||||
import tempfile
|
||||
import shutil
|
||||
import os
|
||||
import datetime
|
||||
import json
|
||||
import time
|
||||
import sys
|
||||
import argparse
|
||||
import hmac
|
||||
import urllib
|
||||
from http.client import HTTPConnection
|
||||
|
||||
LOG = '/tmp/release.log'
|
||||
|
||||
def log(msg):
|
||||
f = open(LOG, mode='ab')
|
||||
f.write(msg.encode('utf-8'))
|
||||
f.close()
|
||||
|
||||
def run(command, quiet=False):
|
||||
log('\n\n%s: RUN: %s\n' % (datetime.datetime.now(), command))
|
||||
if os.system('%s >> %s 2>&1' % (command, LOG)):
|
||||
msg = ' FAILED: %s [see log %s]' % (command, LOG)
|
||||
if not quiet:
|
||||
print(msg)
|
||||
raise RuntimeError(msg)
|
||||
|
||||
env = os.environ
|
||||
try:
|
||||
JAVA_HOME = env['JAVA_HOME']
|
||||
except KeyError:
|
||||
raise RuntimeError("""
|
||||
Please set JAVA_HOME in the env before running release tool
|
||||
On OSX use: export JAVA_HOME=`/usr/libexec/java_home -v '1.6*'`""")
|
||||
|
||||
try:
|
||||
JAVA_HOME = env['JAVA6_HOME']
|
||||
except KeyError:
|
||||
pass #no JAVA6_HOME - we rely on JAVA_HOME
|
||||
|
||||
|
||||
try:
|
||||
MVN='mvn'
|
||||
# make sure mvn3 is used if mvn3 is available
|
||||
# some systems use maven 2 as default
|
||||
run('mvn3 --version', quiet=True)
|
||||
MVN='mvn3'
|
||||
except RuntimeError:
|
||||
pass
|
||||
|
||||
|
||||
def java_exe():
|
||||
path = JAVA_HOME
|
||||
return 'export JAVA_HOME="%s" PATH="%s/bin:$PATH" JAVACMD="%s/bin/java"' % (path, path, path)
|
||||
|
||||
def verify_java_version(version):
|
||||
s = os.popen('%s; java -version 2>&1' % java_exe()).read()
|
||||
if s.find(' version "%s.' % version) == -1:
|
||||
raise RuntimeError('got wrong version for java %s:\n%s' % (version, s))
|
||||
|
||||
def verify_mvn_java_version(version, mvn):
|
||||
s = os.popen('%s; %s --version 2>&1' % (java_exe(), mvn)).read()
|
||||
if s.find('Java version: %s' % version) == -1:
|
||||
raise RuntimeError('got wrong java version for %s %s:\n%s' % (mvn, version, s))
|
||||
|
||||
def get_head_hash():
|
||||
return os.popen('git rev-parse --verify HEAD 2>&1').read().strip()
|
||||
|
||||
def get_current_branch():
|
||||
return os.popen('git rev-parse --abbrev-ref HEAD 2>&1').read().strip()
|
||||
|
||||
verify_java_version('1.6') # we require to build with 1.6
|
||||
verify_mvn_java_version('1.6', MVN)
|
||||
|
||||
def release_branch(release):
|
||||
return 'release_branch_%s' % (release)
|
||||
|
||||
def create_release_branch(remote, src_branch, release):
|
||||
run('git checkout %s' % (src_branch))
|
||||
run('git pull --rebase %s %s' % (remote, src_branch))
|
||||
run('git checkout -b %s' % (release_branch(release)))
|
||||
|
||||
|
||||
def process_file(file_path, line_callback):
|
||||
fh, abs_path = tempfile.mkstemp()
|
||||
with open(abs_path,'w') as new_file:
|
||||
with open(file_path) as old_file:
|
||||
for line in old_file:
|
||||
new_file.write(line_callback(line))
|
||||
#close temp file
|
||||
new_file.close()
|
||||
os.close(fh)
|
||||
old_file.close()
|
||||
#Remove original file
|
||||
os.remove(file_path)
|
||||
#Move new file
|
||||
shutil.move(abs_path, file_path)
|
||||
|
||||
|
||||
def remove_maven_snapshot(pom, release):
|
||||
pattern = '<version>%s-SNAPSHOT</version>' % (release)
|
||||
replacement = '<version>%s</version>' % (release)
|
||||
def callback(line):
|
||||
return line.replace(pattern, replacement)
|
||||
process_file(pom, callback)
|
||||
|
||||
|
||||
def remove_version_snapshot(version_file, release):
|
||||
# 1.0.0.Beta1 -> 1_0_0_Beat1
|
||||
release = release.replace('.', '_')
|
||||
pattern = 'new Version(V_%s_ID, true' % (release)
|
||||
replacement = 'new Version(V_%s_ID, false' % (release)
|
||||
def callback(line):
|
||||
return line.replace(pattern, replacement)
|
||||
process_file(version_file, callback)
|
||||
|
||||
def add_pending_files(*files):
|
||||
for file in files:
|
||||
run('git add %s' % (file))
|
||||
|
||||
def commit_release(release):
|
||||
run('git commit -m "release [%s]"' % release)
|
||||
|
||||
def tag_release(release):
|
||||
run('git tag -a v%s -m "Tag release version %s"' % (release, release))
|
||||
|
||||
def run_mvn(*cmd):
|
||||
for c in cmd:
|
||||
run('%s; %s %s' % (java_exe(), MVN, c))
|
||||
def build_release(run_tests=False, dry_run=True, cpus=1):
|
||||
target = 'deploy'
|
||||
if dry_run:
|
||||
target = 'package'
|
||||
if run_tests:
|
||||
run_mvn('clean',
|
||||
'test -Dtests.cpu=%s -Des.node.mode=local' % (cpus),
|
||||
'test -Dtests.cpu=%s -Des.node.mode=network' % (cpus))
|
||||
run_mvn('clean %s -DskipTests' %(target))
|
||||
|
||||
|
||||
def wait_for_node_startup(host='127.0.0.1', port=9200,timeout=15):
|
||||
conn = HTTPConnection(host, port, timeout);
|
||||
for _ in range(timeout):
|
||||
try:
|
||||
time.sleep(1)
|
||||
conn.request('GET', '')
|
||||
res = conn.getresponse()
|
||||
if res.status == 200:
|
||||
return True
|
||||
except:
|
||||
pass #that is ok it might not be there yet
|
||||
|
||||
return False
|
||||
|
||||
def find_release_version(src_branch):
|
||||
run('git checkout %s' % (src_branch))
|
||||
with open('pom.xml') as file:
|
||||
for line in file:
|
||||
match = re.search(r'<version>(.+)-SNAPSHOT</version>', line)
|
||||
if match:
|
||||
return match.group(1)
|
||||
raise RuntimeError('Could not find release version in branch %s' % (src_branch))
|
||||
|
||||
def get_artifacts(release, path='target/releases/'):
|
||||
return [os.path.join(path, 'elasticsearch-%s.%s' % (release, t)) for t in ['deb', 'tar.gz', 'zip']]
|
||||
|
||||
def generate_checksums(files):
|
||||
res = []
|
||||
for release_file in files:
|
||||
directory = os.path.dirname(release_file)
|
||||
file = os.path.basename(release_file)
|
||||
checksum_file = '%s.sha1.txt' % file
|
||||
|
||||
if os.system('cd %s; shasum %s > %s' % (directory, file, checksum_file)):
|
||||
raise RuntimeError('Failed to generate checksum for file %s' % release_file)
|
||||
res = res + [os.path.join(directory, checksum_file), release_file]
|
||||
return res
|
||||
|
||||
def smoke_test_release(release, files):
|
||||
for release_file in files:
|
||||
if not os.path.isfile(release_file):
|
||||
raise RuntimeError('Smoketest failed missing file %s' % (release_file))
|
||||
tmp_dir = tempfile.mkdtemp()
|
||||
if release_file.endswith('tar.gz'):
|
||||
run('tar -xzf %s -C %s' % (release_file, tmp_dir))
|
||||
elif release_file.endswith('zip'):
|
||||
run('unzip %s -d %s' % (release_file, tmp_dir))
|
||||
else:
|
||||
continue # nothing to do here
|
||||
es_run_path = os.path.join(tmp_dir, 'elasticsearch-%s' % (release), 'bin/elasticsearch')
|
||||
print(' Smoke testing package [%s]' % release_file)
|
||||
print(' Starting elasticsearch deamon from [%s]' % os.path.join(tmp_dir, 'elasticsearch-%s' % release))
|
||||
run('%s; %s -Des.node.name=smoke_tester' % (java_exe(), es_run_path))
|
||||
conn = HTTPConnection('127.0.0.1', 9200, 20);
|
||||
wait_for_node_startup()
|
||||
try:
|
||||
try:
|
||||
conn.request('GET', '')
|
||||
res = conn.getresponse()
|
||||
if res.status == 200:
|
||||
version = json.loads(res.read().decode("utf-8"))['version']
|
||||
if release != version['number']:
|
||||
raise RuntimeError('Expected version [%s] but was [%s]' % (release, version['number']))
|
||||
if version['build_snapshot']:
|
||||
raise RuntimeError('Expected non snapshot version')
|
||||
if version['build_hash'].strip() != get_head_hash():
|
||||
raise RuntimeError('HEAD hash does not match expected [%s] but got [%s]' % (get_head_hash(), version['build_hash']))
|
||||
else:
|
||||
raise RuntimeError('Expected HTTP 200 but got %s' % res.status)
|
||||
finally:
|
||||
conn.request('POST', '/_cluster/nodes/_local/_shutdown')
|
||||
time.sleep(1) # give the node some time to shut down
|
||||
if conn.getresponse().status != 200:
|
||||
raise RuntimeError('Expected HTTP 200 but got %s on node shutdown' % res.status)
|
||||
|
||||
finally:
|
||||
conn.close()
|
||||
shutil.rmtree(tmp_dir)
|
||||
|
||||
def merge_tag_push(remote, src_branch, release_version, dry_run):
|
||||
run('git checkout %s' % src_branch)
|
||||
run('git merge %s' % release_branch(release_version))
|
||||
run('git tag v%s' % release_version)
|
||||
if not dry_run:
|
||||
run('git push %s %s' % (remote, src_branch)) # push the commit
|
||||
run('git push %s v%s' % (remote, release_version)) # push the tag
|
||||
else:
|
||||
print(' dryrun [True] -- skipping push to remote %s' % remote)
|
||||
|
||||
def publish_artifacts(artifacts, base='elasticsearch/elasticsearch', dry_run=True):
|
||||
location = os.path.dirname(os.path.realpath(__file__))
|
||||
for artifact in artifacts:
|
||||
if dry_run:
|
||||
print('Skip Uploading %s to Amazon S3' % artifact)
|
||||
else:
|
||||
print('Uploading %s to Amazon S3' % artifact)
|
||||
# requires boto to be installed but it is not available on python3k yet so we use a dedicated tool
|
||||
run('python %s/upload-s3.py --file %s ' % (location, os.path.abspath(artifact)))
|
||||
|
||||
def print_sonartype_notice():
|
||||
settings = os.path.join(os.path.expanduser('~'), '.m2/settings.xml')
|
||||
if os.path.isfile(settings):
|
||||
with open(settings) as settings_file:
|
||||
for line in settings_file:
|
||||
if line.strip() == '<id>sonatype-nexus-snapshots</id>':
|
||||
# moving out - we found the indicator no need to print the warning
|
||||
return
|
||||
print("""
|
||||
NOTE: No sonartype settings detected, make sure you have configured
|
||||
your sonartype credentials in '~/.m2/settings.xml':
|
||||
|
||||
<settings>
|
||||
...
|
||||
<servers>
|
||||
<server>
|
||||
<id>sonatype-nexus-snapshots</id>
|
||||
<username>your-jira-id</username>
|
||||
<password>your-jira-pwd</password>
|
||||
</server>
|
||||
<server>
|
||||
<id>sonatype-nexus-staging</id>
|
||||
<username>your-jira-id</username>
|
||||
<password>your-jira-pwd</password>
|
||||
</server>
|
||||
</servers>
|
||||
...
|
||||
</settings>
|
||||
""")
|
||||
|
||||
def check_s3_credentials():
|
||||
if not env.get('AWS_ACCESS_KEY_ID', None) or not env.get('AWS_SECRET_ACCESS_KEY', None):
|
||||
raise RuntimeError('Could not find "AWS_ACCESS_KEY_ID" / "AWS_SECRET_ACCESS_KEY" in the env variables please export in order to upload to S3')
|
||||
|
||||
VERSION_FILE = 'src/main/java/org/elasticsearch/Version.java'
|
||||
POM_FILE = 'pom.xml'
|
||||
|
||||
# we print a notice if we can not find the relevant infos in the ~/.m2/settings.xml
|
||||
print_sonartype_notice()
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser(description='Builds and publishes a Elasticsearch Release')
|
||||
parser.add_argument('--branch', '-b', metavar='master', default=get_current_branch(),
|
||||
help='The branch to release from. Defaults to the current branch.')
|
||||
parser.add_argument('--cpus', '-c', metavar='1', default=1,
|
||||
help='The number of cpus to use for running the test. Default is [1]')
|
||||
parser.add_argument('--skiptests', '-t', dest='tests', action='store_false',
|
||||
help='Skips tests before release. Tests are run by default.')
|
||||
parser.set_defaults(tests=True)
|
||||
parser.add_argument('--remote', '-r', metavar='origin', default='origin',
|
||||
help='The remote to push the release commit and tag to. Default is [origin]')
|
||||
parser.add_argument('--publish', '-d', dest='dryrun', action='store_false',
|
||||
help='Publishes the release. Disable by default.')
|
||||
parser.set_defaults(dryrun=True)
|
||||
args = parser.parse_args()
|
||||
|
||||
src_branch = args.branch
|
||||
remote = args.remote
|
||||
run_tests = args.tests
|
||||
dry_run = args.dryrun
|
||||
cpus = args.cpus
|
||||
if not dry_run:
|
||||
check_s3_credentials()
|
||||
print('WARNING: dryrun is set to "false" - this will push and publish the release')
|
||||
input('Press Enter to continue...')
|
||||
|
||||
print(''.join(['-' for _ in range(80)]))
|
||||
print('Preparing Release from branch [%s] running tests: [%s] dryrun: [%s]' % (src_branch, run_tests, dry_run))
|
||||
print(' JAVA_HOME is [%s]' % JAVA_HOME)
|
||||
print(' Running with maven command: [%s] ' % (MVN))
|
||||
release_version = find_release_version(src_branch)
|
||||
head_hash = get_head_hash()
|
||||
run_mvn('clean') # clean the env!
|
||||
print(' Release version: [%s]' % release_version)
|
||||
create_release_branch(remote, src_branch, release_version)
|
||||
print(' Created release branch [%s]' % (release_branch(release_version)))
|
||||
success = False
|
||||
try:
|
||||
remove_maven_snapshot(POM_FILE, release_version)
|
||||
remove_version_snapshot(VERSION_FILE, release_version)
|
||||
print(' Done removing snapshot version')
|
||||
add_pending_files(VERSION_FILE, POM_FILE)
|
||||
commit_release(release_version)
|
||||
print(' Committed release version [%s]' % (release_version))
|
||||
print(''.join(['-' for _ in range(80)]))
|
||||
print('Building Release candidate')
|
||||
input('Press Enter to continue...')
|
||||
print(' Running maven builds now - run-tests [%s]' % run_tests)
|
||||
build_release(run_tests=run_tests, dry_run=True, cpus=cpus)
|
||||
artifacts = get_artifacts(release_version)
|
||||
artifacts_and_checksum = generate_checksums(artifacts)
|
||||
smoke_test_release(release_version, artifacts)
|
||||
print(''.join(['-' for _ in range(80)]))
|
||||
print('Finish Release -- dry_run: %s' % dry_run)
|
||||
input('Press Enter to continue...')
|
||||
print(' merge release branch, tag and push to %s %s -- dry_run: %s' % (remote, src_branch, dry_run))
|
||||
merge_tag_push(remote, src_branch, release_version, dry_run)
|
||||
print(' publish artifacts to S3 -- dry_run: %s' % dry_run)
|
||||
publish_artifacts(artifacts_and_checksum, dry_run=dry_run)
|
||||
print(' publish maven artifacts -- dry_run: %s' % dry_run)
|
||||
if not dry_run:
|
||||
build_release(run_tests=False, dry_run=dry_run)
|
||||
success = True
|
||||
finally:
|
||||
if not success:
|
||||
run('git reset --hard HEAD')
|
||||
run('git checkout %s' % src_branch)
|
||||
elif dry_run:
|
||||
run('git reset --hard %s' % head_hash)
|
||||
run('git tag -d v%s' % release_version)
|
||||
# we delete this one anyways
|
||||
run('git branch -D %s' % (release_branch(release_version)))
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
# Licensed to ElasticSearch and Shay Banon under one or more
|
||||
# contributor license agreements. See the NOTICE file distributed with
|
||||
# this work for additional information regarding copyright ownership.
|
||||
# The ASF licenses this file to You 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 sys
|
||||
import argparse
|
||||
try:
|
||||
import boto.s3
|
||||
except:
|
||||
raise RuntimeError("""
|
||||
S3 upload requires boto to be installed
|
||||
Use one of:
|
||||
'pip install -U boto'
|
||||
'apt-get install python-boto'
|
||||
'easy_install boto'
|
||||
""")
|
||||
|
||||
import boto.s3
|
||||
|
||||
|
||||
def list_buckets(conn):
|
||||
return conn.get_all_buckets()
|
||||
|
||||
|
||||
def upload_s3(conn, path, key, file, bucket):
|
||||
print 'Uploading %s to Amazon S3 bucket %s/%s' % \
|
||||
(file, bucket, os.path.join(path, key))
|
||||
def percent_cb(complete, total):
|
||||
sys.stdout.write('.')
|
||||
sys.stdout.flush()
|
||||
bucket = conn.create_bucket(bucket)
|
||||
k = bucket.new_key(os.path.join(path, key))
|
||||
k.set_contents_from_filename(file, cb=percent_cb, num_cb=100)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser(description='Uploads files to Amazon S3')
|
||||
parser.add_argument('--file', '-f', metavar='path to file',
|
||||
help='the branch to release from', required=True)
|
||||
parser.add_argument('--bucket', '-b', metavar='B42', default='download.elasticsearch.org',
|
||||
help='The S3 Bucket to upload to')
|
||||
parser.add_argument('--path', '-p', metavar='elasticsearch/elasticsearch', default='elasticsearch/elasticsearch',
|
||||
help='The key path to use')
|
||||
parser.add_argument('--key', '-k', metavar='key', default=None,
|
||||
help='The key - uses the file name as default key')
|
||||
args = parser.parse_args()
|
||||
if args.key:
|
||||
key = args.key
|
||||
else:
|
||||
key = os.path.basename(args.file)
|
||||
|
||||
connection = boto.connect_s3()
|
||||
upload_s3(connection, args.path, key, args.file, args.bucket);
|
||||
|
||||
Loading…
Reference in New Issue