django-azure-backup

Author: ajitmourya7

.gitignore

@@ -0,0 +1,4 @@
+**/__pycache__/
+.idea/
+**/**/.env
+main_backup/.env

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Glib
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# Glib Backup
+
+This package can take postgres dump and able to upload data in azure cloud storage.
+
+## Build Process
+open the link.
+[click here for steps.](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
+
+## Required 
+1. Django Default Database Config.
+2. AZURE_ACCOUNT_NAME (Azure Storage Account Name).
+3. AZURE_CREDENTIAL (Azure Key).
+4. AZURE_CONTAINER (Azure Container Name).
+5. AZURE_BACKUP_FOLDER_NAME.

django_azure_backup/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

django_azure_backup/admin.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class DjangoAzureBackupConfig(AppConfig):
+    name = 'django_azure_backup'

django_azure_backup/apps.py

@@ -0,0 +1,116 @@
+import os
+import subprocess
+from django.conf import settings
+from azure.storage.blob import BlockBlobService
+
+
+class BackupSystem:
+
+    def __init__(self):
+        self.blob_service_client: BlockBlobService
+        default_config = settings.DATABASES.get('default')
+        self.postgres_host = default_config.get('HOST')
+        self.postgres_port = default_config.get('PORT')
+        self.postgres_db = default_config.get('NAME')
+        self.postgres_user = default_config.get('USER')
+        self.postgres_password = default_config.get('PASSWORD')
+        self.azure_credential = settings.AZURE_CREDENTIAL
+        self.azure_container = settings.AZURE_CONTAINER
+        self.azure_account_name = settings.AZURE_ACCOUNT_NAME
+        self.azure_backup_folder_name = settings.AZURE_BACKUP_FOLDER_NAME
+        self.blob_service_client = BlockBlobService(account_name=self.azure_account_name,
+                                                    account_key=self.azure_credential)
+
+    def get_list_of_blobs(self):
+        return self.blob_service_client.list_blobs(container_name=self.azure_container,
+                                                   prefix=self.azure_backup_folder_name + '/')
+
+    def download_blob_file(self, name):
+        return self.blob_service_client.get_blob_to_bytes(container_name=self.azure_container,
+                                                          blob_name=self.azure_backup_folder_name + "/" + name).content
+
+    def upload_blob_file(self, name, data):
+        self.blob_service_client.create_blob_from_bytes(container_name=self.azure_container,
+                                                        blob_name=self.azure_backup_folder_name + "/" + name,
+                                                        blob=data)
+
+    def backup_postgres_db(self, verbose):
+        """
+        Backup postgres db to a file.
+        """
+        if verbose:
+            try:
+                process = subprocess.Popen(
+                    ['pg_dump',
+                     '-Fc',
+                     '-v'],
+                    shell=True,
+                    env={
+                        'PGUSER': self.postgres_user,
+                        'PGPASSWORD': self.postgres_password,
+                        'PGDATABASE': self.postgres_db,
+                        'PGPORT': str(self.postgres_port),
+                        'PGHOST': self.postgres_host
+                    },
+                    stdout=subprocess.PIPE
+                )
+                output = process.communicate()[0]
+                if int(process.returncode) != 0:
+                    print('Command failed. Return code : {}'.format(process.returncode))
+                    exit(1)
+                return output
+            except Exception as e:
+                print(e)
+                exit(1)
+        else:
+            print('{}:{}@{}:{}/{}'.format(self.postgres_user,
+                                          self.postgres_password,
+                                          self.postgres_host,
+                                          self.postgres_port,
+                                          self.postgres_db))
+            try:
+                process = subprocess.Popen(
+                    ['pg_dump',
+                     '-Fc'],
+                    shell=True,
+                    env={
+                        'PGUSER': self.postgres_user,
+                        'PGPASSWORD': self.postgres_password,
+                        'PGDATABASE': self.postgres_db,
+                        'PGPORT': str(self.postgres_port),
+                        'PGHOST': self.postgres_host
+                    },
+                    stdout=subprocess.PIPE
+                )
+                output = process.communicate()[0]
+                if process.returncode != 0:
+                    print('Command failed. Return code : {}'.format(process.returncode))
+                    exit(1)
+                return output
+            except Exception as e:
+                print(e)
+                exit(1)
+
+    def restore_postgres_db(self, filepath):
+        """Restore postgres db from a file."""
+        try:
+            d = dict(os.environ)
+            d['PGPASSFILE'] = filepath
+            d['PGPASSWORD'] = self.postgres_password
+            host = self.postgres_host
+
+            process = subprocess.Popen(['psql',
+                                        "-f%s" % filepath,
+                                        "-d%s" % self.postgres_db,
+                                        "-h%s" % host,
+                                        "-U%s" % self.postgres_user
+                                        ], env=d,
+                                       stdout=subprocess.PIPE, stderr=subprocess.DEVNULL
+                                       )
+            process.wait()
+            if process.returncode != 0:
+                print('Command failed. Return code : {}'.format(process.returncode))
+                exit(1)
+            return process.returncode
+        except Exception as e:
+            print("Issue with the db restore : {}".format(e))

django_azure_backup/db/__init__.py

@@ -0,0 +1,15 @@
+from ...db.base import BackupSystem
+import datetime
+from django.core.management.base import BaseCommand
+import argparse
+import configparser
+
+
+class Command(BaseCommand):
+
+    def handle(self, **options):
+        print('checking configuration')
+        backup_service = BackupSystem()
+        print('Backup file list: --\n')
+        for backup_file in backup_service.get_list_of_blobs():
+            print(backup_file.name)

django_azure_backup/db/base.py

@@ -0,0 +1,17 @@
+from ...db.base import BackupSystem
+import datetime
+from django.core.management.base import BaseCommand
+
+
+class Command(BaseCommand):
+
+    def handle(self, **options):
+        print('checking configuration')
+        backup_service = BackupSystem()
+        print('creating psql dump')
+        datafile = backup_service.backup_postgres_db(True)
+        file_name = str(datetime.datetime.now().strftime('%Y-%m-%d-%M-%S')) + \
+                    "-" + backup_service.postgres_db + ".psql"
+        print('uploading psql dump to azure container')
+        backup_service.upload_blob_file(name=file_name, data=datafile)
+        print('successfully uploaded file name: {}'.format(file_name))

django_azure_backup/management/__init__.py

@@ -0,0 +1,27 @@
+import os
+from ...db.base import BackupSystem
+from django.core.management.base import BaseCommand
+
+
+class Command(BaseCommand):
+    def add_arguments(self, parser):
+        parser.add_argument('-n', "--name", type=ascii, help='blob file name dont add backup folder name')
+
+    def handle(self, **options):
+        filename = options['name'][1:-1]
+        print(filename)
+        print('checking configuration')
+        backup_service = BackupSystem()
+        print('downloading backup file')
+        obj_file = backup_service.download_blob_file(name=filename)
+        with open('/tmp/' + filename, 'wb') as file_writer:
+            file_writer.write(obj_file)
+        print('restoring')
+        backup_service.restore_postgres_db(filepath='/tmp/'+filename)
+        print('restoring completed')
+        try:
+            print('removing temp file')
+            os.remove('/tmp/' + filename)
+        except:
+            print('unable to delete file')
+        print('request completed')

django_azure_backup/management/commands/__init__.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

django_azure_backup/management/commands/db-backup-list.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

django_azure_backup/management/commands/db-backup.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

django_azure_backup/management/commands/db-restore.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for rewaflux project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'main_backup.settings')
+
+application = get_asgi_application()