refactor: migrate from Depoy.dump to JobSpec.model_dump

Now we have a Pydantic model that represents the full data requirement
of the scheduler, we can use the builtin `JobSpec.model_dump()` instead of
the custom `Deploy.dump()`. At the moment this model has to contain a
couple of callback functions which cannot be serialised, so these
attributes are excluded.

This commit does change the format of the dumped "deployment" objects
file. So if this is being used to check for breaking changes, then
hashes need to be compared against one generated from this commit from
now on.

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

Author: machshev

src/dvsim/flow/base.py

@@ -417,21 +417,30 @@ def deploy_objects(self) -> Sequence[CompletedJobStatus]:
             log.error("Nothing to run!")
             sys.exit(1)
 
+        jobs = [d.get_job_spec() for d in deploy]
+
         if os.environ.get("DVSIM_DEPLOY_DUMP", "true"):
             filename = f"deploy_{self.branch}_{self.timestamp}.json"
             (Path(self.scratch_root) / filename).write_text(
                 json.dumps(
                     # Sort on full name to ensure consistent ordering
                     sorted(
-                        [d.dump() for d in deploy],
-                        key=lambda d: d["full_name"],
+                        [
+                            j.model_dump(
+                                # callback functions can't be serialised
+                                exclude={"pre_launch", "post_finish"},
+                                mode="json",
+                            )
+                            for j in jobs
+                        ],
+                        key=lambda j: j["full_name"],
                     ),
                     indent=2,
                 ),
             )
 
         return Scheduler(
-            items=[d.get_job_spec() for d in deploy],
+            items=jobs,
             launcher_cls=get_launcher_cls(),
             interactive=self.interactive,
         ).run()

src/dvsim/job/deploy.py

@@ -350,25 +350,6 @@ def callback(status: str) -> None:
     def get_timeout_mins(self) -> float | None:
         """Return the timeout in minutes."""
 
-    def dump(self) -> Mapping:
-        """Dump the deployment object to mapping object.
-
-        Returns:
-            Representation of a deployment object as a dict.
-
-        """
-        job_spec = self.get_job_spec()
-        return {
-            "full_name": job_spec.full_name,
-            "type": self.__class__.__name__,
-            "exports": job_spec.exports,
-            "interactive": job_spec.interactive,
-            "log_path": str(job_spec.log_path),
-            "timeout_mins": job_spec.timeout_mins,
-            "cmd": job_spec.cmd,
-            "gui": job_spec.gui,
-        }
-
 
 class CompileSim(Deploy):
     """Abstraction for building the simulation executable."""