Feature/ck 2099 merge upstream

.github/workflows/integration_tests.yml

@@ -22,26 +22,22 @@ jobs:
         openstack_version: [ "stable/2023.2" ]
         php_version: [ 8.1 ]
         include:
-          - name: "bobcat"
-            openstack_version: "stable/2023.2"
+          - name: "dalmatian"
+            openstack_version: "stable/2024.2"
+            ubuntu_version: "22.04"
+          - name: "caracal"
+            openstack_version: "stable/2024.1"
             ubuntu_version: "22.04"
           - name: "antelope"
-            openstack_version: "stable/2023.1"
+            openstack_version: "unmaintained/2023.1"
             ubuntu_version: "22.04"
           - name: "zed"
-            openstack_version: "stable/zed"
-            ubuntu_version: "20.04"
-          - name: "yoga"
-            openstack_version: "unmaintained/yoga"
-            ubuntu_version: "20.04"
-          - name: "wallaby"
-            openstack_version: "unmaintained/wallaby"
-            ubuntu_version: "20.04"
-            block_storage_v2: true
+            openstack_version: "unmaintained/zed"
+            ubuntu_version: "22.04"
     runs-on: ubuntu-${{ matrix.ubuntu_version }}
     name: Deploy OpenStack ${{ matrix.name }} and run integration tests with php ${{matrix.php_version}}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: get cache directory
         id: composer-cache
@@ -120,7 +116,7 @@ jobs:
 
       - name: Save logs
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: failure-logs
+          name: failure-logs-${{ strategy.job-index }}
           path: failure-logs

.github/workflows/unit_tests.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-         php: [ 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3 ]
+         php: [ 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3, 8.4 ]
          composer:
            - name: lowest
              arg: "--prefer-lowest --prefer-stable"
@@ -34,7 +34,7 @@ jobs:
         run: |
           echo "::set-output name=dir::$(composer config cache-files-dir)"
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.php_cs.cache

COVERAGE.md

@@ -1,6 +1,8 @@
 # OpenStack versions coverage
 
 While we strive to support all versions of OpenStack, we can only test limited number of versions. The current set:
+* 2024.2 Dalmatian
+* 2024.1 Caracal
 * 2023.2 Bobcat
 * 2023.1 Antelope
 * Zed

composer.json

@@ -31,7 +31,7 @@
         "guzzlehttp/guzzle": "^7.0",
         "guzzlehttp/psr7": ">=1.7",
         "guzzlehttp/uri-template": "^0.2 || ^1.0",
