fix

oppia · brianrodri · Sep 8, 2019 · Aug 17, 2019 · Aug 18, 2019 · Aug 18, 2019
commit 8b7bb5a3acb478eac2db36d5ed84bebbcd3f8a6f
@@ -258,8 +258,8 @@ def recursive_chmod(path, mode):
             os.chmod(os.path.join(root, filename), mode)
 
 
-def print_string_after_two_new_lines(strings):
-    """Prints each string after two new lines.
+def print_each_string_after_two_new_lines(strings):
+    """Prints the given strings, separating adjacent strings with two newlines.
 
     Args:
         strings: list(str). The strings to print.
@@ -268,19 +268,20 @@ def print_string_after_two_new_lines(strings):
         python_utils.PRINT('%s\n' % string)
 
 
-def install_npm_library(library, version, path):
+def install_npm_library(library_name, version, path):
     """Installs the npm library after ensuring its not already installed.
 
     Args:
-        library: str. The library name.
+        library_name: str. The library name.
         version: str. The library version.
         path: str. The installation path for the library.
     """
     python_utils.PRINT(
-        'Checking whether %s is installed in %s' % (library, path))
-    if not os.path.exists(os.path.join(NODE_MODULES_PATH, library)):
-        python_utils.PRINT('Installing %s' % library)
-        subprocess.call([NPM_PATH, 'install', '%s@%s' % (library, version)])
+        'Checking whether %s is installed in %s' % (library_name, path))
+    if not os.path.exists(os.path.join(NODE_MODULES_PATH, library_name)):
+        python_utils.PRINT('Installing %s' % library_name)
+        subprocess.call([
+            NPM_PATH, 'install', '%s@%s' % (library_name, version)])
 
 
 class CD(python_utils.OBJECT):

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""It produces the expression parser."""
+"""This script produces the expression parser."""
 from __future__ import absolute_import  # pylint: disable=import-only-modules
 
 import fileinput

@@ -54,7 +54,7 @@ def pip_install(package, version, install_path):
         python_utils.PRINT('Checking if pip is installed on the local machine')
         import pip
     except ImportError:
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'Pip is required to install Oppia dependencies, but pip wasn\'t '
             'found',
             'on your local machine.',

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""It runs all the (Python) backend tests, in parallel."""
+"""This script runs all the (Python) backend tests, in parallel."""
 from __future__ import absolute_import  # pylint: disable=import-only-modules
 
 import argparse

diff --git a/scripts/run_e2e_tests.py b/scripts/run_e2e_tests.py
@@ -78,7 +78,7 @@ def cleanup():
         time.sleep(1)
 
     if os.path.isdir('../protractor-screenshots'):
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'Note: If ADD_SCREENSHOT_REPORTER is set to true in',
             'core/tests/protractor.conf.js, you can view screenshots',
             'of the failed tests in ../protractor-screenshots/'])
@@ -98,14 +98,14 @@ def main(argv=None):
         parsed_args.skip_install, parsed_args.run_minified_tests)
 
     if common.is_port_open(8181):
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'There is already a server running on localhost:8181.',
             'Please terminate it before running the end-to-end tests.',
             'Exiting.'])
         sys.exit(1)
 
     if common.is_port_open(9001):
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'There is already a server running on localhost:9001.',
             'Please terminate it before running the end-to-end tests.',
             'Exiting.'])

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""It runs unit tests for frontend JavaScript code (using Karma)."""
+"""This script runs unit tests for frontend JavaScript code (using Karma)."""
 from __future__ import absolute_import  # pylint: disable=import-only-modules
 
 import argparse
@@ -50,7 +50,7 @@ def main(argv=None):
     parsed_args, _ = _PARSER.parse_known_args(args=argv)
     install_third_party_libs.maybe_install_dependencies(
         parsed_args.skip_install, parsed_args.run_minified_tests)
-    common.print_string_after_two_new_lines([
+    common.print_each_string_after_two_new_lines([
         'View interactive frontend test coverage reports by navigating to',
         '../karma_coverage_reports',
         'on your filesystem.',

@@ -85,7 +85,7 @@ def main(argv=None):
         parsed_args.skip_install, parsed_args.run_minified_tests)
 
     if common.is_port_open(8181):
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'There is already a server running on localhost:8181',
             'Please terminate it before running the performance tests.',
             'Exiting.'])

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""It runs the following tests in all cases.
+"""This script runs the following tests in all cases.
 - Javascript and Python Linting
 - Backend Python tests
 
