Moves build system to invoke

AUTHORS

@@ -153,4 +153,6 @@ Muhammad Ammar <mammar@edx.org>
 Abdallah Nassif <abdoosh00@gmail.com>
 Johnny Brown <johnnybrown7@gmail.com>
 Ben McMorran <bmcmorran@edx.org>
-Mat Peterson <mpeterson@edx.org>
+Mat Peterson <mpeterson@edx.org>
+Andreas Dewes <andreas.dewes@gmail.com>
+Leo Urbina <leo.a.urbina@gmail.com>

common/djangoapps/terrain/stubs/http.py

@@ -221,6 +221,12 @@ def _format_msg(self, format_str, *args):
             format_str % args
         )
 
+    def do_HEAD(self):
+        """
+        Respond to an HTTP HEAD request
+        """
+        self.send_response(200)
+
 
 class StubHttpService(HTTPServer, object):
     """

pavelib/__init__.py

@@ -1,4 +1,13 @@
 """
 paver commands
 """
-from . import assets, servers, docs, prereqs, quality, tests, js_test
+__all__ = [
+    "assets_deprecated", "servers_deprecated", "docs_deprecated",
+    "prereqs_deprecated", "quality_deprecated", "tests_deprecated",
+    "js_test_deprecated"
+]
+from . import (
+    assets_deprecated, servers_deprecated, docs_deprecated,
+    prereqs_deprecated, quality_deprecated, tests_deprecated,
+    js_test_deprecated
+)

pavelib/assets.py → pavelib/assets_deprecated.py

@@ -10,6 +10,8 @@
 import traceback
 from .utils.envs import Env
 from .utils.cmd import cmd, django_cmd
+from .utils.deprecated import deprecated
+
 
 # setup baseline paths
 
@@ -190,8 +192,9 @@ def watch_assets(options):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @consume_args
+@deprecated('invoke assets.update')
 def update_assets(args):
     """
     Compile CoffeeScript and Sass, then collect static assets.

pavelib/docs.py → pavelib/docs_deprecated.py

@@ -1,7 +1,7 @@
 from __future__ import print_function
 import sys
 from paver.easy import *
-
+from .utils.deprecated import deprecated
 
 DOC_PATHS = {
     "dev": "docs/en_us/developers",
@@ -54,11 +54,12 @@ def doc_path(options, allow_default=True):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @cmdopts([
     ("type=", "t", "Type of docs to compile"),
     ("verbose", "v", "Display verbose output"),
 ])
+@deprecated('invoke docs.build')
 def build_docs(options):
     """
     Invoke sphinx 'make build' to generate docs.

pavelib/js_test.py → pavelib/js_test_deprecated.py

@@ -5,6 +5,7 @@
 from paver.easy import task, cmdopts, needs
 from pavelib.utils.test.suites import JsTestSuite
 from pavelib.utils.envs import Env
+from .utils.deprecated import deprecated
 
 __test__ = False  # do not collect
 
@@ -19,6 +20,7 @@
     ("mode=", "m", "dev or run"),
     ("coverage", "c", "Run test under coverage"),
 ])
+@deprecated('invoke js_test.test_js')
 def test_js(options):
     """
     Run the JavaScript tests
@@ -52,6 +54,7 @@ def test_js(options):
     ("suite=", "s", "Test suite to run"),
     ("coverage", "c", "Run test under coverage"),
 ])
+@deprecated('invoke js_test.test_js_run')
 def test_js_run(options):
     """
     Run the JavaScript tests and print results to the console
@@ -64,6 +67,7 @@ def test_js_run(options):
 @cmdopts([
     ("suite=", "s", "Test suite to run"),
 ])
+@deprecated('invoke js_test.test_js_dev')
 def test_js_dev(options):
     """
     Run the JavaScript tests in your default browsers

pavelib/prereqs.py → pavelib/prereqs_deprecated.py

