chatterino2
Code Issues

docs: update linux & test docs (#5864)

Browse Source
This commit is contained in:
pajlada
2025-01-28 18:39:40 +01:00
committed by GitHub
parent bbdbb84e3e
commit 6f3cf28477
2 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
BUILDING_ON_LINUX.md
+2
View File
@@ -26,6 +26,8 @@ sudo apt install qt6-base-dev qt6-5compat-dev qt6-svg-dev qt6-image-formats-plug
sudo pacman -S --needed qt6-base qt6-tools boost-libs openssl qt6-imageformats qt6-5compat qt6-svg boost rapidjson pkgconf openssl cmake
```
If you use Wayland, you will also need to ensure `qt6-wayland` is installed.
Alternatively you can use the [chatterino2-git](https://aur.archlinux.org/packages/chatterino2-git/) package to build and install Chatterino for you.
### Fedora 39 and above
tests/README.md
+19 -1
View File
@@ -1,7 +1,25 @@
To run tests, you'll first need to enable the test flag in cmake. You can do this by adding the `-DBUILD_TESTS=On` flag to your cmake setup call. (e.g. `mkdir build && cd build && cmake -DBUILD_TESTS=On ..`)
After you've built Chatterino, you can now run the tests with `ctest` or by manually running the newly created `chatterino-test` executable
# Pre-requisites to running tests
- Download & run [httpbox](https://github.com/Chatterino/httpbox/releases/latest)
We expect this to be listening to port 9051, you can launch it like this:
`httpbox --port 9051`
- Download & run [twitch-pubsub-server-test](https://github.com/Chatterino/twitch-pubsub-server-test/releases/latest)
`twitch-pubsub-server-test`
We expect this to be listening to port 9050, you can launch it like this:
`twitch-pubsub-server-test 127.0.0.1:9050`
# Modifying message building
If you make a change that has to do with message building, there's a big chance that some of the snapshot tests will fail.
If this happens, you might want to:
1. Set the `UPDATE_SNAPSHOTS` boolean at the top of the [IrcMessageHandler.cpp](./src/IrcMessageHandler.cpp) test file to `true`
1. Re-run the tests (this will update the snapshots to match your new reality)
1. Reset `UPDATE_SNAPSHOTS` to `false` again
1. Then run the tests a final time.
Once this is done, you should take a look at the changes made to the snapshot json files to ensure that it looks correct.