-        "justinrainbow/json-schema": "^5.2"
+        "justinrainbow/json-schema": "^5.2 || ^6.0"
     },
     "require-dev": {
         "ext-json": "*",

samples/Networking/v2/floatingIPs/create.php

@@ -17,5 +17,6 @@
 $floatingIp = $networking->createFloatingIp([
     "floatingNetworkId" => "{networkId}",
     "portId"            => "{portId}",
-    'fixedIpAddress'    => '{fixedIpAddress}',
+    "fixedIpAddress"    => "{fixedIpAddress}",
+    "description"       => "{description}",
 ]);

src/Common/Api/OperatorTrait.php

@@ -101,8 +101,13 @@ protected function sendRequest(Operation $operation, array $userValues = [], boo
 
         $uri = Utils::uri_template($operation->getPath(), $userValues);
 
-        if (array_key_exists('requestOptions', $userValues)) {
+        if (isset($userValues['requestOptions'])) {
             $options += $userValues['requestOptions'];
+
+            // headers are always created in options, merge them
+            if (isset($userValues['requestOptions']['headers'])) {
+                $options['headers'] = array_merge($options['headers'], $userValues['requestOptions']['headers']);
+            }
         }
 
         $options['openstack.skip_auth'] = $operation->getSkipAuth();

src/Common/Auth/AuthHandler.php

@@ -25,7 +25,7 @@ class AuthHandler
     /** @var Token */
     private $token;
 
-    public function __construct(callable $nextHandler, callable $tokenGenerator, Token $token = null)
+    public function __construct(callable $nextHandler, callable $tokenGenerator, ?Token $token = null)
     {
         $this->nextHandler    = $nextHandler;
         $this->tokenGenerator = $tokenGenerator;

src/Common/Error/Builder.php

@@ -35,7 +35,7 @@ class Builder
      */
     private $client;
 
-    public function __construct(ClientInterface $client = null)
+    public function __construct(?ClientInterface $client = null)
     {
         $this->client = $client ?: new Client();
     }
@@ -164,7 +164,7 @@ private function getStatusCodeMessage(int $statusCode): string
      * @param mixed       $userValue    The incorrect value the user actually provided
      * @param string|null $furtherLink  a link to further information if necessary (optional)
      */
-    public function userInputError(string $expectedType, $userValue, string $furtherLink = null): UserInputError
+    public function userInputError(string $expectedType, $userValue, ?string $furtherLink = null): UserInputError
     {
         $message = $this->header('User Input Error');
 

src/Common/HydratorStrategyTrait.php

@@ -25,7 +25,7 @@ public function hydrate(array $data, array $aliases = [])
         }
     }
 
-    public function set(string $key, $property, array $data, callable $fn = null)
+    public function set(string $key, $property, array $data, ?callable $fn = null)
     {
         if (isset($data[$key]) && property_exists($this, $property)) {
             $value           = $fn ? call_user_func($fn, $data[$key]) : $data[$key];

src/Common/JsonSchema/Schema.php

@@ -14,7 +14,7 @@ class Schema
     /** @var Validator */
     private $validator;
 
-    public function __construct($body, Validator $validator = null)
+    public function __construct($body, ?Validator $validator = null)
     {
         $this->body      = (object) $body;
         $this->validator = $validator ?: new Validator();

src/Common/Resource/Alias.php

@@ -26,7 +26,7 @@ class Alias
      * @param string|null $className    A class name for the property value
      * @param bool        $list         Whether value of the property should be treated as a list or not
      */
-    public function __construct(string $propertyName, string $className = null, bool $list = false)
+    public function __construct(string $propertyName, ?string $className = null, bool $list = false)
     {
         $this->isList       = $list;
         $this->propertyName = $propertyName;

src/Common/Resource/Listable.php

@@ -18,11 +18,11 @@ interface Listable
      * of the marker will depend on the last element returned in the previous response. If a limit is
      * provided, the loop will continue up until that point.
      *
-     * @param array    $def      The operation definition
-     * @param array    $userVals The user values
-     * @param callable $mapFn    an optional callback that will be executed on every resource iteration
+     * @param array         $def      The operation definition
+     * @param array         $userVals The user values
+     * @param callable|null $mapFn    an optional callback that will be executed on every resource iteration
      *
      * @returns \Generator<mixed, static>
      */
-    public function enumerate(array $def, array $userVals = [], callable $mapFn = null);
+    public function enumerate(array $def, array $userVals = [], ?callable $mapFn = null);
 }

src/Common/Resource/OperatorResource.php

@@ -69,7 +69,7 @@ private function getResourcesKey(): string
      *
      * @returns \Generator<mixed, static>
      */
-    public function enumerate(array $def, array $userVals = [], callable $mapFn = null): \Generator
+    public function enumerate(array $def, array $userVals = [], ?callable $mapFn = null): \Generator
     {
         $operation = $this->getOperation($def);
 
@@ -105,7 +105,7 @@ public function enumerate(array $def, array $userVals = [], callable $mapFn = nu
      *
      * @return array<self>
      */
-    public function extractMultipleInstances(ResponseInterface $response, string $key = null): array
+    public function extractMultipleInstances(ResponseInterface $response, ?string $key = null): array
     {
         $key           = $key ?: $this->getResourcesKey();
         $resourcesData = Utils::jsonDecode($response)[$key];

src/Common/Service/Builder.php

@@ -109,7 +109,7 @@ private function stockAuthHandler(array &$options): void
         }
     }
 
-    private function httpClient(string $baseUrl, HandlerStack $stack, string $serviceType = null, string $microVersion = null): ClientInterface
+    private function httpClient(string $baseUrl, HandlerStack $stack, ?string $serviceType = null, ?string $microVersion = null): ClientInterface
     {
         $clientOptions = [
             'base_uri' => Utils::normalizeUrl($baseUrl),

src/Common/Transport/HandlerStack.php

@@ -10,7 +10,7 @@ class HandlerStack
     /**
      * @deprecated use \OpenStack\Common\Transport\HandlerStackFactory::createWithOptions instead
      */
-    public static function create(callable $handler = null): \GuzzleHttp\HandlerStack
+    public static function create(?callable $handler = null): \GuzzleHttp\HandlerStack
     {
         return HandlerStackFactory::create($handler);
     }

src/Common/Transport/HandlerStackFactory.php

@@ -13,7 +13,7 @@ class HandlerStackFactory
     /**
      * @deprecated use \OpenStack\Common\Transport\HandlerStackFactory::createWithOptions instead
      */
-    public static function create(callable $handler = null): HandlerStack
+    public static function create(?callable $handler = null): HandlerStack
     {
         $stack = new HandlerStack($handler ?: Utils::chooseHandler());
         $stack->push(Middleware::httpErrors(), 'http_errors');

src/Common/Transport/Middleware.php

@@ -31,7 +31,7 @@ function (ResponseInterface $response) use ($request, $verbosity) {
         };
     }
 
-    public static function authHandler(callable $tokenGenerator, Token $token = null): callable
+    public static function authHandler(callable $tokenGenerator, ?Token $token = null): callable
     {
         return function (callable $handler) use ($tokenGenerator, $token) {
             return new AuthHandler($handler, $tokenGenerator, $token);
@@ -49,7 +49,7 @@ public static function history(array &$container): callable
     /**
      * @codeCoverageIgnore
      */
-    public static function retry(callable $decider, callable $delay = null): callable
+    public static function retry(callable $decider, ?callable $delay = null): callable
     {
         return GuzzleMiddleware::retry($decider, $delay);
     }

src/Common/Transport/RequestSerializer.php

@@ -11,7 +11,7 @@ class RequestSerializer
 {
     private $jsonSerializer;
 
-    public function __construct(JsonSerializer $jsonSerializer = null)
+    public function __construct(?JsonSerializer $jsonSerializer = null)
     {
         $this->jsonSerializer = $jsonSerializer ?: new JsonSerializer();
     }

src/Common/Transport/Utils.php

@@ -45,7 +45,7 @@ public static function jsonDecode(ResponseInterface $response, bool $assoc = tru
      *
      * @return array
      */
-    public static function flattenJson($data, string $key = null)
+    public static function flattenJson($data, ?string $key = null)
     {
         return (!empty($data) && $key && isset($data[$key])) ? $data[$key] : $data;
     }

src/Compute/v2/Service.php

@@ -44,7 +44,7 @@ public function createServer(array $options): Server
      *
      * @return \Generator<mixed, \OpenStack\Compute\v2\Models\Server>
      */
-    public function listServers(bool $detailed = false, array $options = [], callable $mapFn = null): \Generator
+    public function listServers(bool $detailed = false, array $options = [], ?callable $mapFn = null): \Generator
     {
         $def = (true === $detailed) ? $this->api->getServersDetail() : $this->api->getServers();
 
@@ -72,13 +72,13 @@ public function getServer(array $options = []): Server
     /**
      * List flavors.
      *
-     * @param array    $options  {@see \OpenStack\Compute\v2\Api::getFlavors}
-     * @param callable $mapFn    a callable function that will be invoked on every iteration of the list
-     * @param bool     $detailed set to true to fetch flavors' details
+     * @param array         $options  {@see \OpenStack\Compute\v2\Api::getFlavors}
+     * @param callable|null $mapFn    a callable function that will be invoked on every iteration of the list
+     * @param bool          $detailed set to true to fetch flavors' details
      *
      * @return \Generator<mixed, \OpenStack\Compute\v2\Models\Flavor>
      */
-    public function listFlavors(array $options = [], callable $mapFn = null, bool $detailed = false): \Generator
+    public function listFlavors(array $options = [], ?callable $mapFn = null, bool $detailed = false): \Generator
     {
         $def = true === $detailed ? $this->api->getFlavorsDetail() : $this->api->getFlavors();
 
@@ -119,7 +119,7 @@ public function createFlavor(array $options = []): Flavor
      *
      * @return \Generator<mixed, \OpenStack\Compute\v2\Models\Image>
      */
-    public function listImages(array $options = [], callable $mapFn = null): \Generator
+    public function listImages(array $options = [], ?callable $mapFn = null): \Generator
     {
         return $this->model(Image::class)->enumerate($this->api->getImages(), $options, $mapFn);
     }
@@ -143,12 +143,12 @@ public function getImage(array $options = []): Image
     /**
      * List key pairs.
      *
-     * @param array    $options {@see \OpenStack\Compute\v2\Api::getKeyPairs}
-     * @param callable $mapFn   a callable function that will be invoked on every iteration of the list
+     * @param array         $options {@see \OpenStack\Compute\v2\Api::getKeyPairs}
+     * @param callable|null $mapFn   a callable function that will be invoked on every iteration of the list
      *
      * @return \Generator<mixed, \OpenStack\Compute\v2\Models\Keypair>
      */
-    public function listKeypairs(array $options = [], callable $mapFn = null): \Generator
+    public function listKeypairs(array $options = [], ?callable $mapFn = null): \Generator
     {
         return $this->model(Keypair::class)->enumerate($this->api->getKeypairs(), $options, $mapFn);
     }
@@ -197,14 +197,14 @@ public function getHypervisorStatistics(): HypervisorStatistic
     /**
      * List hypervisors.
      *
-     * @param bool     $detailed Determines whether detailed information will be returned. If FALSE is specified, only
-     *                           the ID, name and links attributes are returned, saving bandwidth.
-     * @param array    $options  {@see \OpenStack\Compute\v2\Api::getHypervisors}
-     * @param callable $mapFn    a callable function that will be invoked on every iteration of the list
+     * @param bool          $detailed Determines whether detailed information will be returned. If FALSE is specified, only
+     *                                the ID, name and links attributes are returned, saving bandwidth.
+     * @param array         $options  {@see \OpenStack\Compute\v2\Api::getHypervisors}
+     * @param callable|null $mapFn    a callable function that will be invoked on every iteration of the list
      *
      * @return \Generator<mixed, \OpenStack\Compute\v2\Models\Hypervisor>
      */
-    public function listHypervisors(bool $detailed = false, array $options = [], callable $mapFn = null): \Generator
+    public function listHypervisors(bool $detailed = false, array $options = [], ?callable $mapFn = null): \Generator
     {
         $def = (true === $detailed) ? $this->api->getHypervisorsDetail() : $this->api->getHypervisors();
 
@@ -224,12 +224,12 @@ public function getHypervisor(array $options = []): Hypervisor
     /**
      * List hosts.
      *
-     * @param array    $options {@see \OpenStack\Compute\v2\Api::getHosts}
-     * @param callable $mapFn   a callable function that will be invoked on every iteration of the list
+     * @param array         $options {@see \OpenStack\Compute\v2\Api::getHosts}
+     * @param callable|null $mapFn   a callable function that will be invoked on every iteration of the list
      *
      * @return \Generator<mixed, \OpenStack\Compute\v2\Models\Host>
      */
-    public function listHosts(array $options = [], callable $mapFn = null): \Generator
+    public function listHosts(array $options = [], ?callable $mapFn = null): \Generator
     {
         return $this->model(Host::class)->enumerate($this->api->getHosts(), $options, $mapFn);
     }
@@ -255,12 +255,12 @@ public function getHost(array $options = []): Host
     /**
      * List AZs.
      *
-     * @param array    $options {@see \OpenStack\Compute\v2\Api::getAvailabilityZones}
-     * @param callable $mapFn   a callable function that will be invoked on every iteration of the list
+     * @param array         $options {@see \OpenStack\Compute\v2\Api::getAvailabilityZones}
+     * @param callable|null $mapFn   a callable function that will be invoked on every iteration of the list
      *
      * @return \Generator<mixed, \OpenStack\Compute\v2\Models\AvailabilityZone>
      */
-    public function listAvailabilityZones(array $options = [], callable $mapFn = null): \Generator
+    public function listAvailabilityZones(array $options = [], ?callable $mapFn = null): \Generator
     {
         return $this->model(AvailabilityZone::class)->enumerate($this->api->getAvailabilityZones(), $options, $mapFn);
     }

src/Images/v2/Models/Schema.php

@@ -8,7 +8,7 @@
 
 class Schema extends \OpenStack\Common\JsonSchema\Schema
 {
-    public function __construct($data, Validator $validator = null)
+    public function __construct($data, ?Validator $validator = null)
     {
         if (!isset($data->type)) {
             $data->type = 'object';

src/Networking/v2/Extensions/Layer3/Api.php

@@ -26,6 +26,7 @@ public function postFloatingIps(): array
             'jsonKey' => 'floatingip',
             'params'  => [
                 'tenantId'          => $this->params->tenantIdJson(),
+                'description'       => $this->notRequired($this->params->descriptionJson()),
                 'floatingNetworkId' => $this->params->floatingNetworkIdJson(),
                 'fixedIpAddress'    => $this->params->fixedIpAddressJson(),
                 'floatingIpAddress' => $this->params->floatingIpAddressJson(),
@@ -53,6 +54,7 @@ public function putFloatingIp(): array
             'jsonKey' => 'floatingip',
             'params'  => [
                 'id'                => $this->params->idPath(),
+                'description'       => $this->notRequired($this->params->descriptionJson()),
                 'floatingNetworkId' => $this->notRequired($this->params->floatingNetworkIdJson()),
                 'fixedIpAddress'    => $this->params->fixedIpAddressJson(),
                 'floatingIpAddress' => $this->params->floatingIpAddressJson(),