@@ -7,7 +7,7 @@
 from distutils import sysconfig
 from paver.easy import *
 from .utils.envs import Env
-
+from .utils.deprecated import deprecated
 
 PREREQS_MD5_DIR = os.getenv('PREREQ_CACHE_DIR', Env.REPO_ROOT / '.prereqs_cache')
 NPM_REGISTRY = "http://registry.npmjs.org/"
@@ -117,6 +117,7 @@ def python_prereqs_installation():
 
 
 @task
+@deprecated('invoke prereqs.install.ruby')
 def install_ruby_prereqs():
     """
     Installs Ruby prereqs
@@ -125,6 +126,7 @@ def install_ruby_prereqs():
 
 
 @task
+@deprecated('invoke prereqs.install.node')
 def install_node_prereqs():
     """
     Installs Node prerequisites
@@ -133,6 +135,7 @@ def install_node_prereqs():
 
 
 @task
+@deprecated('invoke prereqs.install.python')
 def install_python_prereqs():
     """
     Installs Python prerequisites
@@ -141,6 +144,7 @@ def install_python_prereqs():
 
 
 @task
+@deprecated('invoke prereqs.install')
 def install_prereqs():
     """
     Installs Ruby, Node and Python prerequisites

pavelib/servers.py → pavelib/servers_deprecated.py

@@ -7,7 +7,7 @@
 from paver.easy import *
 from .utils.cmd import django_cmd
 from .utils.process import run_process, run_multi_processes
-
+from .utils.deprecated import deprecated
 
 DEFAULT_PORT = {"lms": 8000, "studio": 8001}
 DEFAULT_SETTINGS = 'dev'
@@ -42,12 +42,13 @@ def run_server(system, settings=None, port=None, skip_assets=False):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @cmdopts([
     ("settings=", "s", "Django settings"),
     ("port=", "p", "Port"),
     ("fast", "f", "Skip updating assets")
 ])
+@deprecated('invoke servers.lms')
 def lms(options):
     """
     Run the LMS server.
@@ -59,12 +60,13 @@ def lms(options):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @cmdopts([
     ("settings=", "s", "Django settings"),
     ("port=", "p", "Port"),
     ("fast", "f", "Skip updating assets")
 ])
+@deprecated('invoke servers.cms')
 def studio(options):
     """
     Run the Studio server.
@@ -76,8 +78,9 @@ def studio(options):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @consume_args
+@deprecated('invoke --help servers.devstack')
 def devstack(args):
     """
     Start the devstack lms or studio server
@@ -90,10 +93,11 @@ def devstack(args):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @cmdopts([
     ("settings=", "s", "Django settings"),
 ])
+@deprecated('invoke servers.celery')
 def celery(options):
     """
     Runs Celery workers.
@@ -103,14 +107,16 @@ def celery(options):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @cmdopts([
     ("settings=", "s", "Django settings for both LMS and Studio"),
     ("worker_settings=", "w", "Celery worker Django settings"),
     ("fast", "f", "Skip updating assets"),
     ("settings_lms=", "l", "Set LMS only, overriding the value from --settings (if provided)"),
     ("settings_cms=", "c", "Set Studio only, overriding the value from --settings (if provided)"),
 ])
+# Can't deal with parsing arguments of deprecated functions
+@deprecated('invoke servers.run')
 def run_all_servers(options):
     """
     Runs Celery workers, Studio, and LMS.
@@ -137,10 +143,11 @@ def run_all_servers(options):
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @cmdopts([
     ("settings=", "s", "Django settings"),
 ])
+@deprecated('invoke servers.update_db')
 def update_db():
     """
     Runs syncdb and then migrate.
@@ -151,8 +158,10 @@ def update_db():
 
 
 @task
-@needs('pavelib.prereqs.install_prereqs')
+@needs('pavelib.prereqs_deprecated.install_prereqs')
 @consume_args
