def setup_remote(quiet=True):
''' Setup remote environment before we can proceed with the deployment process. '''
base_dir = get_deploy_dir()
release_dir = get_release_dir()
current_path = get_current_path()
preset = get_config()['deployment']['preset']
did_setup = False
stage = shell.get_stage()
# If the release directory does not exist, create it.
if not fs.exists(release_dir):
info('Setting up {} server for {} deployment'.format(stage, preset))
fs.mkdir(release_dir, nested=True)
# Create new build meta file.
save_history(merge(INITIAL_BUILD_HISTORY, {'preset': preset}))
# Setup a default web page for web deployment.
if preset == presets.WEB:
setup_default_html(base_dir)
did_setup = True
if not did_setup and not quiet:
info('Remote already setup for deployment')
return (release_dir, current_path)
def test_info(capsys):
''' Test for info() '''
message = 'Test message'
info(message)
out, _ = capsys.readouterr()
assert message in out
def env_inject_secrets(path, silent=False):
'''
Read secrets from the vault (from the given path),
and inject them into the environment as env vars.
'''
secrets = read_secrets(path)
if not silent:
info('Using secrets from vault ({})'.format(path))
for key, value in secrets.iteritems():
os.environ[key] = value
def build(stage, config):
'''
Trigger build script to prepare a build for the given stage.
'''
info('Getting the build ready for deployment')
# Trigger the install script
runner.run_script(known_scripts.INSTALL, remote=False)
env_vars = get_build_env_vars(stage, config)
with shell_env(**env_vars):
runner.run_script(known_scripts.BUILD, remote=False)
def delete_old_builds(history):
''' Delete old unnecessary build directories from the remote. '''
build_path = get_release_dir()
kept_builds = map(lambda x: get_build_name(x['id']), history['builds'])
found_builds = fs.glob(build_path)
old_builds = [x for x in found_builds if x not in kept_builds]
# Skip, if there are no builds to be deleted.
if not old_builds:
return
old_builds = map(lambda x: os.path.join(build_path, x), old_builds)
# Remove directories to be deleted.
fs.rm_rf(old_builds)
info('Deleted {} old build(s) from the remote'.format(len(old_builds)))
def deploy():
''' Zero-Downtime deployment for the backend. '''
config = get_config()
stage = shell.get_stage()
is_first_deployment = not buildman.is_remote_setup()
branch = git.current_branch(remote=False)
commit = git.last_commit(remote=False, short=True)
info('Deploying <{branch}:{commit}> to the {stage} server'.format(
branch=branch, commit=commit, stage=stage))
tmp_path = fs.get_temp_filename()
build_dir = buildman.resolve_local_build_dir()
included_files = config['deployment']['include_files']
deployer_user = shell.get_user()
notif.send(notification_types.DEPLOYMENT_STARTED, {
'user': deployer_user,
'commit': commit,
'branch': branch,
'stage': stage
})
(release_dir, current_path) = buildman.setup_remote()
timestamp = datetime.utcnow()
build_id = timestamp.strftime('%Y%m%d%H%M%S')
build_name = buildman.get_build_name(build_id)
build_compressed = build_name + '.tar.gz'
release_path = release_dir + '/' + build_name
dist_path = build_name + '/dist'
buildman.build(stage, config)
info('Compressing the build')
fs.tar_archive(build_compressed, build_dir, remote=False)
info('Uploading the build {} to {}'.format(build_compressed, tmp_path))
fs.upload(build_compressed, tmp_path)
# Remove the compressed build from the local directory.
fs.rm(build_compressed, remote=False)
# Once, the build is uploaded to the remote,
# set things up in the remote server.
with cd(release_dir):
remote_info('Extracting the build {}'.format(build_compressed))
# Create a new directory for the build in the remote.
fs.mkdir(dist_path, nested=True)
# Extract the build.
fs.tar_extract(tmp_path, dist_path)
# Remove the uploaded archived from the temp path.
fs.rm_rf(tmp_path)
# Upload the files to be included eg: package.json file
# to the remote build location.
upload_included_files(included_files, release_path)
remote_info('Pointing the current symlink to the latest build')
fs.update_symlink(release_path, current_path)
# Change directory to the release path.
with cd(current_path):
install_remote_dependencies()
# Start or restart the application service.
start_or_reload_service(is_first_deployment)
# Save build history
buildman.record_history({
'id': build_id,
'path': release_path,
'branch': branch,
'commit': commit,
'stage': stage,
'createdBy': deployer_user,
'timestamp': timestamp.strftime(buildman.TS_FORMAT)
})
# Send deployment finished notification.
notif.send(notification_types.DEPLOYMENT_FINISHED, {
'user': deployer_user,
'branch': branch,
'commit': commit,
'stage': stage
})
remote_info('Deployment Completed')
def deploy():
''' Zero-Downtime deployment for the web. '''
config = get_config()
stage = shell.get_stage()
user = get_stage_config(stage)['user']
# Get the current branch and commit (locally).
branch = git.current_branch(remote=False)
commit = git.last_commit(remote=False, short=True)
info('Deploying <{branch}:{commit}> to the {stage} server'.format(
branch=branch, commit=commit, stage=stage))
tmp_path = fs.get_temp_filename()
build_dir = buildman.resolve_local_build_dir()
deploy_dir = buildman.get_deploy_dir()
deployer_user = shell.get_user()
notif.send(notification_types.DEPLOYMENT_STARTED, {
'user': deployer_user,
'branch': branch,
'commit': commit,
'stage': stage
})
(release_dir, current_path) = buildman.setup_remote()
timestamp = datetime.utcnow()
build_id = timestamp.strftime('%Y%m%d%H%M%S')
build_name = buildman.get_build_name(build_id)
build_compressed = build_name + '.tar.gz'
release_path = release_dir + '/' + build_name
buildman.build(stage, config)
info('Compressing the build')
fs.tar_archive(build_compressed, build_dir, remote=False)
info('Uploading the build {} to {}'.format(build_compressed, tmp_path))
fs.upload(build_compressed, tmp_path)
# Remove the compressed build from the local directory.
fs.rm(build_compressed, remote=False)
# Once, the build is uploaded to the remote,
# set things up in the remote server.
with cd(release_dir):
remote_info('Extracting the build {}'.format(build_compressed))
# Create a new directory for the build in the remote.
fs.mkdir(build_name)
# Extract the build.
fs.tar_extract(tmp_path, build_name)
# Remove the uploaded archived from the temp path.
fs.rm_rf(tmp_path)
remote_info('Changing ownership of {} to user {}'.format(
deploy_dir, user))
fs.chown(release_path, user, user)
remote_info('Pointing the current symlink to the latest build')
fs.update_symlink(release_path, current_path)
# Save build history
buildman.record_history({
'id': build_id,
'path': release_path,
'branch': branch,
'commit': commit,
'stage': stage,
'createdBy': deployer_user,
'timestamp': timestamp.strftime(buildman.TS_FORMAT)
})
# Send deployment finished notification.
notif.send(notification_types.DEPLOYMENT_FINISHED, {
'user': deployer_user,
'branch': branch,
'commit': commit,
'stage': stage
})
remote_info('Deployment Completed')
def deploy():
''' Zero-Downtime deployment for the backend. '''
config = get_config()
stage = shell.get_stage()
is_remote_setup = buildman.is_remote_setup()
is_first_deployment = not is_remote_setup
if is_remote_setup and buildman.is_remote_up_to_date():
echo('Remote build is already up to date.')
return
branch = git.current_branch(remote=False)
commit = git.last_commit(remote=False, short=True)
info('Deploying <{branch}:{commit}> to the {stage} server'.format(
branch=branch,
commit=commit,
stage=stage
))
build_dir = os.path.abspath(buildman.resolve_local_build_dir())
included_files = config['deployment']['include_files']
deployer_user = shell.get_user()
notif_params = dict(
user=deployer_user,
commit=commit,
branch=branch,
stage=stage
)
notif.send(notification_types.DEPLOYMENT_STARTED, notif_params)
runner.run_script_safely(known_scripts.PRE_DEPLOY)
(release_dir, current_path) = buildman.setup_remote()
timestamp = datetime.utcnow()
build_id = timestamp.strftime('%Y%m%d%H%M%S')
build_name = buildman.get_build_name(build_id)
release_path = os.path.join(release_dir + '/' + build_name)
dist_path = os.path.join(release_dir, build_name + '/dist')
buildman.build(stage, config)
uploader = BulkUploader()
uploader.add(build_dir, dist_path)
# Upload the files to be included eg: package.json file
# to the remote build location.
for filename in included_files:
path = os.path.abspath(filename)
# Add for upload if the file exist.
if exists_local(path):
uploader.add(path, release_path)
uploader.upload()
remote_info('Updating the current symlink')
fs.update_symlink(release_path, current_path)
# Once, the build is uploaded to the remote,
# set things up in the remote server.
# Change directory to the release path.
install_remote_dependencies(
commit=commit,
current_path=current_path,
smart_install=get_stage_config(stage)['deployment']['smart_install']
)
# Start or restart the application service.
start_or_reload_service(is_first_deployment)
# Save build history
buildman.record_history({
'id': build_id,
'path': release_path,
'branch': branch,
'commit': commit,
'stage': stage,
'createdBy': deployer_user,
'timestamp': timestamp.strftime(buildman.TS_FORMAT)
})
runner.run_script_safely(known_scripts.POST_DEPLOY)
# Send deployment finished notification.
notif.send(notification_types.DEPLOYMENT_FINISHED, notif_params)
info('Deployment Completed')