feat(BE-2913): use code style for tests, too; upgrade rdkafka (#39)

jobcloud · Jul 14, 2022 · 79bed1d · 79bed1d
1 parent 85903ef
commit 79bed1d
Show file tree

Hide file tree

Showing 22 changed files with 142 additions and 102 deletions.
diff --git a/docker/dev/php/Dockerfile b/docker/dev/php/Dockerfile
@@ -40,7 +40,7 @@ RUN ln -s /run/secrets/ssh_host_key /root/.ssh/id_rsa && \
 
 # PHP: Install php extensions
 RUN pecl channel-update pecl.php.net && \
-    pecl install pcov rdkafka-6.0.2 && \
+    pecl install pcov rdkafka-6.0.3 && \
     php-ext-enable pcov rdkafka
 
 # COMPOSER: install binary

diff --git a/phpcs.xml b/phpcs.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PHP_CodeSniffer" xsi:noNamespaceSchemaLocation="phpcs.xsd">
     <file>src</file>
+    <file>tests</file>
     <rule ref="PSR12"/>
     <arg name="report-gitblame"/>
     <arg name="report-full"/>

diff --git a/tests/AbstractSchemaRegistryTestCase.php b/tests/AbstractSchemaRegistryTestCase.php
@@ -9,7 +9,7 @@
 abstract class AbstractSchemaRegistryTestCase extends TestCase
 {
     /**
-     * @param $class
+     * @param string $class
      * @param array|null $methodMap (array of method returns, or NULL)
      *     1. NULL - Methods won't be mocked, it will run original code
      *     2. Array of method names - ['method_name' => 'method_value',...].
@@ -27,14 +27,24 @@ final public function makeMock(string $class, array $methodMap = []): MockObject
         }
 
         $methodNames = array_merge(
-            array_keys(array_filter($methodMap, static function ($key){
-                return !is_numeric($key);
-                }, ARRAY_FILTER_USE_KEY
-            )),
-            array_values(array_filter($methodMap, static function ($key){
-                return is_numeric($key);
-                }, ARRAY_FILTER_USE_KEY
-            ))
+            array_keys(
+                array_filter(
+                    $methodMap,
+                    static function ($key) {
+                        return !is_numeric($key);
+                    },
+                    ARRAY_FILTER_USE_KEY
+                )
+            ),
+            array_values(
+                array_filter(
+                    $methodMap,
+                    static function ($key) {
+                        return is_numeric($key);
+                    },
+                    ARRAY_FILTER_USE_KEY
+                )
+            )
         );
 
         $mock = $mockBuilder->onlyMethods($methodNames)->getMock();
@@ -65,12 +75,12 @@ final public function makeMock(string $class, array $methodMap = []): MockObject
      * @param string $className
      * @param array $array
      */
-    protected static function assertArrayHasInstanceOf(string $className, array $array):void
+    protected static function assertArrayHasInstanceOf(string $className, array $array): void
     {
-        $filtered = array_filter($array, static function ($item) use ($className){
+        $filtered = array_filter($array, static function ($item) use ($className) {
             return $item instanceof $className;
         });
 
         self::assertGreaterThan(0, count($filtered));
     }
-}
+}
diff --git a/tests/Command/CheckAllSchemaTemplatesDocCommentsCommandTest.php b/tests/Command/CheckAllSchemaTemplatesDocCommentsCommandTest.php
@@ -80,7 +80,7 @@ class CheckAllSchemaTemplatesDocCommentsCommandTest extends AbstractSchemaRegist
     protected function setUp(): void
     {
         parent::setUp();
-        if (!file_exists(self::SCHEMA_DIRECTORY)){
+        if (!file_exists(self::SCHEMA_DIRECTORY)) {
             mkdir(self::SCHEMA_DIRECTORY);
         }
     }
@@ -97,7 +97,7 @@ protected function tearDown(): void
         }
     }
 
-    public function testOutputWhenAllValid():void
+    public function testOutputWhenAllValid(): void
     {
         file_put_contents(
             sprintf('%s/test.schema.%d.avsc', self::SCHEMA_DIRECTORY, 1),
@@ -119,7 +119,7 @@ public function testOutputWhenAllValid():void
         self::assertEquals(0, $commandTester->getStatusCode());
     }
 
-    public function testOutputWhenAllNotInvalid():void
+    public function testOutputWhenAllNotInvalid(): void
     {
         file_put_contents(
             sprintf('%s/test.schema.bad.avsc', self::SCHEMA_DIRECTORY),
@@ -151,7 +151,7 @@ public function testOutputWhenAllNotInvalid():void
         self::assertEquals(1, $commandTester->getStatusCode());
     }
 
-    public function testExceptionWhenAllNotInvalid():void
+    public function testExceptionWhenAllNotInvalid(): void
     {
         file_put_contents(
             sprintf('%s/test.schema.bad1.avsc', self::SCHEMA_DIRECTORY),

diff --git a/tests/Command/CheckAllSchemasAreValidAvroCommandTest.php b/tests/Command/CheckAllSchemasAreValidAvroCommandTest.php
@@ -67,7 +67,7 @@ class CheckAllSchemasAreValidAvroCommandTest extends AbstractSchemaRegistryTestC
     protected function setUp(): void
     {
         parent::setUp();
-        if (!file_exists(self::SCHEMA_DIRECTORY)){
+        if (!file_exists(self::SCHEMA_DIRECTORY)) {
             mkdir(self::SCHEMA_DIRECTORY);
         }
     }
@@ -78,7 +78,7 @@ protected function setUp(): void
     protected function tearDown(): void
     {
         parent::tearDown();
-        if (file_exists(self::SCHEMA_DIRECTORY)){
+        if (file_exists(self::SCHEMA_DIRECTORY)) {
             array_map('unlink', glob(self::SCHEMA_DIRECTORY . '/*.*'));
             rmdir(self::SCHEMA_DIRECTORY);
         }
@@ -88,10 +88,11 @@ protected function tearDown(): void
      * @param int $numberOfFiles
      * @param bool $makeBad
      */
-    protected function generateFiles(int $numberOfFiles, bool $makeBad = false): void {
-        $numbers = range(1,$numberOfFiles);
+    protected function generateFiles(int $numberOfFiles, bool $makeBad = false): void
+    {
+        $numbers = range(1, $numberOfFiles);
 
-        if($makeBad) {
+        if ($makeBad) {
             file_put_contents(
                 sprintf('%s/test.schema.bad1.avsc', self::SCHEMA_DIRECTORY),
                 self::BAD_SCHEMA
@@ -103,15 +104,15 @@ protected function generateFiles(int $numberOfFiles, bool $makeBad = false): voi
             );
         }
 
-        array_walk($numbers , static function ($item) {
+        array_walk($numbers, static function ($item) {
             file_put_contents(
                 sprintf('%s/test.schema.%d.avsc', self::SCHEMA_DIRECTORY, $item),
                 self::GOOD_SCHEMA
             );
         });
     }
 
-    public function testOutputWhenAllValid():void
+    public function testOutputWhenAllValid(): void
     {
         $this->generateFiles(5);
 
@@ -130,7 +131,7 @@ public function testOutputWhenAllValid():void
         self::assertEquals(0, $commandTester->getStatusCode());
     }
 
-    public function testOutputWhenAllNotInvalid():void
+    public function testOutputWhenAllNotInvalid(): void
     {
         $this->generateFiles(5, true);
 

diff --git a/tests/Command/CheckAllSchemasCompatibilityCommandTest.php b/tests/Command/CheckAllSchemasCompatibilityCommandTest.php
@@ -47,7 +47,7 @@ class CheckAllSchemasCompatibilityCommandTest extends AbstractSchemaRegistryTest
     protected function setUp(): void
     {
         parent::setUp();
-        if (!file_exists(self::SCHEMA_DIRECTORY)){
+        if (!file_exists(self::SCHEMA_DIRECTORY)) {
             mkdir(self::SCHEMA_DIRECTORY);
         }
     }
@@ -58,7 +58,7 @@ protected function setUp(): void
     protected function tearDown(): void
     {
         parent::tearDown();
-        if (file_exists(self::SCHEMA_DIRECTORY)){
+        if (file_exists(self::SCHEMA_DIRECTORY)) {
             array_map('unlink', glob(self::SCHEMA_DIRECTORY . '/*.*'));
             rmdir(self::SCHEMA_DIRECTORY);
         }
@@ -68,10 +68,11 @@ protected function tearDown(): void
      * @param int $numberOfFiles
      * @param string $contents
      */
-    protected function generateFiles(int $numberOfFiles, string $contents = self::DUMMY_SCHEMA): void {
-        $numbers = range(1,$numberOfFiles);
+    protected function generateFiles(int $numberOfFiles, string $contents = self::DUMMY_SCHEMA): void
+    {
+        $numbers = range(1, $numberOfFiles);
 
-        array_walk($numbers , static function ($item) use ($contents) {
+        array_walk($numbers, static function ($item) use ($contents) {
             file_put_contents(
                 sprintf('%s/test.schema.%d.avsc', self::SCHEMA_DIRECTORY, $item),
                 $contents
@@ -84,13 +85,13 @@ protected function generateFiles(int $numberOfFiles, string $contents = self::DU
         );
     }
 
-    public function testOutputWhenAllCompatible():void
+    public function testOutputWhenAllCompatible(): void
     {
         $this->generateFiles(5);
 
         /** @var MockObject|KafkaSchemaRegistryApiClient $schemaRegistryApi */
         $schemaRegistryApi = $this->makeMock(KafkaSchemaRegistryApiClient::class, [
-            'checkSchemaCompatibilityForVersion' => TRUE,
+            'checkSchemaCompatibilityForVersion' => true,
             'getSchemaDefinitionByVersion',
             'getLatestSubjectVersion' => '1'
         ]);
@@ -115,7 +116,7 @@ public function testOutputWhenAllCompatible():void
         self::assertEquals(0, $commandTester->getStatusCode());
     }
 
-    public function testOutputWhenAllNotCompatible():void
+    public function testOutputWhenAllNotCompatible(): void
     {
         $this->generateFiles(5);
 

diff --git a/tests/Command/CheckCompatibilityCommandTest.php b/tests/Command/CheckCompatibilityCommandTest.php
@@ -43,8 +43,7 @@ public function testCommand(
         $versionArgument,
         string $expectedOutput,
         int $expectedExitCode
-    ):void
-    {
+    ): void {
         /** @var MockObject|KafkaSchemaRegistryApiClient $schemaRegistryApi */
         $schemaRegistryApi = $this->makeMock(KafkaSchemaRegistryApiClient::class, [
             'checkSchemaCompatibilityForVersion' => $actualCompatible,

diff --git a/tests/Command/CheckDocCommentsCommandTest.php b/tests/Command/CheckDocCommentsCommandTest.php
@@ -75,7 +75,8 @@ class CheckDocCommentsCommandTest extends AbstractSchemaRegistryTestCase
 }
 EOF;
 
-    public function testCommandSuccess(): void {
+    public function testCommandSuccess(): void
+    {
         $application = new Application();
         $application->add(new CheckDocCommentsCommand());
         $command = $application->find('kafka-schema-registry:check:template:doc');
@@ -93,7 +94,8 @@ public function testCommandSuccess(): void {
         self::assertEquals(0, $commandTester->getStatusCode());
     }
 
-    public function testCommandBadSchema(): void {
+    public function testCommandBadSchema(): void
+    {
         $application = new Application();
         $application->add(new CheckDocCommentsCommand());
         $command = $application->find('kafka-schema-registry:check:template:doc');
@@ -111,7 +113,8 @@ public function testCommandBadSchema(): void {
         self::assertEquals(1, $commandTester->getStatusCode());
     }
 
-    public function testCommandBadSchema1(): void {
+    public function testCommandBadSchema1(): void
+    {
         $application = new Application();
         $application->add(new CheckDocCommentsCommand());
         $command = $application->find('kafka-schema-registry:check:template:doc');
@@ -126,7 +129,8 @@ public function testCommandBadSchema1(): void {
         ]);
     }
 
-    public function testCommandBadSchema2(): void {
+    public function testCommandBadSchema2(): void
+    {
         $application = new Application();
         $application->add(new CheckDocCommentsCommand());
         $command = $application->find('kafka-schema-registry:check:template:doc');

diff --git a/tests/Command/CheckIsRegisteredCommandTest.php b/tests/Command/CheckIsRegisteredCommandTest.php
@@ -38,7 +38,7 @@ public function argumentsDataProvider(): array
      * @param string $expectedOutput
      * @param int $expectedExitCode
      */
-    public function testCommand(?string $actualVersion, string $expectedOutput, int $expectedExitCode):void
+    public function testCommand(?string $actualVersion, string $expectedOutput, int $expectedExitCode): void
     {
         /** @var MockObject|KafkaSchemaRegistryApiClient $schemaRegistryApi */
         $schemaRegistryApi = $this->makeMock(KafkaSchemaRegistryApiClient::class, [

diff --git a/tests/Command/GetCompatibilityModeForSchemaCommandTest.php b/tests/Command/GetCompatibilityModeForSchemaCommandTest.php
@@ -16,7 +16,7 @@
  */
 class GetCompatibilityModeForSchemaCommandTest extends AbstractSchemaRegistryTestCase
 {
-    public function testCommand():void
+    public function testCommand(): void
     {
         /** @var MockObject|KafkaSchemaRegistryApiClient $schemaRegistryApi */
         $schemaRegistryApi = $this->makeMock(KafkaSchemaRegistryApiClient::class, [

diff --git a/tests/Command/GetLatestSchemaCommandTest.php b/tests/Command/GetLatestSchemaCommandTest.php
@@ -74,7 +74,7 @@ public function testMissingSchema(): void
         self::assertEquals(1, $commandTester->getStatusCode());
     }
 
-    public function testUnknownClientErrorCodeThrowsException():void
+    public function testUnknownClientErrorCodeThrowsException(): void
     {
         $clientException = new ClientException('ERROR MESSAGE', 401);
 

diff --git a/tests/Command/GetSchemaByVersionCommandTest.php b/tests/Command/GetSchemaByVersionCommandTest.php
@@ -18,7 +18,7 @@ class GetSchemaByVersionCommandTest extends AbstractSchemaRegistryTestCase
 {
     protected const SCHEMA_TEST_FILE = '/tmp/test.avsc';
 
-    public function testCommand():void
+    public function testCommand(): void
     {
         $schema = [];
 
@@ -47,7 +47,7 @@ public function testCommand():void
         self::assertEquals(json_encode($schema, JSON_THROW_ON_ERROR), $fileContents);
     }
 
-    public function testCommandFailToReadFile():void
+    public function testCommandFailToReadFile(): void
     {
         $failurePath = '..';
 

diff --git a/tests/Command/ListAllSchemasCommandTest.php b/tests/Command/ListAllSchemasCommandTest.php
@@ -16,7 +16,7 @@
  */
 class ListAllSchemasCommandTest extends AbstractSchemaRegistryTestCase
 {
-    public function testCommand():void
+    public function testCommand(): void
     {
         /** @var MockObject|KafkaSchemaRegistryApiClient $schemaRegistryApi */
         $schemaRegistryApi = $this->makeMock(KafkaSchemaRegistryApiClient::class, [

diff --git a/tests/Command/ListVersionForSchemaCommandTest.php b/tests/Command/ListVersionForSchemaCommandTest.php
@@ -16,7 +16,7 @@
  */
 class ListVersionForSchemaCommandTest extends AbstractSchemaRegistryTestCase
 {
-    public function testCommand():void
+    public function testCommand(): void
     {
         /** @var MockObject|KafkaSchemaRegistryApiClient $schemaRegistryApi */
         $schemaRegistryApi = $this->makeMock(KafkaSchemaRegistryApiClient::class, [