Simplify report API call, pass output file instead output dir

Author: varmar05

mergin/report.py

@@ -167,18 +167,18 @@ def report(self):
         return records
 
 
-def create_report(mc, directory, project, since, to, out_dir=tempfile.gettempdir()):
+def create_report(mc, directory, since, to, out_file):
     """ Creates report from geodiff changesets for a range of project versions in CSV format.
 
     Args:
         mc (MerginClient): MerginClient instance.
         directory (str): local project directory (must already exist).
-        project (str): full project name (<namespace/project>).
         since (str): starting project version tag, for example 'v3'.
         to (str): ending project version tag, for example 'v6'.
-        out_dir (str): output directory to save report.csv in, defaults to temp dir
+        out_file (str): output file to save csv in
     """
     mp = MerginProject(directory)
+    project = mp.metadata["name"]
     mp.log.info(f"--- Creating changesets report for {project} from {since} to {to} versions ----")
     versions_map = {v["name"]: v for v in mc.project_versions(project, since, to)}
     headers = ["file", "table", "author", "date", "time", "version", "operation", "length", "area", "count"]
@@ -245,10 +245,10 @@ def create_report(mc, directory, project, since, to, out_dir=tempfile.gettempdir
             raise ClientError("Reporting failed, please check log for details")
 
     # export report to csv file
-    proj_name = project.replace(os.path.sep, "-")
-    report_file = os.path.join(out_dir, f'report-{proj_name}-{since}-{to}.csv')
-    with open(report_file, 'w', newline='') as f_csv:
+    out_dir = os.path.dirname(out_file)
+    os.makedirs(out_dir, exist_ok=True)
+    with open(out_file, 'w', newline='') as f_csv:
         writer = csv.DictWriter(f_csv, fieldnames=headers)
         writer.writeheader()
         writer.writerows(records)
-    mp.log.info(f"--- Report saved to {report_file} ----")
+    mp.log.info(f"--- Report saved to {out_file} ----")

mergin/test/test_client.py

@@ -9,6 +9,7 @@
 import pytz
 import sqlite3
 
+from .. import InvalidProject
 from ..client import MerginClient, ClientError, MerginProject, LoginError, decode_token_data, TokenError
 from ..client_push import push_project_async, push_project_cancel
 from ..utils import (
@@ -1630,9 +1631,11 @@ def test_report(mc):
     directory = mp.dir
     since = "v2"
     to = "v4"
-    create_report(mc, directory, project, since, to, TMP_DIR)
     proj_name = project.replace(os.path.sep, "-")
-    report_file = os.path.join(TMP_DIR, f'report-{proj_name}-{since}-{to}.csv')
+    report_file = os.path.join(TMP_DIR, "report", f'{proj_name}-{since}-{to}.csv')
+    if os.path.exists(report_file):
+        os.remove(report_file)
+    create_report(mc, directory, since, to, report_file)
     assert os.path.exists(report_file)
     # assert headers and content in report file
     with open(report_file, "r") as rf:
@@ -1643,3 +1646,8 @@ def test_report(mc):
         assert "v3,update,,,2" in content
         # files not edited are not in reports
         assert "inserted_1_A.gpkg" not in content
+
+    # rm local mergin project and try again
+    shutil.rmtree(directory)
+    with pytest.raises(InvalidProject):
+        create_report(mc, directory, since, to, report_file)