simplify tests

src/auto_ir_metadata/utils.py

@@ -102,7 +102,7 @@ def _notebook_contents() -> tuple[Path, Path]:
 
     ipython = get_ipython()  # type: ignore
 
-    f = Path(tempfile.TemporaryDirectory().name + '-1234')
+    f = Path(tempfile.TemporaryDirectory().name + "-1234")
     f.mkdir(parents=True, exist_ok=True)
     python_file = Path(f) / "script.py"
     notebook_file = Path(f) / "notebook.ipynb"

test/PythonScriptApprovalTests.test_for_jupyter_notebook_in_valid_git_repo.approved.json

@@ -1,21 +1,11 @@
 {
-    "file": {
-        "content": "# coding: utf-8\nimport sys, os\nsys.path.append('/home/vscode/.local/lib/python3.12/site-packages/runnb')\nimport tee\nsys.stdin = tee.Tee(sys.__stdin__, sys.stdin)\nsys.stdout = tee.Tee(sys.__stdout__, sys.stdout)\nsys.stderr = tee.Tee(sys.__stderr__, sys.stderr)\ndel sys.modules['tee']\ndel tee\nimport click\nimport pandas as pd\nimport pyterrier as pt\nfrom auto_ir_metadata import persist_ir_metadata\nrun = pd.DataFrame([\n    {\"qid\": \"q-1\", \"docno\": \"doc-01\", \"rank\": 1, \"score\": 10},\n    {\"qid\": \"q-1\", \"docno\": \"doc-02\", \"rank\": 2, \"score\": 9},\n    {\"qid\": \"q-1\", \"docno\": \"doc-03\", \"rank\": 3, \"score\": 8},\n])\n\noutput_directory = \".\"\n\npt.io.write_results(run, f\"{output_directory}/run.txt\", format=\"trec\")\npersist_ir_metadata(output_directory, system_name='my-system', system_description='my-description')\n",
-        "name": "script.py"
-    },
+    "file": "OMMITTED.",
     "git": "OMMITTED.",
     "notebook": "OMMITTED.",
     "pkg_resources": [
         "python-terrier==0.12.0"
     ],
-    "sys": {
-        "argv": [],
-        "executable": "python3",
-        "modules": [
-            "pyterrier"
-        ],
-        "version_info": "3.XY.XY"
-    },
+    "sys": "OMMITTED.",
     "system_description": "my-description",
     "system_name": "my-system"
 }

test/PythonScriptApprovalTests.test_for_valid_git_repo.approved.json

@@ -1,10 +1,7 @@
 {
     "elapsed time": "OMMITTED.",
     "energy": {},
-    "file": {
-        "content": "#!/usr/bin/env python3\nfrom pathlib import Path\n\nimport click\nimport pandas as pd\nimport pyterrier as pt\n\nfrom auto_ir_metadata import Environment, persist_ir_metadata\n\n\n@click.command()\n@click.argument(\"output-directory\", type=Path)\ndef main(output_directory):\n    with Environment().measure() as tracker:\n        run = pd.DataFrame(\n            [\n                {\"qid\": \"q-1\", \"docno\": \"doc-01\", \"rank\": 1, \"score\": 10},\n                {\"qid\": \"q-1\", \"docno\": \"doc-02\", \"rank\": 2, \"score\": 9},\n                {\"qid\": \"q-1\", \"docno\": \"doc-03\", \"rank\": 3, \"score\": 8},\n            ]\n        )\n    output_directory.mkdir(exist_ok=True, parents=True)\n    pt.io.write_results(run, output_directory / \"run.txt\", format=\"trec\")\n    persist_ir_metadata(output_directory, 'my-system-name', 'my-description', tracker)\n\n\nif __name__ == \"__main__\":\n    main()\n",
-        "name": "example-script.py"
-    },
+    "file": "OMMITTED.",
     "git": "OMMITTED.",
     "gpu": {
         "supported": "0"
@@ -13,16 +10,7 @@
         "python-terrier==0.12.0"
     ],
     "resources": "OMMITTED.",
-    "sys": {
-        "argv": [
-            "example-script.py"
-        ],
-        "executable": "python3",
-        "modules": [
-            "pyterrier"
-        ],
-        "version_info": "3.XY.XY"
-    },
+    "sys": "OMMITTED.",
     "system": "OMMITTED.",
     "system_description": "my-description",
     "system_name": "my-system-name"

test/PythonScriptApprovalTests.test_for_valid_git_repo_without_emissions.approved.json

@@ -1,20 +1,8 @@
 {
-    "file": {
-        "content": "#!/usr/bin/env python3\nfrom pathlib import Path\n\nimport click\nimport pandas as pd\nimport pyterrier as pt\n\nfrom auto_ir_metadata import persist_ir_metadata\n\n\n@click.command()\n@click.argument(\"output-directory\", type=Path)\ndef main(output_directory):\n    run = pd.DataFrame(\n        [\n            {\"qid\": \"q-1\", \"docno\": \"doc-01\", \"rank\": 1, \"score\": 10},\n            {\"qid\": \"q-1\", \"docno\": \"doc-02\", \"rank\": 2, \"score\": 9},\n            {\"qid\": \"q-1\", \"docno\": \"doc-03\", \"rank\": 3, \"score\": 8},\n        ]\n    )\n    output_directory.mkdir(exist_ok=True, parents=True)\n    pt.io.write_results(run, output_directory / \"run.txt\", format=\"trec\")\n    persist_ir_metadata(output_directory)\n\n\nif __name__ == \"__main__\":\n    main()\n",
-        "name": "example-script-without-emissions.py"
-    },
+    "file": "OMMITTED.",
     "git": "OMMITTED.",
     "pkg_resources": [
         "python-terrier==0.12.0"
     ],
-    "sys": {
-        "argv": [
-            "example-script-without-emissions.py"
-        ],
-        "executable": "python3",
-        "modules": [
-            "pyterrier"
-        ],
-        "version_info": "3.XY.XY"
-    }
+    "sys": "OMMITTED."
 }

test/test_python_script.py

@@ -35,18 +35,20 @@ def run_command_and_return_persisted_metadata(command, include_path=False):
         actual["sys"]["argv"] = [i.split("/")[-1] for i in actual["sys"]["argv"] if "example" in i]
         actual["sys"]["modules"] = [i for i in actual["sys"]["modules"] if "terrier" in i]
         actual["pkg_resources"] = [i for i in actual["pkg_resources"] if "python-terrier" in i]
-        if "git" in actual:
-            actual["git"] = "OMMITTED."
-        if "codecarbon_emissions" in actual:
-            actual["codecarbon_emissions"] = "OMMITTED."
-        if "resources" in actual:
-            actual["resources"] = "OMMITTED."
-        if "system" in actual:
-            actual["system"] = "OMMITTED."
-        if "notebook" in actual:
-            actual["notebook"] = "OMMITTED."
-        if "elapsed time" in actual:
-            actual["elapsed time"] = "OMMITTED."
+
+        for field_to_omit in [
+            "sys",
+            "git",
+            "git",
+            "codecarbon_emissions",
+            "resources",
+            "system",
+            "notebook",
+            "file",
+            "elapsed time",
+        ]:
+            if field_to_omit in actual:
+                actual[field_to_omit] = "OMMITTED."
 
         if include_path:
             actual["path"] = Path(f)