Added a server which manually starts database dumping on acess

Author: MultiFox200

.gitignore

@@ -1 +1,2 @@
-.idea/
+.idea/
+.vscode/

README.md

@@ -8,8 +8,12 @@ Ready to use simple example how to [backup SQL Database wtih this script](https:
 To use this image you need to setup all of it's environment values. If one of it's values are missing, empty or of a wrong type, it will print out a message to log to let you know.
 
 Environment values meaning:
-- TEST: defaults to False, if set to True doesn't start the scheduler instead waits 30 seconds and runs database dump
+- TEST: defaults to False, if set to True doesn't start the scheduler or server and instead waits 30 seconds and runs database dump
 - CRON: crontab syntax that is used to determine when to backup database, if you're new to crontab or unsure you can use [crontab.guru](crontab.guru) website;
+- START_SERVER: defaults to True, if set to True starts a server which you can access to manually start database dumping
+- SERVER_PORT: default to 33399
+- SERVER_BASIC_AUTH_USER: default to admin; username for server basic auth
+- SERVER_BASIC_AUTH_PASSWORD: default to admin; password for server basic auth
 - DATABASE_TYPE: type of database you want to backup, available values [MySQL, PostgreSQL]
 - DATABASE_HOST: hostname or ip address to database
 - DATABASE_NAME: scheme name to backup

src/Dockerfile

@@ -5,6 +5,7 @@ RUN apk add --no-cache postgresql-client mysql-client
 RUN python -m pip install apscheduler boto3 slack_sdk
 
 COPY scheduler.py /scheduler/scheduler.py
+COPY server.py /scheduler/server.py
 COPY logging.ini /scheduler/logging.ini
 
 ENV PYTHONUNBUFFERED=TRUE

src/scheduler.py

@@ -5,7 +5,11 @@
 from slack_sdk.webhook import WebhookClient
 
 from apscheduler.triggers.cron import CronTrigger
-from apscheduler.schedulers.background import BlockingScheduler
+from apscheduler.schedulers.background import BackgroundScheduler
+
+from server import AuthServer
+import time
+import random
 
 logging.config.fileConfig('logging.ini')
 logger = logging.getLogger('ddg_scheduler')
@@ -19,10 +23,17 @@ def sizeof_fmt(num):
     return "%.1f%s" % (num, 'PiB')
 
 
-def send_slack_message(environment, message, success=True):
+def send_slack_message(environment, message, type='SUCCESS'):
     webhook_url = environment['SLACK_WEBHOOK']
     project_name = environment['PROJECT_NAME']
 
+    color_map = {
+        'SUCCESS': '#36a64f',
+        'FAIL': '#ee2700',
+        'OTHER': '#FFCC00'
+    }
+    fallback_color = '#808080'
+
     logger.info(message)
 
     if project_name and len(project_name) > 0:
@@ -35,7 +46,7 @@ def send_slack_message(environment, message, success=True):
         response = client.send(
             attachments=[
                 {
-                    "color": "#36a64f" if success else "#ee2700",
+                    "color": color_map.get(type, fallback_color),
                     "blocks": [
                         {
                             "type": "header",
@@ -73,6 +84,10 @@ def get_env():
     env_variables = {
         'TEST': {'type': bool, 'required': False, 'default': False},
         'CRON': {'type': str},
+        'START_SERVER': {'type': bool, 'required': False, 'default': True},
+        'SERVER_PORT': {'type': int, 'required': False, 'default': 33399},
+        'SERVER_BASIC_AUTH_USER': {'type': str, 'required': False, 'default': 'admin'},
+        'SERVER_BASIC_AUTH_PASSWORD': {'type': str, 'required': False, 'default': 'admin'},
         'DATABASE_TYPE': {'type': str, 'possible_values': ['postgresql', 'mysql']},
         'DATABASE_HOST': {'type': str},
         'DATABASE_NAME': {'type': str},
@@ -147,7 +162,7 @@ def dump_database():
 
         if wait_exit_status != 0 or exit_status != 0:
             logger.error("RETURN CODE OF DUMP PROCESS != 0. CHECK OUTPUT ABOVE FOR ERRORS!")
-            send_slack_message(environment, "Failed to create DB dump. Please check the error in the container logs.", False)
+            send_slack_message(environment, "Failed to create DB dump. Please check the error in the container logs.", 'FAIL')
         else:
             file_size = 0
 
@@ -171,22 +186,30 @@ def dump_database():
                     send_slack_message(environment, f"Successfully created and uploaded DB dump ({sizeof_fmt(file_size)}).")
             except Exception as e:
                 logger.exception(e)
-                send_slack_message(environment, f"Failed to upload DB dump ({sizeof_fmt(file_size)}) to AWS Glacier. Please check the error in the container logs.", False)
+                send_slack_message(environment, f"Failed to upload DB dump ({sizeof_fmt(file_size)}) to AWS Glacier. Please check the error in the container logs.", 'FAIL')
     else:
         logger.error(f'Database of type {database_type} is not supported. If you see this message something went horribly wrong.')
 
 
 if __name__ == "__main__":
     environment = get_env()
 
-    print(f"|{os.getenv('SLACK_WEBHOOK')}|")
-
     if environment.get('TEST'):
         import time
         time.sleep(10)
         dump_database()
         time.sleep(300)
     else:
-        dumper_scheduler = BlockingScheduler()
-        dumper_scheduler.add_job(dump_database, CronTrigger.from_crontab(os.getenv('CRON')))
+        dumper_scheduler = BackgroundScheduler()
+        dumper_scheduler.add_job(dump_database, CronTrigger.from_crontab(environment.get('CRON')))
         dumper_scheduler.start()
+
+        if environment.get('START_SERVER'):
+            def on_get():
+                send_slack_message(environment, 'Backup triggered from server', 'OTHER')
+                dump_database()
+
+            server = AuthServer(('', environment.get('SERVER_PORT')))
+            server.set_auth(environment.get('SERVER_BASIC_AUTH_USER'), environment.get('SERVER_BASIC_AUTH_PASSWORD'))
+            server.set_on_get(on_get)
+            server.serve_forever()

src/server.py

@@ -0,0 +1,64 @@
+import http.server
+import base64
+import json
+
+
+class AuthServerHandler(http.server.BaseHTTPRequestHandler):
+
+    def do_AUTHHEAD(self):
+        self.send_response(401)
+        self.send_header(
+            'WWW-Authenticate', 'Basic realm="Basic Realm"')
+        self.send_header('Content-type', 'application/json')
+        self.end_headers()
+
+    def do_GET(self):
+        key = self.server.auth_key
+
+        ''' Present frontpage with user authentication. '''
+        if self.headers.get('Authorization') == None:
+            self.do_AUTHHEAD()
+
+            response = {
+                'success': False,
+                'error': 'No auth header received'
+            }
+
+            self.wfile.write(bytes(json.dumps(response), 'utf-8'))
+
+        elif self.headers.get('Authorization') == 'Basic ' + str(key):
+            self.send_response(200)
+            self.send_header('Content-type', 'application/json')
+            self.end_headers()
+
+            self.server.on_get()
+
+            self.wfile.write(b'Hello')
+        else:
+            self.do_AUTHHEAD()
+
+            response = {
+                'success': False,
+                'error': 'Invalid credentials'
+            }
+
+            self.wfile.write(bytes(json.dumps(response), 'utf-8'))
+
+
+class AuthServer(http.server.HTTPServer):
+    auth_key = ''
+    on_get = lambda: None
+
+    def __init__(self, address):
+        super().__init__(address, AuthServerHandler)
+
+    def set_auth(self, username, password):
+        self.auth_key = base64.b64encode(
+            bytes('%s:%s' % (username, password), 'utf-8')).decode('ascii')
+
+    def set_on_get(self, on_get):
+        self.on_get = on_get
+
+    def serve_forever(self, poll_interval=0.5):
+        print(f'Starting server on {self.server_port}')
+        super().serve_forever(poll_interval=poll_interval)

test/mysql_compose.yaml

@@ -13,6 +13,8 @@ services:
 
   mysql_dumper:
     build: ../src
+    ports:
+    - 33399:33399
     environment:
       TEST: "true"
       CRON: "* * * * *"