From 730f25c46b8fc225dfc5a511a7844c8d96f91950 Mon Sep 17 00:00:00 2001 From: Nils Loewen <26473489+nilswloewen@users.noreply.github.com> Date: Wed, 19 Oct 2022 03:46:35 -0700 Subject: [PATCH] Fix typo in contrib instructions `cargo make tests` -> `cargo make test` (#2909) * Fix typo in contrib instructions `cargo make tests` -> `cargo make test` * Use `cargo make test-flow` for running all tests * Remove 'WebSocket service tests' section from CONTRIBUTING.md --- CONTRIBUTING.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94fe29828..8a4553f4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,12 +27,12 @@ The most important tasks are outlined below. To run all tests, use the following command: ```bash -cargo make tests +cargo make test-flow ``` ### Browser tests -`cargo make tests` will automatically download Geckodriver to a temporary location if it isn't in the PATH. +`cargo make test` will automatically download Geckodriver to a temporary location if it isn't in the PATH. Because Geckodriver looks for `firefox` in the path, if you use FireFox Developer Edition, you may get an error, because Developer Editions @@ -44,18 +44,10 @@ To fix this, either install the standard version of Firefox or symlink The tests for the fetch service require a local [httpbin](https://httpbin.org/) server. If you have [Docker](https://www.docker.com/) installed, -`cargo make tests` will automatically run httpbin in a container for you. +`cargo make test` will automatically run httpbin in a container for you. Alternatively, you can set the `HTTPBIN_URL` environment variable to the URL you wish to run tests against. -### WebSocket service tests - -The tests for the web-socket service require an echo server. -If you have [Docker](https://www.docker.com/) installed, -`cargo make tests` will automatically run an [echo server](https://hub.docker.com/r/jmalloc/echo-server) in a container for you. - -Alternatively, you can set the `ECHO_SERVER_URL` environment variable to the URL you wish to run tests against. - ### Macro tests When adding or updating tests, please make sure to update the appropriate `stderr` file, which you can find [here](https://github.com/yewstack/yew/tree/master/packages/yew-macro/tests/macro) for the `html!` macro.