Merge pull request #383 from keboola/pepa_PST-1658_applicationToken

PST-1658 Allow listing jobs using application token

Author: pepamartinec

azure-pipelines.tests.yml

@@ -11,6 +11,7 @@ jobs:
         testCommand: composer ci
       variables:
         CLOUD_PROVIDER: aws
+        HOSTNAME_SUFFIX: $(HOSTNAME_SUFFIX__AWS)
         STORAGE_API_URL: $(STORAGE_API_URL__AWS)
         GOOGLE_APPLICATION_CREDENTIALS: /code/var/gcp-private-key.json
       secrets:

composer.json

@@ -47,6 +47,7 @@
         "phpstan/phpstan": "^1.0",
         "phpstan/phpstan-phpunit": "^1.3",
         "phpunit/phpunit": "^9.5",
+        "sempro/phpunit-pretty-print": "^1.4",
         "symfony/dotenv": "^6.3"
     },
     "scripts": {

phpunit.xml.dist

@@ -8,6 +8,7 @@
          bootstrap="tests/bootstrap.php"
          convertDeprecationsToExceptions="false"
          cacheResultFile="/tmp/phpunit.result.cache"
+         printerClass="Sempro\PHPUnitPrettyPrinter\PrettyPrinterForPhpUnit9"
 >
   <php>
     <ini name="display_errors" value="1" />

src/Client.php

@@ -47,9 +47,16 @@ public function __construct(
         string $internalQueueApiUrl,
         ?string $internalQueueToken,
         ?string $storageApiToken,
+        ?string $applicationToken,
         array $options = [],
     ) {
-        $this->validateConfiguration($internalQueueApiUrl, $internalQueueToken, $storageApiToken, $options);
+        $this->validateConfiguration(
+            $internalQueueApiUrl,
+            $internalQueueToken,
+            $storageApiToken,
+            $applicationToken,
+            $options,
+        );
         if (!empty($options['backoffMaxTries'])) {
             $options['backoffMaxTries'] = intval($options['backoffMaxTries']);
         } else {
@@ -59,7 +66,13 @@ public function __construct(
             $options['userAgent'] = self::DEFAULT_USER_AGENT;
         }
 
-        $this->guzzle = $this->initClient($internalQueueApiUrl, $internalQueueToken, $storageApiToken, $options);
+        $this->guzzle = $this->initClient(
+            $internalQueueApiUrl,
+            $internalQueueToken,
+            $storageApiToken,
+            $applicationToken,
+            $options,
+        );
         $this->existingJobFactory = $existingJobFactory;
         $this->logger = $logger;
     }
@@ -68,15 +81,24 @@ private function validateConfiguration(
         string $internalQueueApiUrl,
         ?string $internalQueueToken,
         ?string $storageApiToken,
+        ?string $applicationToken,
         array $options,
     ): void {
         $validator = Validation::createValidator();
         $errors = $validator->validate($internalQueueApiUrl, [new Url()]);
-        if ($internalQueueToken === null && $storageApiToken === null) {
-            throw new ClientException('Both InternalApiToken and StorageAPIToken are empty.');
+
+        $providedTokens = array_filter(
+            [$internalQueueToken, $storageApiToken, $applicationToken],
+            fn(?string $token) => $token !== null,
+        );
+
+        if (count($providedTokens) === 0) {
+            throw new ClientException(
+                'No token provided (internalQueueToken, storageApiToken and applicationToken are empty)',
+            );
         }
-        if ($internalQueueToken !== null && $storageApiToken !== null) {
-            throw new ClientException('Both InternalApiToken and StorageAPIToken are non-empty. Use only one.');
+        if (count($providedTokens) > 1) {
+            throw new ClientException('More than one authentication token provided');
         }
         if ($internalQueueToken !== null) {
             $errors->addAll(
@@ -88,6 +110,11 @@ private function validateConfiguration(
                 $validator->validate($storageApiToken, [new NotBlank()]),
             );
         }
+        if ($applicationToken !== null) {
+            $errors->addAll(
+                $validator->validate($applicationToken, [new NotBlank()]),
+            );
+        }
         if (!empty($options['backoffMaxTries'])) {
             $errors->addAll($validator->validate($options['backoffMaxTries'], [new Range(['min' => 0, 'max' => 100])]));
         }
@@ -347,6 +374,7 @@ private function initClient(
         string $url,
         ?string $internalToken,
         ?string $storageToken,
+        ?string $applicationToken,
         array $options = [],
     ): GuzzleClient {
         // Initialize handlers (start with those supplied in constructor)
@@ -359,7 +387,7 @@ private function initClient(
         $handlerStack->push(Middleware::retry($this->createDefaultDecider($options['backoffMaxTries'])));
         // Set handler to set default headers
         $handlerStack->push(Middleware::mapRequest(
-            function (RequestInterface $request) use ($internalToken, $storageToken, $options) {
+            function (RequestInterface $request) use ($internalToken, $storageToken, $applicationToken, $options) {
                 $request = $request->withHeader('User-Agent', $options['userAgent'])
                         ->withHeader('Content-type', 'application/json');
                 if ($internalToken !== null) {
@@ -368,6 +396,9 @@ function (RequestInterface $request) use ($internalToken, $storageToken, $option
                 if ($storageToken !== null) {
                     $request = $request->withHeader('X-StorageApi-Token', $storageToken);
                 }
+                if ($applicationToken !== null) {
+                    $request = $request->withHeader('X-KBC-ManageApiToken', $applicationToken);
+                }
                 return $request;
             },
         ));

tests/BaseClientFunctionalTest.php

@@ -90,6 +90,7 @@ protected function getClient(
             self::getRequiredEnv('TEST_QUEUE_API_URL'),
             self::getRequiredEnv('TEST_QUEUE_API_TOKEN'),
             null,
+            null,
         );
     }
 

tests/ClientExceptionTest.php

@@ -52,6 +52,7 @@ private function getClient(array $options): Client
             'http://example.com/',
             'testToken',
             null,
+            null,
             $options,
         );
     }