refactor: make cov_db_dirs deterministic

Sort the coverage database paths, while leaving the first path in place.
This should mean that the dumped deployment objects are now
deterministic. At the moment when comparing dumps often the only
difference is the order of these paths, adding unnecessary noise and
making it more difficult to check for meaningful differences.

Signed-off-by: James McCorrie <[email protected]>

Author: machshev

src/dvsim/job/deploy.py

@@ -711,6 +711,10 @@ def __init__(self, run_items, sim_cfg) -> None:
                 else:
                     self.cov_db_dirs.append(run.cov_db_dir)
 
+        # Sort the cov_db_dir except for the first directory
+        if len(self.cov_db_dirs) > 1:
+            self.cov_db_dirs = [self.cov_db_dirs[0], *sorted(self.cov_db_dirs[1:])]
+
         # Early lookup the cov_merge_db_dir, which is a mandatory misc
         # attribute anyway. We need it to compute additional cov db dirs.
         self.cov_merge_db_dir = subst_wildcards("{cov_merge_db_dir}", sim_cfg.__dict__)