mirror of
https://github.com/checktheroads/hyperglass
synced 2024-05-11 05:55:08 +00:00
88 lines
2.1 KiB
Python
88 lines
2.1 KiB
Python
"""API Events."""
|
|
# Third Party
|
|
from starlette.exceptions import HTTPException
|
|
|
|
# Project
|
|
from hyperglass.util import (
|
|
log,
|
|
check_redis,
|
|
check_python,
|
|
build_frontend,
|
|
clear_redis_cache,
|
|
)
|
|
from hyperglass.exceptions import HyperglassError
|
|
from hyperglass.configuration import (
|
|
URL_DEV,
|
|
URL_PROD,
|
|
CONFIG_PATH,
|
|
REDIS_CONFIG,
|
|
params,
|
|
frontend_params,
|
|
)
|
|
|
|
|
|
async def check_python_version():
|
|
"""Ensure Python version meets minimum requirement.
|
|
|
|
Raises:
|
|
HyperglassError: Raised if Python version is invalid.
|
|
"""
|
|
try:
|
|
python_version = check_python()
|
|
log.info(f"Python {python_version} detected")
|
|
except RuntimeError as r:
|
|
raise HyperglassError(str(r), level="danger") from None
|
|
|
|
|
|
async def check_redis_instance():
|
|
"""Ensure Redis is running before starting server.
|
|
|
|
Raises:
|
|
HyperglassError: Raised if Redis is not running.
|
|
|
|
Returns:
|
|
{bool} -- True if Redis is running.
|
|
"""
|
|
try:
|
|
await check_redis(db=params.cache.database, config=REDIS_CONFIG)
|
|
except RuntimeError as e:
|
|
raise HyperglassError(str(e), level="danger") from None
|
|
|
|
log.debug(f"Redis is running at: {REDIS_CONFIG['host']}:{REDIS_CONFIG['port']}")
|
|
return True
|
|
|
|
|
|
async def build_ui():
|
|
"""Perform a UI build prior to starting the application.
|
|
|
|
Raises:
|
|
HTTPException: Raised if any build errors occur.
|
|
|
|
Returns:
|
|
{bool} -- True if successful.
|
|
"""
|
|
try:
|
|
await build_frontend(
|
|
dev_mode=params.developer_mode,
|
|
dev_url=URL_DEV,
|
|
prod_url=URL_PROD,
|
|
params=frontend_params,
|
|
app_path=CONFIG_PATH,
|
|
)
|
|
except RuntimeError as e:
|
|
raise HTTPException(detail=str(e), status_code=500)
|
|
return True
|
|
|
|
|
|
async def clear_cache():
|
|
"""Clear the Redis cache on shutdown."""
|
|
try:
|
|
await clear_redis_cache(db=params.cache.database, config=REDIS_CONFIG)
|
|
except RuntimeError as e:
|
|
log.error(str(e))
|
|
pass
|
|
|
|
|
|
on_startup = [check_python_version, check_redis_instance, build_ui]
|
|
on_shutdown = [clear_cache]
|