Merge pull request #2 from utopia-php/feat-clone-commit-hash

Added commit hash to git clone command
utopia-php · Aug 21, 2023 · ec388e0 · ec388e0
2 parents fc9c38a + 9ff6ba6
commit ec388e0
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 15 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/VCS/Adapter.php b/src/VCS/Adapter.php
@@ -158,7 +158,7 @@ abstract public function updateComment(string $owner, string $repositoryName, in
     /**
      * Generates a clone command using app access token
      */
-    abstract public function generateCloneCommand(string $owner, string $repositoryName, string $branchName, string $directory, string $rootDirectory): string;
+    abstract public function generateCloneCommand(string $owner, string $repositoryName, string $branchName, string $directory, string $rootDirectory, string $commitHash = null): string;
 
     /**
      * Parses webhook event payload

diff --git a/src/VCS/Adapter/Git/GitHub.php b/src/VCS/Adapter/Git/GitHub.php
@@ -444,7 +444,7 @@ public function updateCommitStatus(string $repositoryName, string $commitHash, s
     /**
      * Generates a clone command using app access token
      */
-    public function generateCloneCommand(string $owner, string $repositoryName, string $branchName, string $directory, string $rootDirectory): string
+    public function generateCloneCommand(string $owner, string $repositoryName, string $branchName, string $directory, string $rootDirectory, string $commitHash = null): string
     {
         if (empty($rootDirectory)) {
             $rootDirectory = '*';
@@ -459,6 +459,9 @@ public function generateCloneCommand(string $owner, string $repositoryName, stri
         $directory = escapeshellarg($directory);
         $rootDirectory = escapeshellarg($rootDirectory);
         $branchName = escapeshellarg($branchName);
+        if (!empty($commitHash)) {
+            $commitHash = escapeshellarg($commitHash);
+        }
 
         $commands = [
             "mkdir -p {$directory}",
@@ -468,9 +471,14 @@ public function generateCloneCommand(string $owner, string $repositoryName, stri
             "git remote add origin {$cloneUrl}",
             "git config core.sparseCheckout true",
             "echo {$rootDirectory} >> .git/info/sparse-checkout",
-            "if git ls-remote --exit-code --heads origin {$branchName}; then git pull origin {$branchName} && git checkout {$branchName}; else git checkout -b {$branchName}; fi"
         ];
 
+        if (empty($commitHash)) {
+            $commands[] = "if git ls-remote --exit-code --heads origin {$branchName}; then git pull origin {$branchName} && git checkout {$branchName}; else git checkout -b {$branchName}; fi";
+        } else {
+            $commands[] = "git pull origin {$commitHash}";
+        }
+
         $fullCommand = implode(" && ", $commands);
 
         return $fullCommand;

diff --git a/tests/VCS/Adapter/GitHubTest.php b/tests/VCS/Adapter/GitHubTest.php
@@ -160,6 +160,13 @@ public function testGenerateCloneCommand(): void
         $this->assertStringContainsString('sparse-checkout', $gitCloneCommand);
     }
 
+    public function testGenerateCloneCommandWithCommitHash(): void
+    {
+        $gitCloneCommand = $this->vcsAdapter->generateCloneCommand('test-kh', 'test2', 'main', 'test', '*', '4fb10447faea8a55c5cad7b5ebdfdbedca349fe4');
+        $this->assertNotEmpty($gitCloneCommand);
+        $this->assertStringContainsString('sparse-checkout', $gitCloneCommand);
+    }
+
     public function testUpdateComment(): void
     {
         $commentId = $this->vcsAdapter->updateComment('test-kh', 'test2', 1630320767, 'update');

diff --git a/tests/VCS/Base.php b/tests/VCS/Base.php
@@ -21,6 +21,8 @@ abstract public function testUpdateComment(): void;
 
     abstract public function testGenerateCloneCommand(): void;
 
+    abstract public function testGenerateCloneCommandWithCommitHash(): void;
+
     abstract public function testgetEvent(): void;
 
     abstract public function testGetRepositoryName(): void;