Commit 54c4eac7 authored by James R. Wilcox's avatar James R. Wilcox
Browse files

README nits

parent 4aef915c
# Tests for CS 4962 exercises
# Tests for Web Browser Engineering exercises
The markdown files in this repository contain tests for your web browser.
For example, the file `chapter1-base-tests.md` contains basic unit tests
......@@ -11,13 +11,13 @@ Read through the test files for each chapter before working on the web
browser.
The test files contain additional information about how you should
implement each exercise and how it will be tested.
Note that this repository will be updated throughout the semester with
Note that this repository will be updated throughout the quarter with
new tests for each chapter.
## Running the tests
You do not need to run these tests manually.
They will be automatically run by Github Actions in your repository student.
They will be automatically run by Gitlab CI in your student repository.
The output should look like this:
$ python3 src/run-tests.py
......@@ -32,8 +32,6 @@ The output should look like this:
----------------------------------------------------
Final: all passed
If any tests fail, you will probably also get an email from Github.
To run the tests manually,
go to the root directory of your web browser
run `python3 src/run-tests.py` with no arguments.
......@@ -41,7 +39,7 @@ The script will look for the `browser.py` file in that directory
and run all of the tests on that file.
With no arguments this script will test the coming week's homework,
but you can also specify an
but you can also specify an
argument to select a specific chapter's tests.
For example, run `python3 src/run-tests.py chapter1`
to run the tests for the first chapter.
......@@ -53,8 +51,8 @@ You can also run just the test file for a specific exercise.
use the argument `chapter1-base`. To run the chapter1 file url tests (corresponding file name `chapter1-exercise-file-urls-tests.md`),
use the argument `chapter1-file-urls`
The output of the script is [doctest](https://docs.python.org/3/library/doctest.html)
output for each markdown file for the current chapter followed by a
The output of the script is [doctest](https://docs.python.org/3/library/doctest.html)
output for each markdown file for the current chapter followed by a
summary of which files contain failed tests.
## Mocked modules and methods
......@@ -72,5 +70,5 @@ Specifically, here are the mocked methods in various modules:
| `socket` | The `socket` class and its methods `connect`, `send`, `makefile`, `close` |
| `ssl` | The `wrap_socket` function |
This table will be updated throughout the semester
This table will be updated throughout the quarter
as we test more parts of your browser.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment