[MAD-15408] adding block storage v3 support

.gitattributes

@@ -0,0 +1,11 @@
+/.github export-ignore
+/doc export-ignore
+/samples export-ignore
+/tests export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.php-cs-fixer.dist.php export-ignore
+/.readthedocs.yaml export-ignore
+/.scrutinizer.yml export-ignore
+/phpunit.sample.xml.dist export-ignore
+/phpunit.xml.dist export-ignore

.github/workflows/format.yml

@@ -0,0 +1,50 @@
+name: "Format"
+on:
+  push:
+    branches:
+      - '*'
+
+jobs:
+  composer-normalize:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          extensions: mbstring
+          php-version: 8.2
+
+      - run: composer install --no-interaction --no-progress --no-suggest
+
+      - run: composer normalize
+
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Normalize composer.json
+
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          extensions: mbstring
+          php-version: 8.1
+
+      - run: composer install --no-interaction --no-progress --no-suggest
+
+      - run: vendor/bin/php-cs-fixer fix
+
+      - run: git pull
+
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Apply php-cs-fixer changes

.github/workflows/integration_tests.yml

@@ -0,0 +1,124 @@
+name: Integration Tests
+
+on:
+  workflow_dispatch:
+    inputs:
+      tmate_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled'
+        required: false
+        default: false
+      openstack_version:
+        description: 'Comma-separated list of Openstack versions e.g. "stable/2025.1", "unmaintained/zed"'
+        required: false
+        default: false
+  pull_request:
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    if: |
+      !contains(github.event.pull_request.body, 'skip ci') 
+      && !contains(github.event.pull_request.body, 'skip integration')
+    strategy:
+      fail-fast: false
+      matrix:
+        openstack_version: ${{ fromJSON(format('[{0}]', inputs.openstack_version || vars.OPENSTACK_VERSIONS )) }}
+        php_version: [ 8.1 ]
+        ubuntu_version: [ 22.04 ]
+    runs-on: ubuntu-${{ matrix.ubuntu_version }}
+    name: Deploy OpenStack ${{ matrix.openstack_version }} and run integration tests with php ${{matrix.php_version}}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: get cache directory
+        id: composer-cache
+        run: |
+          echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.php_cs.cache
+            ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ matrix.php_version }}-${{ hashFiles('**.composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-${{ matrix.php_version }}-
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php_version }}
+          extensions: curl
+          tools: composer:v2
+          coverage: none
+
+      - run: composer install --prefer-dist --no-interaction --no-progress
+
+      - name: Restore devstack cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            /opt/stack/*
+            !/opt/stack/data
+            ~/devstack/
+          key: ${{ runner.os }}-openstack-${{ matrix.openstack_version }}-${{ github.workflow }}
+
+      - name: Deploy devstack
+        uses: EmilienM/devstack-action@v0.15
+        with:
+          branch: ${{ matrix.openstack_version }}
+          conf_overrides: |
+            CINDER_ISCSI_HELPER=lioadm
+            SWIFT_ENABLE_TEMPURLS=True
+            SWIFT_TEMPURL_KEY=secretkey
+            TARGET_BRANCH=${{ matrix.openstack_version }}
+            [[post-config|\$SWIFT_CONFIG_PROXY_SERVER]]
+            [filter:versioned_writes]
+            allow_object_versioning = true
+          enabled_services: 's-account,s-container,s-object,s-proxy,s-bak'
+
+      - name: Set env variables
+        run: |
+          {
+            echo OS_AUTH_URL="$(grep -oP -m 1 "(?<=auth_url: )(.*)\$" /etc/openstack/clouds.yaml)/v3"
+            echo OS_REGION=RegionOne
+            echo OS_REGION_NAME=RegionOne
+            echo OS_USER_ID=$(openstack --os-cloud=devstack-admin user show admin -f value -c id)
+            echo OS_USERNAME=admin
+            echo OS_PASSWORD=secret
+            echo OS_PROJECT_ID=$(openstack --os-cloud=devstack-admin project show admin -f value -c id)
+            echo OS_PROJECT_NAME=admin
+            echo OS_RESIZE_FLAVOR=c1
+            echo OS_FLAVOR=1
+            echo OS_DOMAIN_ID=default
+          } >> "$GITHUB_ENV"
+
+      - name: Check if Block Storage API v2 must be tested
+        if: matrix.block_storage_v2 == true
+        run: echo "OS_BLOCK_STORAGE_V2=1" >> "$GITHUB_ENV"
+
+      - name: Execute Integration tests via PhpUnit
+        run: vendor/bin/phpunit --configuration ./phpunit.sample.xml.dist
+
+      - name: Collect logs
+        if: ${{ failure() }}
+        run: |
+          set -x
+          journalctl >failure-logs
+
+      - name: Save logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: failure-logs-${{ strategy.job-index }}
+          path: failure-logs
+
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ always() && github.event_name == 'workflow_dispatch' && inputs.tmate_enabled }}

.github/workflows/unit_tests.yml

@@ -0,0 +1,57 @@
+name: Unit Tests
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-22.04
+    if: |
+      !contains(github.event.pull_request.body, 'skip ci') 
+      && !contains(github.event.pull_request.body, 'skip unit')
+    strategy:
+      fail-fast: false
+      matrix:
+         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"
+           - name: highest
+             arg: "" # No args added as highest is default
+    name: PHPUnit on PHP ${{ matrix.php }} with ${{ matrix.composer.name }} dependencies
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: get cache directory
+        id: composer-cache
+        run: |
+          echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.php_cs.cache
+            ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-cache-${{ matrix.php }}-${{ matrix.composer.name }}-${{ hashFiles('**.composer.lock') }}
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: curl
+          tools: composer:v2
+          coverage: none
+
+      - run: composer update --prefer-dist --no-interaction --no-progress ${{ matrix.composer.arg }}
+
+      - run: vendor/bin/parallel-lint --exclude vendor .
+
+      - name: execute unit tests
+        run: vendor/bin/phpunit --configuration phpunit.xml.dist
+

.gitignore

@@ -4,6 +4,7 @@ coverage/
 vendor/
 *.pyc
 phpunit.xml
+.phpunit.result.cache
 coverage.xml
 composer.lock
 env_test.sh

.php_cs.dist → .php-cs-fixer.dist.php

@@ -4,7 +4,7 @@
     exit(0);
 }
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setRules(
         [
             '@PSR2'                  => true,

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "doc/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: doc/requirements.txt