forked from mirrors/thatmattlove-hyperglass
implement CLI setup wizard
This commit is contained in:
checktheroads
parent
bf31d74c35
commit
dbf6628e8b
2 changed files with 199 additions and 54 deletions
|
|
@ -1,19 +1,22 @@
|
|||
"""CLI utility functions."""
|
||||
# Standard Library
|
||||
import os
|
||||
import shutil
|
||||
from typing import Iterable
|
||||
from pathlib import Path
|
||||
|
||||
# Third Party
|
||||
import click
|
||||
from click import echo, style
|
||||
|
||||
# Project
|
||||
from hyperglass.cli.echo import info, error, status, success
|
||||
from hyperglass.cli.static import CL, NL, WS, VALUE, SUCCESS, E
|
||||
from hyperglass.cli.echo import info, error, status, success, warning
|
||||
from hyperglass.cli.static import CL, NL, WS, E
|
||||
|
||||
PROJECT_ROOT = Path(__file__).parent.parent
|
||||
|
||||
|
||||
def async_command(func):
|
||||
"""Decororator for to make async functions runable from syncronous code."""
|
||||
"""Decororator for to make async functions runable from synchronous code."""
|
||||
import asyncio
|
||||
from functools import update_wrapper
|
||||
|
||||
|
|
@ -44,9 +47,9 @@ def fix_ownership(user, group, directory):
|
|||
os.chown(full_path, uid, gid)
|
||||
os.chown(root, uid, gid)
|
||||
except Exception as e:
|
||||
error("Failed to change 'hyperglass/' ownership", e)
|
||||
error("Failed to change '{d}' ownership: {e}", d="hyperglass/", e=e)
|
||||
|
||||
success("Successfully changed 'hyperglass/' ownership")
|
||||
success("Successfully changed '{d}' ownership", d="hyperglass/")
|
||||
|
||||
|
||||
def fix_permissions(directory):
|
||||
|
|
@ -63,9 +66,9 @@ def fix_permissions(directory):
|
|||
os.chmod(full_path, 0o744)
|
||||
os.chmod(root, 0o744)
|
||||
except Exception as e:
|
||||
error("Failed to change 'hyperglass/' permissions", e)
|
||||
error("Failed to change '{d}' ownership: {e}", d="hyperglass/", e=e)
|
||||
|
||||
success("Successfully changed 'hyperglass/' permissions")
|
||||
success("Successfully changed '{d}' ownership", d="hyperglass/")
|
||||
|
||||
|
||||
def start_web_server(start, params):
|
||||
|
|
@ -76,18 +79,18 @@ def start_web_server(start, params):
|
|||
msg_port = str(params["port"])
|
||||
msg_len = len("".join([msg_start, WS[1], msg_uri, msg_host, CL[1], msg_port]))
|
||||
try:
|
||||
click.echo(
|
||||
echo(
|
||||
NL[1]
|
||||
+ WS[msg_len + 8]
|
||||
+ E.ROCKET
|
||||
+ NL[1]
|
||||
+ E.CHECK
|
||||
+ click.style(msg_start, fg="green", bold=True)
|
||||
+ style(msg_start, fg="green", bold=True)
|
||||
+ WS[1]
|
||||
+ click.style(msg_uri, fg="white")
|
||||
+ click.style(msg_host, fg="blue", bold=True)
|
||||
+ click.style(CL[1], fg="white")
|
||||
+ click.style(msg_port, fg="magenta", bold=True)
|
||||
+ style(msg_uri, fg="white")
|
||||
+ style(msg_host, fg="blue", bold=True)
|
||||
+ style(CL[1], fg="white")
|
||||
+ style(msg_port, fg="magenta", bold=True)
|
||||
+ WS[1]
|
||||
+ E.ROCKET
|
||||
+ NL[1]
|
||||
|
|
@ -97,7 +100,7 @@ def start_web_server(start, params):
|
|||
start()
|
||||
|
||||
except Exception as e:
|
||||
error("Failed to start test server", e)
|
||||
error("Failed to start web server: {e}", e=e)
|
||||
|
||||
|
||||
def migrate_config(config_dir):
|
||||
|
|
@ -112,25 +115,25 @@ def migrate_config(config_dir):
|
|||
config_dir = Path(config_dir)
|
||||
|
||||
if not config_dir.exists():
|
||||
error(f"{str(config_dir)} does not exist")
|
||||
error("'{d}' does not exist", d=str(config_dir))
|
||||
|
||||
migrated = 0
|
||||
for file in examples:
|
||||
target_file = config_dir / file.with_suffix("").name
|
||||
try:
|
||||
if target_file.exists():
|
||||
info(f"{str(target_file)} already exists")
|
||||
info("{f} already exists", f=str(target_file))
|
||||
else:
|
||||
shutil.copyfile(file, target_file)
|
||||
migrated += 1
|
||||
info(f"Migrated {str(target_file)}")
|
||||
info("Migrated {f}", f=str(target_file))
|
||||
except Exception as e:
|
||||
error(f"Failed to migrate {str(target_file)}", e)
|
||||
error("Failed to migrate '{f}': {e}", f=str(target_file), e=e)
|
||||
|
||||
if migrated == 0:
|
||||
info(f"Migrated {migrated} example config files")
|
||||
info("Migrated {n} example config files", n=migrated)
|
||||
elif migrated > 0:
|
||||
success(f"Successfully migrated {migrated} example config files")
|
||||
success("Successfully migrated {n} example config files", n=migrated)
|
||||
|
||||
|
||||
def migrate_systemd(source, destination):
|
||||
|
|
@ -145,28 +148,28 @@ def migrate_systemd(source, destination):
|
|||
status("Migrating example systemd service...")
|
||||
|
||||
if os.path.exists(newfile):
|
||||
info(f"{newfile} already exists")
|
||||
info("'{f}' already exists", f=str(newfile))
|
||||
else:
|
||||
shutil.copyfile(source, newfile)
|
||||
|
||||
except Exception as e:
|
||||
error("Error migrating example systemd service", e)
|
||||
error("Error migrating example systemd service: {e}", e=e)
|
||||
|
||||
success(f"Successfully migrated systemd service to: {newfile}")
|
||||
success("Successfully migrated systemd service to: {f}", f=str(newfile))
|
||||
|
||||
|
||||
def build_ui():
|
||||
"""Create a new UI build.
|
||||
|
||||
Raises:
|
||||
click.ClickException: Raised on any errors.
|
||||
ClickException: Raised on any errors.
|
||||
"""
|
||||
try:
|
||||
import asyncio
|
||||
from hyperglass.configuration import params, frontend_params
|
||||
from hyperglass.configuration import params, frontend_params, CONFIG_PATH
|
||||
from hyperglass.util import build_frontend
|
||||
except ImportError as e:
|
||||
error("Error importing UI builder", e)
|
||||
error("Error importing UI builder: {e}", e=e)
|
||||
|
||||
status("Starting new UI build...")
|
||||
|
||||
|
|
@ -176,27 +179,182 @@ def build_ui():
|
|||
dev_mode = "development"
|
||||
|
||||
try:
|
||||
success = asyncio.run(
|
||||
build_success = asyncio.run(
|
||||
build_frontend(
|
||||
dev_mode=params.developer_mode,
|
||||
dev_url=f"http://localhost:{str(params.listen_port)}/api/",
|
||||
dev_url=f"http://localhost:{str(params.listen_port)}/",
|
||||
prod_url="/api/",
|
||||
params=frontend_params,
|
||||
force=True,
|
||||
app_path=CONFIG_PATH,
|
||||
)
|
||||
)
|
||||
if success:
|
||||
click.echo(
|
||||
NL[1]
|
||||
+ E.CHECK
|
||||
+ click.style("Completed UI build in", **SUCCESS)
|
||||
+ WS[1]
|
||||
+ click.style(dev_mode, **VALUE)
|
||||
+ WS[1]
|
||||
+ click.style("mode", **SUCCESS)
|
||||
+ NL[1]
|
||||
)
|
||||
if build_success:
|
||||
success("Completed UI build in {m} mode", m=dev_mode)
|
||||
|
||||
except Exception as e:
|
||||
error("Error building UI", e)
|
||||
error("Error building UI: {e}", e=e)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def create_dir(path, **kwargs):
|
||||
"""Validate and attempt to create a directory, if it does not exist."""
|
||||
|
||||
if not isinstance(path, Path):
|
||||
# If input path is not a path object, try to make it one
|
||||
|
||||
try:
|
||||
path = Path(path)
|
||||
except TypeError:
|
||||
error("{p} is not a valid path", p=path)
|
||||
|
||||
if not path.exists():
|
||||
# If path does not exist, try to create it
|
||||
|
||||
try:
|
||||
path.mkdir(**kwargs)
|
||||
except PermissionError:
|
||||
error(
|
||||
"{u} does not have permission to create {p}. Try running with sudo?",
|
||||
u=os.getlogin(),
|
||||
p=path,
|
||||
)
|
||||
|
||||
if path.exists():
|
||||
# Verify the path was actually created
|
||||
success("Created {p}", p=path)
|
||||
|
||||
elif path.exists():
|
||||
# If the path already exists, inform the user
|
||||
info("{p} already exists", p=path)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def move_files(src, dst, files): # noqa: C901
|
||||
"""Move iterable of files from source to destination.
|
||||
|
||||
Arguments:
|
||||
src {Path} -- Current directory of files
|
||||
dst {Path} -- Target destination directory
|
||||
files {Iterable} -- Iterable of files
|
||||
"""
|
||||
|
||||
if not isinstance(src, Path):
|
||||
try:
|
||||
src = Path(src)
|
||||
except TypeError:
|
||||
error("{p} is not a valid path", p=src)
|
||||
if not isinstance(dst, Path):
|
||||
try:
|
||||
dst = Path(dst)
|
||||
except TypeError:
|
||||
error("{p} is not a valid path", p=dst)
|
||||
|
||||
if not isinstance(files, Iterable):
|
||||
error(
|
||||
"{fa} must be an iterable (list, tuple, or generator). Received {f}",
|
||||
fa="Files argument",
|
||||
f=files,
|
||||
)
|
||||
|
||||
for path in (src, dst):
|
||||
if not path.exists():
|
||||
error("{p} does not exist", p=str(path))
|
||||
|
||||
migrated = 0
|
||||
|
||||
for file in files:
|
||||
dst_file = dst / file.name
|
||||
|
||||
if not file.exists():
|
||||
error("{f} does not exist", f=file)
|
||||
|
||||
try:
|
||||
if dst_file.exists():
|
||||
warning("{f} already exists", f=dst_file)
|
||||
else:
|
||||
shutil.copyfile(file, dst_file)
|
||||
migrated += 1
|
||||
info("Migrated {f}", f=dst_file)
|
||||
except Exception as e:
|
||||
error("Failed to migrate {f}: {e}", f=dst_file, e=e)
|
||||
|
||||
if migrated == 0:
|
||||
warning("Migrated {n} files", n=migrated)
|
||||
elif migrated > 0:
|
||||
success("Successfully migrated {n} files", n=migrated)
|
||||
return True
|
||||
|
||||
|
||||
def make_systemd(user):
|
||||
"""Generate a systemd file based on the local system.
|
||||
|
||||
Arguments:
|
||||
user {str} -- User hyperglass needs to be run as
|
||||
|
||||
Returns:
|
||||
{str} -- Generated systemd template
|
||||
"""
|
||||
|
||||
import platform
|
||||
|
||||
template = """
|
||||
[Unit]
|
||||
Description=hyperglass
|
||||
After=network.target
|
||||
Requires={redis_name}
|
||||
|
||||
[Service]
|
||||
User={user}
|
||||
Group={group}
|
||||
ExecStart={hyperglass_path} start
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
"""
|
||||
known_rhel = ("rhel", "centos")
|
||||
distro = platform.linux_distribution()
|
||||
if distro[0] in known_rhel:
|
||||
redis_name = "redis"
|
||||
else:
|
||||
redis_name = "redis-server"
|
||||
|
||||
hyperglass_path = shutil.which("hyperglass")
|
||||
|
||||
if not hyperglass_path:
|
||||
hyperglass_path = "python3 -m hyperglass.console"
|
||||
warning("hyperglass executable not found, using {h}", h=hyperglass_path)
|
||||
|
||||
systemd = template.format(
|
||||
redis_name=redis_name, user=user, group=user, hyperglass_path=hyperglass_path
|
||||
)
|
||||
info(f"Generated systemd service:\n{systemd}")
|
||||
return systemd
|
||||
|
||||
|
||||
def write_to_file(file, data):
|
||||
"""Write string data to a file.
|
||||
|
||||
Arguments:
|
||||
file {Path} -- File path
|
||||
data {str} -- String data to write
|
||||
|
||||
Returns:
|
||||
{bool} -- True if successful
|
||||
"""
|
||||
try:
|
||||
with file.open("w+") as f:
|
||||
f.write(data.strip())
|
||||
except PermissionError:
|
||||
error(
|
||||
"{u} does not have permission to write to {f}. Try running with sudo?",
|
||||
u=os.getlogin(),
|
||||
f=file,
|
||||
)
|
||||
if not file.exists():
|
||||
error("Error writing file {f}", f=file)
|
||||
elif file.exists():
|
||||
success("Wrote systemd file {f}", f=file)
|
||||
return True
|
||||
|
|
|
|||
|
|
@ -1,13 +0,0 @@
|
|||
[Unit]
|
||||
Description=hyperglass
|
||||
After=network.target
|
||||
Requires=redis-server.service
|
||||
|
||||
[Service]
|
||||
User=www-data
|
||||
Group=www-data
|
||||
WorkingDirectory=/opt/hyperglass
|
||||
ExecStart=/usr/local/bin/python3 -m sanic hyperglass.web.app
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
Loading…
Add table
Reference in a new issue