Add ability to generate files of specific size

We need to be able to generate files of specific sizes to carry out quantity
tests and perhaps it would have other uses.

Issue: PermanentOrg#13

Signed-off-by: fenn-cs <[email protected]>

Author: nfebe

README.md

@@ -174,6 +174,42 @@ Run
 Check the downloads folder in `test-tree/downloads` and ensure that the `downloads/nested` directory has a structure like the nested directory uploaded in the [nested uploads test](#nested-uploads).
 
 
+#### Quantity Tests
+
+To test uploads/downloads with a large number of files, we definitely need "a large number" of files on either side (local/remote) of the process.
+
+To generate a number of files with a specific size in `test-tree/special-files`, run `./create-files.py --quantity 10 --size 10000 --root-name "10-10B"` (*In this case, the command would generate 10, 10 bytes files.*)
+
+*Take note that in the command `--quantity`, `--size` and `--root-name` are arguments whose values you can change. Quanity for number of files, size for file zie and root name for the name of the parent folder that would hold the files*
+##### Large number of uploads
+
+For 1000, 1B Files:
+- Run `./create-files.py`
+
+- Run `./upload-test.py test-tree/special-files/1000-1B --remote-dir=1000-10B --log-file=log-1000-1B.txt --remote=prod --archive-path="/archives/QA (0a21-0000)/My Files/"`
+
+For 1000, 10B Files:
+- Run `./create-files.py --quantity 1000 --size 10000 --root-name "1000-10B"`
+
+- Run `./upload-test.py test-tree/special-files/1000-10B --remote-dir=1000-10B --log-file=log-1000-10B.txt --remote=prod --archive-path="/archives/QA (0a21-0000)/My Files/"`
+
+For 1000, 1MB Files:
+- Run `./create-files.py --quantity 1000 --size 1000000 --root-name "1000-1MB"`
+
+- Run `./upload-test.py test-tree/special-files/1000-1MB --remote-dir=1000-1MB --log-file=log-1000-1MB.txt --remote=prod --archive-path="/archives/QA (0a21-0000)/My Files/"`
+
+For 1000, 5MB Files:
+- Run `./create-files.py --quantity 1000 --size 5000000 --root-name "1000-5MB"`
+
+- Run `./upload-test.py test-tree/special-files/1000-5MB --remote-dir=1000-5MB --log-file=log-1000-5MB.txt --remote=prod --archive-path="/archives/QA (0a21-0000)/My Files/"`
+
+*Of course, by looking at the pattern above, other number-size arrangements can be generated for further testing.*
+
+
+##### Large number of downloads
+
+
+
 ### What file types and scenarios are left out?
 
 Anything not included in the section above describing what is currently covered is by implication excluded from these tests.

create-files.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+
+import os
+import random
+import string
+import argparse
+
+QUANTITY = 1000
+FILE_NAME_LENGTH = 10
+FILE_SIZE = 1  # 1 Byte
+ROOT_NAME = "1000-1B"
+SPECIAL_FILES_ROOT = "test-tree/special-files/"
+
+
+def random_string(length=FILE_NAME_LENGTH):
+    "Generate random string of specified length"
+    return "".join(random.choices(string.ascii_lowercase, k=length))
+
+
+def parse_cli():
+    """Prepare parser"""
+    parser = argparse.ArgumentParser(prog="create-files", description="Generate files")
+    parser.add_argument("--quantity", help="Number of files to be generated", type=int)
+    parser.add_argument("--size", help="Size of each file to be generated", type=int)
+    parser.add_argument("--root-name", help="Download zip files for testing")
+    return parser.parse_args()
+
+
+def write_file(path, size):
+    """Write file of {size} to {path}"""
+    with open(SPECIAL_FILES_ROOT + "/" + path, "wb") as out:
+        out.seek((size) - 1)
+        out.write(b"\0")
+
+
+def check_path(path):
+    """Make sure given path exists within special files directory"""
+    if not os.path.exists(SPECIAL_FILES_ROOT):
+        os.makedirs(SPECIAL_FILES_ROOT)
+    if not os.path.exists(SPECIAL_FILES_ROOT + "/" + path):
+        os.makedirs(SPECIAL_FILES_ROOT + "/" + path)
+
+
+def main():
+    global QUANTITY
+    global FILE_SIZE
+    global ROOT_NAME
+    args = parse_cli()
+    if args.quantity:
+        QUANTITY = args.quantity
+    if args.size:
+        FILE_SIZE = args.size
+    if args.root_name:
+        ROOT_NAME = args.root_name
+    check_path(ROOT_NAME)
+    for _ in range(0, QUANTITY):
+        write_file(ROOT_NAME + "/" + random_string(), FILE_SIZE)
+
+
+if __name__ == "__main__":
+    main()