add more unit tests

.devcontainer/devcontainer.json

@@ -5,18 +5,19 @@
     "dockerfile": "Dockerfile"
   },
   "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
     "ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {
       "plugins": "git zsh-syntax-highlighting zsh-autosuggestions poetry poetry-env gpg-agent",
       "omzPlugins": "https://github.com/zsh-users/zsh-syntax-highlighting https://github.com/zsh-users/zsh-autosuggestions"
     },
+    "ghcr.io/stuartleeks/dev-container-features/shell-history:0": {},
     "ghcr.io/devcontainers/features/github-cli:1": {}
   },
   "containerEnv": {
     "LOGURU_LEVEL": "DEBUG",
     "GH_TOKEN": "${localEnv:GH_TOKEN}"
   },
   "mounts": [
-    "source=${localWorkspaceFolder}/.zsh_history,target=/home/poetry/.zsh_history,type=bind,consistency=cached",
     "source=${localWorkspaceFolder}/config.yml,target=/config/config.yml,type=bind,consistency=cached"
   ],
   "postCreateCommand": "zsh .devcontainer/postCreateCommand.sh",
@@ -63,7 +64,7 @@
             "unittestEnabled": false,
             "pytestEnabled": true,
             "pytestArgs": [
-              "test"
+              "tests"
             ]
           }
         },

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: sunday
+
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+      day: sunday

.github/workflows/build-test-lint.yaml

@@ -1,6 +1,13 @@
 name: Python package
 
