Script converting AdBlock Plus rules into privoxy format.
The script privoxy-blocklist.sh downloads AdBlock Plus filter files and generates privoxy compatible filter and action files based on these.
After the generation is done it modifies the privoxy configuration files /etc/privoxy/config to import the generated files.
Due to this behaviour the script must run as root user to be able to modify the privoxy configuration file.
Either run privoxy-blocklist.sh manually with root privileges (e.g., sudo privoxy-blocklist.sh) or via root cronjob.
The release process is automated via github action Release and triggered by pushing a tag to the main branch.
The following tags are recognized:
| Tag-Schema | Result |
|---|---|
[0-9]+.[0-9]+.[0-9]+ |
create public release e.g., 0.4.0 |
[0-9]+.[0-9]+.[0-9]+-a |
create private alpha release e.g., 0.4.0-a (only visible to collaborators) |
[0-9]+.[0-9]+.[0-9]+-rc |
create public release candidate e.g., 0.4.0-rc (pre-release) |
Code changes must be tested to ensure that all functionality is working as intended. For that a pytest based test suite is maintained and runs on every pull request within Gitlab Actions.
The test suite is designed to run within a docker container based on the definition of this repository. It is currently only tested on Ubuntu Linux but should work on every system with a POSIX compliant shell and docker.
To start all tests of the test suite just run:
./tests/run.sh
To start a single test file you can run:
./tests/run.sh tests/test_….py
To start all tests on ubuntu:
./tests/run.sh -o ubuntu
The whole process simplified by ./tests/run.sh runs the following:
- build docker image based on project Dockerfile
- start container based on created image with git repository mounted to
/appand persistent volume for pytest-cache mounted to/pytest_cache
Within the container all pytest magic happens and all scripts matching test_*.py within tests/ are executed.
- Badge Generator for providing easy method to generate badges/shields