test

Reviewed-on: https://git.jbranan.com/jblu/qbit-maid/pulls/54

.dockerignore

@@ -3,7 +3,6 @@ LICENSE
 *.log
 README.md
 requirements.txt
-test_*
 Dockerfile
 *docker-test*
 *.log
@@ -11,6 +10,12 @@ Dockerfile
 *.csv
 *.toml
 *.git*
+.dockerignore
+.DS_Store
+.vscode/*
+thunder-tests/*
+.drone.yml
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.drone.yml

@@ -0,0 +1,59 @@
+kind: pipeline
+name: default
+steps:
+- name: docker
+  image: plugins/docker
+  settings:
+    registry: git.jonb.io
+    dry_run: false
+    username: jblu
+    password: 
+      from_secret: gittea_drone
+    repo: git.jonb.io/jblu/qbit-maid
+    tags:
+    - latest
+  when:
+    branch:
+      - main
+    event:
+      - push
+      - pull_request
+- name: docker-test
+  image: plugins/docker
+  settings:
+    registry: git.jonb.io
+    dry_run: false
+    username: jblu
+    password: 
+      from_secret: gittea_drone
+    repo: git.jonb.io/jblu/qbit-maid
+    tags:
+    - dev
+  when:
+    branch:
+      - dev*
+    event:
+      - push
+      - pull_request
+- name: test-main
+  image: git.jonb.io/jblu/qbit-maid:latest
+  commands:
+  - python test_qbitmaid.py
+  - python test_dragnet.py
+  when:
+    branch:
+      - main
+    event:
+      - push
+      - pull_request
+- name: test-dev
+  image: git.jonb.io/jblu/qbit-maid:dev
+  commands:
+  - python test_qbitmaid.py
+  - python test_dragnet.py
+  when:
+    branch:
+      - dev*
+    event:
+      - push
+      - pull_request

Dockerfile

@@ -1,8 +1,8 @@
 FROM python:alpine3.18
 WORKDIR /
 COPY . opt
+RUN apk add --no-cache supercronic
 RUN pip install requests
 RUN pip install qbittorrent-api
-RUN crontab /opt/crontab
 RUN chmod +x /opt/entrypoint.sh
 CMD ["/opt/entrypoint.sh"]

README.md

@@ -1,6 +1,8 @@
-# qbit-maid
 
-## Warning: This application removes torrents that are over the minimum age and that are not part of the ignored categories, domains or tags. Please use the delete_torrents feature set to false when first testing its functionality.
+# qbit-maid
+> Warning: This application removes torrents that are over the minimum age and that are not part of the ignored categories, domains or tags. Please use the delete_torrents feature set to false when first testing its functionality.
+
+![](https://drone.jbranan.com/api/badges/jblu/phc/status.svg)
 
 The objective is to remove torrents based on the following criteria:
 - tracker domain name
@@ -8,94 +10,88 @@ The objective is to remove torrents based on the following criteria:
 - ratio
 - state
 
-```mermaid
-graph TD;
-    qbit-maid.py-->qlogging.py;
-    qbit-maid.py-->qlist.py;
-    qbit-maid.py-->qprocess.py;
-    qlogging.py-->qbit-maid.py;
-    qlist.py-->qbit-maid.py;
-    qprocess.py-->qbit-maid.py;
-```
+## Install
+### Docker(Recommended)
 
-| File | Purpose |
-| --- | --- |
-| qbit-maid.py | Client to the qbit api and calls functions from the other files |
-| qlist.py | Builds out torrent lists |
-| qlogging.py | Logging and push notification communication |
-| qprocess.py | Submits qualifying torrents for deletion |
-| test_qbitmaid.py | Unit tests |
-| ignored_categories.json | whitelist for categorys to ignore |
-| ignored_tags.json | whitelist for torrent tags to ignore |
-| ignored_trackers.json | whitelist of fqdn names to ignore |
+[package ](https://git.jbranan.com/jblu/-/packages/container/qbit-maid/latest)
 
-You will need a config.json in the root directory.
+    docker pull git.jbranan.com/jblu/qbit-maid:latest
 
-| Key | Value |
-| --- | --- |
-| host | string, ip or hostname of qbittorrent server |
-| port | number, port of admin gui(used for api aswell) |
-| username | admin account for qbittorrent |
-| password | password for admin account |
-| log_level | is what log messages are written to the log file. INFO or DEBUG are valid entries(case sensitive) |
-| protected_tag | used to mark torrents to handle with care |
-| non_protected_tag | we don't care about these torrents |
-| log_path | will write a log in root directory if left as is other wise specify other path using forward slashes |
-| age | number, seconds for how long we keep torrents from IPTORRENTS |
-| minimum_age | age in seconds torrents should reached before they are removed |
-| use_pushover | true or false to enable or disable pushover notification summary |
-| use_log | true or false to enable or disable writing to alog file |
-| po_key | pushover key |
-| po_token | pushover api token |
-| delete_torrents | true or false to enable or disable deletion. Useful for dry-runs |
-| enable_dragnet | true or false to enable dragnet functionality. Useful for debugging |
+#### Docker Run Command:
 
-It should look something like this:
-Config.json
-```
-{
-    "host": "192.168.1.1",
-    "port": 8080,
-    "username": "admin",
-    "password": "admin",
-    "loglevel": "INFO",
-    "logpath": "./qc.log",
-    "protected_tag": "ipt",
-    "non_protected_tag": "public",
-    "age": 2419200,
-    "minimum_age": 432000,
-    "use_pushover": false,
-    "use_log": true,
-    "po_key": "",
-    "po_token": "",
-    "delete_torrents": false
-    "enable_dragnet": false,
-    "dragnet_outfile": "./orphaned.csv"
-}
-```
+> Please note it is best practice to escape spaces in variables. That is why there is backslashes in the cron schedule.
 
-You will need a ignored_categories.json in the root directory. This will ignore any of the categories found in the values of the entries.
-```
-{
-    "example": "general",
-    "example2": "sonarr"
-}
-```
+    docker run --name qbit-maid -v /opt/qbit-maid:/config/ -e CRON=0\ 1\ *\ *\ * -e toml_path=/config/config.toml git.jbranan.com/jblu/qbit-maid
 
-You will need a ignored_domains.json in the root directory. This will ignore any torrents from these trackers.
-```
-{
-"iptorrents-empirehost": "ssl.empirehost.me",
-"iptorrents-stackoverflow": "localhost.stackoverflow.tech",
-"iptorrents-bgp": "routing.bgp.technology"
-}
-```
+#### Docker Compose
 
-You will need a ignored_tags.json in the root directory. This will ignore any torrents with these tags.
 ```
-{
-"first":"first",
-"second":"second",
-"third":"third"
-}
+version: '3.3'
+services:
+    qbit-maid:
+        image: git.jbranan.com/jblu/qbit-maid
+        container_name: qbit-maid
+        volumes:
+            - /opt/qbit-maid:/config
+        environment:
+            - CRON="0 1 * * *"
+            - toml_path=/config/config.toml
+```
+### Via Git
+    git clone https://git.jbranan.com/jblu/qbit-maid.git
+
+Qbit-maid will look for an environment variable *toml_path* for its configuration.If it doesn't find it, it will look for a config.toml file in it's own directory.
+##### config.toml
+```
+[qbittorrent]
+host = "192.168.x.x"
+port = 8080
+username = "user"
+password = "pass"
+
+[logging]
+use_log = true
+log_level = "INFO"
+log_path = "./qc.log"
+
+[app_tags]
+protected_tag = "ipt"
+non_protected_tag = "public"
+
+[torrent]
+age = 2419200
+minimum_age = 432000
+delete_torrents = false
+
+[pushover]
+use_pushover = false
+po_key = "<key>>"
+po_token = "<token>>"
+
+[apprise]
+use_apprise = false
+host = "192.168.x.x"
+port = 8088
+aurls = 'mailto://user:pass@gmail.com'
+
+[dragnet]
+enable_dragnet = false
+dragnet_outfile = "./orphaned.csv"
+
+[ignored_categories]
+tech = "tech"
+books = "books"
+general = "general"
+
+[ignored_domains]
+iptorrents-empirehost = "ssl.empirehost.me"
+iptorrents-stackoverflow = "localhost.stackoverflow.tech"
+iptorrents-bgp = "routing.bgp.technology"
+
+[ignored_tags]
+save = "save"
+
+[healthcheck]
+use_healthcheck = false
+healthcheck_url = "https://example.com/ping/<uuid>>"
 ```

config.toml.example

@@ -1,12 +1,12 @@
 [qbittorrent]
-host = "192.168.4.11"
-port = 8085
-username = "jman"
-password = "nO^touchy@"
+host = "192.168.x.x"
+port = 8080
+username = "user"
+password = "pass"
 
 [logging]
 use_log = true
-log_level = "DEBUG"
+log_level = "INFO"
 log_path = "./qc.log"
 
 [app_tags]
@@ -16,20 +16,21 @@ non_protected_tag = "public"
 [torrent]
 age = 2419200
 minimum_age = 432000
-delete_torrents = true
+delete_torrents = false
 
 [pushover]
 use_pushover = false
-po_key = ""
-po_token = ""
+po_key = "<key>>"
+po_token = "<token>>"
 
 [apprise]
+use_apprise = false
 host = "192.168.x.x"
 port = 8088
 aurls = 'mailto://user:pass@gmail.com'
 
 [dragnet]
-enable_dragnet = true
+enable_dragnet = false
 dragnet_outfile = "./orphaned.csv"
 
 [ignored_categories]
@@ -43,6 +44,8 @@ iptorrents-stackoverflow = "localhost.stackoverflow.tech"
 iptorrents-bgp = "routing.bgp.technology"
 
 [ignored_tags]
-first = "first"
-second = "second"
-third = "third"
+save = "save"
+
+[healthcheck]
+use_healthcheck = true
+healthcheck_url = "https://example.com/ping/<uuid>>"

crontab

@@ -1 +0,0 @@
-0 1 * * * . /etc/environment; python /opt/qbit-maid.py >> /logfile

entrypoint.sh

@@ -1,5 +1,7 @@
 #!/bin/sh
 
-printenv | grep -v "no_proxy" >> /etc/environment
+CRON_CONFIG_FILE="/opt/crontab"
 
-crond -f
+echo "${CRON} python /opt/qbit-maid.py" > $CRON_CONFIG_FILE
+
+exec supercronic -passthrough-logs -quiet $CRON_CONFIG_FILE

qbit-maid.py

@@ -12,16 +12,18 @@ from collections import Counter
 import csv
 import requests as r
 import os
-import sys
+r.packages.urllib3.disable_warnings()
+
 class Qbt:
     def __init__(self):
         """Main object, should be calling functions from qlist.py, qlogging.py and qprocess.py"""
         # Open the config. Needs a json file with the data in config.json.example
         self.st = datetime.datetime.now()
         
-        config_file_path=os.environ["toml_path"]
-        with open(config_file_path, 'rb') as c:
-            self.config = load(c)
+        if os.getenv("toml_path"):
+            config_file_path=os.getenv("toml_path")
+            with open(config_file_path, 'rb') as c:
+                self.config = load(c)
         if os.path.exists('./config.toml'):
             config_file_path = './config.toml'
             with open(config_file_path, 'rb') as c:
@@ -80,6 +82,10 @@ class Qbt:
         #ignored_tags
         self.ignored_tags = self.config["ignored_domains"]
 
+        #healthcheck
+        self.use_healthcheck = self.config["healthcheck"]["use_healthcheck"]
+        self.healthcheck_url = self.config["healthcheck"]["healthcheck_url"]
+
         # Calling log and notify functions
         tor_log(self)
         tor_notify(self)
@@ -121,6 +127,8 @@ class Qbt:
             tor_notify_summary(self)
         if self.use_apprise:
             tor_notify_apprise(self, r, apprise_notify)
+        if self.use_healthcheck:
+            send_ping(self, r, self.healthcheck_url)
 # Run
 if  __name__== "__main__":
     Qbt()

qlogging.py

@@ -84,4 +84,10 @@ def get_script_runtime(self):
     if self.use_pushover:
         self.extm = f"Execution time: [{elapsed_time}]"
     if self.use_apprise:
-        self.extm = f"Execution time: [{elapsed_time}]"
+        self.extm = f"Execution time: [{elapsed_time}]"
+
+def send_ping(self, req_obj, healthcheck_url):
+    try:
+        req_obj.get(healthcheck_url, timeout=10)
+    except req_obj.RequestException as e:
+        self.tl.info(f"Ping failed: {e}")

test_qbitmaid.py

@@ -15,7 +15,7 @@ class TestQbitmaid(unittest.TestCase):
         self.assertTrue(is_cat_ignored('b', ['a','b','c']))
         self.assertTrue(is_cat_ignored('c', ['a','b','c']))
         self.assertFalse(is_cat_ignored('d', ['a','b','c']))
-        self.assertFalse(is_cat_ignored(1, ['a','b','c']))
+        self.assertFalse(is_cat_ignored(1, ['a','b','d']))
         self.assertFalse(is_cat_ignored(1.0000000, ['a','b','c']))
 
     def test_iscatignored(self):