Support for approve workflows

Author: Nyholm

composer.json

@@ -11,7 +11,7 @@
         "doctrine/doctrine-migrations-bundle": "^3.0",
         "doctrine/orm": "^2.7",
         "incenteev/composer-parameter-handler": "~2.0",
-        "knplabs/github-api": "^2.16",
+        "knplabs/github-api": "^3.3",
         "nyholm/psr7": "^1.3",
         "sensio/framework-extra-bundle": "^5.1",
         "symfony/console": "^5.1",

config/packages/github_api.yaml

@@ -11,11 +11,11 @@ services:
     Github\HttpClient\Builder:
         arguments:
             - '@github.httplug_client'
-            - '@Http\Message\RequestFactory'
-            - '@Http\Message\StreamFactory'
+            - '@Psr\Http\Message\RequestFactoryInterface'
+            - '@Psr\Http\Message\StreamFactoryInterface'
 
     github.httplug_client:
-        class: Symfony\Component\HttpClient\HttplugClient
+        class: Symfony\Component\HttpClient\Psr18Client
         arguments:
             - '@github.retryable_client'
             - '@Psr\Http\Message\ResponseFactoryInterface'
@@ -56,8 +56,6 @@ services:
 
     Github\Api\Issue\Timeline:
         factory: ['@Github\Api\Issue', timeline]
-        calls:
-            - [configure]
 
     Github\Api\PullRequest:
         factory: ['@Github\Client', api]
@@ -75,3 +73,8 @@ services:
         arguments: [search]
         calls:
             - ['setPerPage', [100]]
+
+    Github\Api\Repository\Actions\WorkflowRuns:
+        factory: ['@Github\Api\Repo', workflowRuns]
+        calls:
+            - ['setPerPage', [100]]

config/services.yaml

@@ -75,12 +75,12 @@ services:
         resource: '../src/Subscriber/*'
         autoconfigure: false
 
-
     App\Api\Issue\IssueApi: '@App\Api\Issue\GithubIssueApi'
     App\Api\Label\LabelApi: '@App\Api\Label\GithubLabelApi'
     App\Api\Milestone\MilestoneApi: '@App\Api\Milestone\GithubMilestoneApi'
     App\Api\PullRequest\PullRequestApi: '@App\Api\PullRequest\GithubPullRequestApi'
     App\Api\Status\StatusApi: '@App\Api\Status\GitHubStatusApi'
+    App\Api\Workflow\WorkflowApi: '@App\Api\Workflow\GitHubWorkflowApi'
 
     App\Service\RepositoryProvider:
         arguments: [ '%repositories%' ]

config/services_test.yaml

@@ -8,3 +8,4 @@ services:
     App\Api\Milestone\MilestoneApi: '@App\Api\Milestone\StaticMilestoneApi'
     App\Api\PullRequest\PullRequestApi: '@App\Api\PullRequest\NullPullRequestApi'
     App\Api\Status\StatusApi: '@App\Api\Status\NullStatusApi'
+    App\Api\Workflow\WorkflowApi: '@App\Api\Workflow\NullWorkflowApi'

src/Api/Workflow/GithubWorkflowApi.php

@@ -0,0 +1,39 @@
+<?php
+
+
+namespace App\Api\Workflow;
+
+
+use App\Api\Label\LabelApi;
+use App\Model\Repository;
+use Github\Api\Repository\Actions\WorkflowRuns;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class GithubWorkflowApi implements WorkflowApi
+{
+    private WorkflowRuns $workflowApi;
+    private LoggerInterface $logger;
+
+    public function __construct(WorkflowRuns $workflowApi, LoggerInterface $logger)
+    {
+        $this->workflowApi = $workflowApi;
+        $this->logger = $logger;
+    }
+
+    public function approveWorkflowsForPullRequest(Repository $repository, string $headRepository, string $headBranch): void
+    {
+        $result = $this->workflowApi->all($repository->getVendor(), $repository->getName(), [
+            'branch' => $headBranch,
+            'status' => 'action_required'
+        ]);
+
+        foreach ($result['workflow_runs'] as $run) {
+            if ($headRepository === $run['head_repository']['full_name']) {
+                $this->workflowApi->approve($repository->getVendor(), $repository->getName(), $run['id']);
+            }
+        }
+    }
+}

src/Api/Workflow/NullWorkflowApi.php

@@ -0,0 +1,16 @@
+<?php
+
+
+namespace App\Api\Workflow;
+
+
+use App\Model\Repository;
+
+class NullWorkflowApi implements WorkflowApi
+{
+    public function approveWorkflowsForPullRequest(Repository $repository, string $headRepository, string $headBranch): void
+    {
+
+    }
+
+}

src/Api/Workflow/WorkflowApi.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Api\Workflow;
+
+
+use App\Model\Repository;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+interface WorkflowApi
+{
+    /**
+     * Find workflow runs related to the PR and approve them.
+     */
+    public function approveWorkflowsForPullRequest(Repository $repository, string $headRepository, string $headBranch): void;
+}

src/Subscriber/ApproveCiForNonContributors.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Subscriber;
+
+use App\Api\Status\Status;
+use App\Api\Status\StatusApi;
+use App\Api\Workflow\WorkflowApi;
+use App\Event\GitHubEvent;
+use App\GitHubEvents;
+use App\Service\WipParser;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Make sure CI is running for all PRs.
+ *
+ * @author Wouter de Jong <[email protected]>
+ */
+class ApproveCiForNonContributors implements EventSubscriberInterface
+{
+    private WorkflowApi $workflowApi;
+
+    public function onPullRequest(GitHubEvent $event)
+    {
+        $data = $event->getData();
+        if (!in_array($data['action'], ['opened', 'reopened', 'synchronize'])) {
+            return;
+        }
+
+        $repository = $event->getRepository();
+        $pullRequestNumber = $data['pull_request']['number'];
+        $headRepository = $data['pull_request']['head']['repo']['full_name'];
+        $headBranch = $data['pull_request']['head']['ref'];
+        $this->workflowApi->approveWorkflowsForPullRequest($repository, $pullRequestNumber, $headRepository, $headBranch);
+
+        $event->setResponseData(['approved_run'=>true]);
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return [
+            GitHubEvents::PULL_REQUEST => 'onPullRequest',
+        ];
+    }
+}

tests/webhook_examples/pull_request.opened.json

@@ -70,7 +70,7 @@
       "repo": {
         "id": 21151556,
         "name": "symfony",
-        "full_name": "carsonbot-playground/symfony",
+        "full_name": "weaverryan/symfony",
         "owner": {
           "login": "weaverryan",
           "id": 121003,