Merge pull request #17 from keboola/pepa_SOX-328_branchId

pepamartinec · web-flow · commit fccf04594772 · 2023-08-03T12:28:09.000+02:00
SOX-328 Add `branch.id` to job events
diff --git a/Dockerfile b/Dockerfile
@@ -13,10 +13,8 @@ COPY docker/php.ini /usr/local/etc/php/php.ini
 
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin/ --filename=composer
 
-RUN pecl channel-update pecl.php.net \
-  && pecl config-set php_ini /usr/local/etc/php.ini \
-  && yes | pecl install xdebug \
-  && docker-php-ext-enable xdebug
+RUN pecl install xdebug-3.1.6 \
+ && docker-php-ext-enable xdebug
 
 COPY composer.* ./
 RUN composer install $COMPOSER_FLAGS --no-scripts --no-autoloader
diff --git a/src/Requests/PostEvent/JobFailedEventData.php b/src/Requests/PostEvent/JobFailedEventData.php
@@ -10,13 +10,20 @@ class JobFailedEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private string $errorMessage;
     private JobData $jobData;
 
-    public function __construct(string $projectId, string $projectName, string $errorMessage, JobData $jobData)
-    {
+    public function __construct(
+        string $projectId,
+        string $projectName,
+        string $branchId,
+        string $errorMessage,
+        JobData $jobData
+    ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->errorMessage = $errorMessage;
         $this->jobData = $jobData;
     }
@@ -30,6 +37,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
         ];
     }
 
diff --git a/src/Requests/PostEvent/JobProcessingLongEventData.php b/src/Requests/PostEvent/JobProcessingLongEventData.php
@@ -10,6 +10,7 @@ class JobProcessingLongEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private float $durationOvertimePercentage;
     private float $averageDuration;
     private float $currentDuration;
@@ -18,13 +19,15 @@ class JobProcessingLongEventData implements EventDataInterface
     public function __construct(
         string $projectId,
         string $projectName,
+        string $branchId,
         float $durationOvertimePercentage,
         float $averageDuration,
         float $currentDuration,
         JobData $jobData
     ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->durationOvertimePercentage = $durationOvertimePercentage;
         $this->jobData = $jobData;
         $this->averageDuration = $averageDuration;
@@ -42,6 +45,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
             'uniqueId' => $this->jobData->getJobId(),
         ];
     }
diff --git a/src/Requests/PostEvent/JobSucceededEventData.php b/src/Requests/PostEvent/JobSucceededEventData.php
@@ -10,12 +10,18 @@ class JobSucceededEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private JobData $jobData;
 
-    public function __construct(string $projectId, string $projectName, JobData $jobData)
-    {
+    public function __construct(
+        string $projectId,
+        string $projectName,
+        string $branchId,
+        JobData $jobData
+    ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->jobData = $jobData;
     }
 
@@ -27,6 +33,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
         ];
     }
 
diff --git a/src/Requests/PostEvent/JobSucceededWithWarningEventData.php b/src/Requests/PostEvent/JobSucceededWithWarningEventData.php
@@ -10,13 +10,20 @@ class JobSucceededWithWarningEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private string $errorMessage;
     private JobData $jobData;
 
-    public function __construct(string $projectId, string $projectName, string $errorMessage, JobData $jobData)
-    {
+    public function __construct(
+        string $projectId,
+        string $projectName,
+        string $branchId,
+        string $errorMessage,
+        JobData $jobData
+    ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->errorMessage = $errorMessage;
         $this->jobData = $jobData;
     }
@@ -30,6 +37,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
         ];
     }
 
diff --git a/src/Requests/PostEvent/PhaseJobFailedEventData.php b/src/Requests/PostEvent/PhaseJobFailedEventData.php
@@ -10,6 +10,7 @@ class PhaseJobFailedEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private string $errorMessage;
     private JobData $jobData;
     private string $phaseName;
