Update tests to use tmp_path to avoid writing over actual files

Also update test functionality

Author: OCopping

tests/conftest.py

@@ -1,3 +1,4 @@
+import shutil
 from pathlib import Path
 from unittest.mock import MagicMock, Mock, patch
 
@@ -118,15 +119,18 @@ def components(builder_with_test_files: Builder):
 
 
 @pytest.fixture
-def json_map_generator():
+def json_map_generator(tmp_path):
     return JsonMapGenerator(
-        Path(__file__).parent.joinpath(Path("t01-services/synoptic/index.bob"))
+        Path(__file__).parent.joinpath(Path("t01-services/synoptic/index.bob")),
+        output=tmp_path,
     )
 
 
 @pytest.fixture
-def status_gen():
-    return GenerateStatusPvs(Path("tests/t01-services/synoptic/techui.yaml").absolute())
+def status_gen(tmp_path):
+    return GenerateStatusPvs(
+        Path("tests/t01-services/synoptic/techui.yaml").absolute(), output=tmp_path
+    )
 
 
 @pytest.fixture
@@ -145,12 +149,15 @@ def example_json_map_root():
 
 
 @pytest.fixture
-def json_map_generator_with_test_files():
+def json_map_generator_with_test_files(tmp_path):
+    # Copy test files to tmp_path so they are visible to the tests
+    shutil.copytree(Path("tests/test_files/"), tmp_path / "test_files")
+    shutil.copytree(Path(__file__).parent / "t01-services", tmp_path / "t01-services")
+
     return JsonMapGenerator(
-        bob_path=Path("tests/test_files/test_bob.bob").absolute(),
-        techui=Path(__file__).parent.joinpath(
-            Path("t01-services/synoptic/techui.yaml")
-        ),
+        bob_path=tmp_path / "test_files/test_bob.bob",
+        techui=tmp_path / "t01-services/synoptic/techui.yaml",
+        output=tmp_path / "test_files",
     )
 
 

tests/test_files/test_bob_embedded.bob

@@ -21,11 +21,16 @@ $(pv_value)
 $(actions)</tooltip>
   </widget>
   <widget type="embedded" version="2.0.0">
-    <name>Embedded Display</name>
+    <name>Z</name>
+    <width>220</width>
+    <height>120</height>
     <file>motor_embed.bob</file>
+    <macros>
+      <P>BL01T-MO-MOTOR-01</P>
+      <M>:EMBED</M>
+      <label>EMBED</label>
+    </macros>
     <x>150</x>
     <y>120</y>
-    <width>160</width>
-    <height>80</height>
   </widget>
 </display>

tests/test_generate_jsonmap.py

@@ -31,10 +31,12 @@ def test_write_json_map_no_synoptic(json_map_generator):
         json_map_generator.write_json_map()
 
 
-def test_app():
-    result = runner.invoke(app, ["tests/t01-services/synoptic/techui.yaml"])
-    if Path.exists(Path("tests/t01-services/synoptic/JsonMap.json")):
-        os.remove("tests/t01-services/synoptic/JsonMap.json")
+def test_app(tmp_path):
+    result = runner.invoke(
+        app, ["tests/t01-services/synoptic/index.bob", "--output", tmp_path]
+    )
+    if Path.exists(Path(tmp_path / "JsonMap.json")):
+        os.remove(tmp_path / "JsonMap.json")
     assert result.exit_code == 0
 
 
