[FT] Add new Schema Registry compatibility modes (#23)

* [CI] Simplifying `Makefile`

* [CI] Enable PHP 7.3 docker build and use xdebug 2.7.0

* [CI] Upgrade `.php_cs.dist` file to support new cs-fixer versions

* [FT] Add new SR compatibility modes

* [CI] Use `-l 7` for low compat reasons

* [FX] Add return types to `ExceptionMapTest`

Author: tPl0ch

.php_cs.dist

@@ -10,7 +10,10 @@ return PhpCsFixer\Config::create()
     ->setRules(
         [
             'no_unused_imports' => true,
-            'ordered_imports' => true,
+            'ordered_imports' => [
+                'sort_algorithm' => 'alpha',
+                'imports_order' => ['class', 'const', 'function'],
+            ],
             'phpdoc_summary' => false,
             'phpdoc_to_comment' => false,
             'concat_space' => ['spacing' => 'one'],

.travis.yml

@@ -8,6 +8,7 @@ services:
 php:
 - '7.1'
 - '7.2'
+- '7.3'
 
 env:
   global:
@@ -32,13 +33,13 @@ script:
 jobs:
   include:
   - stage: coverage
-    php: 7.2
+    php: '7.2'
     env:
     - DEPENDENCIES="stable"
     script:
     - PHP=php make coverage
   - stage: integration
-    php: 7.2
+    php: '7.2'
     env:
     - DEPENDENCIES="stable"
     - INTEGRATION_TEST="enabled"
@@ -47,7 +48,7 @@ jobs:
     - make platform
     - PHP=php make phpunit-integration
   - stage: integration
-    php: 7.2
+    php: '7.2'
     env:
     - DEPENDENCIES="stable"
     - INTEGRATION_TEST="enabled"
@@ -56,7 +57,7 @@ jobs:
     - make platform
     - PHP=php make phpunit-integration
   - stage: integration
-    php: 7.2
+    php: '7.2'
     env:
     - DEPENDENCIES="stable"
     - INTEGRATION_TEST="enabled"
@@ -65,7 +66,7 @@ jobs:
     - make platform
     - PHP=php make phpunit-integration
   - stage: integration
-    php: 7.2
+    php: '7.2'
     env:
     - DEPENDENCIES="stable"
     - INTEGRATION_TEST="enabled"
@@ -74,7 +75,7 @@ jobs:
     - make platform
     - PHP=php make phpunit-integration
   - stage: integration
-    php: 7.2
+    php: '7.2'
     env:
     - DEPENDENCIES="stable"
     - INTEGRATION_TEST="enabled"
@@ -83,7 +84,7 @@ jobs:
     - make platform
     - PHP=php make phpunit-integration
   - stage: integration
-    php: 7.2
+    php: '7.2'
     env:
     - DEPENDENCIES="stable"
     - INTEGRATION_TEST="enabled"

Dockerfile

@@ -2,10 +2,10 @@ ARG PHP_VERSION=7.1
 
 FROM php:${PHP_VERSION}-cli-alpine
 
-ARG XDEBUG_VERSION=2.6.1
+ARG XDEBUG_VERSION=2.7.0RC1
 
-RUN apk add --no-cache --virtual .build-deps $PHPIZE_DEPS zlib-dev \
-    && apk add --no-cache --virtual .runtime-deps git \
+RUN apk add --no-cache --virtual .build-deps $PHPIZE_DEPS \
+    && apk add --no-cache --virtual .runtime-deps git libzip-dev \
     && docker-php-ext-install zip \
     && pecl install xdebug-$XDEBUG_VERSION \
     && docker-php-ext-enable xdebug \

Makefile

@@ -1,18 +1,18 @@
 # no buildin rules and variables
 MAKEFLAGS =+ -rR --warn-undefined-variables
 
-.PHONY: composer-install composer-update phpstan cs-fixer examples docker run
+.PHONY: composer-install composer-update phpstan cs-fixer cs-fixer-modify examples coverage docker run ci-local platform
 
 CONFLUENT_VERSION ?= latest
 CONFLUENT_NETWORK_SUBNET ?= 172.68.0.0/24
 SCHEMA_REGISTRY_IPV4 ?= 172.68.0.103
 KAFKA_BROKER_IPV4 ?= 172.68.0.102
 ZOOKEEPER_IPV4 ?= 172.68.0.101
 COMPOSER ?= bin/composer.phar
-COMPOSER_VERSION ?= 1.7.2
+COMPOSER_VERSION ?= 1.8.3
 PHP ?= bin/php
 PHP_VERSION ?= 7.2
-XDEBUG_VERSION ?= 2.6.1
+XDEBUG_VERSION ?= 2.7.0RC1
 
 export
 
@@ -72,7 +72,7 @@ install-phars:
 platform:
 	docker-compose down
 	docker-compose up -d
-	sleep 20
+	sleep 25
 
 clean:
 	rm -rf build

src/Constants/Constants.php

@@ -4,7 +4,10 @@
 
 const COMPATIBILITY_NONE = 'NONE';
 const COMPATIBILITY_BACKWARD = 'BACKWARD';
+const COMPATIBILITY_BACKWARD_TRANSITIVE = 'BACKWARD_TRANSITIVE';
 const COMPATIBILITY_FORWARD = 'FORWARD';
+const COMPATIBILITY_FORWARD_TRANSITIVE = 'FORWARD_TRANSITIVE';
 const COMPATIBILITY_FULL = 'FULL';
+const COMPATIBILITY_FULL_TRANSITIVE = 'FULL_TRANSITIVE';
 
 const VERSION_LATEST = 'latest';

src/Requests/Functions.php

@@ -7,8 +7,11 @@
 use GuzzleHttp\UriTemplate;
 use Psr\Http\Message\RequestInterface;
 use const FlixTech\SchemaRegistryApi\Constants\COMPATIBILITY_BACKWARD;
+use const FlixTech\SchemaRegistryApi\Constants\COMPATIBILITY_BACKWARD_TRANSITIVE;
 use const FlixTech\SchemaRegistryApi\Constants\COMPATIBILITY_FORWARD;
+use const FlixTech\SchemaRegistryApi\Constants\COMPATIBILITY_FORWARD_TRANSITIVE;
 use const FlixTech\SchemaRegistryApi\Constants\COMPATIBILITY_FULL;
+use const FlixTech\SchemaRegistryApi\Constants\COMPATIBILITY_FULL_TRANSITIVE;
 use const FlixTech\SchemaRegistryApi\Constants\COMPATIBILITY_NONE;
 use const FlixTech\SchemaRegistryApi\Constants\VERSION_LATEST;
 
@@ -154,7 +157,16 @@ function prepareJsonSchemaForTransfer(string $schema): string
 function validateCompatibilityLevel(string $compatibilityVersion): string
 {
     Assert::that($compatibilityVersion)->inArray(
-        [COMPATIBILITY_NONE, COMPATIBILITY_BACKWARD, COMPATIBILITY_FORWARD, COMPATIBILITY_FULL],
+        [
+            COMPATIBILITY_NONE,
+            COMPATIBILITY_BACKWARD,
+            COMPATIBILITY_BACKWARD_TRANSITIVE,
+            COMPATIBILITY_FORWARD,
+            COMPATIBILITY_FORWARD_TRANSITIVE,
+            COMPATIBILITY_FULL,
+            COMPATIBILITY_FULL_TRANSITIVE,
+
+        ],
         '$level must be one of "NONE", "BACKWARD", "FORWARD" or "FULL"'
     );
 

test/Exception/ExceptionMapTest.php

@@ -27,7 +27,7 @@ class ExceptionMapTest extends TestCase
     /**
      * @test
      */
-    public function it_should_handle_InvalidAvroSchema_code()
+    public function it_should_handle_InvalidAvroSchema_code(): void
     {
         $this->assertSchemaRegistryException(
             InvalidAvroSchemaException::class,
@@ -50,7 +50,7 @@ public function it_should_handle_InvalidAvroSchema_code()
     /**
      * @test
      */
-    public function it_should_handle_IncompatibleAvroSchema_code()
+    public function it_should_handle_IncompatibleAvroSchema_code(): void
     {
         $this->assertSchemaRegistryException(
             IncompatibleAvroSchemaException::class,
@@ -73,7 +73,7 @@ public function it_should_handle_IncompatibleAvroSchema_code()
     /**
      * @test
      */
-    public function it_should_handle_BackendDataStore_code()
+    public function it_should_handle_BackendDataStore_code(): void
     {
         $this->assertSchemaRegistryException(
             BackendDataStoreException::class,
@@ -96,7 +96,7 @@ public function it_should_handle_BackendDataStore_code()
     /**
      * @test
      */
-    public function it_should_handle_InvalidCompatibilityLevel_code()
+    public function it_should_handle_InvalidCompatibilityLevel_code(): void
     {
         $this->assertSchemaRegistryException(
             InvalidCompatibilityLevelException::class,
@@ -119,7 +119,7 @@ public function it_should_handle_InvalidCompatibilityLevel_code()
     /**
      * @test
      */
-    public function it_should_handle_InvalidVersion_code()
+    public function it_should_handle_InvalidVersion_code(): void
     {
         $this->assertSchemaRegistryException(
             InvalidVersionException::class,
@@ -142,7 +142,7 @@ public function it_should_handle_InvalidVersion_code()
     /**
      * @test
      */
-    public function it_should_handle_MasterProxy_code()
+    public function it_should_handle_MasterProxy_code(): void
     {
         $this->assertSchemaRegistryException(
             MasterProxyException::class,
@@ -165,7 +165,7 @@ public function it_should_handle_MasterProxy_code()
     /**
      * @test
      */
-    public function it_should_handle_OperationTimedOut_code()
+    public function it_should_handle_OperationTimedOut_code(): void
     {
         $this->assertSchemaRegistryException(
             OperationTimedOutException::class,
@@ -188,7 +188,7 @@ public function it_should_handle_OperationTimedOut_code()
     /**
      * @test
      */
-    public function it_should_handle_SchemaNotFound_code()
+    public function it_should_handle_SchemaNotFound_code(): void
     {
         $this->assertSchemaRegistryException(
             SchemaNotFoundException::class,
@@ -211,7 +211,7 @@ public function it_should_handle_SchemaNotFound_code()
     /**
      * @test
      */
-    public function it_should_handle_SubjectNotFound_code()
+    public function it_should_handle_SubjectNotFound_code(): void
     {
         $this->assertSchemaRegistryException(
             SubjectNotFoundException::class,
@@ -234,7 +234,7 @@ public function it_should_handle_SubjectNotFound_code()
     /**
      * @test
      */
-    public function it_should_handle_VersionNotFound_code()
+    public function it_should_handle_VersionNotFound_code(): void
     {
         $this->assertSchemaRegistryException(
             VersionNotFoundException::class,
@@ -260,7 +260,7 @@ public function it_should_handle_VersionNotFound_code()
      * @expectedException \RuntimeException
      * @expectedExceptionMessage RequestException has no response to inspect
      */
-    public function it_should_not_process_exceptions_with_missing_response()
+    public function it_should_not_process_exceptions_with_missing_response(): void
     {
         (ExceptionMap::instance())(
             new RequestException(
@@ -275,7 +275,7 @@ public function it_should_not_process_exceptions_with_missing_response()
      *
      * @expectedException \LogicException
      */
-    public function it_will_check_for_invalid_schema_registry_exceptions_not_defining_a_code()
+    public function it_will_check_for_invalid_schema_registry_exceptions_not_defining_a_code(): void
     {
         InvalidNewSchemaRegistryException::errorCode();
     }
@@ -286,7 +286,7 @@ public function it_will_check_for_invalid_schema_registry_exceptions_not_definin
      * @expectedException \RuntimeException
      * @expectedExceptionMessage Invalid message body received - cannot find "error_code" field in response body
      */
-    public function it_should_not_process_exceptions_with_missing_error_codes()
+    public function it_should_not_process_exceptions_with_missing_error_codes(): void
     {
         (ExceptionMap::instance())(
             new RequestException(
@@ -307,7 +307,7 @@ public function it_should_not_process_exceptions_with_missing_error_codes()
      * @expectedException \RuntimeException
      * @expectedExceptionMessage Unknown error code "99999"
      */
-    public function it_should_not_process_unknown_error_codes()
+    public function it_should_not_process_unknown_error_codes(): void
     {
         (ExceptionMap::instance())(
             new RequestException(
@@ -327,7 +327,8 @@ private function assertSchemaRegistryException(
         string $expectedMessage,
         int $errorCode,
         SchemaRegistryException $exception
-    ) {
+    ): void
+    {
         $this->assertInstanceOf($exceptionClass, $exception);
         $this->assertEquals($errorCode, $exception->getCode());
         $this->assertEquals($expectedMessage, $exception->getMessage());