run.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
"""Starter file for the project."""

import argparse
import pkg_resources
from pkg_resources import DistributionNotFound
from pkg_resources import VersionConflict
import sys


IMPORT_ERROR = '''
==============================================
It seems like you don't have all dependencies.
Please re-run:
    pip install -r config/requirements-dev.txt
==============================================
'''

NO_CONF_ERROR = '''
==============================================
The config.py file seems to be missing.

Please create a copy of config.py.example and customize it accordingly.
For details, please see
https://github.com/webcompat/webcompat.com/blob/master/.github/CONTRIBUTING.md#configuring-the-server
==============================================
'''


try:
    from webcompat import app
except ImportError as e:
    if 'import_name' in e and e.import_name == 'config':
        # config not found, did you forget to copy config.py.example?
        raise ImportError('{0}\n\n{1}'.format(e, NO_CONF_ERROR))
    else:
        raise ImportError('{0}\n\n{1}'.format(e, IMPORT_ERROR))


TOKEN_HELP = '''
The OAUTH_TOKEN is not configured in your config file.
You will need to set up one on github for testing your
local developments.
Read Instructions at
https://github.com/webcompat/webcompat.com/blob/master/docs/dev-env-setup.md#configuring-the-server
'''

DEPS_VERSION_HELP = '''
The following required versions do not match your locally installed versions:

  %s

Install the correct versions using the commands below before continuing:

pip uninstall name
pip install name==1.2.1
'''

DEPS_NOTFOUND_HELP = '''
The following required module is missing from your installation.

  %s

Install the module using the command below before continuing:

pip install name==1.2.1
'''


def check_pip_deps():
    """Check installed pip dependencies.

    Make sure that the installed pip packages match what is in
    requirements.txt, prompting the user to upgrade if not.
    """
    for req in open("./config/requirements.txt"):
        try:
            pkg_resources.require(req)
        except VersionConflict as e:
            print(DEPS_VERSION_HELP % e)
        except DistributionNotFound as e:
            print(DEPS_NOTFOUND_HELP % e)
        else:
            return True


def config_validator():
    """Make sure the config file is ready."""
    # Checking if oauth token is configured
    if app.config['OAUTH_TOKEN'] == '':
        sys.exit(TOKEN_HELP)


if __name__ == '__main__':
    # Parsing arguments
    parser = argparse.ArgumentParser()
    parser.add_argument('-t', '--testmode', action='store_true',
                        help='Run server in "test mode".')
    parser.add_argument('-l', '--listen', default='localhost',
                        help='Interface to listen on.')
    args = parser.parse_args()

    if check_pip_deps():
        if not args.testmode:
            # testing the config file.
            # this file is only important in non-test mode.
            # in test mode everything must be mocked,
            # so there is no external api communication.
            config_validator()
            app.run(host=args.listen)
        else:
            # disable HttpOnly setting for session cookies so Selenium
            # can interact with them. *ONLY* do this for testing.
            app.config['SESSION_COOKIE_HTTPONLY'] = False
            app.config['SESSION_COOKIE_SAMESITE'] = None
            app.config['TESTING'] = True
            print("Starting server in ~*TEST MODE*~")
            app.run(host=args.listen)