@@ -48,18 +50,14 @@ def test_json_map_generator_techui_exception(
     assert "No such file or directory" in str(excinfo.value)
 
 
-def test_write_json_map(json_map_generator):
+def test_write_json_map(json_map_generator, tmp_path):
     test_map = JsonMap(
         str(Path(__file__).parent.joinpath("test_files/test_bob.bob")), None
     )
 
     # We don't want cover _generate_json_map in this test
     json_map_generator.generate_json_map = Mock(return_value=test_map)
 
-    # Make sure opis/ dir exists
-    if not Path.exists(json_map_generator._write_directory):
-        os.mkdir(json_map_generator._write_directory)
-
     # We don't want to access the _serialise_json_map function in this test
     with patch(
         "techui_builder.generate_jsonmap._serialise_json_map"
@@ -71,20 +69,16 @@ def test_write_json_map(json_map_generator):
     dest_path = json_map_generator._write_directory.joinpath("JsonMap.json")
     assert Path.exists(dest_path)
 
-    if Path.exists(dest_path):
-        os.remove(dest_path)
-
 
 # We don't want to access the _get_action_group function in this test
 @patch("techui_builder.generate_jsonmap._get_action_group")
 def test_generate_json_map(
     mock_get_action_group: MagicMock,
     json_map_generator_with_test_files,
     example_json_map,
+    tmp_path,
 ):
-    json_map_generator_with_test_files.bob_path = Path(
-        "tests/test_files/test_bob.bob"
-    ).absolute()
+    json_map_generator_with_test_files.bob_path = tmp_path / "test_files/test_bob.bob"
 
     mock_xml = objectify.Element("action")
     mock_xml["file"] = "test_child_bob.bob"
@@ -105,7 +99,7 @@ def test_generate_json_map(
 
 
 def test_generate_json_map_embedded_screen(
-    json_map_generator_with_test_files, example_json_map
+    json_map_generator_with_test_files, example_json_map, tmp_path
 ):
     list_names = [
         "Display",
@@ -121,17 +115,17 @@ def test_generate_json_map_embedded_screen(
         side_effect=list_names
     )
 
-    json_map_generator_with_test_files.bob_path = Path(
-        "tests/test_files/test_bob_embedded.bob"
-    ).absolute()
+    json_map_generator_with_test_files.bob_path = (
+        tmp_path / "test_files/test_bob_embedded.bob"
+    )
 
     example_json_map.file = "test_bob_embedded.bob"
     example_json_map.children.append(
         JsonMap(
             "$(IOC)/pmacAxis.pvi.bob",
             display_name="Embedded Display",
             exists=False,
-            macros={"M": "$(M)", "P": "$(P)"},
+            macros={"M": ":EMBED", "P": "BL01T-MO-MOTOR-01", "label": "EMBED"},
         )
     )
 
@@ -143,7 +137,7 @@ def test_generate_json_map_embedded_screen(
 
 
 def test_generate_json_map_nav_tabs(
-    json_map_generator_with_test_files, example_json_map_root
+    json_map_generator_with_test_files, example_json_map_root, tmp_path
 ):
     json_map_generator_with_test_files._parse_display_name = Mock(
         side_effect=["Display", "Tab1", "Tab2"]
@@ -152,9 +146,9 @@ def test_generate_json_map_nav_tabs(
         side_effect=["Display", "Tab1", "Tab2"]
     )
 
-    json_map_generator_with_test_files.bob_path = Path(
-        "tests/test_files/test_bob_navtabs.bob"
-    ).absolute()
+    json_map_generator_with_test_files.bob_path = (
+        tmp_path / "test_files/test_bob_navtabs.bob"
+    )
 
     example_json_map_root.file = "test_bob_navtabs.bob"
     example_json_map_root.children.extend(
@@ -265,11 +259,11 @@ def test_generate_json_map_get_macros(
 
 
 def test_generate_json_map_xml_parse_error(
-    json_map_generator_with_test_files,
+    json_map_generator_with_test_files, tmp_path
 ):
-    json_map_generator_with_test_files.bob_path = Path(
-        "tests/test_files/test_bob_bad.bob"
-    ).absolute()
+    json_map_generator_with_test_files.bob_path = (
+        tmp_path / "test_files/test_bob_bad.bob"
+    )
 
     test_json_map = json_map_generator_with_test_files.generate_json_map(
         json_map_generator_with_test_files.bob_path,