PXP-11291 - Fix/data import directory notice

.gitignore

@@ -5,3 +5,4 @@ sample_test_data/
 *.egg-info/
 
 tests/TestData
+/.idea/

datasimulator/file_handling.py

@@ -0,0 +1,10 @@
+from cdislogging import get_logger
+logger = get_logger("data-simulator", log_level="info")
+
+
+def write_submission_order_to_file(submission_order, file_path):
+    with open(file_path, "w") as output_file:
+        for node in submission_order:
+            output_file.write(f"{node.name}\t{node.category}\n")
+    return True
+

datasimulator/main.py

@@ -5,9 +5,8 @@
 
 from .graph import Graph
 from .submit_data_utils import submit_test_data
-
+from .file_handling import write_submission_order_to_file
 from cdislogging import get_logger
-
 logger = get_logger("data-simulator", log_level="info")
 
 
@@ -144,9 +143,13 @@ def run_submission_order_generation(graph, data_path, node_name=None):
     else:
         submission_order = graph.generate_submission_order()
 
-    with open(os.path.join(data_path, "DataImportOrderPath.txt"), "w") as outfile:
-        for node in submission_order:
-            outfile.write(node.name + "\t" + node.category + "\n")
+    file_path = os.path.join(data_path, "DataImportOrderPath.txt")
+    path_exists = os.path.exists(data_path)
+    if not path_exists:
+        raise Exception(f"Cannot create file because path does not exist. Here is the path we expect: '{data_path}'")
+    else:
+        write_submission_order_to_file(submission_order, file_path)
+
 
 
 # python main.py simulate --url https://s3.amazonaws.com/dictionary-artifacts/bhcdictionary/0.4.3/schema.json --path ./data-simulator/sample_test_data --program DEV --project test

datasimulator/utils.py

@@ -1,11 +1,17 @@
-import os
 import random
 import json
 from functools import reduce
 
 from .errors import UserError
 
 
+def attempt(action):
+    try:
+        return {"success": True, "result": action()}
+    except Exception as e:
+        return {"success": False, "error": e}
+
+
 def is_mixed_type(arr):
     # An enum is said "mixed type" if the enum items don't all have the same type. The only
     # exception to this is NoneType, which is allowed in enums regardless of the type of other

tests/test_file_handling.py

@@ -0,0 +1,27 @@
+import os
+from datasimulator.utils import attempt
+from datasimulator.file_handling import write_submission_order_to_file
+from datasimulator.node import Node
+
+node_a = Node(
+    'first_node',
+    {"category": "foo", "properties": "bar", "links": "biz", "oneOf": "baz"},
+    'test_project',
+    False)
+node_b = Node(
+    'second_node',
+    {"category": "aoo", "properties": "aar", "links": "aiz", "oneOf": "aaz"},
+    'test_project',
+    False)
+example_submission_order = [node_a, node_b]
+
+
+def test_write_to_file_or_log_error_succeeds(tmpdir):
+    """ asking for tmpdir in the parameter provides an empty test directory for testing """
+    test_path = tmpdir.mkdir("test-data").join("DataImportOrderPath.txt")
+    succeeded = write_submission_order_to_file(example_submission_order, test_path)
+    assert succeeded and os.path.getsize(test_path) > 0
+
+def test_write_to_file_or_log_error_fails():
+    write_result = attempt(lambda: write_submission_order_to_file(example_submission_order, "/test-path"))
+    assert not write_result["success"]