@@ -18,13 +19,15 @@ class PhaseJobFailedEventData implements EventDataInterface
     public function __construct(
         string $projectId,
         string $projectName,
+        string $branchId,
         string $phaseName,
         string $phaseId,
         string $errorMessage,
         JobData $jobData
     ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->errorMessage = $errorMessage;
         $this->jobData = $jobData;
         $this->phaseName = $phaseName;
@@ -44,6 +47,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
         ];
     }
 
diff --git a/src/Requests/PostEvent/PhaseJobProcessingLongEventData.php b/src/Requests/PostEvent/PhaseJobProcessingLongEventData.php
@@ -10,6 +10,7 @@ class PhaseJobProcessingLongEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private float $durationOvertimePercentage;
     private float $averageDuration;
     private float $currentDuration;
@@ -20,6 +21,7 @@ class PhaseJobProcessingLongEventData implements EventDataInterface
     public function __construct(
         string $projectId,
         string $projectName,
+        string $branchId,
         string $phaseName,
         string $phaseId,
         float $durationOvertimePercentage,
@@ -29,6 +31,7 @@ public function __construct(
     ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->durationOvertimePercentage = $durationOvertimePercentage;
         $this->jobData = $jobData;
         $this->averageDuration = $averageDuration;
@@ -52,6 +55,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
             'uniqueId' => $this->jobData->getJobId(),
         ];
     }
diff --git a/src/Requests/PostEvent/PhaseJobSucceededEventData.php b/src/Requests/PostEvent/PhaseJobSucceededEventData.php
@@ -10,19 +10,22 @@ class PhaseJobSucceededEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private JobData $jobData;
     private string $phaseName;
     private string $phaseId;
 
     public function __construct(
         string $projectId,
         string $projectName,
+        string $branchId,
         string $phaseName,
         string $phaseId,
         JobData $jobData
     ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->jobData = $jobData;
         $this->phaseName = $phaseName;
         $this->phaseId = $phaseId;
@@ -40,6 +43,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
         ];
     }
 
diff --git a/src/Requests/PostEvent/PhaseJobSucceededWithWarningEventData.php b/src/Requests/PostEvent/PhaseJobSucceededWithWarningEventData.php
@@ -10,6 +10,7 @@ class PhaseJobSucceededWithWarningEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
+    private string $branchId;
     private string $errorMessage;
     private JobData $jobData;
     private string $phaseName;
@@ -18,13 +19,15 @@ class PhaseJobSucceededWithWarningEventData implements EventDataInterface
     public function __construct(
         string $projectId,
         string $projectName,
+        string $branchId,
         string $phaseName,
         string $phaseId,
         string $errorMessage,
         JobData $jobData
     ) {
         $this->projectId = $projectId;
         $this->projectName = $projectName;
+        $this->branchId = $branchId;
         $this->errorMessage = $errorMessage;
         $this->jobData = $jobData;
         $this->phaseName = $phaseName;
@@ -44,6 +47,9 @@ public function jsonSerialize(): array
                 'id' => $this->projectId,
                 'name' => $this->projectName,
             ],
