def run_script(script, remote=True):
''' Run a script. '''
custom_scripts = _get_config()['scripts']
# If the script is not defined raise error.
if not is_script_defined(script):
raise RuntimeError('Missing script "{}"'.format(script))
needs_notification = should_notify(script)
if needs_notification:
notif.send(RUNNING_SCRIPT_STARTED, {
'script': script,
'user': shell.get_user(),
'stage': shell.get_stage()
})
# Get the command defined in the script.
script_cmd = custom_scripts[script]
info_text = 'Running {}\n{}'.format(
cyan(script), cyan('> ' + script_cmd)
)
host_info(info_text, remote=remote)
# Run a custom script defined in the config.
with hide('running'):
run(script_cmd, remote)
if needs_notification:
notif.send(RUNNING_SCRIPT_FINISHED, {
'script': script,
'user': shell.get_user(),
'stage': shell.get_stage()
})
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()
build_history_path = get_builds_file()
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):
remote_info('Setting up {} server for {} deployment'.format(
stage, preset))
remote_info('Creating the releases directory {}'.format(
cyan(release_dir)))
fs.mkdir(release_dir, nested=True)
# Add build history file.
remote_info('Creating new build meta file {}'.format(
cyan(build_history_path)))
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:
remote_info('Remote already setup for deployment')
return (release_dir, current_path)
def deploy(branch=None):
''' Deploy to remote source. '''
stage = shell.get_stage()
deployer_user = shell.get_user()
branch = branch or resolve_deployment_branch(stage)
commit = git.last_commit(remote=False, short=True)
notif.send(notification_types.DEPLOYMENT_STARTED, {
'user': deployer_user,
'branch': branch,
'commit': commit,
'stage': stage
})
with cd(get_repo_path()):
runner.run_script_safely(known_scripts.PRE_DEPLOY)
# Get the latest code from the repository
sync(branch)
install_dependencies()
# Building the app
build(stage)
reload_service()
runner.run_script_safely(known_scripts.POST_DEPLOY)
notif.send(notification_types.DEPLOYMENT_FINISHED, {
'user': deployer_user,
'branch': branch,
'commit': commit,
'stage': stage
})
remote_info('Deployment Completed')
def deploy(branch=None):
''' Deploy to remote source. '''
stage = shell.get_stage()
deployer_user = shell.get_user()
branch = branch or get_stage_config(stage)['branch']
commit = git.last_commit(short=True)
notif.send(notification_types.DEPLOYMENT_STARTED, {
'user': deployer_user,
'branch': branch,
'commit': commit,
'stage': stage
})
# Get the latest code from the repository
sync(branch)
install_dependencies()
# Building the app
build(stage)
reload_service()
notif.send(notification_types.DEPLOYMENT_FINISHED, {
'user': deployer_user,
'branch': branch,
'commit': commit,
'stage': stage
})
remote_info('Deployment Completed')
def build(stage_name=None):
''' Build the application. '''
stage = shell.get_stage()
with shell_env(STAGE=(stage_name or stage)):
# Trigger the build script.
runner.run_script_safely(known_scripts.BUILD)
def configure_env():
''' Configures the fabric env. '''
config = get_config()
stage = get_stage()
stage_config = get_stage_config(stage)
env.user = stage_config.get('user') or config['user']
env.port = stage_config.get('port') or config['port']
env.cwd = stage_config.get('cwd') or config['cwd']
env.key_filename = stage_config.get(
'key_filename') or config['key_filename']
env.hosts = [stage_config['host']]
ssh_forward_agent = stage_config.get(
'ssh_forward_agent') or config['ssh_forward_agent']
env.forward_agent = (
ssh_forward_agent and
str(ssh_forward_agent).lower() == 'true'
)
# If Verbose logging is turned on show verbose logs.
verbose_logging = stage_config.get('verbose_logging') or config[
'verbose_logging']
if str(verbose_logging).lower() == 'true':
set_verbose_logging()
def get_deploy_dir():
''' Get the deployment base directory path. '''
config = get_stage_config(shell.get_stage())
deploy_dir = '{}/{}'.format(config['deployment']['base_dir'].rstrip('/'),
get_config()['project_name'])
return deploy_dir
def deploy(branch=None):
''' Deploy to remote source. '''
stage = shell.get_stage()
branch = branch or resolve_deployment_branch(stage)
params = dict(user=shell.get_user(), stage=stage, branch=branch)
notif.send(notification_types.DEPLOYMENT_STARTED, params)
run_deploy_script(stage, branch)
notif.send(notification_types.DEPLOYMENT_FINISHED, params)
remote_info('Deployment Completed')
def init(module_name):
''' Initialize the boss configuration. '''
os.environ['BOSS_RUNNING'] = 'true'
setup_boss_home()
stage = get_stage()
config = load_config(stage=stage)
module = sys.modules[module_name]
define_stage_tasks(module, config)
define_preset_tasks(module, config)
return (config, stage)
def resolve_local_build_dir():
'''
Get the local build directory and verify if it exists locally.
Throws and error if the build directory doesn't exist.
'''
config = get_stage_config(shell.get_stage())
build_dir = config['deployment']['build_dir']
# If build_dir is configured, just return it.
if build_dir:
return build_dir
# Look up for fallback local directories, if build_dir isn't provided.
for folder in LOCAL_BUILD_DIRECTORIES:
if os.path.exists(folder):
return folder
# If fallback directories don't exist either,
# return one of the default build directories.
return LOCAL_BUILD_DIRECTORIES[0]
def deploy(branch=None):
''' Deploy to remote source. '''
stage = shell.get_stage()
branch = branch or fallback_branch(stage)
notif.send(notif.DEPLOYMENT_STARTED, {
'user': shell.get_user(),
'branch': branch,
'stage': stage
})
# Get the latest code from the repository
sync(branch)
install_dependencies()
# Building the app
build(stage)
reload_service()
notif.send(notif.DEPLOYMENT_FINISHED, {'branch': branch, 'stage': stage})
remote_info('Deployment Completed')
def resolve_local_build_dir():
'''
Get the local build directory and verify if it exists locally.
Throws and error if the build directory doesn't exist.
'''
config = get_stage_config(shell.get_stage())
build_dir = config['deployment']['build_dir']
print('build dir = ', build_dir)
if not build_dir:
# Look up for fallback local directories, if it's not provided.
for folder in LOCAL_BUILD_DIRECTORIES:
if os.path.exists(folder):
return folder
elif build_dir and os.path.exists(build_dir):
# If build_dir is provided and it exists, return it.
return build_dir
halt('Build directory doesn\'t exist "{}"'.format(build_dir))
return None
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 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')
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 get_deploy_dir():
''' Get the deployment base directory path. '''
config = get_stage_config(shell.get_stage())
return config['deployment']['base_dir'].rstrip('/')
def build():
''' Build the code locally. '''
config = get_config()
stage = shell.get_stage()
buildman.build(stage, config)
