Running tests

FreshRSS is tested with PHPUnit. No code should be merged in edge if the tests don’t pass.

Locally

As a developer, you can run the test suite on your PC easily with make commands. You can run the test suite with:

make test

This command downloads the PHPUnit binary and verifies its checksum. If the verification fails, the file is deleted. In this case, you should open an issue on GitHub to let maintainers know about the problem.

Then, it executes PHPUnit in a Docker container. If you don’t use Docker, you can run the command directly with:

NO_DOCKER=true make test

The linter can be run with a make command as well:

make lint # to execute the linter on the PHP files
make lint-fix # or, to fix the errors detected by the linter

Similarly to PHPUnit, it downloads a PHP_CodeSniffer binary (i.e. phpcs or phpcbf depending on the command) and verifies its checksum.

GitHub Actions for Continuous Integration

Tests are automatically run when you open a pull request on GitHub. They are performed with GitHub Actions. This ensures your code will not introduce some kind of regression. We will not merge a PR if tests fail so we will ask you to fix any bugs before reviewing your code.

If you are interested, you can take a look at the configuration file.

Using feed snapshots

As feed data is volatile, it’s better to work with snapshots when debugging some issues. You can find the description to retrieve a snapshot here.

To serve those snapshots, you can use a mock server. Here we will demonstrate how to work with WireMock but other solutions exist. Here are the steps to start using the WireMock mock server:

Go to the mock server home folder. If you do not have one, you need to create one.
Inside the mock server home folder, create the __file and mappings folders.
Copy or move your snapshots in the __file folder.

Create the feed.json file in the mappings folder with the following content:

 {
     "request": {
         "method": "GET",
         "urlPathPattern": "/.*"
     },
     "response": {
         "status": 200,
         "bodyFileName": "",
         "transformers": ["response-template"],
         "headers": {
             "Content-Type": "application/rss+xml"
         }
     }
 }

Launch the containerized server with the following command:

 # <PORT> is the port used on the host to communicate with the server
 # <NETWORK> is the name of the docker network used (by default, it’s freshrss-network)
 docker run -it --rm -p <PORT>:8080 --name wiremock --network <NETWORK> -v $PWD:/home/wiremock wiremock/wiremock:latest-alpine --local-response-templating

You can access the <RSS> mock file directly:
- from the host by sending a GET request to http://localhost:<PORT>/<RSS>,
- from any container connected on the same network by sending a GET request to http://wiremock:8080/<RSS>.

FreshRSS

Documentation center

Running tests

Locally

GitHub Actions for Continuous Integration

Using feed snapshots