Tracker Checker: console command to run tracker checks

[josecelano]

Parent issue: #620

Console command that runs some checks against live running trackers. It would be used for:

• E2E testing.
• Smoke tests after deploying the live demo.

It can be run with the following alternatives:

cargo run --bin tracker_checker -- --config-path "./share/default/config/tracker_checker.json"

TORRUST_CHECKER_CONFIG_PATH="./share/default/config/tracker_checker.json" cargo run --bin tracker_checker

TORRUST_CHECKER_CONFIG=$(cat "./share/default/config/tracker_checker.json") cargo run --bin tracker_checker

And you can pass a list of services to check in the configuration:

{
    "udp_trackers": [
        "127.0.0.1:6969"
    ],
    "http_trackers": [
        "http://127.0.0.1:7070"
    ],
    "health_checks": [
        "http://127.0.0.1:1313/health_check"
    ]
}

For UDP and HTTP trackers it will make an announce and scrape requests.

Subtasks

• Tracker Checker: call health check endpoints #638
• Tracker Checker: pass configuration with env var #656
• Tracker Checker: check HTTP trackers #640
• Tracker Checker: check UDP trackers #639

[josecelano]

If you want to check the live demo you can use this configuration:

{
    "udp_trackers": [
        "144.126.245.19:6969"
    ],
    "http_trackers": [
        "https://tracker.torrust-demo.com"
    ],
    "health_checks": [
        "https://tracker.torrust-demo.com/api/health_check"
    ]
}

cargo run --bin tracker_checker -- --config-path "./tracker_checker.json"

NOTICE: the /announce path is not included.

The current output is:

[josecelano]

You can also run it without creating the config file with:

TORRUST_CHECKER_CONFIG='{
    "udp_trackers": ["144.126.245.19:6969"],
    "http_trackers": ["https://tracker.torrust-demo.com"],
    "health_checks": ["https://tracker.torrust-demo.com/api/health_check"]
}' cargo run --bin tracker_checker

[josecelano]

The Tracker Checher does not work with trackers that respond with other fields. For example, this won't work:

TORRUST_CHECKER_CONFIG='{
    "udp_trackers": ["104.21.73.163:80"],
    "http_trackers": ["https://tracker.gbitt.info:443"],
    "health_checks": []
}' cargo run --bin tracker_checker

This is the tracker: https://www.gbitt.info/

Probably the announce and scrape responses have more fields than the one we deserialize.

Running checks for trackers ...
UDP trackers ...
✓ - UDP tracker at udp://104.21.73.163:80 is OK (TODO)
HTTP trackers ...
✗ - Announce at https://tracker.gbitt.info/ is failing
thread 'main' panicked at src/shared/bit_torrent/tracker/http/client/responses/scrape.rs:33:46:
provided bytes should be a valid bencoded response: EndOfStream
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

[josecelano]

You can run the checker for the local env or live demo.

Local dev env

Command:

TORRUST_CHECKER_CONFIG='{
    "udp_trackers": ["127.0.0.1:6969"],
    "http_trackers": ["http://127.0.0.1:7070"],
    "health_checks": ["http://127.0.0.1:1313/health_check"]
}' cargo run --bin tracker_checker

Output:

Running checks for trackers ...
UDP trackers ...
✓ - Announce at 127.0.0.1:6969 is OK
✓ - Announce at 127.0.0.1:6969 is OK
HTTP trackers ...
✓ - Announce at http://127.0.0.1:7070/ is OK
✓ - Scrape at http://127.0.0.1:7070/ is OK
Health checks ...
✓ - Health API at http://127.0.0.1:1313/health_check is OK

Live demo

Command:

TORRUST_CHECKER_CONFIG='{
    "udp_trackers": ["144.126.245.19:6969"],
    "http_trackers": ["https://tracker.torrust-demo.com"],
    "health_checks": ["https://tracker.torrust-demo.com/health_check"]
}' cargo run --bin tracker_checker

Output:

Running checks for trackers ...
UDP trackers ...
✓ - Announce at 144.126.245.19:6969 is OK
✓ - Announce at 144.126.245.19:6969 is OK
HTTP trackers ...
✓ - Announce at https://tracker.torrust-demo.com/ is OK
✓ - Scrape at https://tracker.torrust-demo.com/ is OK
Health checks ...
✓ - Health API at https://tracker.torrust-demo.com/health_check is OK