-on: [push]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - feat/**
+      - main
 
 jobs:
   build:
@@ -45,7 +52,7 @@ jobs:
       #----------------------------------------------
       - name: Test with pytest
         run: |
-          pytest --cov=src --cov-report=xml
+          pytest --cov-branch --cov=src --cov-report=xml tests
 
       #----------------------------------------------
       #              lint and formatting

.gitignore

@@ -1,10 +1,5 @@
-
-.zsh_history
 config.yml
 
-# Ignore dynaconf secret files
-.secrets.*
-
 # Created by https://www.toptal.com/developers/gitignore/api/macos,linux,python,pycharm+all,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=macos,linux,python,pycharm+all,visualstudiocode
 

README.md

@@ -85,6 +85,8 @@ There is a [devcontainer](https://containers.dev/) provided; it is optional but
 
 ####
 
+You will need to create `config.yml` in the root of the repo, to mount your config within the devcontainer
+
 ```shell
 $ poetry install
 

pyproject.toml

@@ -24,6 +24,9 @@ ruff = "^0.4.4"
 [tool.poetry.group.test.dependencies]
 pytest = "^8.2.0"
 pytest-cov = "^5.0.0"
+pytest-mock = "^3.14.0"
+mock = "^5.1.0"
+pytest-loguru = "^0.4.0"
 
 [build-system]
 requires = ["poetry-core"]
@@ -32,13 +35,13 @@ build-backend = "poetry.core.masonry.api"
 [tool.pytest.ini_options]
 pythonpath = [
     "./src",
-    "./src/config",
     "./src/models"
 ]
 testpaths = [
-    "./test",
-    "./test/models"
+    "./tests",
+    "./tests/models"
 ]
 addopts = [
     "--import-mode=importlib",
 ]
+mock_use_standalone_module = "True"

src/main.py

@@ -3,91 +3,89 @@
 from time import sleep
 
 import schedule
-from config.schema import CONFIG_SCHEMA
+from config_schema import CONFIG_SCHEMA
 from existing_renamer import ExistingRenamer
 from loguru import logger
 from pycliarr.api import CliServerError
 from pyconfigparser import ConfigError, ConfigFileNotFoundError, configparser
 from series_scanner import SeriesScanner
 
 
-def series_scanner_job(sonarr_config):
-    try:
-        SeriesScanner(
-            name=sonarr_config.name,
-            url=sonarr_config.url,
-            api_key=sonarr_config.api_key,
-            hours_before_air=sonarr_config.series_scanner.hours_before_air,
-        ).scan()
-    except CliServerError as exc:
-        logger.error(exc)
-
-
-def schedule_series_scanner(sonarr_config):
-    series_scanner_job(sonarr_config)
-
-    if sonarr_config.series_scanner.hourly_job:
-        # Add a random delay of +-5 minutes between jobs
-        schedule.every(55).to(65).minutes.do(
-            series_scanner_job, sonarr_config=sonarr_config
+class Main:
+    def __init__(self):
+        logger_format = (
+            "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | "
+            "<level>{level}</level> | "
+            "<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> | "
+            "{extra[instance]} | "
+            "{extra[series]} | "
+            "<level>{message}</level>"
         )
-
-
-def existing_renamer_job(sonarr_config):
-    try:
-        ExistingRenamer(
-            name=sonarr_config.name,
-            url=sonarr_config.url,
-            api_key=sonarr_config.api_key,
-        ).scan()
-    except CliServerError as exc:
-        logger.error(exc)
-
-
-def schedule_existing_renamer(sonarr_config):
-    existing_renamer_job(sonarr_config)
-
-    if sonarr_config.existing_renamer.hourly_job:
-        # Add a random delay of +-5 minutes between jobs
-        schedule.every(55).to(65).minutes.do(
-            existing_renamer_job, sonarr_config=sonarr_config
-        )
-
-
-def loguru_config():
-    logger_format = (
-        "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | "
-        "<level>{level}</level> | "
-        "<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> | "
-        "{extra[instance]} | "
-        "{extra[series]} | "
-        "<level>{message}</level>"
-    )
-    logger.configure(extra={"instance": "", "series": ""})  # Default values
-    logger.remove()
-    logger.add(stdout, format=logger_format)
+        logger.configure(extra={"instance": "", "series": ""})  # Default values
+        logger.remove()
+        logger.add(stdout, format=logger_format)
+
+    def __series_scanner_job(self, sonarr_config):
+        try:
+            SeriesScanner(
+                name=sonarr_config.name,
+                url=sonarr_config.url,
+                api_key=sonarr_config.api_key,
+                hours_before_air=sonarr_config.series_scanner.hours_before_air,
+            ).scan()
+        except CliServerError as exc:
+            logger.error(exc)
+
+    def __schedule_series_scanner(self, sonarr_config):
+        self.__series_scanner_job(sonarr_config)
+
+        if sonarr_config.series_scanner.hourly_job:
+            # Add a random delay of +-5 minutes between jobs
+            schedule.every(55).to(65).minutes.do(
+                self.__series_scanner_job, sonarr_config=sonarr_config
+            )
+
+    def __existing_renamer_job(self, sonarr_config):
+        try:
+            ExistingRenamer(
+                name=sonarr_config.name,
+                url=sonarr_config.url,
+                api_key=sonarr_config.api_key,
+            ).scan()
+        except CliServerError as exc:
+            logger.error(exc)
+
+    def __schedule_existing_renamer(self, sonarr_config):
+        self.__existing_renamer_job(sonarr_config)
+
+        if sonarr_config.existing_renamer.hourly_job:
+            # Add a random delay of +-5 minutes between jobs
+            schedule.every(55).to(65).minutes.do(
+                self.__existing_renamer_job, sonarr_config=sonarr_config
+            )
+
+    def start(self) -> None:
+        try:
+            config = configparser.get_config(
+                CONFIG_SCHEMA,
+                config_dir=path.relpath("/config"),
+                file_name="config.yml",
+            )
+        except (ConfigError, ConfigFileNotFoundError) as exc:
+            logger.error(exc)
+            exit(1)
+
+        for sonarr_config in config.sonarr:
+            if sonarr_config.series_scanner.enabled:
+                self.__schedule_series_scanner(sonarr_config)
+            if sonarr_config.existing_renamer.enabled:
+                self.__schedule_existing_renamer(sonarr_config)
+
+        if schedule.get_jobs():
+            while True:
+                schedule.run_pending()
+                sleep(1)
 
 
 if __name__ == "__main__":
-    loguru_config()
-
-    try:
-        config = configparser.get_config(
-            CONFIG_SCHEMA,
-            config_dir=path.relpath("/config"),
-            file_name="config.yml",
-        )
-    except (ConfigError, ConfigFileNotFoundError) as exc:
-        logger.error(exc)
-        exit(1)
-
-    for sonarr_config in config.sonarr:
-        if sonarr_config.series_scanner.enabled:
-            schedule_series_scanner(sonarr_config)
-        if sonarr_config.existing_renamer.enabled:
-            schedule_existing_renamer(sonarr_config)
-
-    if schedule.get_jobs():
-        while True:
-            schedule.run_pending()
-            sleep(1)
+    Main().start()