deploy_heroku.py

#!/usr/bin/python
"""Deploys Tabbycat to Heroku.
This script is compatible with both Python 2.7 and Python 3.4 (and later)."""

import argparse
import platform
import re
import shutil
import subprocess
import sys
import time

try:
    from django.core.management.utils import get_random_secret_key
except ImportError:
    from random import SystemRandom

    def get_random_secret_key():
        chars = 'abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'
        return ''.join(SystemRandom().choice(chars) for _ in range(50))

# Arguments
parser = argparse.ArgumentParser(description="Deploy Tabbycat to a new Heroku app.")

parser.add_argument(
    "urlname", type=str,
    help="Name of the Heroku app. The app will be at urlname.herokuapp.com. Use '-' to use a Heroku-generated default.")

parser.add_argument(
    "--no-open", action="store_false", default=True, dest="open",
    help="Don't open the Heroku website in your browser at the end")

parser.add_argument(
    "--git-remote", type=str, default=None,
    help="Name of Git remote to use. Use '-' to use the urlname. If omitted, reverts to default Heroku behaviour.")

parser.add_argument(
    "--git-branch", type=str, default=None,
    help="Git branch to push (defaults to current branch)")

parser.add_argument(
    "--pg-plan", "--postgresql-plan", type=str, default="essential-0",
    help="Heroku Postgres plan (default essential-0)")

parser.add_argument(
    "--web-dynos", type=str, default="1",
    help="Web dyno specification, passed to heroku ps:scale web=[], e.g. 1:eco, 1:basic, 2:Standard-1X")

parser.add_argument(
    "--import-tournament", type=str, metavar="IMPORT_DIR",
    help="Also run the importtournament command, importing from IMPORT_DIR")

parser.add_argument(
    "--dry-run", action="store_true", default=False,
    help="Print commands, don't run them.")

config_group = parser.add_argument_group("heroku configuration settings")
config_group.add_argument("--fast-cache-timeout", type=int, default=None, metavar="TIMEOUT",
                          help="Set the faster public page cache timeout to TIMEOUT")
config_group.add_argument("--slow-cache-timeout", type=int, default=None, metavar="TIMEOUT",
                          help="Set the slower public page cache timeout to TIMEOUT")
config_group.add_argument("--tab-cache-timeout", type=int, default=None, metavar="TIMEOUT",
                          help="Set the tab page cache timeout to TIMEOUT")
config_group.add_argument("--enable-debug", action="store_true", default=False,
                          help="Enable Django debug pages")
config_group.add_argument("--time-zone", type=str, default="Australia/Melbourne",
                          help="Time zone name from the IANA tz database")

# Import tournament arguments are copied from importtournament.py, and should be
# updated when these options in importtournament.py change.
import_tournament_group = parser.add_argument_group(
    "import tournament options",
    "Passed to the importtournament command. Ignored unless " +
    "--import-tournament is used. Provided for convenience; to use other " +
    "importtournament options, run the importtournament command separately instead.")
import_tournament_group.add_argument(
    '-s', '--slug', type=str, action='store', default=None, dest="tournament_slug",
    help='Override tournament slug. (Default: use name of directory.)')
import_tournament_group.add_argument(
    '--name', type=str, action='store', default=None, dest="tournament_name",
    help='Override tournament name. (Default: use name of directory.)')
import_tournament_group.add_argument(
    '--short-name', type=str, action='store', default=None, dest="tournament_short_name",
    help='Override tournament short name. (Default: use name of directory.)')

args = parser.parse_args()

if platform.system() == "Windows":
    subprocess_kwargs = dict(shell=True)
    use_color = False
else:
    subprocess_kwargs = dict()
    use_color = True

# Helper functions


def print_command(command):
    message = "$ " + " ".join(command)
    if use_color:
        message = "\033[1;36m" + message + "\033[0m"
    print(message)


def run_command(command):
    print_command(command)
    if not args.dry_run:
        subprocess.check_call(command, **subprocess_kwargs)


def make_heroku_command(command):
    return ["heroku"] + command + ["--app", urlname]


def run_heroku_command(command):
    command = make_heroku_command(command)
    run_command(command)


def get_output_from_command(command):
    print_command(command)
    output = subprocess.check_output(command, **subprocess_kwargs)
    output = output.decode()
    sys.stdout.write(output)
    sys.stdout.flush()
    return output


def print_yellow(message):
    if use_color:
        message = "\033[1;33m" + message + "\033[0m"
    print(message)


