aboutsummaryrefslogtreecommitdiff
path: root/scripts/authentication/resource.py
diff options
context:
space:
mode:
authorBonfaceKilz2021-10-04 12:21:16 +0300
committerBonfaceKilz2021-10-04 13:00:53 +0300
commitdf487791c91a5aa1a9a3b4e1a6c9ce17a58eafe6 (patch)
treea7e7a46edcc31f3d94e2362e1cd2652e7fdc69e6 /scripts/authentication/resource.py
parentedb6fe1b9dd98d84deb0925a2d83726e739d8677 (diff)
downloadgenenetwork2-df487791c91a5aa1a9a3b4e1a6c9ce17a58eafe6.tar.gz
Modify resource editing script to enable data backups & restoration
Diffstat (limited to 'scripts/authentication/resource.py')
-rw-r--r--scripts/authentication/resource.py101
1 files changed, 88 insertions, 13 deletions
diff --git a/scripts/authentication/resource.py b/scripts/authentication/resource.py
index 75ef9e93..8fcf09d7 100644
--- a/scripts/authentication/resource.py
+++ b/scripts/authentication/resource.py
@@ -1,25 +1,100 @@
-"""A script that adds the group: 'editors' to every
-resource. 'editors' should have the right to edit both metadata and
-data.
+"""A script that:
-To use this script, simply run:
+- Optionally restores data from a json file.
+
+- By default, without any args provided, adds the group: 'editors' to
+every resource. 'editors' should have the right to edit both metadata
+and data.
+
+- Optionally creates a back-up every time you edit a resource.
+
+
+To restore a back-up:
+
+.. code-block:: python
+ python resource.py --restore <PATH/TO/RESOURCE/BACK-UP/FILE>
+
+To add editors to every resource without creating a back-up:
.. code-block:: python
python resource.py
+To add editors to every resource while creating a back-up before any
+destructive edits:
+
+.. code-block:: python
+ python resource.py --enable-backup
+
"""
+import argparse
import json
import redis
+import os
+
+from datetime import datetime
+
+
+def recover_hash(name: str, file_path: str, set_function) -> bool:
+ """Recover back-ups using the `set_function`
+
+ Parameters:
+
+ - `name`: Redis hash where `file_path` will be restored
+
+ - `file_path`: File path where redis hash is sourced from
+
+ - `set_function`: Function used to do the Redis backup for
+ example: HSET
+
+ """
+ try:
+ with open(file_path, "r") as f:
+ resources = json.load(f)
+ for resource_id, resource in resources.items():
+ set_function(name=name,
+ key=resource_id,
+ value=resource)
+ return True
+ except Exception as e:
+ print(e)
+ return False
if __name__ == "__main__":
- REDIS_CONN = redis.Redis()
- resources = REDIS_CONN.hgetall("resources_clone")
- for resource_id, resource in resources.items():
- deserialized_resource = json.loads(resource)
- deserialized_resource["group_masks"] = {
- "editors": {"metadata": "edit",
- "data": "edit"}}
- REDIS_CONN.hset("resources_clone",
+ # Initialising the parser CLI arguments
+ parser = argparse.ArgumentParser()
+ parser.add_argument("--restore",
+ help="Restore from a given backup")
+ parser.add_argument("--enable-backup", action="store_true",
+ help="Create a back up before edits")
+ args = parser.parse_args()
+
+ if args.restore:
+ if recover_hash(name="resources",
+ file_path=args.back_up,
+ set_function=redis.Redis(decode_responses=True).hset):
+ exit(f"\n Done restoring {args.back_up}!\n")
+ else:
+ exit(f"\n There was an error restoring {args.back_up}!\n")
+
+ REDIS_CONN = redis.Redis(decode_responses=True)
+ RESOURCES = REDIS_CONN.hgetall("resources")
+ BACKUP_DIR = os.path.join(os.getenv("HOME"), "redis")
+ if args.enable_backup:
+ FILENAME = ("resources-"
+ f"{datetime.now().strftime('%Y-%m-%d-%I:%M:%S-%p')}"
+ ".json")
+ if not os.path.exists(BACKUP_DIR):
+ os.mkdir(BACKUP_DIR)
+ with open(os.path.join(BACKUP_DIR, FILENAME), "w") as f:
+ json.dump(RESOURCES, f, indent=4)
+ print(f"\nDone backing upto {FILENAME}")
+
+ for resource_id, resource in RESOURCES.items():
+ _resource = json.loads(resource) # str -> dict conversion
+ _resource["group_masks"] = {"editors": {"metadata": "edit",
+ "data": "edit"}}
+ REDIS_CONN.hset("resources",
resource_id,
- json.dumps(deserialized_resource))
+ json.dumps(_resource))
+ exit("Done updating `resources`\n")