add unit tests to phpstan

boxblinkracer · Dec 23, 2023 · 0a470ae · 0a470ae
1 parent 9f8f627
commit 0a470ae
Show file tree

Hide file tree

Showing 33 changed files with 133 additions and 84 deletions.
diff --git a/.phpstan.neon b/.phpstan.neon
@@ -2,6 +2,7 @@ parameters:
     level: 9
     paths:
         - ./src
+        - ./tests/phpunit
     excludePaths:
         - ./src/vendor/*
     checkExplicitMixed: false
diff --git a/src/Bundles/Exchange/CSV/Services/CSVWriter.php b/src/Bundles/Exchange/CSV/Services/CSVWriter.php
@@ -2,6 +2,8 @@
 
 namespace PHPUnuhi\Bundles\Exchange\CSV\Services;
 
+use Exception;
+
 class CSVWriter implements CSVWriterInterface
 {
 
@@ -28,11 +30,18 @@ public function deleteFile(string $filename): void
 
     /**
      * @param string $filename
-     * @return false|resource
+     * @throws Exception
+     * @return mixed
      */
-    public function open(string $filename)
+    public function open(string $filename) : mixed
     {
-        return fopen($filename, 'ab');
+        $resource = fopen($filename, 'ab');
+
+        if (!$resource) {
+            throw new Exception('Could not open file: ' . $filename);
+        }
+
+        return $resource;
     }
 
     /**

diff --git a/src/Bundles/Exchange/CSV/Services/CSVWriterInterface.php b/src/Bundles/Exchange/CSV/Services/CSVWriterInterface.php
@@ -21,7 +21,7 @@ public function deleteFile(string $filename): void;
      * @param string $filename
      * @return resource
      */
-    public function open(string $filename);
+    public function open(string $filename) : mixed;
 
     /**
      * @param resource $file

diff --git a/tests/phpunit/Bundles/Storage/JSON/Services/JsonSaverTest.php b/tests/phpunit/Bundles/Storage/JSON/Services/JsonSaverTest.php
@@ -13,8 +13,15 @@ class JsonStorageTest extends TestCase
      */
     private $locale;
 
+    /**
+     * @var array<string>
+     */
     private $files = [];
 
+
+    /**
+     * @return void
+     */
     protected function setUp(): void
     {
         parent::setUp();
@@ -26,13 +33,19 @@ protected function setUp(): void
         $this->locale = $locale;
     }
 
+    /**
+     * @return void
+     */
     protected function tearDown(): void
     {
         parent::tearDown();
 
         \array_map('unlink', \array_filter($this->files, 'is_file'));
     }
 
+    /**
+     * @return void
+     */
     public function testIndentBy4WithNewLineAtTheEnd(): void
     {
         $testFile = $this->createRandomFile();
@@ -53,6 +66,9 @@ public function testIndentBy4WithNewLineAtTheEnd(): void
         static::assertSame($expected, $json);
     }
 
+    /**
+     * @return void
+     */
     public function testIndentBy2WithoutNewLineAtTheEnd(): void
     {
         $testFile = $this->createRandomFile();
@@ -72,6 +88,10 @@ public function testIndentBy2WithoutNewLineAtTheEnd(): void
         static::assertSame($expected, $json);
     }
 
+
+    /**
+     * @return void
+     */
     public function testIndentBy5AndSortedKeys(): void
     {
         $testFile = $this->createRandomFile();
@@ -91,9 +111,12 @@ public function testIndentBy5AndSortedKeys(): void
         static::assertSame($expected, $json);
     }
 
