accounting/bench
2
0
Fork 0
mirror of https://github.com/frappe/bench.git synced 2025-01-08 00:04:38 +00:00
Code Issues Releases Activity

Merge pull request #1197 from gavindsouza/misc-fixes

Browse Source 
fix: Misc fixes
This commit is contained in:
gavin 2021-09-09 16:40:56 +05:30 committed by GitHub
commit aefdc3bb47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 105 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
bench/cli.py
View File

@ -1,7 +1,6 @@
# imports - standard imports # imports - standard imports
import atexit import atexit
import json import json
import logging
import os import os
import pwd import pwd
import sys import sys
@ -14,7 +13,21 @@ import bench
from bench.app import get_apps from bench.app import get_apps
from bench.commands import bench_command from bench.commands import bench_command
from bench.config.common_site_config import get_config from bench.config.common_site_config import get_config
from bench.utils import PatchError, bench_cache_file, check_latest_version, drop_privileges, find_parent_bench, generate_command_cache, get_cmd_output, get_env_cmd, get_frappe, is_bench_directory, is_dist_editable, is_root, log, setup_logging from bench.utils import (
bench_cache_file,
check_latest_version,
drop_privileges,
find_parent_bench,
generate_command_cache,
get_cmd_output,
get_env_cmd,
get_frappe,
is_bench_directory,
is_dist_editable,
is_root,
log,
setup_logging,
)
from_command_line = False from_command_line = False
change_uid_msg = "You should not run this command as root" change_uid_msg = "You should not run this command as root"
@ -30,31 +43,52 @@ def cli():
logger = setup_logging() logger = setup_logging()
logger.info(command) logger.info(command)
if len(sys.argv) > 1 and sys.argv[1] not in ("src", ): if len(sys.argv) > 1 and sys.argv[1] not in ("src",):
check_uid() check_uid()
change_uid() change_uid()
change_dir() change_dir()
if is_dist_editable(bench.PROJECT_NAME) and len(sys.argv) > 1 and sys.argv[1] != "src" and not get_config(".").get("developer_mode"): if (
log("bench is installed in editable mode!\n\nThis is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install frappe-bench`\n", level=3) is_dist_editable(bench.PROJECT_NAME)
and len(sys.argv) > 1
and sys.argv[1] != "src"
and not get_config(".").get("developer_mode")
):
log(
"bench is installed in editable mode!\n\nThis is not the recommended mode"
" of installation for production. Instead, install the package from PyPI"
" with: `pip install frappe-bench`\n",
level=3,
)
if not is_bench_directory() and not cmd_requires_root() and len(sys.argv) > 1 and sys.argv[1] not in ("init", "find", "src"): if (
not is_bench_directory()
and not cmd_requires_root()
and len(sys.argv) > 1
and sys.argv[1] not in ("init", "find", "src")
):
log("Command not being executed in bench directory", level=3) log("Command not being executed in bench directory", level=3)
if len(sys.argv) > 2 and sys.argv[1] == "frappe": if len(sys.argv) > 2 and sys.argv[1] == "frappe":
return old_frappe_cli() old_frappe_cli()
elif len(sys.argv) > 1: elif len(sys.argv) > 1:
if sys.argv[1] in get_frappe_commands() + ["--site", "--verbose", "--force", "--profile"]: if sys.argv[1] == "--help":
return frappe_cmd()
elif sys.argv[1] == "--help":
print(click.Context(bench_command).get_help()) print(click.Context(bench_command).get_help())
print(get_frappe_help()) print(get_frappe_help())
return return
elif sys.argv[1] in get_apps(): if sys.argv[1] in ["--site", "--verbose", "--force", "--profile"]:
return app_cmd() frappe_cmd()
if sys.argv[1] in get_cached_frappe_commands():
frappe_cmd()
if sys.argv[1] in get_frappe_commands():
frappe_cmd()
if sys.argv[1] in get_apps():
app_cmd()
if not (len(sys.argv) > 1 and sys.argv[1] == "src"): if not (len(sys.argv) > 1 and sys.argv[1] == "src"):
atexit.register(check_latest_version) atexit.register(check_latest_version)
@ -65,29 +99,50 @@ def cli():
return_code = getattr(e, "code", 0) return_code = getattr(e, "code", 0)
if return_code: if return_code:
logger.warning(f"{command} executed with exit code {return_code}") logger.warning(f"{command} executed with exit code {return_code}")
if isinstance(e, Exception):
raise e
finally:
try:
return_code
except NameError:
return_code = 0
sys.exit(return_code) sys.exit(return_code)
def check_uid(): def check_uid():
if cmd_requires_root() and not is_root(): if cmd_requires_root() and not is_root():
log('superuser privileges required for this command', level=3) log("superuser privileges required for this command", level=3)
sys.exit(1) sys.exit(1)
def cmd_requires_root(): def cmd_requires_root():
if len(sys.argv) > 2 and sys.argv[2] in ('production', 'sudoers', 'lets-encrypt', 'fonts', if len(sys.argv) > 2 and sys.argv[2] in (
'print', 'firewall', 'ssh-port', 'role', 'fail2ban', 'wildcard-ssl'): "production",
"sudoers",
"lets-encrypt",
"fonts",
"print",
"firewall",
"ssh-port",
"role",
"fail2ban",
"wildcard-ssl",
):
return True return True
if len(sys.argv) >= 2 and sys.argv[1] in ('patch', 'renew-lets-encrypt', 'disable-production'): if len(sys.argv) >= 2 and sys.argv[1] in (
"patch",
"renew-lets-encrypt",
"disable-production",
):
return True return True
if len(sys.argv) > 2 and sys.argv[1] in ('install'): if len(sys.argv) > 2 and sys.argv[1] in ("install"):
return True return True
def change_dir(): def change_dir():
if os.path.exists('config.json') or "init" in sys.argv: if os.path.exists("config.json") or "init" in sys.argv:
return return
dir_path_file = '/etc/frappe_bench_dir' dir_path_file = "/etc/frappe_bench_dir"
if os.path.exists(dir_path_file): if os.path.exists(dir_path_file):
with open(dir_path_file) as f: with open(dir_path_file) as f:
dir_path = f.read().strip() dir_path = f.read().strip()
@ -97,52 +152,56 @@ def change_dir():
def change_uid(): def change_uid():
if is_root() and not cmd_requires_root(): if is_root() and not cmd_requires_root():
frappe_user = get_config(".").get('frappe_user') frappe_user = get_config(".").get("frappe_user")
if frappe_user: if frappe_user:
drop_privileges(uid_name=frappe_user, gid_name=frappe_user) drop_privileges(uid_name=frappe_user, gid_name=frappe_user)
os.environ['HOME'] = pwd.getpwnam(frappe_user).pw_dir os.environ["HOME"] = pwd.getpwnam(frappe_user).pw_dir
else: else:
log(change_uid_msg, level=3) log(change_uid_msg, level=3)
sys.exit(1) sys.exit(1)
def old_frappe_cli(bench_path='.'): def old_frappe_cli(bench_path="."):
f = get_frappe(bench_path=bench_path) f = get_frappe(bench_path=bench_path)
os.chdir(os.path.join(bench_path, 'sites')) os.chdir(os.path.join(bench_path, "sites"))
os.execv(f, [f] + sys.argv[2:]) os.execv(f, [f] + sys.argv[2:])
def app_cmd(bench_path='.'): def app_cmd(bench_path="."):
f = get_env_cmd('python', bench_path=bench_path) f = get_env_cmd("python", bench_path=bench_path)
os.chdir(os.path.join(bench_path, 'sites')) os.chdir(os.path.join(bench_path, "sites"))
os.execv(f, [f] + ['-m', 'frappe.utils.bench_helper'] + sys.argv[1:]) os.execv(f, [f] + ["-m", "frappe.utils.bench_helper"] + sys.argv[1:])
def frappe_cmd(bench_path='.'): def frappe_cmd(bench_path="."):
f = get_env_cmd('python', bench_path=bench_path) f = get_env_cmd("python", bench_path=bench_path)
os.chdir(os.path.join(bench_path, 'sites')) os.chdir(os.path.join(bench_path, "sites"))
os.execv(f, [f] + ['-m', 'frappe.utils.bench_helper', 'frappe'] + sys.argv[1:]) os.execv(f, [f] + ["-m", "frappe.utils.bench_helper", "frappe"] + sys.argv[1:])
def get_cached_frappe_commands():
if os.path.exists(bench_cache_file):
command_dump = open(bench_cache_file, "r").read() or "[]"
return json.loads(command_dump)
return []
def get_frappe_commands(): def get_frappe_commands():
if not is_bench_directory(): if not is_bench_directory():
return [] return []
if os.path.exists(bench_cache_file): return generate_command_cache()
command_dump = open(bench_cache_file, 'r').read() or '[]'
return json.loads(command_dump)
else:
return generate_command_cache()
def get_frappe_help(bench_path='.'): def get_frappe_help(bench_path="."):
python = get_env_cmd('python', bench_path=bench_path) python = get_env_cmd("python", bench_path=bench_path)
sites_path = os.path.join(bench_path, 'sites') sites_path = os.path.join(bench_path, "sites")
try: try:
out = get_cmd_output(f"{python} -m frappe.utils.bench_helper get-frappe-help", cwd=sites_path) out = get_cmd_output(
return "\n\nFramework commands:\n" + out.split('Commands:')[1] f"{python} -m frappe.utils.bench_helper get-frappe-help", cwd=sites_path
except: )
return "\n\nFramework commands:\n" + out.split("Commands:")[1]
except Exception:
return "" return ""

2
bench/utils.py
View File

@ -1076,6 +1076,8 @@ def generate_command_cache(bench_path='.'):
if hasattr(e, "stderr"): if hasattr(e, "stderr"):
print(e.stderr.decode('utf-8')) print(e.stderr.decode('utf-8'))
return []
def clear_command_cache(bench_path='.'): def clear_command_cache(bench_path='.'):
"""Clears commands cached """Clears commands cached