+            'branch' => [
+                'id' => $this->branchId,
+            ],
         ];
     }
 
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -116,6 +116,7 @@ private function getPostEventData(): Event
             new JobFailedEventData(
                 '1234',
                 'My project',
+                'branch-id',
                 'Some Error',
                 new JobData(
                     '23456',
diff --git a/tests/EventsClientFunctionalTest.php b/tests/EventsClientFunctionalTest.php
@@ -39,6 +39,7 @@ public function testPostEvent(): void
             new JobFailedEventData(
                 '1234',
                 'My project',
+                'branch-id',
                 'job failed',
                 new JobData(
                     '23456',
@@ -77,6 +78,7 @@ public function testPostEventUniqueId(): void
             new JobProcessingLongEventData(
                 '1234',
                 'My project',
+                'branch-id',
                 12.5,
                 102.2,
                 120,
@@ -118,6 +120,7 @@ public function testPostEventsHeaders(): void
             new JobFailedEventData(
                 '1234',
                 'My project',
+                'branch-id',
                 'Some Error',
                 new JobData(
                     '23456',
diff --git a/tests/Requests/EventTest.php b/tests/Requests/EventTest.php
@@ -18,6 +18,7 @@ public function testJsonSerialize(): void
             new JobFailedEventData(
                 '1234',
                 'My Project',
+                'branch-id',
                 'My failed job',
                 new JobData(
                     '23456',
@@ -53,6 +54,9 @@ public function testJsonSerialize(): void
                     'id' => '1234',
                     'name' => 'My Project',
                 ],
+                'branch' => [
+                    'id' => 'branch-id',
+                ],
             ],
             $postEventRequest->jsonSerialize()
         );
diff --git a/tests/Requests/PostEvent/JobFailedEventDataTest.php b/tests/Requests/PostEvent/JobFailedEventDataTest.php
@@ -23,7 +23,13 @@ public function testJsonSerialize(): void
             'my-configuration',
             'My configuration'
         );
-        $failedEventData = new JobFailedEventData('1234', 'My project', 'someMessage', $jobData);
+        $failedEventData = new JobFailedEventData(
+            '1234',
+            'My project',
+            'branch-id',
+            'someMessage',
+            $jobData
+        );
         self::assertSame(
             [
                 'errorMessage' => 'someMessage',
@@ -46,6 +52,9 @@ public function testJsonSerialize(): void
                     'id' => '1234',
                     'name' => 'My project',
                 ],
+                'branch' => [
+                    'id' => 'branch-id',
+                ],
             ],
             $failedEventData->jsonSerialize()
         );
diff --git a/tests/Requests/PostEvent/JobProcessingLongEventDataTest.php b/tests/Requests/PostEvent/JobProcessingLongEventDataTest.php
@@ -24,7 +24,15 @@ public function testJsonSerialize(): void
             'my-configuration',
             'My configuration'
         );
-        $failedEventData = new JobProcessingLongEventData('1234', 'My project', 12.534, 23.854, 12.0, $jobData);
+        $failedEventData = new JobProcessingLongEventData(
+            '1234',
+            'My project',
+            'branch-id',
+            12.534,
+            23.854,
+            12.0,
+            $jobData
+        );
         self::assertSame(
             [
                 'averageDuration' => 23.854,
@@ -49,6 +57,9 @@ public function testJsonSerialize(): void
                     'id' => '1234',
                     'name' => 'My project',
                 ],
+                'branch' => [
+                    'id' => 'branch-id',
+                ],
                 'uniqueId' => '23456',
             ],
             $failedEventData->jsonSerialize()
diff --git a/tests/Requests/PostEvent/JobSucceededEventDataTest.php b/tests/Requests/PostEvent/JobSucceededEventDataTest.php
@@ -26,6 +26,7 @@ public function testJsonSerialize(): void
         $failedEventData = new JobSucceededEventData(
             '1234',
             'My project',
+            'branch-id',
             $jobData
         );
 
@@ -50,6 +51,9 @@ public function testJsonSerialize(): void
                     'id' => '1234',
                     'name' => 'My project',
                 ],
+                'branch' => [
+                    'id' => 'branch-id',
+                ],
             ],
             $failedEventData->jsonSerialize()
         );
diff --git a/tests/Requests/PostEvent/JobSucceededWithWarningEventDataTest.php b/tests/Requests/PostEvent/JobSucceededWithWarningEventDataTest.php
diff --git a/tests/Requests/PostEvent/PhaseJobFailedEventDataTest.php b/tests/Requests/PostEvent/PhaseJobFailedEventDataTest.php
diff --git a/tests/Requests/PostEvent/PhaseJobProcessingLongEventDataTest.php b/tests/Requests/PostEvent/PhaseJobProcessingLongEventDataTest.php
diff --git a/tests/Requests/PostEvent/PhaseJobSucceededEventDataTest.php b/tests/Requests/PostEvent/PhaseJobSucceededEventDataTest.php
diff --git a/tests/Requests/PostEvent/PhaseJobSucceededWithWarningEventDataTest.php b/tests/Requests/PostEvent/PhaseJobSucceededWithWarningEventDataTest.php