+    /**
+     * @return string
+     */
     private function createRandomFile(): string
     {
-        $result = \tempnam(\sys_get_temp_dir(), 'phpunuhiJsonStorageTest');
+        $result = (string)\tempnam(\sys_get_temp_dir(), 'phpunuhiJsonStorageTest');
 
         $this->files[] = $result;
 

diff --git a/tests/phpunit/Components/Configuration/Services/StyleLoaderTest.php b/tests/phpunit/Components/Configuration/Services/StyleLoaderTest.php
@@ -5,6 +5,7 @@
 use PHPUnit\Framework\TestCase;
 use PHPUnuhi\Configuration\Services\StyleLoader;
 use PHPUnuhi\Models\Configuration\CaseStyle;
+use SimpleXMLElement;
 
 class StyleLoaderTest extends TestCase
 {
@@ -22,8 +23,7 @@ public function testLoadStyles(): void
 </styles>
 XML;
 
-        $xml = simplexml_load_string($xmlString);
-
+        $xml = $this->loadXml($xmlString);
 
         $loader = new StyleLoader();
         $result = $loader->loadStyles($xml);
@@ -55,7 +55,7 @@ public function testLoadWithoutStylesNode(): void
 </root>
 XML;
 
-        $xml = simplexml_load_string($xmlString);
+        $xml = $this->loadXml($xmlString);
 
         $loader = new StyleLoader();
         $result = $loader->loadStyles($xml);
@@ -75,11 +75,26 @@ public function testLoadWithInvalidStyle(): void
 </styles>
 XML;
 
-        $xml = simplexml_load_string($xmlString);
+        $xml = $this->loadXml($xmlString);
 
         $loader = new StyleLoader();
         $result = $loader->loadStyles($xml);
 
         $this->assertCount(2, $result);
     }
+
+    /**
+     * @param string $xml
+     * @return SimpleXMLElement
+     */
+    private function loadXml(string $xml): SimpleXMLElement
+    {
+        $element = simplexml_load_string($xml);
+
+        if ($element === false) {
+            return new SimpleXMLElement('');
+        }
+
+        return $element;
+    }
 }
