Merge pull request #258 from lmc-eu/feature/reflections-replace

Replace deprecated nette/reflection

CHANGELOG.md

@@ -19,6 +19,7 @@
 - Don't hardcode timezone to `Europe/Prague`. Timezone is now used based on your PHP settings ([date.timezone](https://php.net/manual/en/datetime.configuration.php#ini.date.timezone)).
 - Server URL now must be provided including URL prefix (if it has one, like `/wd/hub`) - eg. `http://foo.bar:4444/wd/hub`. This means the `/wd/hub` part is now never auto-amended.
 - Package `symfony/polyfill-mbstring` now provides mbstring functions even if PHP mbstring extension is not installed.
+- Read annotations (like `@group`, `@noBrowser` etc.) using different and more-robust underlying library.
 
 ### Fixed
 - Remote server running in W3C-protocol mode (eg. Selenium v3.5.3+) was erroneously detected as BrowserStack cloud service.

composer.json

@@ -32,10 +32,11 @@
         "doctrine/inflector": "^2.0.3",
         "florianwolters/component-util-singleton": "0.3.2",
         "graphp/algorithms": "^0.8.1",
-        "nette/reflection": "^2.4.2",
         "ondram/ci-detector": "^3.1",
         "php-webdriver/webdriver": "^1.8.1",
+        "phpdocumentor/reflection-docblock": "^5.2",
         "phpunit/phpunit": "^7.5.20",
+        "roave/better-reflection": "^4.3",
         "symfony/console": "^4.0",
         "symfony/event-dispatcher": "^4.0",
         "symfony/filesystem": "^4.0",

easy-coding-standard.yaml

@@ -18,3 +18,4 @@ parameters:
     exclude_files:
         - 'src-tests/coverage/*'
         - 'src-tests/FunctionalTests/logs/coverage/*'
+        - 'src-tests/Utils/Annotations/Fixtures/*'

src-tests/Process/ProcessSetCreatorTest.php

@@ -120,16 +120,6 @@ public function testShouldCreateProcessSetFromGivenFiles(): void
         $this->assertSame('/foo/bar/logs', $testEnv['LOGS_DIR']);
     }
 
-    public function testShouldThrowExceptionIfAddingFileWithNoClass(): void
-    {
-        $files = $this->findDummyTests('NoClassTest.php', 'InvalidTests');
-
-        $this->expectException(\RuntimeException::class);
-        $this->expectExceptionMessageRegExp('/No class found in file ".*NoClassTest.php"/');
-
-        $this->creator->createFromFiles($files, [], []);
-    }
-
     public function testShouldThrowExceptionIfAddingClassWithNameMismatchingTheFileName(): void
     {
         $files = $this->findDummyTests('WrongClassTest.php', 'InvalidTests');
@@ -143,17 +133,6 @@ public function testShouldThrowExceptionIfAddingClassWithNameMismatchingTheFileN
         $this->creator->createFromFiles($files, [], []);
     }
 
