convert

oppia · brianrodri · Sep 8, 2019 · Aug 17, 2019 · Aug 18, 2019 · Aug 18, 2019
commit d2ed087c9c9ebf323e7ec2f37c3184ece9c07ff9
@@ -38,6 +38,7 @@
 GOOGLE_CLOUD_SDK_HOME = os.path.join(
     OPPIA_TOOLS_DIR, 'google-cloud-sdk-251.0.0/google-cloud-sdk')
 NODE_PATH = os.path.join(OPPIA_TOOLS_DIR, 'node-10.15.3')
+FRONTEND_DIR = 'core/templates/dev/head'
 
 
 def ensure_directory_exists(d):
@@ -209,6 +210,21 @@ def kill_process(port):
                 process.send_signal(signal.SIGTERM)
 
 
+def run_command(command):
+    """Runs a subprocess command.
+
+    Args:
+        command: str. The command to be run.
+
+    Returns:
+        str. The command output.
+
+    Raises:
+        CalledProcessError. Raised when the command fails.
+    """
+    return subprocess.check_output(command.split())
+
+
 class CD(python_utils.OBJECT):
     """Context manager for changing the current working directory."""
 

@@ -59,6 +59,7 @@
 import argparse
 import os
 import subprocess
+import sys
 
 import python_utils
 
@@ -76,7 +77,7 @@
     action='store_true')
 
 
-def main():
+def main(argv):
     """Runs the backend tests."""
     setup.main()
     setup_gae.main()
@@ -87,7 +88,7 @@ def main():
     coverage_home = os.path.join(common.OPPIA_TOOLS_DIR, 'coverage-4.5.4')
     coverage_path = os.path.join(coverage_home, 'coverage')
 
-    parsed_args, _ = _PARSER.parse_known_args()
+    parsed_args, _ = _PARSER.parse_known_args(args=argv)
     if parsed_args.generate_coverage_report:
         python_utils.PRINT(
             'Checking whether coverage is installed in %s'
@@ -126,4 +127,4 @@ def main():
 
 
 if __name__ == '__main__':
-    main()
+    main(sys.argv)
@@ -32,6 +32,7 @@
 import argparse
 import os
 import subprocess
+import sys
 
 import python_utils
 
@@ -51,14 +52,14 @@
     action='store_true')
 
 
-def main():
+def main(argv):
     """Runs the frontend tests."""
     setup.main()
     setup_gae.main()
     xvfb_prefix = ''
     if os.environ.get('VAGRANT') or os.path.isfile('/etc/is_vagrant_vm'):
         xvfb_prefix = '/usr/bin/xvfb-run'
-    parsed_args = _PARSER.parse_args()
+    parsed_args = _PARSER.parse_args(args=argv)
     setup.maybe_install_dependencies(
         parsed_args.skip_install, parsed_args.run_minified_tests)
     python_utils.PRINT('')
@@ -98,4 +99,4 @@ def main():
 
 
 if __name__ == '__main__':
-    main()
+    main(sys.argv)
@@ -0,0 +1,110 @@
+# Copyright 2019 The Oppia Authors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS-IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""INSTRUCTIONS:
+
+Run this script from the oppia root folder prior to opening a PR:
+  python -m scripts.run_presubmit_checks
+
+It runs the following tests in all cases.
+- Javascript and Python Linting
+- Backend Python tests
+
+Only when frontend files are changed will it run Frontend Karma unit tests.
+
+If any of these tests result in errors, this script will terminate.
+
+Note: The test scripts are arranged in increasing order of time taken. This
+enables a broken build to be detected as quickly as possible.
+
+=====================
+CUSTOMIZATION OPTIONS
+=====================
+
+Set the origin branch to compare against by adding
+
+  --branch=your_branch or -b=your_branch
+
+By default, if the current branch tip exists on remote origin,
+the current branch is compared against its tip on GitHub.
+Otherwise it's compared against 'develop'.
+"""
+from __future__ import absolute_import  # pylint: disable=import-only-modules
+
+import argparse
+import sys
+
+import python_utils
+
+from . import common
+from . import pre_commit_linter
+from . import run_backend_tests
+from . import run_frontend_tests
+
+_PARSER = argparse.ArgumentParser()
+_PARSER.add_argument(
+    '--branch', '-b',
+    help='optional; if specified, the origin branch to compare against.')
+
+
+def main(argv):
+    """Run the presubmit checks."""
+
+    # Run Javascript and Python linters.
+    python_utils.PRINT('Linting files since the last commit')
+    pre_commit_linter.main()
+    python_utils.PRINT('Linting passed.')
+    python_utils.PRINT('')
+
+    current_branch = common.run_command('git rev-parse --abbrev-ref HEAD')
+
+    # If the current branch exists on remote origin, matched_branch_num=1
+    # else matched_branch_num=0.
+    matched_branch_num = common.run_command(
+        'git ls-remote --heads origin %s | wc -l' % current_branch)
+
+    # Set the origin branch to develop if it's not specified.
+    parsed_args, _ = _PARSER.parse_known_args(args=argv)
+    if parsed_args.branch:
+        branch = parsed_args.branch
+    elif matched_branch_num == '1':
+        branch = 'origin/%s' % current_branch
+    else:
+        branch = 'develop'
+
+    python_utils.PRINT('Comparing the current branch with %s' % branch)
+
+    all_changed_files = common.run_command(
+        'git diff --cached --name-only --diff-filter=ACM %s' % branch)
+
+    if common.FRONTEND_DIR in all_changed_files:
+        # Run frontend unit tests.
+        python_utils.PRINT('Running frontend unit tests')
+        run_frontend_tests.main(['--run_minified_tests'])
+        python_utils.PRINT('Frontend tests passed.')
+        python_utils.PRINT('')
+    else:
+        # If files in common.FRONTEND_DIR were not changed, skip the tests.
+        python_utils.PRINT('No frontend files were changed.')
+        python_utils.PRINT('Skipped frontend tests')
+
+    # Run backend tests.
+    python_utils.PRINT('Running backend tests')
+    run_backend_tests.main([])
+    python_utils.PRINT('Backend tests passed.')
+    python_utils.PRINT('')
+
+
+if __name__ == '__main__':
+    main(sys.argv)