django-db-anonymiser 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

django_db_anonymiser/db_anonymiser/management/commands/dump_and_anonymise.py

@@ -23,10 +23,16 @@ class Command(BaseCommand):
             action="store_true",
             help="Skip uploading to S3.",
         )
+        parser.add_argument(
+            "--presign",
+            action="store_true",
+            help="Generates and logs a presigned URL for the uploaded file.",
+        )
 
     def configure(self):
         self.keep_local_dumpfile = False
         self.skip_s3_upload = False
+        self.presign = False
         self.dump_file_name = settings.DB_ANONYMISER_DUMP_FILE_NAME
         self.temporary_dump_location = getattr(
             settings,
@@ -63,11 +69,16 @@ class Command(BaseCommand):
 
         if options["skip_s3_upload"]:
             self.skip_s3_upload = True
+        
+        if options["presign"]:
+            self.presign = True
 
         try:
             self.dump_anonymised_db()
             self.write_to_s3()
             logger.info("DB dump and anonymiser was successful!")
+            if self.presign:
+                self.generate_presigned_url()
         finally:
             self.cleanup()
 
@@ -93,6 +104,14 @@ class Command(BaseCommand):
             self.temporary_dump_location, self.s3_bucket_name, self.dump_file_name
         )
         logger.info("Writing file to S3 complete")
+    
+    def generate_presigned_url(self):
+        presigned = self.s3_client.generate_presigned_url(
+            'get_object',
+            Params={'Bucket': self.s3_bucket_name, 'Key': self.dump_file_name},
+            ExpiresIn=600
+        )
+        logger.info("Presigned URL: %s", presigned)
 
     def cleanup(self):
         if self.keep_local_dumpfile:

django_db_anonymiser/db_anonymiser/tests/test_command.py

@@ -1,4 +1,5 @@
 import os
+from unittest.mock import ANY
 from unittest.mock import patch
 
 from django.conf import settings
@@ -8,6 +9,7 @@ from django.test import TransactionTestCase
 
 import boto3
 import pytest
+import requests
 from moto import mock_aws
 
 
@@ -88,3 +90,33 @@ class TestDumpAndAnonmyiseCommand(TransactionTestCase):
     def test_dump_and_anonymise_keeps_local_file(self, mocked_os_remove):
         call_command("dump_and_anonymise", keep_local_dumpfile=True)
         assert not mocked_os_remove.called
+
+    @patch("django_db_anonymiser.db_anonymiser.management.commands.dump_and_anonymise.logger")
+    @patch("django_db_anonymiser.db_anonymiser.management.commands.dump_and_anonymise.Command.generate_presigned_url")
+    @patch(
+        "django_db_anonymiser.db_anonymiser.management.commands.dump_and_anonymise.os.remove"
+    )
+    def test_dump_and_anonymise_no_arguments(self, mocked_os_remove, mocked_presign, mocked_logger):
+        call_command("dump_and_anonymise")
+        bucket_contents = self.aws.list_objects(
+            Bucket=settings.DB_ANONYMISER_AWS_STORAGE_BUCKET_NAME
+        ).get("Contents", [])
+        assert bucket_contents[0]["Key"] == settings.DB_ANONYMISER_DUMP_FILE_NAME
+        mocked_os_remove.assert_called_with(
+            f"/tmp/{settings.DB_ANONYMISER_DUMP_FILE_NAME}"
+        )
+        mocked_presign.assert_not_called()
+        mocked_logger.info.assert_any_call("DB dump and anonymiser was successful!")
+        mocked_logger.info.assert_any_call("Writing anonymised dumpfile to temporary location %s", settings.DB_ANONYMISER_DUMP_FILE_NAME)
+        mocked_logger.info.assert_any_call("Writing file to S3 complete")
+
+    @patch("django_db_anonymiser.db_anonymiser.management.commands.dump_and_anonymise.logger")
+    def test_dump_and_anonymise_with_presign(self, mocked_logger):
+        call_command("dump_and_anonymise", presign=True)
+        bucket_contents = self.aws.list_objects(
+            Bucket=settings.DB_ANONYMISER_AWS_STORAGE_BUCKET_NAME
+        ).get("Contents", [])
+        assert bucket_contents[0]["Key"] == settings.DB_ANONYMISER_DUMP_FILE_NAME
+        mocked_logger.info.assert_any_call("Presigned URL: %s", ANY)
+        presigned_url = mocked_logger.info.call_args_list[6][0][1]
+        assert requests.get(presigned_url).status_code == 200

