Merge pull request #4 from keboola/miro-PS-2486

MiroCillik · web-flow · commit 412ce35fe062 · 2021-08-30T16:22:37.000+02:00
PS-2486: Added Job warning type
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ composer require keboola/notification-api-php-client
 
 ```php
 use Keboola\NotificationClient\EventsClient;
-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
 use Keboola\NotificationClient\Requests\PostEvent\JobData;
 use Keboola\NotificationClient\Requests\Event;
 use Psr\Log\NullLogger;
@@ -23,10 +23,11 @@ $client = new EventsClient(
     'xxx-xxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 );
 $client->postEvent(
-    new Event(
-        'job_failed',
-        new FailedJobEventData(
-            'job failed',
+    new Event(        
+        new JobFailedEventData(
+            '123',
+            'My Project',
+            'Job finished with error',
             new JobData('my-project', '123', 'http://someUrl', '2020-01-02', '2020-01-01', 'my-orchestration')
         )
     )
@@ -68,7 +69,8 @@ $clientFactory->getEventsClient('xxx-xxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
 - Set the following environment variables in `set-env.sh` file (use `set-env.template.sh` as sample):
     - `STORAGE_API_URL` - Keboola Connection URL to arbitrary stack where the notification service is registered.
-    - `TEST_STORAGE_API_TOKEN` - Token to a test project.
+    - `TEST_STORAGE_API_TOKEN` - Token to a test project. 
+    - `TEST_STORAGE_API_PROJECT_ID` - Project ID of the test project.
     - `TEST_MANAGE_API_APPLICATION_TOKEN` - Application token with scope `notifications:push-event`.
 
 - Set one of Azure or AWS resources (or both, but only one is needed).  
@@ -111,18 +113,19 @@ $clientFactory->getEventsClient('xxx-xxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
     SERVICE_PRINCIPAL_ID=$(az ad sp list --display-name testing-notification-api-php-client --query "[0].objectId" --output tsv)
     ```
  
-- Deploy the key vault, provide tenant ID, service principal ID and group ID from the previous commands:
+- Deploy the Storage Account for logs, provide tenant ID, service principal ID and group ID from the previous commands:
     ```bash
-    az deployment group create --resource-group testing-job-queue-api-php-client --template-file provisioning/azure.json --parameters vault_name=test-job-queue-client tenant_id=$TEST_AZURE_TENANT_ID service_principal_object_id=$SERVICE_PRINCIPAL_ID
+    az deployment group create --resource-group testing-notification-api-php-client --template-file provisioning/azure.json --parameters vault_name=test-notification-client tenant_id=$TEST_AZURE_TENANT_ID service_principal_object_id=$SERVICE_PRINCIPAL_ID
     ```
   
-- Show Key Vault URL
+- Get the connection string
     ```bash
-    az keyvault show --name test-job-queue-client --query "properties.vaultUri" --output tsv
+    az storage account show-connection-string -g testing-notification-api-php-client -n mirontfcnacc2 --query "connectionString" --output tsv
     ```
 
-returns e.g. `https://test-job-queue-client.vault.azure.net/`, use this to set values in `set-env.sh` file:
-    - `test_azure_key_vault_url` - https://test-job-queue-client.vault.azure.net/
+Set the connection string and container name you provided as parameter to the create command to following environment variables in the `set-env.sh` file:
+ - AZURE_LOGS_ABS_CONTAINER 
+ - AZURE_LOGS_ABS_CONNECTION_STRING
 
 ## Generate environment configuration
 
