def remove_build_storage_paths(paths):
"""
Remove artifacts from build media storage (cloud or local storage).
:param paths: list of paths in build media storage to delete
"""
log.info('Removing path from media storage.', paths=paths)
for storage_path in paths:
build_media_storage.delete_directory(storage_path)
def store_build_artifacts(
self,
environment,
html=False,
localmedia=False,
search=False,
pdf=False,
epub=False,
):
"""
Save build artifacts to "storage" using Django's storage API.
The storage could be local filesystem storage OR cloud blob storage
such as S3, Azure storage or Google Cloud Storage.
Remove build artifacts of types not included in this build (PDF, ePub, zip only).
:param html: whether to save HTML output
:param localmedia: whether to save localmedia (htmlzip) output
:param search: whether to save search artifacts
:param pdf: whether to save PDF output
:param epub: whether to save ePub output
"""
log.info('Writing build artifacts to media storage')
# NOTE: I don't remember why we removed this state from the Build
# object. I'm re-adding it because I think it's useful, but we can
# remove it if we want
self.update_build(state=BUILD_STATE_UPLOADING)
types_to_copy = []
types_to_delete = []
# HTML media
if html:
types_to_copy.append(('html', self.data.config.doctype))
# Search media (JSON)
if search:
types_to_copy.append(('json', 'sphinx_search'))
if localmedia:
types_to_copy.append(('htmlzip', 'sphinx_localmedia'))
else:
types_to_delete.append('htmlzip')
if pdf:
types_to_copy.append(('pdf', 'sphinx_pdf'))
else:
types_to_delete.append('pdf')
if epub:
types_to_copy.append(('epub', 'sphinx_epub'))
else:
types_to_delete.append('epub')
for media_type, build_type in types_to_copy:
from_path = self.data.version.project.artifact_path(
version=self.data.version.slug,
type_=build_type,
)
to_path = self.data.version.project.get_storage_path(
type_=media_type,
version_slug=self.data.version.slug,
include_file=False,
version_type=self.data.version.type,
)
try:
build_media_storage.sync_directory(from_path, to_path)
except Exception:
# Ideally this should just be an IOError
# but some storage backends unfortunately throw other errors
log.exception(
'Error copying to storage (not failing build)',
media_type=media_type,
from_path=from_path,
to_path=to_path,
)
for media_type in types_to_delete:
media_path = self.data.version.project.get_storage_path(
type_=media_type,
version_slug=self.data.version.slug,
include_file=False,
version_type=self.data.version.type,
)
try:
build_media_storage.delete_directory(media_path)
except Exception:
# Ideally this should just be an IOError
# but some storage backends unfortunately throw other errors
log.exception(
'Error deleting from storage (not failing build)',
media_type=media_type,
media_path=media_path,
)