updated healthchecks to have a run time

Reviewed-on: https://git.jbranan.com/jblu/crane/pulls/24

.dockerignore

@@ -0,0 +1,177 @@
+*.example
+LICENSE
+*.log
+README.md
+requirements.txt
+Dockerfile
+*docker-test*
+*.log
+*.json
+*.csv
+*.toml
+*.git*
+.DS_Store
+.vscode/*
+thunder-tests/*
+.drone.yml
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.drone.yml

@@ -0,0 +1,77 @@
+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/crane
+    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/crane
+    tags:
+    - dev
+  when:
+    branch:
+      - dev*
+    event:
+      - push
+      - pull_request
+- name: test-main
+  image: git.jonb.io/jblu/crane:latest
+  environment:
+    CRANE_HOST:
+      from_secret: CRANE_HOST
+    CRANE_PORT:
+      from_secret: CRANE_PORT
+    CRANE_ENDPOINT:
+      from_secret: CRANE_ENDPOINT
+  commands:
+  - echo $CRANE_HOST
+  - echo $CRANE_PORT
+  - echo $CRANE_ENDPOINT
+  - python test_crane.py
+  when:
+    branch:
+      - main
+    event:
+      - push
+      - pull_request
+- name: test-dev
+  image: git.jonb.io/jblu/crane:dev
+  environment:
+    CRANE_HOST:
+      from_secret: CRANE_HOST
+    CRANE_PORT:
+      from_secret: CRANE_PORT
+    CRANE_ENDPOINT:
+      from_secret: CRANE_ENDPOINT
+  commands:
+  - echo $CRANE_HOST
+  - echo $CRANE_PORT
+  - echo $CRANE_ENDPOINT
+  - python test_crane.py
+  when:
+    branch:
+      - dev*
+    event:
+      - push
+      - pull_request

AppriseClient.py

@@ -0,0 +1,37 @@
+import requests as r
+from tomllib import load
+import os
+
+def apprise_notify(req_obj, host, port, aurls, title, body):
+    payload = {'urls': aurls,'title': title,'body': body,}
+    url = f'http://{host}:{port}/notify/'
+    apprise_response = req_obj.post(url, json = payload ,verify=False)
+    return apprise_response
+
+class AppriseClient:
+    def __init__(self):
+        if os.getenv("DOCKER"):
+            self.host = os.getenv("host")
+            self.port = os.getenv("port")
+            self.aurls = os.getenv("aurls")
+            self.title = os.getenv("title")
+            self.body = os.getenv("body")
+        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:
+                self.config = load(c)
+        if self.config:
+            self.host = self.config["apprise"]["host"]
+            self.port = self.config["apprise"]["port"]
+            self.aurls = self.config["apprise"]["aurls"]
+            self.title = self.config["apprise"]["title"]
+            self.body = self.config["apprise"]["body"]
+        self.apprise_response = apprise_notify(r,self.host,self.port,self.aurls,self.title,self.body)  
+
+if __name__ == "__main__":
+    AppriseClient()

Dockerfile

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

README.md

@@ -1,2 +1,4 @@
 # crane
 App to make sure specified containers are running in portainer
+
+a

cclient.py

@@ -5,11 +5,19 @@ def c_get_containers(req_obj, host, port, access_token, endpoint):
 
 def c_get_filtered_containers(req_obj, j_obj, host, port, access_token, endpoint, containers, statuses):
     filter_string = j_obj.dumps({"name":containers,"status":statuses})
-    # url = 'https://192.168.4.11:9443/api/endpoints/1/docker/containers/json?filters={"name": ["restic","qbittorrent"],"status": ["paused","dead","created","exited","removing","restarting","created"]}'
     url = f'https://{host}:{port}/api/endpoints/{endpoint}/docker/containers/json?filters={filter_string}'
     c_get_containers_response = req_obj.get(url, headers={"X-API-Key": access_token}, verify=False)
     return c_get_containers_response.json()
 
+def c_get_container_id(req_obj, j_obj, host, port, access_token, endpoint, containers, statuses):
+    statuses.append("running")
+    filter_string = j_obj.dumps({"name":containers,"status":statuses})
+    url = f'https://{host}:{port}/api/endpoints/{endpoint}/docker/containers/json?filters={filter_string}'
+    c_get_container_id_response = req_obj.get(url, headers={"X-API-Key": access_token}, verify=False)
+    id = c_get_container_id_response.json()
+    id = id[0]["Id"]
+    return id
+
 def c_start_container(req_obj, host, port, access_token, endpoint, cid):
     url = f'https://{host}:{port}/api/endpoints/{endpoint}/docker/containers/{cid}/start'
     c_start_container_response = req_obj.post(url, headers={"X-API-Key": access_token},verify=False)

clogging.py

@@ -16,11 +16,15 @@ def cont_notify(self):
     if self.use_pushover:
         self.poc = self.po.Pushover(self.po_token)
 
-def cont_notify_summary(self):
+def cont_notify_summary(self, app_obj, req_obj):
     """Main notification method when the app is used in an automated fashion"""
+    title = "--- crane summary ---"
+    body = f'{self.extm}'
     if self.use_pushover:
-        self.poc.message(self.po_key,f"   \
-        {self.extm}", title="--- crane summary ---")
+        #TODO figure out why the flip it thinks its getting 4 pos args
+        self.poc.message(self.po_key, message=body, title=title)
+    if self.use_apprise:
+        app_obj(req_obj, self.apprise_host, self.apprise_port, self.apprise_aurls, title, body)
 
 def list_first_cont(self, index=0):
     """Only lists the first torrent"""
@@ -36,3 +40,11 @@ def get_script_runtime(self):
         self.tl.info(f'Execution time: [{elapsed_time}]')
     if self.use_pushover:
         self.extm = f"Execution time: [{elapsed_time}]"
+    if self.use_apprise:
+        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}")

crane.py

@@ -8,14 +8,24 @@ import datetime
 import logging
 import requests
 from tomllib import load
+import os
+from AppriseClient import apprise_notify
+requests.packages.urllib3.disable_warnings()
 
 class Crn:
     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()
-        with open('./config.toml', 'rb') as 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:
+                self.config = load(c)
+
         # Create the api object
         self.cc = requests
         # Create the logging and pushover objects
@@ -37,13 +47,23 @@ class Crn:
         self.use_pushover = self.config["pushover"]["use_pushover"]
         self.po_key = self.config["pushover"]["po_key"]
         self.po_token = self.config["pushover"]["po_token"]
+        #apprise
+        self.use_apprise = self.config["apprise"]["use_apprise"]
+        self.apprise_host = self.config["apprise"]["host"]
+        self.apprise_port = self.config["apprise"]["port"]
+        self.apprise_aurls = self.config["apprise"]["aurls"]
         #containers
         self.observed_containers = list(self.config["containers"].values())
         self.container_statuses = ["paused","dead","created","exited","removing","restarting","created"]
+        #healthcheck
+        self.use_healthcheck = self.config["healthcheck"]["use_healthcheck"]
+        self.healthcheck_url = self.config["healthcheck"]["healthcheck_url"]
 
         cont_log(self)
         cont_notify(self)
         self.t = time
+        if self.use_healthcheck:
+            send_ping(self, requests, self.healthcheck_url.rstrip("/") + "/start")
 
         #logging in
         try:
@@ -63,7 +83,12 @@ class Crn:
         self.et = datetime.datetime.now()
         get_script_runtime(self)
         if self.use_pushover:
-            cont_notify_summary(self)
+            cont_notify_summary(self, apprise_notify, requests)
+        if self.use_apprise:
+            cont_notify_summary(self, apprise_notify, requests)
+        if self.use_healthcheck:
+            send_ping(self, requests, self.healthcheck_url)
+        
 # Run
 if  __name__== "__main__":
     Crn()

entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+CRON_CONFIG_FILE="/opt/crontab"
+
+echo "${CRON} python /opt/crane.py" > $CRON_CONFIG_FILE
+
+exec supercronic -passthrough-logs -quiet $CRON_CONFIG_FILE

test_crane.py

@@ -2,45 +2,53 @@ import unittest
 import requests
 import json
 from tomllib import load
-from cclient import c_get_filtered_containers, c_start_container, c_stop_container, c_get_filtered_containers
+from cclient import c_get_filtered_containers, c_start_container, c_stop_container, c_get_container_id
 from cprocess import process_cont_list
 # unittest.TestLoader.sortTestMethodsUsing = None
+import os
 
 class TestCrane(unittest.TestCase):
     def setUp(self):
-        with open('./config.toml', 'rb') as c:
+        self.req_obj = requests
+        self.j_obj = json
+        self.req_obj.packages.urllib3.disable_warnings()
+        config_file_path = './docker/config.toml'
+        if os.getenv("toml_path", os.path.exists(config_file_path)):
+            with open(config_file_path, 'rb') as c:
                 self.config = load(c)
             self.host = self.config["portainer"]["host"]
             self.port = self.config["portainer"]["port"]
-        self.access_token = "ptr_ufS1nADXmrU3QSN3bvITLMQ7oOH9yo3ECb/QNwtIYJ4="
             self.endpoint = self.config["portainer"]["endpoint"]
-        self.cid = 'ef8fee86e02b2b82acbddf6f0da1ff023f60bfe52c0b4087cac29c1686ccbac4'
-        self.req_obj = requests
-        self.j_obj = json
-        self.hypercare_containers = ['restic','qbittorrent']
+        else:
+            self.host = os.getenv("CRANE_HOST", "192.168.4.11")
+            self.port = os.getenv("CRANE_PORT", 9443)
+            self.endpoint = os.getenv("CRANE_ENDPOINT", 1)
+        self.access_token = "ptr_ufS1nADXmrU3QSN3bvITLMQ7oOH9yo3ECb/QNwtIYJ4="
+        self.hypercare_containers = ['hottub']
         self.status_filters = ["paused","dead","created","exited","removing","restarting","created"]
-        self.cont_obj = c_get_filtered_containers(self.req_obj,self.j_obj, self.host, self.port, self.access_token, self.endpoint,self.hypercare_containers,self.status_filters)
 
     def test_c_get_filtered_containers(self):
+        self.cid = c_get_container_id(self.req_obj,self.j_obj, self.host, self.port, self.access_token, self.endpoint, self.hypercare_containers,self.status_filters)
+        self.c_stop_container_response = c_stop_container(self.req_obj, self.host, self.port, self.access_token, self.endpoint, self.cid)
+        self.cont_obj = c_get_filtered_containers(self.req_obj,self.j_obj, self.host, self.port, self.access_token, self.endpoint,self.hypercare_containers,self.status_filters)
         self.assertTrue(self.cont_obj, "No cont object returned by c_get_filtered_containers.")
 
     def test_c_start_container(self):
+        self.cid = c_get_container_id(self.req_obj,self.j_obj, self.host, self.port, self.access_token, self.endpoint, self.hypercare_containers,self.status_filters)
+        c_stop_container(self.req_obj, self.host, self.port, self.access_token, self.endpoint, self.cid)
         self.c_start_container_response = c_start_container(self.req_obj, self.host, self.port, self.access_token, self.endpoint, self.cid)
-        # print(self.c_start_container_response)
         self.assertTrue(self.c_start_container_response, "No c_start_container_resonse returned by c_start_container.")
         # 204 success 304 already on
     
     def test_c_process_cont_list(self):
+        self.cont_obj = c_get_filtered_containers(self.req_obj,self.j_obj, self.host, self.port, self.access_token, self.endpoint,self.hypercare_containers,self.status_filters)
         self.assertTrue(process_cont_list(self.cont_obj, c_start_container, self.req_obj, self.host, self.port, self.access_token, self.endpoint))
     
     def test_c_stop_container(self):
+        self.cid = c_get_container_id(self.req_obj,self.j_obj, self.host, self.port, self.access_token, self.endpoint, self.hypercare_containers,self.status_filters)
         self.c_stop_container_response = c_stop_container(self.req_obj, self.host, self.port, self.access_token, self.endpoint, self.cid)
-        # print(self.c_stop_container_response)
         self.assertTrue(self.c_stop_container_response, "No c_start_container_resonse returned by c_start_container.")
         
-    def test_z_tear_down(self):
-        c_stop_container(self.req_obj, self.host, self.port, self.access_token, self.endpoint, self.cid)
-        
 
 if __name__ == '__main__':
     unittest.main()

test_pushover.py

@@ -1,12 +0,0 @@
-import pushover
-from tomllib import load
-
-with open('./config.toml', mode="rb") as c:
-    config = load(c)
-
-po_key = config["pushover"]["po_key"]
-po_token = config["pushover"]["po_token"]
-
-message = "hello"
-
-# pushover.Pushover(po_token).message(po_key, message, title="--- crane summary ---")

test_toml.py

@@ -1,6 +0,0 @@
-from tomllib import load
-
-with open('./config.toml', mode="rb") as c:
-    config = load(c)
-
-print(config["containers"].values())