Enhance pytest report header to include Git branch, commit, and message details

Author: PierreRaybaut

cdl/tests/conftest.py

@@ -53,10 +53,10 @@ def pytest_report_header(config):  # pylint: disable=unused-argument
         qtbindings_version = qtpy.PYQT_VERSION
     infolist = [
         f"DataLab {cdl.__version__} [Plugins: {nfstr if nfstr else 'None'}]",
-        f"guidata {guidata.__version__}, PlotPy {plotpy.__version__}",
-        f"PythonQwt {qwt.__version__}, "
+        f"  guidata {guidata.__version__}, PlotPy {plotpy.__version__}",
+        f"  PythonQwt {qwt.__version__}, "
         f"{qtpy.API_NAME} {qtbindings_version} [Qt version: {qtpy.QT_VERSION}]",
-        f"NumPy {numpy.__version__}, SciPy {scipy.__version__}, "
+        f"  NumPy {numpy.__version__}, SciPy {scipy.__version__}, "
         f"h5py {h5py.__version__}, scikit-image {skimage.__version__}",
     ]
     try:
@@ -65,17 +65,32 @@ def pytest_report_header(config):  # pylint: disable=unused-argument
         infolist[-1] += f", OpenCV {cv2.__version__}"
     except ImportError:
         pass
+    envlist = []
     for vname in ("CDL_DATA", "PYTHONPATH", "DEBUG", "QT_API", "QT_QPA_PLATFORM"):
         value = os.environ.get(vname, "")
         if value:
-            infolist.append(f"{vname}: {value}")
+            if vname == "PYTHONPATH":
+                pathlist = value.split(os.pathsep)
+                envlist.append(f"  {vname}:")
+                envlist.extend(f"    {p}" for p in pathlist if p)
+            else:
+                envlist.append(f"  {vname}: {value}")
+    if envlist:
+        infolist.append("Environment variables:")
+        infolist.extend(envlist)
     sco = subprocess.check_output
     try:
+        gitlist = ["Git information:"]
         branch = sco(["git", "rev-parse", "--abbrev-ref", "HEAD"], text=True).strip()
         commit = sco(["git", "rev-parse", "--short", "HEAD"], text=True).strip()
         message = sco(["git", "log", "-1", "--pretty=%B"], text=True).strip()
-        message = message[:35] + "[…]" if len(message) > 35 else message
-        infolist.append(f"Git branch: {branch}, commit: {message} ({commit})")
+        if len(message.splitlines()) > 1:
+            message = message.splitlines()[0]
+        message = message[:60] + "[…]" if len(message) > 60 else message
+        gitlist.append(f"  Branch: {branch}")
+        gitlist.append(f"  Commit: {commit}")
+        gitlist.append(f"  Message: {message}")
+        infolist.extend(gitlist)
     except (subprocess.CalledProcessError, FileNotFoundError):
         pass
     return infolist