Jote now injects a value for CODE_DIRECTORY

Author: Alan Christie

README.rst

@@ -60,6 +60,20 @@ You can display the utility's help with::
 
     jote --help
 
+Built-in variables
+------------------
+
+Job definition command-expansion relies on a number of *built in* variables.
+Some are provided by the Data Manager when the Job runs under its control
+(i.e. ``DM_INSTANCE_DIRECTORY``) others are built-in to ``jote``.
+
+The set of variables injected into the command expansion by ``jote``
+are: -
+
+- ``DM_INSTANCE_DIRECTORY``. Set to the path of the simulated instance
+  directory created by ``jote``
+- ``CODE_DIRECTORY``. Set to the root of the repository clone under test
+
 Ignoring tests
 --------------
 

src/jote/compose.py

@@ -183,10 +183,13 @@ def run(self, timeout_minutes: int = DEFAULT_TEST_TIMEOUT_M)\
         A non-zero exit code does not necessarily mean the test has failed.
         """
 
+        execution_directory: str = self.get_test_path()
+
         print('# Executing the test ("docker-compose up")...')
+        print(f'# Execution directory is "{execution_directory}"')
 
         cwd = os.getcwd()
-        os.chdir(self.get_test_path())
+        os.chdir(execution_directory)
 
         try:
             # Run the container

src/jote/jote.py

@@ -322,6 +322,9 @@ def _run_nextflow(command: str,
             print('! You cannot test Jobs and have your own config file')
             return 1, '', ''
 
+    print('# Executing the test ("nextflow")...')
+    print(f'# Execution directory is "{project_path}"')
+
     cwd = os.getcwd()
     os.chdir(project_path)
 
@@ -479,9 +482,13 @@ def _test(args: argparse.Namespace,
         decoded_command: str = ''
         if test_status:
 
-            # Job variables must contain 'built-in' variables: -
+            # Jote injects Job variables that are expected.
+            # 'DM_' variables are injected by the Data Manager,
+            # other are injected by Jote.
             # - DM_INSTANCE_DIRECTORY
             job_variables['DM_INSTANCE_DIRECTORY'] = INSTANCE_DIRECTORY
+            # - CODE_DIRECTORY
+            job_variables['CODE_DIRECTORY'] = os.getcwd()
 
             # Get the raw (encoded) command from the job definition...
             raw_command: str = job_definition.command