mirror of
https://github.com/frappe/bench.git
synced 2024-09-29 07:19:05 +00:00
473 lines
17 KiB
Python
Executable File
473 lines
17 KiB
Python
Executable File
# imports - compatibility imports
|
|
from __future__ import print_function
|
|
|
|
# imports - standard imports
|
|
import json
|
|
import logging
|
|
import os
|
|
import re
|
|
import subprocess
|
|
import sys
|
|
|
|
# imports - third party imports
|
|
import click
|
|
|
|
# imports - module imports
|
|
import bench
|
|
from bench.utils import color, CommandFailedError, build_assets, check_git_for_shallow_clone, exec_cmd, get_cmd_output, get_frappe, restart_supervisor_processes, restart_systemd_processes, run_frappe_cmd
|
|
|
|
|
|
logger = logging.getLogger(bench.PROJECT_NAME)
|
|
|
|
|
|
class InvalidBranchException(Exception): pass
|
|
class InvalidRemoteException(Exception): pass
|
|
|
|
class MajorVersionUpgradeException(Exception):
|
|
def __init__(self, message, upstream_version, local_version):
|
|
super(MajorVersionUpgradeException, self).__init__(message)
|
|
self.upstream_version = upstream_version
|
|
self.local_version = local_version
|
|
|
|
def get_apps(bench_path='.'):
|
|
try:
|
|
with open(os.path.join(bench_path, 'sites', 'apps.txt')) as f:
|
|
return f.read().strip().split('\n')
|
|
except IOError:
|
|
return []
|
|
|
|
def add_to_appstxt(app, bench_path='.'):
|
|
apps = get_apps(bench_path=bench_path)
|
|
if app not in apps:
|
|
apps.append(app)
|
|
return write_appstxt(apps, bench_path=bench_path)
|
|
|
|
def remove_from_appstxt(app, bench_path='.'):
|
|
apps = get_apps(bench_path=bench_path)
|
|
if app in apps:
|
|
apps.remove(app)
|
|
return write_appstxt(apps, bench_path=bench_path)
|
|
|
|
def write_appstxt(apps, bench_path='.'):
|
|
with open(os.path.join(bench_path, 'sites', 'apps.txt'), 'w') as f:
|
|
return f.write('\n'.join(apps))
|
|
|
|
def is_git_url(url):
|
|
# modified to allow without the tailing .git from https://github.com/jonschlinkert/is-git-url.git
|
|
pattern = r"(?:git|ssh|https?|git@[-\w.]+):(\/\/)?(.*?)(\.git)?(\/?|\#[-\d\w._]+?)$"
|
|
return bool(re.match(pattern, url))
|
|
|
|
def get_excluded_apps(bench_path='.'):
|
|
try:
|
|
with open(os.path.join(bench_path, 'sites', 'excluded_apps.txt')) as f:
|
|
return f.read().strip().split('\n')
|
|
except IOError:
|
|
return []
|
|
|
|
def add_to_excluded_apps_txt(app, bench_path='.'):
|
|
if app == 'frappe':
|
|
raise ValueError('Frappe app cannot be excludeed from update')
|
|
if app not in os.listdir('apps'):
|
|
raise ValueError('The app {} does not exist'.format(app))
|
|
apps = get_excluded_apps(bench_path=bench_path)
|
|
if app not in apps:
|
|
apps.append(app)
|
|
return write_excluded_apps_txt(apps, bench_path=bench_path)
|
|
|
|
def write_excluded_apps_txt(apps, bench_path='.'):
|
|
with open(os.path.join(bench_path, 'sites', 'excluded_apps.txt'), 'w') as f:
|
|
return f.write('\n'.join(apps))
|
|
|
|
def remove_from_excluded_apps_txt(app, bench_path='.'):
|
|
apps = get_excluded_apps(bench_path=bench_path)
|
|
if app in apps:
|
|
apps.remove(app)
|
|
return write_excluded_apps_txt(apps, bench_path=bench_path)
|
|
|
|
def get_app(git_url, branch=None, bench_path='.', skip_assets=False, verbose=False, restart_bench=True, overwrite=False):
|
|
import requests
|
|
import shutil
|
|
|
|
if not os.path.exists(git_url):
|
|
if not is_git_url(git_url):
|
|
orgs = ['frappe', 'erpnext']
|
|
for org in orgs:
|
|
url = 'https://api.github.com/repos/{org}/{app}'.format(org=org, app=git_url)
|
|
res = requests.get(url)
|
|
if res.ok:
|
|
data = res.json()
|
|
if 'name' in data:
|
|
if git_url == data['name']:
|
|
git_url = 'https://github.com/{org}/{app}'.format(org=org, app=git_url)
|
|
break
|
|
else:
|
|
bench.utils.log("App {app} not found".format(app=git_url), level=2)
|
|
sys.exit(1)
|
|
|
|
# Gets repo name from URL
|
|
repo_name = git_url.rstrip('/').rsplit('/', 1)[1].rsplit('.', 1)[0]
|
|
shallow_clone = '--depth 1' if check_git_for_shallow_clone() else ''
|
|
branch = '--branch {branch}'.format(branch=branch) if branch else ''
|
|
else:
|
|
repo_name = git_url.split(os.sep)[-1]
|
|
shallow_clone = ''
|
|
branch = '--branch {branch}'.format(branch=branch) if branch else ''
|
|
|
|
if os.path.isdir(os.path.join(bench_path, 'apps', repo_name)):
|
|
# application directory already exists
|
|
# prompt user to overwrite it
|
|
if overwrite or click.confirm('''A directory for the application "{0}" already exists.
|
|
Do you want to continue and overwrite it?'''.format(repo_name)):
|
|
shutil.rmtree(os.path.join(bench_path, 'apps', repo_name))
|
|
elif click.confirm('''Do you want to reinstall the existing application?''', abort=True):
|
|
app_name = get_app_name(bench_path, repo_name)
|
|
install_app(app=app_name, bench_path=bench_path, verbose=verbose, skip_assets=skip_assets)
|
|
sys.exit()
|
|
|
|
print('\n{0}Getting {1}{2}'.format(color.yellow, repo_name, color.nc))
|
|
logger.log('Getting app {0}'.format(repo_name))
|
|
exec_cmd("git clone {git_url} {branch} {shallow_clone} --origin upstream".format(
|
|
git_url=git_url,
|
|
shallow_clone=shallow_clone,
|
|
branch=branch),
|
|
cwd=os.path.join(bench_path, 'apps'))
|
|
|
|
app_name = get_app_name(bench_path, repo_name)
|
|
install_app(app=app_name, bench_path=bench_path, verbose=verbose, skip_assets=skip_assets)
|
|
|
|
|
|
def get_app_name(bench_path, repo_name):
|
|
# retrieves app name from setup.py
|
|
app_path = os.path.join(bench_path, 'apps', repo_name, 'setup.py')
|
|
with open(app_path, 'rb') as f:
|
|
app_name = re.search(r'name\s*=\s*[\'"](.*)[\'"]', f.read().decode('utf-8')).group(1)
|
|
if repo_name != app_name:
|
|
apps_path = os.path.join(os.path.abspath(bench_path), 'apps')
|
|
os.rename(os.path.join(apps_path, repo_name), os.path.join(apps_path, app_name))
|
|
return app_name
|
|
|
|
|
|
def new_app(app, bench_path='.'):
|
|
# For backwards compatibility
|
|
app = app.lower().replace(" ", "_").replace("-", "_")
|
|
logger.log('creating new app {}'.format(app))
|
|
apps = os.path.abspath(os.path.join(bench_path, 'apps'))
|
|
bench.set_frappe_version(bench_path=bench_path)
|
|
|
|
if bench.FRAPPE_VERSION == 4:
|
|
exec_cmd("{frappe} --make_app {apps} {app}".format(frappe=get_frappe(bench_path=bench_path),
|
|
apps=apps, app=app))
|
|
else:
|
|
run_frappe_cmd('make-app', apps, app, bench_path=bench_path)
|
|
install_app(app, bench_path=bench_path)
|
|
|
|
|
|
def install_app(app, bench_path=".", verbose=False, no_cache=False, restart_bench=True, skip_assets=False):
|
|
from bench.config.common_site_config import get_config
|
|
|
|
print('\n{0}Installing {1}{2}'.format(color.yellow, app, color.nc))
|
|
logger.log("installing {}".format(app))
|
|
|
|
pip_path = os.path.join(bench_path, "env", "bin", "pip")
|
|
quiet_flag = "-q" if not verbose else ""
|
|
app_path = os.path.join(bench_path, "apps", app)
|
|
cache_flag = "--no-cache-dir" if no_cache else ""
|
|
|
|
exec_cmd("{pip} install {quiet} -U -e {app} {no_cache}".format(pip=pip_path, quiet=quiet_flag, app=app_path, no_cache=cache_flag))
|
|
|
|
if os.path.exists(os.path.join(app_path, 'package.json')):
|
|
exec_cmd("yarn install", cwd=app_path)
|
|
|
|
add_to_appstxt(app, bench_path=bench_path)
|
|
|
|
if not skip_assets:
|
|
build_assets(bench_path=bench_path, app=app)
|
|
|
|
if restart_bench:
|
|
conf = get_config(bench_path=bench_path)
|
|
|
|
if conf.get('restart_supervisor_on_update'):
|
|
restart_supervisor_processes(bench_path=bench_path)
|
|
if conf.get('restart_systemd_on_update'):
|
|
restart_systemd_processes(bench_path=bench_path)
|
|
|
|
|
|
def remove_app(app, bench_path='.'):
|
|
import shutil
|
|
from bench.config.common_site_config import get_config
|
|
|
|
if app not in get_apps(bench_path):
|
|
print("No app named {0}".format(app))
|
|
sys.exit(1)
|
|
|
|
app_path = os.path.join(bench_path, 'apps', app)
|
|
site_path = os.path.join(bench_path, 'sites')
|
|
pip = os.path.join(bench_path, 'env', 'bin', 'pip')
|
|
|
|
for site in os.listdir(site_path):
|
|
req_file = os.path.join(site_path, site, 'site_config.json')
|
|
if os.path.exists(req_file):
|
|
out = subprocess.check_output(["bench", "--site", site, "list-apps"], cwd=bench_path).decode('utf-8')
|
|
if re.search(r'\b' + app + r'\b', out):
|
|
print("Cannot remove, app is installed on site: {0}".format(site))
|
|
sys.exit(1)
|
|
|
|
exec_cmd("{0} uninstall -y {1}".format(pip, app), cwd=bench_path)
|
|
remove_from_appstxt(app, bench_path)
|
|
shutil.rmtree(app_path)
|
|
run_frappe_cmd("build", bench_path=bench_path)
|
|
if get_config(bench_path).get('restart_supervisor_on_update'):
|
|
restart_supervisor_processes(bench_path=bench_path)
|
|
if get_config(bench_path).get('restart_systemd_on_update'):
|
|
restart_systemd_processes(bench_path=bench_path)
|
|
|
|
def pull_apps(apps=None, bench_path='.', reset=False):
|
|
'''Check all apps if there no local changes, pull'''
|
|
from bench.config.common_site_config import get_config
|
|
|
|
rebase = '--rebase' if get_config(bench_path).get('rebase_on_pull') else ''
|
|
|
|
apps = apps or get_apps(bench_path=bench_path)
|
|
# chech for local changes
|
|
if not reset:
|
|
for app in apps:
|
|
excluded_apps = get_excluded_apps()
|
|
if app in excluded_apps:
|
|
print("Skipping reset for app {}".format(app))
|
|
continue
|
|
app_dir = get_repo_dir(app, bench_path=bench_path)
|
|
if os.path.exists(os.path.join(app_dir, '.git')):
|
|
out = subprocess.check_output(["git", "status"], cwd=app_dir)
|
|
out = out.decode('utf-8')
|
|
if not re.search(r'nothing to commit, working (directory|tree) clean', out):
|
|
print('''
|
|
|
|
Cannot proceed with update: You have local changes in app "{0}" that are not committed.
|
|
|
|
Here are your choices:
|
|
|
|
1. Merge the {0} app manually with "git pull" / "git pull --rebase" and fix conflicts.
|
|
1. Temporarily remove your changes with "git stash" or discard them completely
|
|
with "bench update --reset" or for individual repositries "git reset --hard"
|
|
2. If your changes are helpful for others, send in a pull request via GitHub and
|
|
wait for them to be merged in the core.'''.format(app))
|
|
sys.exit(1)
|
|
|
|
excluded_apps = get_excluded_apps()
|
|
for app in apps:
|
|
if app in excluded_apps:
|
|
print("Skipping pull for app {}".format(app))
|
|
continue
|
|
app_dir = get_repo_dir(app, bench_path=bench_path)
|
|
if os.path.exists(os.path.join(app_dir, '.git')):
|
|
remote = get_remote(app)
|
|
if not remote:
|
|
# remote is False, i.e. remote doesn't exist, add the app to excluded_apps.txt
|
|
add_to_excluded_apps_txt(app, bench_path=bench_path)
|
|
print("Skipping pull for app {}, since remote doesn't exist, and adding it to excluded apps".format(app))
|
|
continue
|
|
logger.log('pulling {0}'.format(app))
|
|
if reset:
|
|
exec_cmd("git fetch --all", cwd=app_dir)
|
|
exec_cmd("git reset --hard {remote}/{branch}".format(
|
|
remote=remote, branch=get_current_branch(app,bench_path=bench_path)), cwd=app_dir)
|
|
else:
|
|
exec_cmd("git pull {rebase} {remote} {branch}".format(rebase=rebase,
|
|
remote=remote, branch=get_current_branch(app, bench_path=bench_path)), cwd=app_dir)
|
|
exec_cmd('find . -name "*.pyc" -delete', cwd=app_dir)
|
|
|
|
|
|
def is_version_upgrade(app='frappe', bench_path='.', branch=None):
|
|
try:
|
|
fetch_upstream(app, bench_path=bench_path)
|
|
except CommandFailedError:
|
|
raise InvalidRemoteException("No remote named upstream for {0}".format(app))
|
|
|
|
upstream_version = get_upstream_version(app=app, branch=branch, bench_path=bench_path)
|
|
|
|
if not upstream_version:
|
|
raise InvalidBranchException("Specified branch of app {0} is not in upstream".format(app))
|
|
|
|
local_version = get_major_version(get_current_version(app, bench_path=bench_path))
|
|
upstream_version = get_major_version(upstream_version)
|
|
|
|
if upstream_version - local_version > 0:
|
|
return (True, local_version, upstream_version)
|
|
|
|
return (False, local_version, upstream_version)
|
|
|
|
def get_current_frappe_version(bench_path='.'):
|
|
try:
|
|
return get_major_version(get_current_version('frappe', bench_path=bench_path))
|
|
except IOError:
|
|
return 0
|
|
|
|
def get_current_branch(app, bench_path='.'):
|
|
repo_dir = get_repo_dir(app, bench_path=bench_path)
|
|
return get_cmd_output("basename $(git symbolic-ref -q HEAD)", cwd=repo_dir)
|
|
|
|
def get_remote(app, bench_path='.'):
|
|
repo_dir = get_repo_dir(app, bench_path=bench_path)
|
|
contents = subprocess.check_output(['git', 'remote', '-v'], cwd=repo_dir, stderr=subprocess.STDOUT)
|
|
contents = contents.decode('utf-8')
|
|
if re.findall('upstream[\s]+', contents):
|
|
return 'upstream'
|
|
elif not contents:
|
|
# if contents is an empty string => remote doesn't exist
|
|
return False
|
|
else:
|
|
# get the first remote
|
|
return contents.splitlines()[0].split()[0]
|
|
|
|
def use_rq(bench_path):
|
|
bench_path = os.path.abspath(bench_path)
|
|
celery_app = os.path.join(bench_path, 'apps', 'frappe', 'frappe', 'celery_app.py')
|
|
return not os.path.exists(celery_app)
|
|
|
|
def fetch_upstream(app, bench_path='.'):
|
|
repo_dir = get_repo_dir(app, bench_path=bench_path)
|
|
return subprocess.call(["git", "fetch", "upstream"], cwd=repo_dir)
|
|
|
|
def get_current_version(app, bench_path='.'):
|
|
repo_dir = get_repo_dir(app, bench_path=bench_path)
|
|
try:
|
|
with open(os.path.join(repo_dir, os.path.basename(repo_dir), '__init__.py')) as f:
|
|
return get_version_from_string(f.read())
|
|
|
|
except AttributeError:
|
|
# backward compatibility
|
|
with open(os.path.join(repo_dir, 'setup.py')) as f:
|
|
return get_version_from_string(f.read(), field='version')
|
|
|
|
def get_develop_version(app, bench_path='.'):
|
|
repo_dir = get_repo_dir(app, bench_path=bench_path)
|
|
with open(os.path.join(repo_dir, os.path.basename(repo_dir), 'hooks.py')) as f:
|
|
return get_version_from_string(f.read(), field='develop_version')
|
|
|
|
def get_upstream_version(app, branch=None, bench_path='.'):
|
|
repo_dir = get_repo_dir(app, bench_path=bench_path)
|
|
if not branch:
|
|
branch = get_current_branch(app, bench_path=bench_path)
|
|
try:
|
|
contents = subprocess.check_output(['git', 'show', 'upstream/{branch}:{app}/__init__.py'.format(branch=branch, app=app)], cwd=repo_dir, stderr=subprocess.STDOUT)
|
|
contents = contents.decode('utf-8')
|
|
except subprocess.CalledProcessError as e:
|
|
if b"Invalid object" in e.output:
|
|
return None
|
|
else:
|
|
raise
|
|
return get_version_from_string(contents)
|
|
|
|
def get_repo_dir(app, bench_path='.'):
|
|
return os.path.join(bench_path, 'apps', app)
|
|
|
|
def switch_branch(branch, apps=None, bench_path='.', upgrade=False, check_upgrade=True):
|
|
import git
|
|
from six.moves import reload_module
|
|
from bench.utils import update_requirements, update_node_packages, backup_all_sites, patch_sites, build_assets, post_upgrade
|
|
apps_dir = os.path.join(bench_path, 'apps')
|
|
version_upgrade = (False,)
|
|
switched_apps = []
|
|
|
|
if not apps:
|
|
apps = [name for name in os.listdir(apps_dir)
|
|
if os.path.isdir(os.path.join(apps_dir, name))]
|
|
if branch=="v4.x.x":
|
|
apps.append('shopping_cart')
|
|
|
|
for app in apps:
|
|
app_dir = os.path.join(apps_dir, app)
|
|
|
|
if not os.path.exists(app_dir):
|
|
bench.utils.log("{} does not exist!".format(app), level=2)
|
|
continue
|
|
|
|
repo = git.Repo(app_dir)
|
|
unshallow_flag = os.path.exists(os.path.join(app_dir, ".git", "shallow"))
|
|
bench.utils.log("Fetching upstream {0}for {1}".format("unshallow " if unshallow_flag else "", app))
|
|
|
|
bench.utils.exec_cmd("git remote set-branches upstream '*'", cwd=app_dir)
|
|
bench.utils.exec_cmd("git fetch --all{0} --quiet".format(" --unshallow" if unshallow_flag else ""), cwd=app_dir)
|
|
|
|
if check_upgrade:
|
|
version_upgrade = is_version_upgrade(app=app, bench_path=bench_path, branch=branch)
|
|
if version_upgrade[0] and not upgrade:
|
|
bench.utils.log("Switching to {0} will cause upgrade from {1} to {2}. Pass --upgrade to confirm".format(branch, version_upgrade[1], version_upgrade[2]), level=2)
|
|
sys.exit(1)
|
|
|
|
print("Switching for "+app)
|
|
bench.utils.exec_cmd("git checkout -f {0}".format(branch), cwd=app_dir)
|
|
|
|
if str(repo.active_branch) == branch:
|
|
switched_apps.append(app)
|
|
else:
|
|
bench.utils.log("Switching branches failed for: {}".format(app), level=2)
|
|
|
|
if switched_apps:
|
|
bench.utils.log("Successfully switched branches for: " + ", ".join(switched_apps), level=1)
|
|
print('Please run `bench update --patch` to be safe from any differences in database schema')
|
|
|
|
if version_upgrade[0] and upgrade:
|
|
update_requirements()
|
|
update_node_packages()
|
|
reload_module(bench.utils)
|
|
backup_all_sites()
|
|
patch_sites()
|
|
build_assets()
|
|
post_upgrade(version_upgrade[1], version_upgrade[2])
|
|
|
|
|
|
def switch_to_branch(branch=None, apps=None, bench_path='.', upgrade=False):
|
|
switch_branch(branch, apps=apps, bench_path=bench_path, upgrade=upgrade)
|
|
|
|
def switch_to_master(apps=None, bench_path='.', upgrade=True):
|
|
switch_branch('master', apps=apps, bench_path=bench_path, upgrade=upgrade)
|
|
|
|
def switch_to_develop(apps=None, bench_path='.', upgrade=True):
|
|
switch_branch('develop', apps=apps, bench_path=bench_path, upgrade=upgrade)
|
|
|
|
def get_version_from_string(contents, field='__version__'):
|
|
match = re.search(r"^(\s*%s\s*=\s*['\\\"])(.+?)(['\"])(?sm)" % field, contents)
|
|
return match.group(2)
|
|
|
|
def get_major_version(version):
|
|
import semantic_version
|
|
|
|
return semantic_version.Version(version).major
|
|
|
|
def install_apps_from_path(path, bench_path='.'):
|
|
apps = get_apps_json(path)
|
|
for app in apps:
|
|
get_app(app['url'], branch=app.get('branch'), bench_path=bench_path, skip_assets=True)
|
|
|
|
def get_apps_json(path):
|
|
import requests
|
|
|
|
if path.startswith('http'):
|
|
r = requests.get(path)
|
|
return r.json()
|
|
|
|
with open(path) as f:
|
|
return json.load(f)
|
|
|
|
def validate_branch():
|
|
installed_apps = set(get_apps())
|
|
check_apps = set(['frappe', 'erpnext'])
|
|
intersection_apps = installed_apps.intersection(check_apps)
|
|
|
|
for app in intersection_apps:
|
|
branch = get_current_branch(app)
|
|
|
|
if branch == "master":
|
|
print("""'master' branch is renamed to 'version-11' since 'version-12' release.
|
|
As of January 2020, the following branches are
|
|
version Frappe ERPNext
|
|
11 version-11 version-11
|
|
12 version-12 version-12
|
|
13 develop develop
|
|
|
|
Please switch to new branches to get future updates.
|
|
To switch to your required branch, run the following commands: bench switch-to-branch [branch-name]""")
|
|
|
|
sys.exit(1)
|