From eafebda3f0593e0bdd246c10396838b79da41916 Mon Sep 17 00:00:00 2001
From: Tim Pillinger <26465611+wxtim@users.noreply.github.com>
Date: Thu, 1 Aug 2024 13:46:30 +0100
Subject: [PATCH] added subprocess failure management

---
 cylc/sphinx_ext/metadata/__init__.py | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/cylc/sphinx_ext/metadata/__init__.py b/cylc/sphinx_ext/metadata/__init__.py
index 7b445d7..8305b97 100644
--- a/cylc/sphinx_ext/metadata/__init__.py
+++ b/cylc/sphinx_ext/metadata/__init__.py
@@ -79,6 +79,10 @@ def append(self, text, underline=None):
         super().append('', '', 1)
 
 
+class DependencyError(Exception):
+    ...
+
+
 class CylcMetadata(SphinxDirective):
     """Represent a Cylc Config.
     """
@@ -125,6 +129,9 @@ def load_global_cfg(conf_path=None):
             )
         else:
             sub = run(['cylc', 'config', '--json'], capture_output=True)
+
+        CylcMetadata.check_subproc_output(sub)
+
         return json.loads(sub.stdout)
 
     @staticmethod
@@ -211,6 +218,7 @@ def load_workflow_cfg(conf_path):
             ['cylc', 'config', '--json', conf_path],
             capture_output=True,
         )
+        CylcMetadata.check_subproc_output(sub)
         return json.loads(sub.stdout)
 
     @staticmethod
@@ -294,3 +302,22 @@ def write_section(rst, section, title_level='^'):
 
         # Description
         rst.append(section.get('description', ''))
+
+    @staticmethod
+    def check_subproc_output(sub):
+        """Check subprocess outputs - catch failure.
+        """
+        if sub.returncode:
+            # Very specifically handle the case where the correct
+            # version of Cylc isn't installed:
+            if 'no such option: --json' in sub.stderr.decode():
+                msg = (
+                    'Requires cylc config --json, not available'
+                    ' for this version of Cylc')
+                raise DependencyError(msg)
+            # Handle any and all other errors in the subprocess:
+            else:
+                msg = 'Cylc config metadata failed with: \n'
+                msg += '\n'.join(
+                    i.strip("\n") for i in sub.stderr.decode().split('\n'))
+                raise Exception(msg)