qbit-rs 0.6.0

A Rust library for interacting with qBittorrent's Web API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

name: Test

on:
  workflow_dispatch:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
  cancel-in-progress: true

env:
  RUST_BACKTRACE: 1
  QBIT_BASEURL: http://127.0.0.1:8080
  QBIT_USERNAME: admin
  QBIT_PASSWORD: adminadmin

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup Rust toolchain
        run: rustup toolchain install nightly --profile minimal

      - name: Cache cargo
        uses: Swatinem/rust-cache@v2

      - name: Start qBittorrent (Docker)
        run: |
          set -euo pipefail

          pbkdf2=$(python3 -c "import base64, hashlib, os; salt = os.urandom(16); digest = hashlib.pbkdf2_hmac('sha512', b'$QBIT_PASSWORD', salt, 100000); print('@ByteArray(' + base64.b64encode(salt).decode() + ':' + base64.b64encode(digest).decode() + ')')")

          mkdir -p /tmp/qbit-config
          {
            printf '%s\n' '[LegalNotice]'
            printf '%s\n' 'Accepted=true'
            printf '%s\n' ''
            printf '%s\n' '[Preferences]'
            printf '%s\n' 'WebUI\Port=8080'
            printf '%s\n' "WebUI\\Username=$QBIT_USERNAME"
            printf '%s\n' "WebUI\\Password_PBKDF2=\"$pbkdf2\""
            printf '%s\n' 'WebUI\LocalHostAuth=true'
            printf '%s\n' 'WebUI\CSRFProtection=false'
            printf '%s\n' 'WebUI\HostHeaderValidation=false'
          } > /tmp/qbit-config/qBittorrent.conf

          docker run -d --name qbit --network host \
            -v /tmp/qbit-config:/root/.config/qBittorrent \
            ubuntu:questing bash -c '
              apt-get update
              apt-get install -y software-properties-common
              add-apt-repository -y ppa:qbittorrent-team/qbittorrent-unstable
              apt-get update
              DEBIAN_FRONTEND=noninteractive apt-get install -y qbittorrent-nox
              exec qbittorrent-nox --webui-port=8080
            '

          echo "Waiting for the WebUI to come up..."
          for _ in $(seq 1 60); do
            code=$(curl -s -o /dev/null -w '%{http_code}' http://127.0.0.1:8080 || true)
            if [ "$code" != "000" ]; then
              echo "qBittorrent is up (HTTP $code)"
              break
            fi
            sleep 1
          done

          if [ "$code" = "000" ]; then
            echo "qBittorrent did not start in time"
            docker logs qbit
            exit 1
          fi

          # Login and rotate the API key to get a known one.
          cookie_jar=$(mktemp)
          curl -fsS -c "$cookie_jar" -X POST http://127.0.0.1:8080/api/v2/auth/login \
            -d "username=$QBIT_USERNAME&password=$QBIT_PASSWORD"

          api_key=$(curl -fsS -b "$cookie_jar" -X POST http://127.0.0.1:8080/api/v2/app/rotateAPIKey \
            | jq -r '.apiKey')

          if [ -n "$api_key" ]; then
            echo "Got API key (length=${#api_key}): ${api_key:0:8}..."
            echo "QBIT_API_KEY=$api_key" >> "$GITHUB_ENV"
          else
            echo "rotateAPIKey returned empty, cannot test API key auth"
          fi

          echo "qBittorrent ready"

      - name: Run tests
        run: |
          printf '%s\n' \
            "QBIT_BASEURL=$QBIT_BASEURL" \
            "QBIT_USERNAME=$QBIT_USERNAME" \
            "QBIT_PASSWORD=$QBIT_PASSWORD" > .env
          if [ -n "${QBIT_API_KEY:-}" ]; then
            echo "QBIT_API_KEY=$QBIT_API_KEY" >> .env
          fi
          cargo +nightly test