def test_resolve_local_build_dir_when_build_dir_is_configured(gsc_mock):
'''
Test resolve_local_build_dir() returns configured value if build_dir is configured.
'''
test_build_dir = 'my-build-directory'
gsc_mock.return_value = {'deployment': {'build_dir': test_build_dir}}
assert buildman.resolve_local_build_dir() == test_build_dir
def test_resolve_local_build_dir_when_build_dir_is_none(gsc_mock, exists_mock):
'''
Test resolve_local_build_dir() returns one of the default
build directories, if build_dir is not provided and
fallback directories don't exist either.
'''
exists_mock.return_value = False
gsc_mock.return_value = {'deployment': {'build_dir': None}}
result = buildman.resolve_local_build_dir()
assert result in buildman.LOCAL_BUILD_DIRECTORIES
def test_resolve_local_build_dir_when_build_dir_none_with_fallback_directory(
gsc_mock, exists_mock):
'''
Test resolve_local_build_dir(), when build_dir is not configured,
but one of the fallback directories exist locally. It should return,
the existing directory name.
'''
exists_mock.return_value = True
gsc_mock.return_value = {'deployment': {'build_dir': None}}
result = buildman.resolve_local_build_dir()
assert result in buildman.LOCAL_BUILD_DIRECTORIES[0]
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')