feat: use current checked out commit hash in UploadMetadata

Author: adriencaccia

Cargo.lock

@@ -32,6 +32,7 @@ base64 = "0.21.0"
 async-compression = { version = "0.4.5", features = ["tokio", "gzip"] }
 simplelog = { version = "0.12.1", default-features = false }
 tempfile = "3.10.0"
+git2 = "0.18.3"
 
 [dev-dependencies]
 temp-env = { version = "0.3.6", features = ["async_closure"] }

Cargo.toml

@@ -142,7 +142,6 @@ impl CIProvider for BuildkiteProvider {
         Ok(ProviderMetadata {
             base_ref: self.base_ref.clone(),
             head_ref: self.head_ref.clone(),
-            commit_hash: self.commit_hash.clone(),
             event: self.event.clone(),
             owner: self.owner.clone(),
             repository: self.repository.clone(),

src/ci_provider/buildkite/provider.rs

@@ -1,14 +1,13 @@
 ---
 source: src/ci_provider/buildkite/provider.rs
-expression: upload_metadata
+expression: provider_metadata
 ---
 {
   "ref": "refs/pull/22/merge",
   "headRef": "feat/codspeed-runner",
   "baseRef": "main",
   "owner": "my-org",
   "repository": "adrien-python-test",
-  "commitHash": "abc123",
   "event": "pull_request",
   "ghData": null,
   "repositoryRootPath": "/buildkite/builds/7b10eca7600b-1/my-org/buildkite-test/"

src/ci_provider/buildkite/snapshots/codspeed_runner__ci_provider__buildkite__provider__tests__pull_request_provider_metadata.snap

@@ -132,7 +132,6 @@ impl CIProvider for GitHubActionsProvider {
         Ok(ProviderMetadata {
             base_ref: self.base_ref.clone(),
             head_ref: self.head_ref.clone(),
-            commit_hash: self.commit_hash.clone(),
             event: self.event.clone(),
             gh_data: Some(self.gh_data.clone()),
             owner: self.owner.clone(),

src/ci_provider/github_actions/provider.rs

@@ -1,14 +1,13 @@
 ---
 source: src/ci_provider/github_actions/provider.rs
-expression: upload_metadata
+expression: provider_metadata
 ---
 {
   "ref": "refs/pull/22/merge",
   "headRef": "fork-owner:feat/codspeed-runner",
   "baseRef": "main",
   "owner": "my-org",
   "repository": "adrien-python-test",
-  "commitHash": "24809d9fca9ad0808a777bcbd807ecd5ec8a9100",
   "event": "pull_request",
   "ghData": {
     "runId": 6957110437,

src/ci_provider/github_actions/snapshots/codspeed_runner__ci_provider__github_actions__provider__tests__fork_pull_request_provider_metadata.snap

@@ -1,14 +1,13 @@
 ---
 source: src/ci_provider/github_actions/provider.rs
-expression: upload_metadata
+expression: provider_metadata
 ---
 {
   "ref": "refs/pull/22/merge",
   "headRef": "feat/codspeed-runner",
   "baseRef": "main",
   "owner": "my-org",
   "repository": "adrien-python-test",
-  "commitHash": "24809d9fca9ad0808a777bcbd807ecd5ec8a9100",
   "event": "pull_request",
   "ghData": {
     "runId": 6957110437,

src/ci_provider/github_actions/snapshots/codspeed_runner__ci_provider__github_actions__provider__tests__pull_request_provider_metadata.snap

@@ -9,7 +9,6 @@ pub struct ProviderMetadata {
     pub base_ref: Option<String>,
     pub owner: String,
     pub repository: String,
-    pub commit_hash: String,
     pub event: RunEvent,
     pub gh_data: Option<GhData>,
     pub repository_root_path: String,

src/ci_provider/interfaces.rs

@@ -1,3 +1,4 @@
+use git2::Repository;
 use simplelog::SharedLogger;
 
 use crate::config::Config;
@@ -11,6 +12,20 @@ pub trait CIProviderDetector {
     fn detect() -> bool;
 }
 
+fn get_commit_hash(repository_root_path: &str) -> Result<String> {
+    let repo = Repository::open(repository_root_path).context(format!(
+        "Failed to open repository at path: {}",
+        repository_root_path
+    ))?;
+
+    let commit_hash = repo
+        .revparse_single("HEAD")
+        .context("Failed to get HEAD commit")?
+        .id()
+        .to_string();
+    Ok(commit_hash)
+}
+
 /// `CIProvider` is a trait that defines the necessary methods for a continuous integration provider.
 pub trait CIProvider {
     /// Returns the logger for the CI provider.
@@ -58,11 +73,14 @@ pub trait CIProvider {
     fn get_upload_metadata(&self, config: &Config, archive_hash: &str) -> Result<UploadMetadata> {
         let provider_metadata = self.get_provider_metadata()?;
 
+        let commit_hash = get_commit_hash(&provider_metadata.repository_root_path)?;
+
         Ok(UploadMetadata {
             version: Some(2),
             tokenless: config.token.is_none(),
             provider_metadata,
             profile_md5: archive_hash.into(),
+            commit_hash,
             runner: Runner {
                 name: "codspeed-runner".into(),
                 version: crate::VERSION.into(),
@@ -72,3 +90,15 @@ pub trait CIProvider {
         })
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_get_commit_hash() {
+        let commit_hash = get_commit_hash(env!("CARGO_MANIFEST_DIR")).unwrap();
+        // ensure that the commit hash is correct, thus it has 40 characters
+        assert_eq!(commit_hash.len(), 40);
+    }
+}

src/ci_provider/provider.rs

@@ -10,6 +10,7 @@ pub struct UploadMetadata {
     pub profile_md5: String,
     pub runner: Runner,
     pub platform: String,
+    pub commit_hash: String,
     #[serde(flatten)]
     pub provider_metadata: ProviderMetadata,
 }