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 | |
|---|---|
| sharleenfisher | |
| Review Board | |
| master | |
| 4510 | |
| e6bc59b... | |
| Reviewers | |
| reviewboard, students | |
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_conley
|
|
|
Instead of repeating this instruction, we should instead direct the user to the Getting Started guide that shows how to … |
mike_conley
|
|
|
"depending on if you are running a test on if" is a little awkward. Perhaps this should be: "There are … |
mike_conley
|
|
|
Note the capital S in JavaScript. |
mike_conley
|
|
|
Got some trailing whitespace here, I'm afraid. Can you please remove it? |
mike_conley
|
|
|
Can you fix this so the hyphens are the same width as the text? |
 david
|
|
|
should be "the JavaScript tests" (since it runs all of them). |
david
|
|
|
This should have a trailing / at the end of the URL. |
david
|
|
|
Here too. |
david
|
|
|
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 … |
david
|
-
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 1) 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?
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 1) 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.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+21 -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
-
This looks really good! Just a few small things.
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 2) "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."
-
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 2) Got some trailing whitespace here, I'm afraid. Can you please remove it?
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 3 (+20 -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
Description: |
|
|---|
-
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 3) Can you fix this so the hyphens are the same width as the text?
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 3) should be "the JavaScript tests" (since it runs all of them).
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 3) This should have a trailing / at the end of the URL.
-
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 4 (+20 -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
-
-
docs/codebase/unit-tests/running-tests.rst (Diff revision 4) 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-serverand 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`)
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 5 (+21 -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