-    public function testShouldThrowExceptionIfMultipleClassesAreDefinedInFile(): void
-    {
-        $files = $this->findDummyTests('MultipleClassesInFileTest.php', 'InvalidTests');
-
-        $this->expectException(\RuntimeException::class);
-        $this->expectExceptionMessageRegExp(
-            '/File ".*MultipleClassesInFileTest.php" contains definition of 2 classes/'
-        );
-        $this->creator->createFromFiles($files, [], []);
-    }
-
     public function testShouldOnlyAddTestsOfGivenGroups(): void
     {
         $processSet = $this->creator->createFromFiles($this->findDummyTests(), ['bar', 'foo'], []);

src-tests/Utils/Annotations/ClassAnnotationsTest.php

@@ -0,0 +1,136 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations;
+
+use Lmc\Steward\Utils\Annotations\Fixtures\ClassEmptyDockBlock;
+use Lmc\Steward\Utils\Annotations\Fixtures\ClassKeyAnnotations;
+use Lmc\Steward\Utils\Annotations\Fixtures\ClassKeyValueAnnotations;
+use Lmc\Steward\Utils\Annotations\Fixtures\ClassMixedAnnotations;
+use Lmc\Steward\Utils\Annotations\Fixtures\ClassNoDocBlock;
+use Lmc\Steward\Utils\Annotations\Fixtures\ClassWithMethods;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \Lmc\Steward\Utils\Annotations\ClassAnnotations
+ */
+class ClassAnnotationsTest extends TestCase
+{
+    /**
+     * @dataProvider provideClass
+     */
+    public function testShouldGetAnnotationsForClass(string $className, array $expectedAnnotations): void
+    {
+        $annotations = ClassAnnotations::getAnnotationsForClass($className);
+
+        $this->assertSame($expectedAnnotations, $annotations);
+    }
+
+    /**
+     * @return array[]
+     */
+    public function provideClass(): array
+    {
+        return [
+            'Class with empty doc block' => [
+                ClassEmptyDockBlock::class,
+                [],
+            ],
+            'Class having no doc block at all' => [
+                ClassNoDocBlock::class,
+                [],
+            ],
+            'Class with key-only annotations, without values' => [
+                ClassKeyAnnotations::class,
+                [
+                    'first' => ['', ''],
+                    'second' => [''],
+                    'third' => [''],
+                ],
+            ],
+            'Class with key-value annotations' => [
+                ClassKeyValueAnnotations::class,
+                [
+                    'first' => ['First value', 'Second value of first'],
+                    'second' => ['Second value'],
+                    'third' => ['Third "special" value'],
+                ],
+            ],
+            'Class with mixed key-only and key-value annotations' => [
+                ClassMixedAnnotations::class,
+                [
+                    'first' => ['', 'First with some value'],
+                    'second' => [''],
+                    'third' => [''],
+                    'fourth' => ['Fourth value'],
+                ],
+            ],
+        ];
+    }
+
+    public function testShouldGetAnnotationsForInstances(): void
+    {
+        $annotations = ClassAnnotations::getAnnotationsForInstance(new ClassKeyAnnotations());
+
+        $this->assertSame(
+            [
+                'first' => ['', ''],
+                'second' => [''],
+                'third' => [''],
+            ],
+            $annotations
+        );
+    }
+
+    /**
+     * @dataProvider provideMethod
+     */
+    public function testShouldGetAnnotationsForMethodInClass(string $methodName, array $expectedAnnotations): void
+    {
+        $classInstance = new ClassWithMethods();
+
+        $annotations = ClassAnnotations::getAnnotationsForMethodOfInstance($classInstance, $methodName);
+
+        $this->assertSame($expectedAnnotations, $annotations);
+    }
+
+    /**
+     * @return array[]
+     */
+    public function provideMethod(): array
+    {
+        return [
+            'Method with empty doc block' => [
+                'methodWithEmptyAnnotations',
+                [],
+            ],
+            'Method having no doc block at all' => [
+                'methodWithout',
+                [],
+            ],
+            'Method with key-only annotations, without values' => [
+                'methodWithKeys',
+                [
+                    'first' => ['', ''],
+                    'second' => [''],
+                    'third' => [''],
+                ],
+            ],
+            'Method with key-value annotations' => [
+                'methodWithKeyValues',
+                [
+                    'first' => ['First value', 'Second value of first'],
+                    'second' => ['Second value'],
+                    'third' => ['Third "special" @value!'],
+                ],
+            ],
+            'Method with mixed key-only and key-value annotations' => [
+                'methodWithMixedKeyValues',
+                [
+                    'first' => ['', 'First with some value'],
+                    'second' => ['Second with value', ''],
+                    'third' => [''],
+                ],
+            ],
+        ];
+    }
+}

src-tests/Utils/Annotations/ClassParserTest.php

@@ -0,0 +1,45 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Utils\Annotations;
+
+use Lmc\Steward\Utils\Annotations\ClassParser;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Finder\SplFileInfo;
+
+/**
+ * @covers \Lmc\Steward\Utils\Annotations\ClassParser
+ */
+class ClassParserTest extends TestCase
+{
+    public function testShouldGetClassNameFromFile(): void
+    {
+        $file = $this->createFileInfo('ClassNoDocBlock.php');
+
+        $className = ClassParser::readClassNameFromFile($file);
+
+        $this->assertSame('Lmc\Steward\Utils\Annotations\Fixtures\ClassNoDocBlock', $className);
+    }
+
+    public function testShouldThrowExceptionForMultipleClassesInOneFile(): void
+    {
+        $file = $this->createFileInfo('MultipleClassesInFile.php');
+
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessageRegExp('/^File ".+MultipleClassesInFile.php" contains definition of 2 classes\./');
+        ClassParser::readClassNameFromFile($file);
+    }
+
+    public function testShouldThrowExceptionForNoClassInOneFile(): void
+    {
+        $file = $this->createFileInfo('NoClassInFile.php');
+
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessageRegExp('/^No class found in file ".+NoClassInFile.php"/');
+        ClassParser::readClassNameFromFile($file);
+    }
+
+    private function createFileInfo(string $fileName): SplFileInfo
+    {
+        return new SplFileInfo(__DIR__ . '/Fixtures/' . $fileName, 'Fixtures/', 'Fixtures/' . $fileName);
+    }
+}

src-tests/Utils/Annotations/Fixtures/ClassEmptyDockBlock.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations\Fixtures;
+
+/**
+ *
+ */
+class ClassEmptyDockBlock
+{
+}

src-tests/Utils/Annotations/Fixtures/ClassKeyAnnotations.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations\Fixtures;
+
+/**
+ * Some text with @tag, which will not be treated as annotation.
+ *
+ * @first
+ * @second
+ * @third
+ * @first
+ */
+class ClassKeyAnnotations
+{
+}

src-tests/Utils/Annotations/Fixtures/ClassKeyValueAnnotations.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations\Fixtures;
+
+/**
+ * @first First value
+ * @second Second value
+ * @third Third "special" value
+ * @first Second value of first
+ */
+class ClassKeyValueAnnotations
+{
+}

src-tests/Utils/Annotations/Fixtures/ClassMixedAnnotations.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations\Fixtures;
+
+/**
+ * @first
+ * @second
+ * @first First with some value
+ * @third
+ * @fourth Fourth value
+ */
+class ClassMixedAnnotations
+{
+}

src-tests/Utils/Annotations/Fixtures/ClassNoDocBlock.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations\Fixtures;
+
+class ClassNoDocBlock
+{
+}

src-tests/Utils/Annotations/Fixtures/ClassWithMethods.php

@@ -0,0 +1,56 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations\Fixtures;
+
+/**
+ * This class has few methods with various annotations.
+ *
+ */
+class ClassWithMethods
+{
+    public function methodWithout(): void
+    {
+        // method without annotations
+    }
+
+    /**
+     *
+     */
+    public function methodWithEmptyAnnotations(): void
+    {
+        // method with empty docBlock
+    }
+
+    /**
+     * Some text not treated as @annotation
+     *
+     * @first
+     * @second
+     * @first
+     * @third
+     */
+    public function methodWithKeys(): void
+    {
+    }
+
+    /**
+     * @first First value
+     * @second Second value
+     * @first Second value of first
+     * @third Third "special" @value!
+     */
+    public function methodWithKeyValues(): void
+    {
+    }
+
+    /**
+     * @first
+     * @second Second with value
+     * @first First with some value
+     * @second
+     * @third
+     */
+    public function methodWithMixedKeyValues(): void
+    {
+    }
+}

src-tests/Utils/Annotations/Fixtures/MultipleClassesInFile.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace Lmc\Steward\Utils\Annotations\Fixtures;
+
+class ClassFirst
+{
+}
+
+class ClassSecond
+{
+}