def get_git_push_spec():
    if args.git_branch:
        return "master" if args.git_branch == "master" else args.git_branch + ":master"
    try:
        branch = get_output_from_command(["git", "symbolic-ref", "--short", "--quiet", "HEAD"]).strip()
    except subprocess.CalledProcessError:
        print_yellow("Attempt to find git branch name failed, trying for commit instead...")
    else:
        return "master" if branch == "master" else branch + ":master"
    try:
        return get_output_from_command(["git", "rev-parse", "--short", "--quiet", "HEAD"]).strip() + ":refs/heads/master"
    except subprocess.CalledProcessError:
        print_yellow("Could not determine current git commit or branch. Use --git-branch to specify a git branch to push.")
    exit(1)


# Check that Heroku is installed (shutil.which requires Python 3.3+, otherwise
# skip the check, it'll crash on the next command without a friendly message)
if sys.version_info >= (3, 3) and shutil.which("heroku") is None:
    print_yellow("Error: heroku not found.")
    print("You'll need to install the Heroku CLI before you can use this script.")
    print("Go to https://devcenter.heroku.com/articles/heroku-cli, or search the")
    print("internet for \"Heroku CLI\".")
    exit(1)

# Create the app with addons
addons = ["papertrail", "heroku-postgresql:%s" % args.pg_plan, "rediscloud:30", "heroku-redis:mini"]
command = ["heroku", "apps:create", "--stack", "heroku-22"]

if addons:
    command.extend(["--addons", ",".join(addons)])
if args.urlname != "-":
    command.append(args.urlname)
output = get_output_from_command(command)
match = re.search(r"https://([\w_-]+?)(?:-\w{12})?\.herokuapp\.com/\s+\|\s+(https://git.heroku.com/[\w_-]+.git)", output)
urlname = match.group(1)
heroku_url = match.group(2)

# Set build packs
run_heroku_command(["buildpacks:set", "https://github.com/heroku/heroku-buildpack-nginx.git"])
run_heroku_command(["buildpacks:add", "heroku/nodejs"])
run_heroku_command(["buildpacks:add", "heroku/python"])

# Set config variables
command = ["config:set", "DISABLE_COLLECTSTATIC=1", "ON_HEROKU=1", "USING_NGINX=1"]
secret_key = get_random_secret_key()

if platform.system() == "Windows": # Windows shell needs escaping
    command.append("DJANGO_SECRET_KEY=\"%s\"" % secret_key)
else:
    command.append("DJANGO_SECRET_KEY=%s" % secret_key)

command.append("DEBUG=1" if args.enable_debug else "DEBUG=0")

if args.fast_cache_timeout:
    command.append("PUBLIC_FAST_CACHE_TIMEOUT=%d" % args.fast_cache_timeout)
if args.slow_cache_timeout:
    command.append("PUBLIC_SLOW_CACHE_TIMEOUT=%d" % args.slow_cache_timeout)
if args.tab_cache_timeout:
    command.append("TAB_PAGES_CACHE_TIMEOUT=%d" % args.tab_cache_timeout)
if args.time_zone:
    command.append("TIME_ZONE=%s" % args.time_zone)

run_heroku_command(command)

# Set up a remote, if applicable
if args.git_remote:
    remote_name = args.git_remote if args.git_remote != "-" else urlname
    run_heroku_command(["git:remote", "--remote", remote_name])
else:
    remote_name = heroku_url

# Wait for Redis provisioning, which can take a significant amount of time
redis_provisioned = False
redis_status_command = make_heroku_command(["redis:info"])
print_yellow("Waiting for Heroku Redis to provision (may take up to 5 minutes)...")

while not redis_provisioned:
    time.sleep(30)
    redis_output = subprocess.check_output(redis_status_command).decode().split("\n")
    redis_provisioned = "available" in redis_output[2]

print("Heroku Redis is available, starting deployment")

# Push source code to Heroku
push_spec = get_git_push_spec()
run_command(["git", "push", remote_name, push_spec])

# Scale dynos (by default it only adds 1 web dyno)
run_heroku_command(["ps:scale", "worker=1", "web=%s" % args.web_dynos])

# Import tournament, if provided
if args.import_tournament:
    command = ["run", "python", "tabbycat/manage.py", "importtournament", args.import_tournament]
    if args.tournament_slug:
        command += ["--slug", args.tournament_slug]
    if args.tournament_name:
        command += ["--name", args.tournament_name]
    if args.tournament_short_name:
        command += ["--short-name", args.tournament_short_name]
    run_heroku_command(command)

# Create superuser
print_yellow("Now creating a superuser for the Heroku site.")
print_yellow("You'll need to respond to the prompts:")
run_heroku_command(["run", "python", "tabbycat/manage.py", "createsuperuser"])

# Open in browser
if args.open:
    try:
        run_heroku_command(["open"])
    except subprocess.CalledProcessError:
        print_yellow("There was a problem automatically opening your browser, but your new Tabbycat")
        print_yellow("site itself did deploy successfully. Just visit this URL in your browser:")
        print_yellow("http://%s.herokuapp.com/" % urlname)