zulip/scripts/lib/upgrade-zulip-from-git
Tim Abbott 03420831b0 upgrade-zulip-from-git: Fetch tags from upstream repository.
This ensures that the `git describe` queries that we run for caching
Zulip's Git version are guaranteed to include recent releases.

This change ensures that we have accurate output even if we're pointed
at a fork of Zulip that never updates its tags.

Additionally, it will make it possible to record the
`git merge-base upstream/master` in future commits.

Note that because we run this code before unpacking the new version,
the pre-upgrade version of this code runs.

As a result, we cannot assume that the upstream repository exists.
2021-05-13 11:17:25 -07:00

113 lines
3.6 KiB
Python
Executable File

#!/usr/bin/env python3
import argparse
import logging
import os
import subprocess
import sys
import time
LOCAL_GIT_CACHE_DIR = "/srv/zulip.git"
os.environ["PYTHONUNBUFFERED"] = "y"
sys.path.append(os.path.join(os.path.dirname(__file__), "..", ".."))
from scripts.lib.zulip_tools import (
DEPLOYMENTS_DIR,
assert_running_as_root,
get_config,
get_config_file,
get_deploy_options,
get_deployment_lock,
make_deploy_path,
overwrite_symlink,
release_deployment_lock,
su_to_zulip,
)
config_file = get_config_file()
deploy_options = get_deploy_options(config_file)
upstream_url = "https://github.com/zulip/zulip.git"
remote_url = get_config(config_file, "deployment", "git_repo_url", upstream_url)
assert_running_as_root(strip_lib_from_paths=True)
# make sure we have appropriate file permissions
os.umask(0o22)
logging.Formatter.converter = time.gmtime
logging.basicConfig(format="%(asctime)s upgrade-zulip-from-git: %(message)s", level=logging.INFO)
parser = argparse.ArgumentParser()
parser.add_argument("refname", help="Git reference, e.g. a branch, tag, or commit ID.")
parser.add_argument(
"--remote-url", help="Override the Git remote URL configured in /etc/zulip/zulip.conf."
)
args = parser.parse_args()
refname = args.refname
# Command line remote URL will be given preference above the one
# in /etc/zulip/zulip.conf.
if args.remote_url:
remote_url = args.remote_url
os.makedirs(DEPLOYMENTS_DIR, exist_ok=True)
os.makedirs("/home/zulip/logs", exist_ok=True)
error_rerun_script = f"{DEPLOYMENTS_DIR}/current/scripts/upgrade-zulip-from-git {refname}"
get_deployment_lock(error_rerun_script)
try:
deploy_path = make_deploy_path()
# Populate LOCAL_GIT_CACHE_DIR with both the requested remote and zulip/zulip.
if not os.path.exists(LOCAL_GIT_CACHE_DIR):
logging.info("Cloning the repository")
subprocess.check_call(
["git", "clone", "-q", remote_url, "--mirror", LOCAL_GIT_CACHE_DIR],
stdout=open("/dev/null", "w"),
)
if os.stat(LOCAL_GIT_CACHE_DIR).st_uid == 0:
subprocess.check_call(["chown", "-R", "zulip:zulip", LOCAL_GIT_CACHE_DIR])
os.chdir(LOCAL_GIT_CACHE_DIR)
subprocess.check_call(
["git", "remote", "set-url", "origin", remote_url], preexec_fn=su_to_zulip
)
# Ensure upstream remote is configured; we need this to make `git describe` accurate.
remotes = subprocess.check_output(["git", "remote"], preexec_fn=su_to_zulip).split(b"\n")
if b"upstream" not in remotes:
subprocess.check_call(
["git", "remote", "add", "upstream", remote_url], preexec_fn=su_to_zulip
)
logging.info("Fetching the latest commits")
subprocess.check_call(["git", "fetch", "-q", "--tags", "--all"], preexec_fn=su_to_zulip)
# Generate the deployment directory via git clone from our local repository.
subprocess.check_call(
["git", "clone", "-q", "-b", refname, LOCAL_GIT_CACHE_DIR, deploy_path],
stdout=open("/dev/null", "w"),
preexec_fn=su_to_zulip,
)
os.chdir(deploy_path)
overwrite_symlink("/etc/zulip/settings.py", "zproject/prod_settings.py")
overwrite_symlink(deploy_path, os.path.join(DEPLOYMENTS_DIR, "next"))
try:
subprocess.check_call(
[
os.path.join(deploy_path, "scripts", "lib", "upgrade-zulip-stage-2"),
deploy_path,
"--from-git",
*deploy_options,
]
)
except subprocess.CalledProcessError:
# There's no use in showing a stacktrace here; it just hides
# the error from stage 2.
sys.exit(1)
finally:
release_deployment_lock()