author Matt Woodrow <>
Mon, 15 Apr 2013 18:55:34 +1200
changeset 135530 3b0cda3057dfc1a3c9a2342ad938a8a7ea6bcf32
parent 126716 a874d2756f6530a8ee7c8dc6dbcb7102944d5127
child 144663 6d349e5ae0eddf527a64152222316e3135df15fc
permissions -rw-r--r--
Bug 859526 - Null check parent frames when wrapping preserve-3d display lists. r=roc

# 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

import sys
import os

def welcome():
    Perform a bunch of sanity tests to make sure the Add-on SDK
    environment is sane, and then display a welcome message.

        if sys.version_info[0] > 2:
            print ("Error: You appear to be using Python %d, but "
                   "the Add-on SDK only supports the Python 2.x line." %

        import mozrunner

        if 'CUDDLEFISH_ROOT' not in os.environ:
            print ("Error: CUDDLEFISH_ROOT environment variable does "
                   "not exist! It should point to the root of the "
                   "Add-on SDK repository.")

        env_root = os.environ['CUDDLEFISH_ROOT']

        bin_dir = os.path.join(env_root, 'bin')
        python_lib_dir = os.path.join(env_root, 'python-lib')
        path = os.environ['PATH'].split(os.path.pathsep)

        if bin_dir not in path:
            print ("Warning: the Add-on SDK binary directory %s "
                   "does not appear to be in your PATH. You may "
                   "not be able to run 'cfx' or other SDK tools." %

        if python_lib_dir not in sys.path:
            print ("Warning: the Add-on SDK python-lib directory %s "
                   "does not appear to be in your sys.path, which "
                   "is odd because I'm running from it." % python_lib_dir)

        if not mozrunner.__path__[0].startswith(env_root):
            print ("Warning: your mozrunner package is installed at %s, "
                   "which does not seem to be located inside the Jetpack "
                   "SDK. This may cause problems, and you may want to "
                   "uninstall the other version. See bug 556562 for "
                   "more information." % mozrunner.__path__[0])
    except Exception:
        # Apparently we can't get the actual exception object in the
        # 'except' clause in a way that's syntax-compatible for both
        # Python 2.x and 3.x, so we'll have to use the traceback module.

        import traceback
        _, e, _ = sys.exc_info()
        print ("Verification of Add-on SDK environment failed (%s)." % e)
        print ("Your SDK may not work properly.")

    print ("Welcome to the Add-on SDK. Run 'cfx docs' for assistance.")

if __name__ == '__main__':