diff options
author | halcy <halcy@ARARAGI-KUN> | 2022-11-29 00:50:02 +0200 |
---|---|---|
committer | halcy <halcy@ARARAGI-KUN> | 2022-11-29 00:50:02 +0200 |
commit | 43c7d7ceb8da17954aedee96bd6fb5444a4a728c (patch) | |
tree | bb7cdad59a16447841adc15cb047202b47661220 /tests/README.markdown | |
parent | bd3db974d771d753e7732fabe6a050b779c466e2 (diff) | |
download | mastodon.py-43c7d7ceb8da17954aedee96bd6fb5444a4a728c.tar.gz |
Restructure the docs, a lot
Diffstat (limited to 'tests/README.markdown')
-rw-r--r-- | tests/README.markdown | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/tests/README.markdown b/tests/README.markdown index ae3e42a..49bf894 100644 --- a/tests/README.markdown +++ b/tests/README.markdown | |||
@@ -23,10 +23,10 @@ Note that some tests are slightly unstable, as they require sidekiq to do things | |||
23 | 23 | ||
24 | This test suite uses [VCR.py][] to record requests to Mastodon and replay them in successive runs. | 24 | This test suite uses [VCR.py][] to record requests to Mastodon and replay them in successive runs. |
25 | 25 | ||
26 | If you want to add or change tests, you will need a Mastodon development server running on `http://localhost:3000`, with the default `admin` user and default password. | 26 | If you want to add or change tests, you will need a Mastodon development server running on `http://localhost:3000`. |
27 | To set this up, follow the development guide and set up the database using "rails db:setup". | 27 | To set this up, follow the development guide at https://docs.joinmastodon.org/dev/setup/ . |
28 | 28 | ||
29 | It also needs various things to be set up for it. The following command should do the trick: | 29 | It also needs various things to be set up for it. The following command will do the trick: |
30 | 30 | ||
31 | sudo redis-cli flushall && sleep 3 && \ | 31 | sudo redis-cli flushall && sleep 3 && \ |
32 | sudo /etc/init.d/redis-server restart && \ | 32 | sudo /etc/init.d/redis-server restart && \ |
@@ -39,7 +39,8 @@ It also needs various things to be set up for it. The following command should d | |||
39 | 39 | ||
40 | You _may_ additionally have to set up a database password and pass it as DB_PASS for the streaming tests to function. | 40 | You _may_ additionally have to set up a database password and pass it as DB_PASS for the streaming tests to function. |
41 | 41 | ||
42 | Tests that send requests to Mastodon should be marked as needing VCR with the `pytest.mark.vcr` decorator. | 42 | Tests that send requests to Mastodon should be marked as needing VCR with the `pytest.mark.vcr` decorator. Streaming tests use a |
43 | heavily monkeypatched version of VCR.py to work and may behave in weird ways sometimes. | ||
43 | 44 | ||
44 | ```python | 45 | ```python |
45 | import pytest | 46 | import pytest |