Now checks CWD (for yamllint and data-manager)

Now an error to have no tests pass
Doc tweak

Author: Alan Christie

README.rst

@@ -6,19 +6,22 @@ Data Manager Job implementation repositories against the Job's
 container image.
 
 Job implementations are required to provide a Job Definition (in the
-Job repository's ``data-manager`` directory) and at least one test, located in
-the repository's ``data-manager/tests`` directory. ``jote`` runs the tests
+Job repository's ``data-manager`` directory). The Job Definition should define
+at least one test for every Job in the file. ``jote`` runs the tests
 but also ensures the repository structure meets the Data Manager requirements.
 
-Tests are dined in the Job definition file in the block where the the test
-is defined. Here's a snippet illustrating a test called ``simple-execution``
-that defines an input option defining a file and some other command
-options along with a ``checks`` section that defines the exit criteria
-of a successful test::
+Tests are defined in the Job definition file. Here's a snippet illustrating a
+Job (``max-min-picker``) with a test called ``simple-execution``.
+
+The test defines an input option (a file) and some other command options.
+The ``checks`` section defines the exit criteria of a successful test.
+In this case the container must exit with code ``0`` and the file
+``diverse.smi`` must be found (in the mounted project directory), i.e
+it must *exist* and contain ``100`` lines::
 
     jobs:
       [...]
-      shard:
+      max-min-picker:
         [...]
         tests:
           simple-execution:

jote/jote.py

@@ -59,6 +59,27 @@ def _lint(definition_file: str) -> bool:
     return True
 
 
+def _check_cwd() -> bool:
+    """Checks the execution directory for sanity (cwd). Here we must find
+    a .yamllint file and a data-manager directory?
+    """
+    expected_files: List[str] = [_YAMLLINT_FILE]
+    for expected_file in expected_files:
+        if not os.path.isfile(expected_file):
+            print(f'! Expected file "{expected_file}"'
+                  ' but it is not here')
+            return False
+
+    expected_directories: List[str] = [_DEFINITION_DIRECTORY]
+    for expected_directory in expected_directories:
+        if not os.path.isdir(expected_directory):
+            print(f'! Expected directory "{expected_directory}"'
+                  ' but it is not here')
+            return False
+
+    return True
+
+
 def _load(skip_lint: bool = False) -> Tuple[List[DefaultMunch], int]:
     """Loads definition files (all the YAML files in a given directory)
     and extracts the definitions that contain at least one test.
@@ -373,6 +394,12 @@ def main() -> None:
     # Args are OK if we get here.
     test_fail_count: int = 0
 
+    # Check CWD
+    if not _check_cwd():
+        print('! FAILURE')
+        print('! The directory does not look correct')
+        arg_parser.error('Done (FAILURE)')
+
     # Load all the files we can and then run the tests.
     job_definitions, num_tests = _load(args.skip_lint)
     if num_tests < 0:
@@ -417,15 +444,19 @@ def main() -> None:
                 break
 
     # Success or failure?
+    # It's an error to find no tests.
     print('  ---')
     num_tests_passed: int = num_tests - test_fail_count
     dry_run: str = '[DRY RUN]' if args.dry_run else ''
     if test_fail_count:
-        print()
         arg_parser.error('Done (FAILURE)'
                          f' passed={num_tests_passed}'
                          f' failed={test_fail_count}'
                          f' {dry_run}')
+    elif num_tests_passed == 0:
+        arg_parser.error('Done (FAILURE)'
+                         f' passed={num_tests_passed}'
+                         f' (at least one test must pass) {dry_run}')
     else:
         print(f'Done (OK) passed={num_tests_passed} {dry_run}')