@@ -78,7 +78,7 @@ def main(argv=None):
         python_utils.PRINT('Frontend tests passed.')
     else:
         # If files in common.FRONTEND_DIR were not changed, skip the tests.
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'No frontend files were changed.',
             'Skipped frontend tests'])
 

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""It runs all the tests, in this order:
+"""This script runs all the tests, in this order:
 - Frontend Karma unit tests
 - Backend Python tests
 - End-to-end Protractor tests

@@ -63,7 +63,7 @@ def test_python_version():
         # path.
         os_info = os.uname()
         if os_info[0] != 'Darwin' and os_info[0] != 'Linux':
-            common.print_string_after_two_new_lines([
+            common.print_each_string_after_two_new_lines([
                 'It looks like you are using Windows. If you have Python '
                 'installed,',
                 'make sure it is in your PATH and that PYTHONPATH is set.',
@@ -104,7 +104,7 @@ def main():
     if os_info[0] != 'Darwin' and os_info[0] != 'Linux':
         # Node is a requirement for all installation scripts. Here, we check if
         # the OS supports node.js installation; if not, we exit with an error.
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'WARNING: Unsupported OS for installation of node.js.',
             'If you are running this script on Windows, see the instructions',
             'here regarding installation of node.js:',

@@ -57,7 +57,7 @@
 
 def cleanup():
     """Function for waiting for the servers to go down."""
-    common.print_string_after_two_new_lines([
+    common.print_each_string_after_two_new_lines([
         'INFORMATION',
         'Cleaning up the servers.'])
     while common.is_port_open(8181):
@@ -82,7 +82,7 @@ def main(argv=None):
 
     # Check that there isn't a server already running.
     if common.is_port_open(8181):
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'WARNING',
             'Could not start new server. There is already an existing server',
             'running at port 8181.'])
@@ -153,13 +153,13 @@ def main(argv=None):
         if list(filter(
                 detect_virtualbox_pattern.match,
                 os.listdir('/dev/disk/by-id/'))):
-            common.print_string_after_two_new_lines([
+            common.print_each_string_after_two_new_lines([
                 'INFORMATION',
                 'Setting up a local development server. You can access this '
                 'server',
                 'by navigating to localhost:8181 in a browser window.'])
         else:
-            common.print_string_after_two_new_lines([
+            common.print_each_string_after_two_new_lines([
                 'INFORMATION',
                 'Setting up a local development server at localhost:8181. '
                 'Opening a',
@@ -168,7 +168,7 @@ def main(argv=None):
             background_processes.append(
                 subprocess.Popen(['xdg-open', 'http://localhost:8181/']))
     elif os_info[0] == 'Darwin' and not parsed_args.no_browser:
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'INFORMATION',
             'Setting up a local development server at localhost:8181. '
             'Opening a',
@@ -177,7 +177,7 @@ def main(argv=None):
         background_processes.append(
             subprocess.Popen(['open', 'http://localhost:8181/']))
     else:
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'INFORMATION',
             'Setting up a local development server. You can access this server',
             'by navigating to localhost:8181 in a browser window.'])

diff --git a/scripts/vagrant_lock.py b/scripts/vagrant_lock.py
@@ -44,7 +44,7 @@ def main(argv=None):
         sys.exit(0)
 
     if os.path.isfile(vagrant_lock_file):
-        common.print_string_after_two_new_lines([
+        common.print_each_string_after_two_new_lines([
             'Another setup instance is already running',
             'Please wait for that instance to complete or terminate it',
             'If you ran $0 twice on purpose, you can override this with ',