Compare commits

..

2 Commits
v2.1.0 ... main

Author SHA1 Message Date
d15cc8d95c updated healthchecks to support starting and stopping a job
All checks were successful
continuous-integration/drone/push Build is passing
2024-06-03 20:32:57 -05:00
708d56fc98 Updated documentation
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-05 08:24:28 -05:00
6 changed files with 120 additions and 106 deletions

View File

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

View File

@ -2,7 +2,7 @@
# qbit-maid # 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. > 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) [![Build Status](https://drone.jonb.io/api/badges/jblu/qbit-maid/status.svg?ref=refs/heads/main)](https://drone.jonb.io/jblu/qbit-maid)
The objective is to remove torrents based on the following criteria: The objective is to remove torrents based on the following criteria:
- tracker domain name - tracker domain name
@ -13,15 +13,15 @@ The objective is to remove torrents based on the following criteria:
## Install ## Install
### Docker(Recommended) ### Docker(Recommended)
[package ](https://git.jbranan.com/jblu/-/packages/container/qbit-maid/latest) [package](https://git.jonb.io/jblu/-/packages/container/qbit-maid/latest)
docker pull git.jbranan.com/jblu/qbit-maid:latest docker pull git.jonb.io/jblu/qbit-maid:latest
#### Docker Run Command: #### Docker Run Command:
> Please note it is best practice to escape spaces in variables. That is why there is backslashes in the cron schedule. > Please note it is best practice to escape spaces in variables. That is why there is backslashes in the cron schedule.
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 docker run --name qbit-maid -v /opt/qbit-maid:/config/ -e CRON=0\ 1\ *\ *\ * -e toml_path=/config/config.toml git.jonb.io/jblu/qbit-maid
#### Docker Compose #### Docker Compose
@ -29,7 +29,7 @@ The objective is to remove torrents based on the following criteria:
version: '3.3' version: '3.3'
services: services:
qbit-maid: qbit-maid:
image: git.jbranan.com/jblu/qbit-maid image: git.jonb.io/jblu/qbit-maid
container_name: qbit-maid container_name: qbit-maid
volumes: volumes:
- /opt/qbit-maid:/config - /opt/qbit-maid:/config
@ -38,7 +38,7 @@ services:
- toml_path=/config/config.toml - toml_path=/config/config.toml
``` ```
### Via Git ### Via Git
git clone https://git.jbranan.com/jblu/qbit-maid.git git clone https://git.jonb.io/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. 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 ##### config.toml

View File

@ -94,6 +94,11 @@ class Qbt:
tor_log(self) tor_log(self)
tor_notify(self) tor_notify(self)
self.t = time self.t = time
#start healthcheck job
if self.use_healthcheck:
send_ping(self, r, self.healthcheck_url.rstrip("/") + "/start" )
# Pulling domain names to treat carefully # Pulling domain names to treat carefully
self.tracker_list = [] self.tracker_list = []
self.up_tor_counter = 0 self.up_tor_counter = 0

View File

@ -88,7 +88,7 @@ def get_script_runtime(self):
def send_ping(self, req_obj, healthcheck_url): def send_ping(self, req_obj, healthcheck_url):
try: try:
req_obj.get(healthcheck_url, timeout=10) req_obj.get(healthcheck_url, timeout=5)
except req_obj.RequestException as e: except req_obj.RequestException as e:
self.tl.info(f"Ping failed: {e}") self.tl.info(f"Ping failed: {e}")

View File

@ -1,6 +1,8 @@
import unittest import unittest
import requests as r
from qlist import is_preme,is_cat_ignored,is_tracker_blank,is_protected_tracker,is_not_protected_tracker,is_tag_blank,is_ignored_tag from qlist import is_preme,is_cat_ignored,is_tracker_blank,is_protected_tracker,is_not_protected_tracker,is_tag_blank,is_ignored_tag
from qprocess import is_downloading,is_protected_under_ratio,is_old_tor,is_protected_over_ratio,is_not_protected_tor from qprocess import is_downloading,is_protected_under_ratio,is_old_tor,is_protected_over_ratio,is_not_protected_tor
from qlogging import send_ping
class TestQbitmaid(unittest.TestCase): class TestQbitmaid(unittest.TestCase):
def test_ispreme_sanity(self): def test_ispreme_sanity(self):
@ -94,6 +96,17 @@ class TestQbitmaid(unittest.TestCase):
def test_isignoredtag(self): def test_isignoredtag(self):
self.assertTrue(is_ignored_tag(['save'], 'save,public,ipt')) self.assertTrue(is_ignored_tag(['save'], 'save,public,ipt'))
def test_sendpingstart_sanity(self):
send_ping(self, r, "https://thunder.jonb.io/ping/921625e5-5b76-4f45-a0c3-56145e16f3bb" + "/start")
url = "https://thunder.jonb.io/ping/921625e5-5b76-4f45-a0c3-56145e16f3bb"
send_ping(self, r, url)
def test_sendping_start(self):
url = "https://thunder.jonb.io/ping/921625e5-5b76-4f45-a0c3-56145e16f3bb/"
send_ping(self, r, url.strip("/") + "/start")
send_ping(self, r, "https://thunder.jonb.io/ping/921625e5-5b76-4f45-a0c3-56145e16f3bb")
# def test__sanity(self): # def test__sanity(self):
# pass # pass

View File

@ -1,41 +1,41 @@
from qprocess import write_csv from qprocess import write_csv
import csv import csv
import unittest import unittest
import os import os
# Torrent Items needed for testing # Torrent Items needed for testing
# canidate['state'] {canidate["ratio"]} {torrent["tags"]} torrent["seeding_time"] {torrent["category"]} {torrent["name"][0:20]} {canidate["time_active"]} # canidate['state'] {canidate["ratio"]} {torrent["tags"]} torrent["seeding_time"] {torrent["category"]} {torrent["name"][0:20]} {canidate["time_active"]}
class TestWriteCSV(unittest.TestCase): class TestWriteCSV(unittest.TestCase):
def test_write_csv_dragnet(self): def test_write_csv_dragnet(self):
self.cv = csv self.cv = csv
outfile = './test_dragnet_outfile.csv' outfile = './test_dragnet_outfile.csv'
state = 'downloading' state = 'downloading'
ratio = 1.05 ratio = 1.05
tags = 'ipt' tags = 'ipt'
added = 1 added = 1
age = 240000 age = 240000
time = 123456 time = 123456
thash = 'asfasdf23412adfqwer' thash = 'asfasdf23412adfqwer'
tname = 'thisismynamehahahah' tname = 'thisismynamehahahah'
trname = 'https://localhost.stackoverflow.tech/317332f1c125bc9c1b9b14fb8e054908/announce' trname = 'https://localhost.stackoverflow.tech/317332f1c125bc9c1b9b14fb8e054908/announce'
header = ['state','ratio','tags','added','age','time','thash','tname','trname'] header = ['state','ratio','tags','added','age','time','thash','tname','trname']
row = [state,ratio,tags,added,age,time,thash,tname,trname] row = [state,ratio,tags,added,age,time,thash,tname,trname]
write_csv(self.cv,outfile,header,row) write_csv(self.cv,outfile,header,row)
self.assertTrue(os.path.exists(outfile)) self.assertTrue(os.path.exists(outfile))
def test_write_csv_telemetry(self): def test_write_csv_telemetry(self):
self.cv = csv self.cv = csv
outfile = './test_telemetry_outfile.csv' outfile = './test_telemetry_outfile.csv'
state = 'downloading' state = 'downloading'
ratio = 1.05 ratio = 1.05
tags = 'ipt' tags = 'ipt'
added = 1 added = 1
thash = 'asfasdf23412adfqwer' thash = 'asfasdf23412adfqwer'
tname = 'thisismynamehahahah' tname = 'thisismynamehahahah'
trname = 'https://localhost.stackoverflow.tech/317332f1c125bc9c1b9b14fb8e054908/announce' trname = 'https://localhost.stackoverflow.tech/317332f1c125bc9c1b9b14fb8e054908/announce'
header = ['state','ratio','tags','added','hash','name','tracker'] header = ['state','ratio','tags','added','hash','name','tracker']
row = [state,ratio,tags,added,thash,tname,trname] row = [state,ratio,tags,added,thash,tname,trname]
write_csv(self.cv,outfile,header,row) write_csv(self.cv,outfile,header,row)
self.assertTrue(os.path.exists(outfile)) self.assertTrue(os.path.exists(outfile))
if __name__ == '__main__': if __name__ == '__main__':
unittest.main() unittest.main()