diff --git a/tests/phpunit/Components/Validator/CaseStyle/CaseStyleValidatorFactoryTest.php b/tests/phpunit/Components/Validator/CaseStyle/CaseStyleValidatorFactoryTest.php
@@ -17,7 +17,7 @@ class CaseStyleValidatorFactoryTest extends TestCase
      */
     public function testUnknownIdentifierThrowsException(): void
     {
-        $factory = new CaseStyleValidatorFactory('', [], '');
+        $factory = new CaseStyleValidatorFactory();
 
         $this->expectException(CaseStyleNotFoundException::class);
 
@@ -30,7 +30,7 @@ public function testUnknownIdentifierThrowsException(): void
      */
     public function testValidatorFound(): void
     {
-        $factory = new CaseStyleValidatorFactory('', [], '');
+        $factory = new CaseStyleValidatorFactory();
 
         $validator = $factory->fromIdentifier('camel');
 

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/CamelCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/CamelCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {
@@ -49,6 +49,9 @@ public function getData(): array
 
     /**
      * @dataProvider getData
+     *
+     * @param bool $expectedValid
+     * @param string $text
      * @return void
      */
     public function testIsValid(bool $expectedValid, string $text): void

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/KebabCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/KebabCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/LowerCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/LowerCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/NumberCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/NumberCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/PascalCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/PascalCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/SnakeCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/SnakeCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/StartCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/StartCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {

diff --git a/tests/phpunit/Components/Validator/CaseStyle/Style/UpperCaseValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyle/Style/UpperCaseValidatorTest.php
@@ -33,7 +33,7 @@ public function testIdentifier(): void
     }
 
     /**
-     * @return array[]
+     * @return array<mixed>
      */
     public function getData(): array
     {

diff --git a/tests/phpunit/Components/Validator/CaseStyleValidatorTest.php b/tests/phpunit/Components/Validator/CaseStyleValidatorTest.php
@@ -231,7 +231,7 @@ public function testSingleHierarchyValidation(): void
 
     /**
      * @param Locale $locale
-     * @param array $caseStyles
+     * @param CaseStyle[] $caseStyles
      * @return TranslationSet
      */
     private function buildSet(Locale $locale, array $caseStyles): TranslationSet

diff --git a/tests/phpunit/Components/Validator/EmptyContentValidatorTest.php b/tests/phpunit/Components/Validator/EmptyContentValidatorTest.php
@@ -53,7 +53,7 @@ public function testAllValid(): void
 
         $set = $this->buildSet([$localeDE, $localeEN]);
 
-        $storage = new JsonStorage(3, true);
+        $storage = new JsonStorage();
 
         $result = $this->validator->validate($set, $storage);
 
@@ -76,7 +76,7 @@ public function testEmptyContentFound(): void
 
         $set = $this->buildSet([$localeDE, $localeEN]);
 
-        $storage = new JsonStorage(3, true);
+        $storage = new JsonStorage();
 
         $result = $this->validator->validate($set, $storage);
 
@@ -85,7 +85,7 @@ public function testEmptyContentFound(): void
 
 
     /**
-     * @param array $locales
+     * @param Locale[] $locales
      * @return TranslationSet
      */
     private function buildSet(array $locales): TranslationSet

diff --git a/tests/phpunit/Components/Validator/MixedStructureValidatorTest.php b/tests/phpunit/Components/Validator/MixedStructureValidatorTest.php
@@ -53,7 +53,7 @@ public function testAllValid(): void
 
         $set = $this->buildSet([$localeDE, $localeEN]);
 
-        $storage = new JsonStorage(3, true);
+        $storage = new JsonStorage();
 
         $result = $this->validator->validate($set, $storage);
 
@@ -75,7 +75,7 @@ public function testMixedStructureFound(): void
 
         $set = $this->buildSet([$localeDE, $localeEN]);
 
-        $storage = new JsonStorage(3, true);
+        $storage = new JsonStorage();
 
 
         $result = $this->validator->validate($set, $storage);
@@ -85,7 +85,7 @@ public function testMixedStructureFound(): void
 
 
     /**
-     * @param array $locales
+     * @param Locale[] $locales
      * @return TranslationSet
      */
     private function buildSet(array $locales): TranslationSet

diff --git a/tests/phpunit/Components/Validator/Model/ValidationErrorTest.php b/tests/phpunit/Components/Validator/Model/ValidationErrorTest.php
@@ -24,7 +24,7 @@ public function setUp(): void
             'en_US',
             'en.json',
             'ID-123',
-            '14'
+            14
         );
     }
 

diff --git a/tests/phpunit/Components/Validator/Rules/DisallowedTextsRuleTest.php b/tests/phpunit/Components/Validator/Rules/DisallowedTextsRuleTest.php
@@ -41,7 +41,7 @@ public function testAllValid(): void
 
         $set = $this->buildSet([$localeDE, $localeEN]);
 
-        $storage = new JsonStorage(3, true);
+        $storage = new JsonStorage();
 
         $validator = new DisallowedTextsRule([]);
         $result = $validator->validate($set, $storage);
@@ -65,7 +65,7 @@ public function testDisallowedTextFound(): void
 
         $set = $this->buildSet([$localeDE, $localeEN]);
 
-        $storage = new JsonStorage(3, true);
+        $storage = new JsonStorage();
 
         $validator = new DisallowedTextsRule(
             [
@@ -80,7 +80,7 @@ public function testDisallowedTextFound(): void
 
 
     /**
-     * @param array $locales
+     * @param Locale[] $locales
      * @return TranslationSet
      */
     private function buildSet(array $locales): TranslationSet

diff --git a/tests/phpunit/Components/Validator/Rules/DuplicateContentRuleTest.php b/tests/phpunit/Components/Validator/Rules/DuplicateContentRuleTest.php
@@ -95,7 +95,7 @@ public function testDuplicateInDifferentLocalesIsValid(): void
 
 
     /**
-     * @param array $locales
+     * @param Locale[] $locales
      * @return TranslationSet
      */
     private function buildSet(array $locales): TranslationSet
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,7 +33,7 @@ public function testIdentifier(): void @@
         }
         /**
-         * @return array[]
+         * @return array<mixed>
          */
         public function getData(): array
         {
@@ Expand Down @@