feat: make get_commit_hash different based on the provider

This allows us to add more detailed errors for github actions.

Author: GuillaumeLagrange

src/run/run_environment/github_actions/provider.rs

@@ -1,3 +1,4 @@
+use git2::Repository;
 use lazy_static::lazy_static;
 use regex::Regex;
 use serde_json::Value;
@@ -217,6 +218,24 @@ impl RunEnvironmentProvider for GitHubActionsProvider {
             metadata,
         })
     }
+
+    fn get_commit_hash(&self, repository_root_path: &str) -> Result<String> {
+        let repo = Repository::open(repository_root_path).context(format!(
+            "Failed to open repository at path: {repository_root_path}\n\
+            Make sure git is installed, and that `actions/checkout` used git to fetching the repository\n\
+            If necessary, install git before running `actions/checkout`.\n\
+            If running in docker and running into permission issues, you may need to also run \
+            `git config --global --add safe.directory $GITHUB_WORKSPACE` "
+        ))?;
+
+        let commit_hash = repo
+            .head()
+            .and_then(|head| head.peel_to_commit())
+            .context("Failed to get HEAD commit")?
+            .id()
+            .to_string();
+        Ok(commit_hash)
+    }
 }
 
 #[cfg(test)]

src/run/run_environment/provider.rs

@@ -16,20 +16,6 @@ pub trait RunEnvironmentDetector {
     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
-        .head()
-        .and_then(|head| head.peel_to_commit())
-        .context("Failed to get HEAD commit")?
-        .id()
-        .to_string();
-    Ok(commit_hash)
-}
-
 /// `RunEnvironmentProvider` is a trait that defines the necessary methods
 /// for a continuous integration provider.
 pub trait RunEnvironmentProvider {
@@ -73,7 +59,7 @@ pub trait RunEnvironmentProvider {
     ) -> Result<UploadMetadata> {
         let run_environment_metadata = self.get_run_environment_metadata()?;
 
-        let commit_hash = get_commit_hash(&run_environment_metadata.repository_root_path)?;
+        let commit_hash = self.get_commit_hash(&run_environment_metadata.repository_root_path)?;
 
         Ok(UploadMetadata {
             version: Some(LATEST_UPLOAD_METADATA_VERSION),
@@ -94,16 +80,19 @@ pub trait RunEnvironmentProvider {
             run_part: self.get_run_provider_run_part(),
         })
     }
-}
 
-#[cfg(test)]
-mod tests {
-    use super::*;
+    /// Returns the HEAD commit hash of the repository at the given path.
+    fn get_commit_hash(&self, repository_root_path: &str) -> Result<String> {
+        let repo = Repository::open(repository_root_path).context(format!(
+            "Failed to open repository at path: {repository_root_path}"
+        ))?;
 
-    #[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);
+        let commit_hash = repo
+            .head()
+            .and_then(|head| head.peel_to_commit())
+            .context("Failed to get HEAD commit")?
+            .id()
+            .to_string();
+        Ok(commit_hash)
     }
 }