provide more descriptive message on multiple jobs found

Author: exkson

ceph_devstack/resources/ceph/__init__.py

@@ -236,10 +236,11 @@ async def logs(
             log_file = self.get_log_file(run_name, job_id)
         except FileNotFoundError:
             logger.error("No log file found")
-        except TooManyJobsFound:
-            logger.error(
-                "Found too many jobs for target run. Please pick a job id with -j flag."
+        except TooManyJobsFound as e:
+            msg = "Found too many jobs: {jobs} for target run. Please pick a job id with -j flag.".format(
+                jobs=", ".join(e.jobs)
             )
+            logger.error(msg)
         else:
             if locate:
                 print(log_file)

ceph_devstack/resources/ceph/exceptions.py

@@ -1,2 +1,3 @@
 class TooManyJobsFound(Exception):
-    pass
+    def __init__(self, jobs: list[str]):
+        self.jobs = jobs

ceph_devstack/resources/ceph/utils.py

@@ -40,5 +40,5 @@ def get_job_id(jobs: list[str]):
     if len(dirs) == 0:
         raise FileNotFoundError
     elif len(dirs) > 1:
-        raise TooManyJobsFound
+        raise TooManyJobsFound(dirs)
     return dirs[0]

ceph_devstack/resources/test/test_devstack.py

@@ -47,8 +47,9 @@ def test_get_job_id_throws_filenotfound_on_missing_job(self):
 
     def test_get_job_id_throws_toomanyjobsfound_on_more_than_one_job(self):
         jobs = ["1", "2"]
-        with pytest.raises(TooManyJobsFound):
+        with pytest.raises(TooManyJobsFound) as exc:
             get_job_id(jobs)
+            assert exc.value.dirs == jobs
 
     async def test_logs_command_display_log_file_of_latest_run(self):
         with tempfile.TemporaryDirectory() as data_dir: