fix: git commit and SimCfg revision info

This is still a bit messy, because we do not have ideal abstractions in
place for the cfgs/flows. It might also be nice to separate out the
revision info from the IP Meta even more in the future - some of the
abstractions here still feel a bit arbitrary.

This corrects a few issues with regards to current git commit / revision
handling:
 - Report the short commit hash returned by git, not just an arbitrarily
   truncated hash.
 - The deploy commit is now listed correctly, instead of picking up the
   sim_cfg "revision" string which is generally not the same as the
   commit.
 - While the commit hash, branch and URL are used alternatively, the
   overriding "revision" string from the expanded SimCfg is now also
   picked up into IP metadata right now. This will need to be surfaced
   for Markdown reporting later. It currently isn't used in the HTML
   report, but probably should be later.

Signed-off-by: Alex Jones <alex.jones@lowrisc.org>

Author: AlexJones0

src/dvsim/job/deploy.py

@@ -117,9 +117,11 @@ def get_job_spec(self) -> "JobSpec":
             block=IPMeta(
                 name=self.sim_cfg.name,
                 variant=self.sim_cfg.variant,
-                commit=self.sim_cfg.revision,
+                commit=self.sim_cfg.commit,
+                commit_short=self.sim_cfg.commit_short,
                 branch=self.sim_cfg.branch,
                 url="",
+                revision_info=self.sim_cfg.revision,
             ),
             tool=ToolMeta(
                 name=self.sim_cfg.tool,

src/dvsim/report/data.py

@@ -24,10 +24,14 @@ class IPMeta(BaseModel):
 
     commit: str
     """Git commit sha of the IP the tests are run against."""
+    commit_short: str
+    """Shortened Git commit sha of the IP the tests are run against."""
     branch: str
     """Git branch"""
     url: str
     """URL to where the IP can be found in git (e.g. github)."""
+    revision_info: str | None
+    """Optional revision info string to use for custom info instead of the above fields."""
 
     def variant_name(self, sep: str = "_") -> str:
         """Name suffixed with the variant for disambiguation."""

src/dvsim/sim/flow.py

@@ -168,6 +168,11 @@ def __init__(self, flow_cfg_file, hjson_data, args, mk_config) -> None:
 
         super().__init__(flow_cfg_file, hjson_data, args, mk_config)
 
+        # After initialisation & expansion, save some useful revision metadata
+        proj_root = Path(self.proj_root)
+        self.commit = git_commit_hash(path=proj_root, short=False)
+        self.commit_short = git_commit_hash(path=proj_root, short=True)
+
     def _expand(self) -> None:
         # Choose a wave format now. Note that this has to happen after parsing
         # the configuration format because our choice might depend on the
@@ -603,7 +608,6 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
         """
         repo_root = Path(self.proj_root)
         reports_dir = Path(self.scratch_base_path) / "reports"
-        commit = git_commit_hash(path=repo_root)
         url = git_https_url_with_commit(path=repo_root)
         build_seed = self.build_seed if not self.run_only else None
 
@@ -625,7 +629,6 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
 
             flow_results: SimFlowResults = item._gen_json_results(
                 run_results=item_results,
-                commit=commit,
                 url=url,
             )
 
@@ -651,9 +654,11 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
             top = IPMeta(
                 name=self.name,
                 variant=self.variant,
-                commit=commit,
+                commit=self.commit,
+                commit_short=self.commit_short,
                 branch=self.branch,
                 url=url,
+                revision_info=self.revision,
             )
 
         results_summary = SimResultsSummary(
@@ -674,14 +679,12 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
     def _gen_json_results(
         self,
         run_results: Sequence[CompletedJobStatus],
-        commit: str,
         url: str,
     ) -> SimFlowResults:
         """Generate structured SimFlowResults from simulation run data.
 
         Args:
             run_results: completed job status.
-            commit: git commit Hash
             url: for the IP source
 
         Returns:
@@ -698,9 +701,11 @@ def _gen_json_results(
         block = IPMeta(
             name=self.name.lower(),
             variant=(self.variant or "").lower() or None,
-            commit=commit,
+            commit=self.commit,
+            commit_short=self.commit_short,
             branch=self.branch or "",
             url=url,
+            revision_info=self.revision,
         )
         tool = ToolMeta(name=self.tool.lower(), version="unknown")
 

src/dvsim/templates/reports/block_report.html

@@ -51,7 +51,7 @@ <h2>Simulation Results: {{ block.variant_name(sep='/') }}</h2>
             {% endif %}
             <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
                href="{{ block.url }}">
-                sha: {{ block.commit[:7] }}
+                sha: {{ block.commit_short }}
             </a>
             <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
                         href="{{ block.variant_name() }}.json">json</a>

src/dvsim/templates/reports/summary_report.html

@@ -51,7 +51,7 @@ <h2>{{ title }}</h2>
             {% endif %}
             <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
                 href="{{ meta_info.url }}">
-                sha: {{ meta_info.commit[:7] }}
+                sha: {{ meta_info.commit_short }}
             </a>
             <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
                 href="index.json">json</a>

tests/test_scheduler.py

@@ -247,8 +247,10 @@ def ip_meta_factory(**overrides: str | None) -> IPMeta:
         "name": "test_ip",
         "variant": None,
         "commit": "test_commit",
+        "commit_short": "test",
         "branch": "test_branch",
         "url": "test_url",
+        "revision_info": None,
     }
     meta.update(overrides)
     return IPMeta(**meta)