Add instructions on how to run Jasmine JS tests on the 'Running Unit Tests' page.

Review Request #8637 — Created Jan. 20, 2017 and submitted

Information

Review Board
master
e6bc59b...

Reviewers

There are two types of tests that can be run to check changes or new modules,
before posting code for review. Prior to this change, the 'Running Unit Tests'
page only contained instructions on how to run tests on Python work. This
change adds instruction for how to run unit tests on work done in JavaScript.

Built the change and reviewed the resulting information and formatting on web browser.

Description From Last Updated

I'm not certain if "front-end" and "back-end" are the right separation here - since where does a template fall? Front-end …

mike_conleymike_conley

Instead of repeating this instruction, we should instead direct the user to the Getting Started guide that shows how to …

mike_conleymike_conley

"depending on if you are running a test on if" is a little awkward. Perhaps this should be: "There are …

mike_conleymike_conley

Note the capital S in JavaScript.

mike_conleymike_conley

Got some trailing whitespace here, I'm afraid. Can you please remove it?

mike_conleymike_conley

Can you fix this so the hyphens are the same width as the text?

daviddavid

should be "the JavaScript tests" (since it runs all of them).

daviddavid

This should have a trailing / at the end of the URL.

daviddavid

Here too.

daviddavid

We shouldn't be encoding a link to the docs on the Review Board website. Instead, in docs/codebase/getting-started.rst, next to the …

daviddavid
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
  2. 
      
sharleenfisher
mike_conley
  1. 
      
  2. Show all issues

    I'm not certain if "front-end" and "back-end" are the right separation here - since where does a template fall? Front-end or back-end?

    Perhaps we should instead have a distinction between server tests and JavaScript tests?

    1. Maybe "Python tests" and "Javascript tests"?

  3. Show all issues

    Instead of repeating this instruction, we should instead direct the user to the Getting Started guide that shows how to boot the development server.

    So maybe something like:

    To run a JavaScript test, first launch the web server, then browse to http://localhost:8080/js-tests. The full JavaScript test suite should run automatically.

  4. 
      
sharleenfisher
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
  2. 
      
mike_conley
  1. This looks really good! Just a few small things.

  2. docs/codebase/unit-tests/running-tests.rst (Diff revision 2)
     
     
     
    Show all issues

    "depending on if you are running a test on if" is a little awkward. Perhaps this should be:

    "There are two types of unit tests that can be run: Python and JavaScript."

  3. Show all issues

    Note the capital S in JavaScript.

  4. docs/codebase/unit-tests/running-tests.rst (Diff revision 2)
     
     
     
    Show all issues

    Got some trailing whitespace here, I'm afraid. Can you please remove it?

  5. 
      
sharleenfisher
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
  2. 
      
sharleenfisher
david
  1. 
      
  2. docs/codebase/unit-tests/running-tests.rst (Diff revision 3)
     
     
     
    Show all issues

    Can you fix this so the hyphens are the same width as the text?

  3. Show all issues

    should be "the JavaScript tests" (since it runs all of them).

  4. Show all issues

    This should have a trailing / at the end of the URL.

  5. docs/codebase/unit-tests/running-tests.rst (Diff revision 3)
     
     
     
    Show all issues

    Here too.

  6. 
      
sharleenfisher
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/codebase/unit-tests/running-tests.rst
    
    
  2. 
      
david
  1. 
      
  2. Show all issues

    We shouldn't be encoding a link to the docs on the Review Board website. Instead, in docs/codebase/getting-started.rst, next to the "Development Web Server" section, we can add an anchor:

    .. _development-web-server
    

    and then for the link in the text, we can do:

    ... under :ref:`development-web-server`
    

    It might be nice to do the same for "Getting Started" (replace that text with :ref:`getting-started`)

  3. 
      
sharleenfisher
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/getting-started.rst
        docs/codebase/unit-tests/running-tests.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/codebase/getting-started.rst
        docs/codebase/unit-tests/running-tests.rst
    
    
  2. 
      
mike_conley
  1. This looks good to me. Great work!

  2. 
      
david
  1. Ship It!
  2. 
      
sharleenfisher
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (121e360)
Loading...