diff --git a/composer.json b/composer.json
@@ -33,7 +33,7 @@
     },
     "require-dev": {
         "infection/infection": "^0.18.2|^0.21.2",
-        "keboola/coding-standard": ">=10.0.0",
+        "keboola/coding-standard": "^12.0",
         "php-parallel-lint/php-parallel-lint": "^1.2",
         "phpstan/phpstan": "^0.12.80",
         "phpunit/phpunit": "^9.5"
diff --git a/set-env.template.sh b/set-env.template.sh
@@ -19,3 +19,4 @@ export TEST_AZURE_TENANT_ID=
 export TEST_NOTIFICATION_API_URL=https://localhost:8181/
 export TEST_STORAGE_API_TOKEN=
 export TEST_MANAGE_API_APPLICATION_TOKEN=
+export TEST_STORAGE_API_PROJECT_ID=
diff --git a/src/ClientFactory.php b/src/ClientFactory.php
@@ -4,7 +4,7 @@
 
 namespace Keboola\NotificationClient;
 
-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
 
 class ClientFactory
 {
diff --git a/src/Requests/PostEvent/JobFailedEventData.php b/src/Requests/PostEvent/JobFailedEventData.php
@@ -6,7 +6,7 @@
 
 use Keboola\NotificationClient\Requests\EventDataInterface;
 
-class FailedJobEventData implements EventDataInterface
+class JobFailedEventData implements EventDataInterface
 {
     private string $projectId;
     private string $projectName;
@@ -21,10 +21,7 @@ public function __construct(string $projectId, string $projectName, string $erro
         $this->jobData = $jobData;
     }
 
-    /**
-     * @return mixed
-     */
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return [
             'errorMessage' => $this->errorMessage,
diff --git a/src/Requests/PostEvent/JobSucceededWithWarningEventData.php b/src/Requests/PostEvent/JobSucceededWithWarningEventData.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\NotificationClient\Requests\PostEvent;
+
+use Keboola\NotificationClient\Requests\EventDataInterface;
+
+class JobSucceededWithWarningEventData implements EventDataInterface
+{
+    private string $projectId;
+    private string $projectName;
+    private string $errorMessage;
+    private JobData $jobData;
+
+    public function __construct(string $projectId, string $projectName, string $errorMessage, JobData $jobData)
+    {
+        $this->projectId = $projectId;
+        $this->projectName = $projectName;
+        $this->errorMessage = $errorMessage;
+        $this->jobData = $jobData;
+    }
+
+    public function jsonSerialize(): array
+    {
+        return [
+            'errorMessage' => $this->errorMessage,
+            'job' => $this->jobData->jsonSerialize(),
+            'project' => [
+                'id' => $this->projectId,
+                'name' => $this->projectName,
+            ],
+        ];
+    }
+
+    public static function getEventTypeName(): string
+    {
+        return 'job-succeeded-with-warning';
+    }
+}
diff --git a/src/Requests/Subscription.php b/src/Requests/Subscription.php
@@ -7,7 +7,8 @@
 use JsonSerializable;
 use Keboola\NotificationClient\ClientFactory;
 use Keboola\NotificationClient\Exception\ClientException;
-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
+use Keboola\NotificationClient\Requests\PostEvent\JobSucceededWithWarningEventData;
 use Keboola\NotificationClient\Requests\PostSubscription\EmailRecipient;
 use Keboola\NotificationClient\Requests\PostSubscription\Filter;
 
@@ -26,13 +27,7 @@ class Subscription implements JsonSerializable
      */
     public function __construct(string $eventType, EmailRecipient $recipient, array $filters)
     {
-        if (!in_array($eventType, [FailedJobEventData::getEventTypeName()])) {
-            throw new ClientException(sprintf(
-                'Invalid event type "%s", valid types are: "%s".',
-                $eventType,
-                implode(', ', [FailedJobEventData::getEventTypeName()])
-            ));
-        }
+        $this->checkEventType($eventType);
         $this->eventType = $eventType;
         $this->recipient = $recipient;
         $this->filters = $filters;
@@ -53,4 +48,20 @@ public function jsonSerialize()
             'recipient' => $this->recipient->jsonSerialize(),
         ];
     }
+
+    private function checkEventType(string $eventType): void
+    {
+        $validEventTypes = [
+            JobFailedEventData::getEventTypeName(),
+            JobSucceededWithWarningEventData::getEventTypeName(),
+        ];
+
+        if (!in_array($eventType, $validEventTypes)) {
+            throw new ClientException(sprintf(
+                'Invalid event type "%s", valid types are: "%s".',
+                $eventType,
+                implode(', ', $validEventTypes)
+            ));
+        }
+    }
 }
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -13,8 +13,8 @@
 use Keboola\NotificationClient\EventsClient;
 use Keboola\NotificationClient\Exception\ClientException;
 use Keboola\NotificationClient\Requests\Event;
-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
 use Keboola\NotificationClient\Requests\PostEvent\JobData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\Test\TestLogger;
 
@@ -99,7 +99,7 @@ public function testCreateClientMultipleErrors(): void
     private function getPostEventData(): Event
     {
         return new Event(
-            new FailedJobEventData(
+            new JobFailedEventData(
                 '1234',
                 'My project',
                 'Some Error',
diff --git a/tests/EventsClientFunctionalTest.php b/tests/EventsClientFunctionalTest.php
@@ -7,8 +7,8 @@
 use DateTimeImmutable;
 use Keboola\NotificationClient\EventsClient;
 use Keboola\NotificationClient\Requests\Event;
-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
 use Keboola\NotificationClient\Requests\PostEvent\JobData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
 use PHPUnit\Framework\TestCase;
 
 class EventsClientFunctionalTest extends TestCase
@@ -25,7 +25,7 @@ public function testPostEvent(): void
     {
         $client = $this->getClient();
         $client->postEvent(new Event(
-            new FailedJobEventData(
+            new JobFailedEventData(
                 '1234',
                 'My project',
                 'job failed',
diff --git a/tests/Requests/EventTest.php b/tests/Requests/EventTest.php
@@ -6,16 +6,16 @@
 
 use DateTimeImmutable;
 use Keboola\NotificationClient\Requests\Event;
-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
 use Keboola\NotificationClient\Requests\PostEvent\JobData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
 use PHPUnit\Framework\TestCase;
 
 class EventTest extends TestCase
 {
     public function testJsonSerialize(): void
     {
         $postEventRequest = new Event(
-            new FailedJobEventData(
+            new JobFailedEventData(
                 '1234',
                 'My Project',
                 'My failed job',
diff --git a/tests/Requests/PostEvent/JobFailedEventDataTest.php b/tests/Requests/PostEvent/JobFailedEventDataTest.php
@@ -5,11 +5,11 @@
 namespace Keboola\NotificationClient\Tests\Requests\PostEvent;
 
 use DateTimeImmutable;
-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
 use Keboola\NotificationClient\Requests\PostEvent\JobData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
 use PHPUnit\Framework\TestCase;
 
-class FailedJobEventDataTest extends TestCase
+class JobFailedEventDataTest extends TestCase
 {
     public function testJsonSerialize(): void
     {
@@ -23,7 +23,7 @@ public function testJsonSerialize(): void
             'my-configuration',
             'My configuration'
         );
-        $failedEventData = new FailedJobEventData('1234', 'My project', 'someMessage', $jobData);
+        $failedEventData = new JobFailedEventData('1234', 'My project', 'someMessage', $jobData);
         self::assertSame(
             [
                 'errorMessage' => 'someMessage',
diff --git a/tests/Requests/PostEvent/JobSucceededWithWarningEventDataTest.php b/tests/Requests/PostEvent/JobSucceededWithWarningEventDataTest.php
@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\NotificationClient\Tests\Requests\PostEvent;
+
+use DateTimeImmutable;
+use Keboola\NotificationClient\Requests\PostEvent\JobData;
+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;
+use Keboola\NotificationClient\Requests\PostEvent\JobSucceededWithWarningEventData;
+use PHPUnit\Framework\TestCase;
+
+class JobSucceededWithWarningEventDataTest extends TestCase
+{
+    public function testJsonSerialize(): void
+    {
+        $jobData = new JobData(
+            '23456',
+            'http://someUrl',
+            new DateTimeImmutable('2020-01-01T11:11:00+00:00'),
+            new DateTimeImmutable('2020-01-01T12:11:00+00:00'),
+            'keboola.orchestrator',
+            'Orchestrator',
+            'my-configuration',
+            'My configuration'
+        );
+        $failedEventData = new JobSucceededWithWarningEventData(
+            '1234',
+            'My project',
+            'someMessage',
+            $jobData
+        );
+
+        self::assertSame(
+            [
+                'errorMessage' => 'someMessage',
+                'job' => [
+                    'id' => '23456',
+                    'url' => 'http://someUrl',
+                    'component' => [
+                        'id' => 'keboola.orchestrator',
+                        'name' => 'Orchestrator',
+                    ],
+                    'tasks' => [],
+                    'startTime' => '2020-01-01T11:11:00+00:00',
+                    'endTime' => '2020-01-01T12:11:00+00:00',
+                    'configuration' => [
+                        'id' => 'my-configuration',
+                        'name' => 'My configuration',
+                    ],
+                ],
+                'project' => [
+                    'id' => '1234',
+                    'name' => 'My project',
+                ],
+            ],
+            $failedEventData->jsonSerialize()
+        );
+    }
+}
diff --git a/tests/SubscriptionClientFunctionalTest.php b/tests/SubscriptionClientFunctionalTest.php
@@ -27,12 +27,14 @@ public function testCreateSubscription(): void
         $response = $client->createSubscription(new Subscription(
             'job-failed',
             new EmailRecipient('johnDoe@example.com'),
-            [new Filter('projectId', (string) getenv('TEST_STORAGE_API_PROJECT_ID'))]
+            [
+                new Filter('project.id', (string) getenv('TEST_STORAGE_API_PROJECT_ID')),
+            ]
         ));
 
         self::assertNotEmpty($response->getId());
         self::assertSame('job-failed', $response->getEvent());
-        self::assertSame('projectId', $response->getFilters()[0]->getField());
+        self::assertSame('project.id', $response->getFilters()[0]->getField());
         self::assertSame((string) getenv('TEST_STORAGE_API_PROJECT_ID'), $response->getFilters()[0]->getValue());
         self::assertSame('johnDoe@example.com', $response->getRecipientAddress());
         self::assertSame('email', $response->getRecipientChannel());
@@ -42,7 +44,9 @@ public function testCreateInvalidSubscription(): void
     {
         $client = $this->getClient();
         self::expectException(ClientException::class);
-        self::expectExceptionMessage('Invalid event type "dummy-event", valid types are: "job-failed".');
+        self::expectExceptionMessage(
+            'Invalid event type "dummy-event", valid types are: "job-failed, job-succeeded-with-warning".'
+        );
         $client->createSubscription(new Subscription(
             'dummy-event',
             new EmailRecipient('johnDoe@example.com'),

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Keboola\NotificationClient;`
`6`	`6`
`7`		`-use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;`
	`7`	`+use Keboola\NotificationClient\Requests\PostEvent\JobFailedEventData;`
`8`	`8`
`9`	`9`	`class ClientFactory`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`use Keboola\NotificationClient\Requests\EventDataInterface;`
`8`	`8`
`9`		`-class FailedJobEventData implements EventDataInterface`
	`9`	`+class JobFailedEventData implements EventDataInterface`
`10`	`10`	`{`
`11`	`11`	`private string $projectId;`
`12`	`12`	`private string $projectName;`
`@@ -21,10 +21,7 @@ public function __construct(string $projectId, string $projectName, string $erro`
`21`	`21`	`$this->jobData = $jobData;`
`22`	`22`	`}`
`23`	`23`
`24`		`- /**`
`25`		`- * @return mixed`
`26`		`- */`
`27`		`- public function jsonSerialize()`
	`24`	`+ public function jsonSerialize(): array`
`28`	`25`	`{`
`29`	`26`	`return [`
`30`	`27`	`'errorMessage' => $this->errorMessage,`