{django_db_anonymiser-0.1.0.dist-info → django_db_anonymiser-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-db-anonymiser
-Version: 0.1.0
+Version: 0.2.1
 Summary: Django app to create configurable anonymised DB dumps.
 Author: Brendan Smith
 Author-email: brendan.smith@digital.trade.gov.uk
@@ -16,6 +16,7 @@ Requires-Dist: django-environ (>=0.12.0,<0.13.0)
 Requires-Dist: faker (>=4.18.0)
 Requires-Dist: psycopg2-binary (>=2.9.10,<3.0.0)
 Requires-Dist: pymysql (>=1.1.2,<2.0.0)
+Requires-Dist: pyyaml (==6.0.2)
 Description-Content-Type: text/markdown
 
 # django-db-anonymiser
@@ -42,7 +43,7 @@ because it is unmaintained.
 ## Getting started
 
 - Add `faker>=4.18.0`, `boto3>=1.26.17` to python requirements; it is assumed python/psycopg and co are already installed.
-- Either add this github repository as a submodule to your django application named `django_db_anonymiser` or install the python package (django-db-anonymiser)[] from PyPI.
+- Either add this github repository as a submodule to your django application named `django_db_anonymiser` or install the python package (django-db-anonymiser)[https://pypi.org/project/django-db-anonymiser/] from PyPI.
 - Add `django_db_anonymiser.db_anonymiser` to `INSTALLED_APPS`
 - Set the following django settings;
     - `DB_ANONYMISER_CONFIG_LOCATION` - the location of your anonymisation yaml file
@@ -56,7 +57,7 @@ because it is unmaintained.
 
 For local unit testing from the root of the repository run:
 
-    $ poetry run pytest
+    $ poetry run pytest django_db_anonymiser
 
 **Note:** Currently for full test coverage, it is necessary to run tests in circleci, where we spin up a postgres db and test
 the `db_anonymiser` command directly
@@ -92,7 +93,7 @@ _Note: Make sure your Pull Request (PR) is approved and contains the version upg
 poetry publish
 ```
 
-Check the [PyPI Release history](https://pypi.org/project/dbt-platform-helper/#history) to make sure the package has been updated.
+Check the [PyPI Release history](https://pypi.org/project/django-db-anonymiser/#history) to make sure the package has been updated.
 
 For an optional manual check, install the package locally and test everything works as expected.
 

{django_db_anonymiser-0.1.0.dist-info → django_db_anonymiser-0.2.1.dist-info}/RECORD

@@ -32,9 +32,9 @@ django_db_anonymiser/db_anonymiser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQe
 django_db_anonymiser/db_anonymiser/faker.py,sha256=5X8tH_MAMtrsg248waXMSXTkoacMosqQlkCSFjy_0pA,1729
 django_db_anonymiser/db_anonymiser/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_db_anonymiser/db_anonymiser/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_db_anonymiser/db_anonymiser/management/commands/dump_and_anonymise.py,sha256=XNyDLwGgDWD1vXUs9ChYPdzI-gbLOJrcfcCceRR1tCU,3692
-django_db_anonymiser/db_anonymiser/tests/test_command.py,sha256=lngzFc-_K2fC-LgIaLNSkJa3iBrDAPWxh56heIa5whg,3637
+django_db_anonymiser/db_anonymiser/management/commands/dump_and_anonymise.py,sha256=kvocsusmjuBeBKfKE9xg9k3MdnY6hUBT__jc6Q2HHYc,4339
+django_db_anonymiser/db_anonymiser/tests/test_command.py,sha256=J6_KF59S-DBtOx5yumP1Y1LRYU2jR78R0-oOupEflB0,5481
 django_db_anonymiser/db_anonymiser/tests/test_faker.py,sha256=gvrOpSlWDjr4ajLyN5BEhxtkxO7_zls-CP04EolFFV4,3197
-django_db_anonymiser-0.1.0.dist-info/METADATA,sha256=G1Wk_yRHC2lIfUXUsrk1pBf2frmBM0dCz29eGujFFCc,4567
-django_db_anonymiser-0.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-django_db_anonymiser-0.1.0.dist-info/RECORD,,
+django_db_anonymiser-0.2.1.dist-info/METADATA,sha256=8fJ2QNHGfe4vSSY56VGky_wKe2Z2rE247APT1V_BMbM,4667
+django_db_anonymiser-0.2.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+django_db_anonymiser-0.2.1.dist-info/RECORD,,

{django_db_anonymiser-0.1.0.dist-info → django_db_anonymiser-0.2.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.3
+Generator: poetry-core 2.0.1
 Root-Is-Purelib: true
 Tag: py3-none-any