+# Can't deal with parsing arguments of deprecated functions
+@deprecated('invoke --help servers.check_settings')
 def check_settings(args):
     """
     Checks settings files.

pavelib/tests.py → pavelib/tests_deprecated.py

@@ -7,6 +7,7 @@
 from pavelib.utils.test import suites
 from pavelib.utils.envs import Env
 from optparse import make_option
+from .utils.deprecated import deprecated
 
 try:
     from pygments.console import colorize
@@ -31,6 +32,7 @@
     make_option("-q", "--quiet", action="store_const", const=0, dest="verbosity"),
     make_option("-v", "--verbosity", action="count", dest="verbosity", default=1),
 ])
+@deprecated('invoke tests.test_system')
 def test_system(options):
     """
     Run tests on our djangoapps for lms and cms
@@ -75,6 +77,7 @@ def test_system(options):
     make_option("-q", "--quiet", action="store_const", const=0, dest="verbosity"),
     make_option("-v", "--verbosity", action="count", dest="verbosity", default=1),
 ])
+@deprecated('invoke tests.test_lib')
 def test_lib(options):
     """
     Run tests for common/lib/
@@ -111,6 +114,7 @@ def test_lib(options):
     make_option("-q", "--quiet", action="store_const", const=0, dest="verbosity"),
     make_option("-v", "--verbosity", action="count", dest="verbosity", default=1),
 ])
+@deprecated('invoke tests.test_python')
 def test_python(options):
     """
     Run all python tests
@@ -130,6 +134,7 @@ def test_python(options):
     'pavelib.prereqs.install_python_prereqs',
     'pavelib.utils.test.utils.clean_reports_dir',
 )
+@deprecated('invoke tests.test_i18n')
 def test_i18n():
     """
     Run all i18n tests
@@ -148,6 +153,7 @@ def test_i18n():
     make_option("-q", "--quiet", action="store_const", const=0, dest="verbosity"),
     make_option("-v", "--verbosity", action="count", dest="verbosity", default=1),
 ])
+@deprecated('invoke tests.test')
 def test(options):
     """
     Run all tests
@@ -170,6 +176,7 @@ def test(options):
 @cmdopts([
     ("compare_branch", "b", "Branch to compare against, defaults to origin/master"),
 ])
+@deprecated('invoke tests.coverage')
 def coverage(options):
     """
     Build the html, xml, and diff coverage reports

pavelib/utils/deprecated.py

@@ -0,0 +1,17 @@
+from __future__ import print_function
+from invoke import run as sh
+from pygments.console import colorize
+
+def deprecated(deprecated_by):
+    def deprecated_decorator(func):
+        def wrapper(*args, **kwargs):
+            sh("pip install -q -r requirements/edx/invoke.txt")
+            print(colorize("darkred", "Task {name} has been deprecated. Use '{deprecated_by}' instead.".\
+                  format(name=func.__name__, deprecated_by=deprecated_by)))
+            sh(deprecated_by, echo=True)
+        # Copy over the necessary metadata
+        wrapper.__name__ = func.__name__
+        wrapper.__module__ = func.__module__
+        wrapper.__doc__ = func.__doc__
+        return wrapper
+    return deprecated_decorator

requirements/edx/invoke.txt

@@ -0,0 +1,4 @@
+invoke==0.7.0
+lazy==1.1
+path.py==5.1
+wsgiref==0.1.2

tasks/__init__.py

@@ -0,0 +1,24 @@
+from __future__ import print_function
+from invoke import Collection
+
+ns = Collection()
+
+
+from . import assets
+from . import clean
+from . import db
+from . import docs
+from . import i18n
+from . import prereqs
+from . import servers
+from . import test
+
+
+ns.add_collection(assets)
+ns.add_collection(clean)
+ns.add_collection(db)
+ns.add_collection(docs)
+ns.add_collection(i18n)
+ns.add_collection(prereqs)
+ns.add_collection(servers)
+ns.add_collection(test)