yunohost/src/migrations/0024_rebuild_python_venv.py
2022-08-07 23:15:24 +02:00

148 lines
5 KiB
Python

import os
from moulinette import m18n
from moulinette.utils.log import getActionLogger
from moulinette.utils.process import call_async_output
from yunohost.tools import Migration, tools_migrations_state
from moulinette.utils.filesystem import rm, read_file
logger = getActionLogger("yunohost.migration")
VENV_REQUIREMENTS_SUFFIX = ".requirements_backup_for_bullseye_upgrade.txt"
def extract_app_from_venv_path(venv_path):
venv_path = venv_path.replace("/var/www/", "")
venv_path = venv_path.replace("/opt/yunohost/", "")
venv_path = venv_path.replace("/opt/", "")
return venv_path.split("/")[0]
def _get_all_venvs(dir, level=0, maxlevel=3):
"""
Returns the list of all python virtual env directories recursively
Arguments:
dir - the directory to scan in
maxlevel - the depth of the recursion
level - do not edit this, used as an iterator
"""
# Using os functions instead of glob, because glob doesn't support hidden
# folders, and we need recursion with a fixed depth
result = []
for file in os.listdir(dir):
path = os.path.join(dir, file)
if os.path.isdir(path):
activatepath = os.path.join(path, "bin", "activate")
if os.path.isfile(activatepath) and os.path.isfile(path + VENV_REQUIREMENTS_SUFFIX):
result.append(path)
continue
if level < maxlevel:
result += _get_all_venvs(path, level=level + 1)
return result
class MyMigration(Migration):
"""
After the update, recreate a python virtual env based on the previously
generated requirements file
"""
ignored_python_apps = [
"calibreweb",
"django-for-runners",
"ffsync",
"jupiterlab",
"librephotos",
"mautrix",
"mediadrop",
"mopidy",
"pgadmin",
"tracim",
"synapse",
"weblate"
]
dependencies = ["migrate_to_bullseye"]
state = None
def is_pending(self):
if not self.state:
self.state = tools_migrations_state()["migrations"].get("0024_rebuild_python_venv", "pending")
return self.state == "pending"
@property
def mode(self):
if not self.is_pending():
return "auto"
if _get_all_venvs("/opt/") + _get_all_venvs("/var/www/"):
return "manual"
else:
return "auto"
@property
def disclaimer(self):
# Avoid having a super long disclaimer to generate if migrations has
# been done
if not self.is_pending():
return None
ignored_apps = []
rebuild_apps = []
venvs = _get_all_venvs("/opt/") + _get_all_venvs("/var/www/")
for venv in venvs:
if not os.path.isfile(venv + VENV_REQUIREMENTS_SUFFIX):
continue
app_corresponding_to_venv = extract_app_from_venv_path(venv)
# Search for ignore apps
if any(app_corresponding_to_venv.startswith(app) for app in self.ignored_python_apps):
ignored_apps.append(app_corresponding_to_venv)
else:
rebuild_apps.append(app_corresponding_to_venv)
msg = m18n.n("migration_0024_rebuild_python_venv_disclaimer_base")
if rebuild_apps:
msg += "\n\n" + m18n.n("migration_0024_rebuild_python_venv_disclaimer_rebuild",
rebuild_apps="\n - " + "\n - ".join(rebuild_apps))
if ignored_apps:
msg += "\n\n" + m18n.n("migration_0024_rebuild_python_venv_disclaimer_ignored",
ignored_apps="\n - " + "\n - ".join(ignored_apps))
return msg
def run(self):
venvs = _get_all_venvs("/opt/") + _get_all_venvs("/var/www/")
for venv in venvs:
app_corresponding_to_venv = extract_app_from_venv_path(venv)
# Search for ignore apps
if any(app_corresponding_to_venv.startswith(app) for app in self.ignored_python_apps):
rm(venv + VENV_REQUIREMENTS_SUFFIX)
logger.info(m18n.n("migration_0024_rebuild_python_venv_broken_app", app=app_corresponding_to_venv))
continue
logger.info(m18n.n("migration_0024_rebuild_python_venv_in_progress", app=app_corresponding_to_venv))
# Recreate the venv
rm(venv, recursive=True)
callbacks = (
lambda l: logger.debug("+ " + l.rstrip() + "\r"),
lambda l: logger.warning(l.rstrip())
)
call_async_output(["python", "-m", "venv", venv], callbacks)
status = call_async_output([
f"{venv}/bin/pip", "install", "-r",
venv + VENV_REQUIREMENTS_SUFFIX], callbacks)
if status != 0:
logger.error(m18n.n("migration_0024_rebuild_python_venv_failed",
app=app_corresponding_to_venv))
else:
rm(venv + VENV_REQUIREMENTS_SUFFIX)