Fix PHPStan errors for PHPUnit assert methods

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Aug 10, 2020 · ba09c84 · ba09c84
1 parent c33d35f
commit ba09c84
Show file tree

Hide file tree

Showing 19 changed files with 87 additions and 125 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -2965,11 +2965,6 @@ parameters:
 			count: 1
 			path: test/classes/Config/DescriptionTest.php
 
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, null given\\.$#"
-			count: 5
-			path: test/classes/Config/FormDisplayTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$str of function strip_tags expects string, string\\|false given\\.$#"
 			count: 1
@@ -3010,16 +3005,6 @@ parameters:
 			count: 1
 			path: test/classes/FileTest.php
 
-		-
-			message: "#^Parameter \\#1 \\$expected of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\) expects class\\-string\\<object\\>, string given\\.$#"
-			count: 1
-			path: test/classes/Gis/GisFactoryTest.php
-
-		-
-			message: "#^Unable to resolve the template type ExpectedType in call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\)$#"
-			count: 1
-			path: test/classes/Gis/GisFactoryTest.php
-
 		-
 			message: "#^Call to an undefined method object\\:\\:generateParams\\(\\)\\.$#"
 			count: 2
@@ -3085,96 +3070,31 @@ parameters:
 			count: 1
 			path: test/classes/LanguageTest.php
 
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 1
-			path: test/classes/Navigation/NavigationTreeTest.php
-
 		-
 			message: "#^Parameter \\#2 \\$name of static method PhpMyAdmin\\\\Navigation\\\\NodeFactory\\:\\:getInstance\\(\\) expects string, array\\<string, string\\> given\\.$#"
 			count: 1
 			path: test/classes/Navigation/Nodes/NodeColumnTest.php
 
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 4
-			path: test/classes/Plugins/Auth/AuthenticationConfigTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 1
-			path: test/classes/Plugins/Auth/AuthenticationHttpTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 1
-			path: test/classes/Plugins/Auth/AuthenticationSignonTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$version1 of function version_compare expects string, string\\|false given\\.$#"
 			count: 1
 			path: test/classes/Plugins/Auth/AuthenticationSignonTest.php
 
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 4
-			path: test/classes/Plugins/Export/ExportCodegenTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$string of function htmlspecialchars_decode expects string, string\\|false given\\.$#"
 			count: 1
 			path: test/classes/Plugins/Export/ExportHtmlwordTest.php
 
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 5
-			path: test/classes/Plugins/Export/ExportLatexTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 3
-			path: test/classes/Plugins/Export/ExportPhparrayTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 35
-			path: test/classes/Plugins/Export/ExportSqlTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 3
-			path: test/classes/Plugins/Export/ExportTexytextTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 11
-			path: test/classes/Plugins/Export/ExportXmlTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 1
-			path: test/classes/Plugins/Export/ExportYamlTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$subgroupHeader of method PhpMyAdmin\\\\Properties\\\\Options\\\\Groups\\\\OptionsPropertySubgroup\\:\\:setSubgroupHeader\\(\\) expects PhpMyAdmin\\\\Properties\\\\PropertyItem, string given\\.$#"
 			count: 1
 			path: test/classes/Properties/Options/Groups/OptionsPropertySubgroupTest.php
 
-		-
-			message: "#^Call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertNull\\(\\) with void will always evaluate to false\\.$#"
-			count: 1
-			path: test/classes/Properties/Options/OptionsPropertyGroupTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$property of method PhpMyAdmin\\\\Properties\\\\Options\\\\OptionsPropertyGroup\\:\\:addProperty\\(\\) expects PhpMyAdmin\\\\Properties\\\\Options\\\\OptionsPropertyItem, int given\\.$#"
 			count: 1
 			path: test/classes/Properties/Options/OptionsPropertyGroupTest.php
 
-		-
-			message: "#^Result of method PhpMyAdmin\\\\Properties\\\\Options\\\\OptionsPropertyGroup\\:\\:addProperty\\(\\) \\(void\\) is used\\.$#"
-			count: 1
-			path: test/classes/Properties/Options/OptionsPropertyGroupTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$property of method PhpMyAdmin\\\\Properties\\\\Options\\\\OptionsPropertyGroup\\:\\:addProperty\\(\\) expects PhpMyAdmin\\\\Properties\\\\Options\\\\OptionsPropertyItem, string given\\.$#"
 			count: 1
@@ -3190,26 +3110,6 @@ parameters:
 			count: 1
 			path: test/classes/Properties/Options/OptionsPropertyOneItemTest.php
 
-		-
-			message: "#^Parameter \\#1 \\$needle of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, bool\\|string given\\.$#"
-			count: 1
-			path: test/classes/Server/PrivilegesTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$haystack of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#"
-			count: 4
-			path: test/classes/Setup/FormProcessingTest.php
-
-		-
-			message: "#^Parameter \\#1 \\$expected of method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\) expects class\\-string\\<object\\>, string given\\.$#"
-			count: 1
-			path: test/classes/StorageEngineTest.php
-
-		-
-			message: "#^Unable to resolve the template type ExpectedType in call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\)$#"
-			count: 1
-			path: test/classes/StorageEngineTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$str of function trim expects string, string\\|null given\\.$#"
 			count: 1
@@ -3310,11 +3210,6 @@ parameters:
 			count: 1
 			path: test/classes/TrackingTest.php
 
-		-
-			message: "#^Call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\) with 'PhpMyAdmin\\\\\\\\Message' and true will always evaluate to false\\.$#"
-			count: 1
-			path: test/classes/UserPreferencesTest.php
-
 		-
 			message: "#^Offset 0 does not exist on array\\|null\\.$#"
 			count: 1

diff --git a/test/classes/Config/FormDisplayTest.php b/test/classes/Config/FormDisplayTest.php
@@ -168,9 +168,9 @@ public function testDisplayErrors(): void
         $attrIsValidated->setAccessible(true);
         $attrIsValidated->setValue($this->object, []);
 
-        $this->assertNull(
-            $this->object->displayErrors()
-        );
+        $result = $this->object->displayErrors();
+
+        $this->assertNull($result);
 
         $arr = [
             'Servers/1/test' => ['e1'],
@@ -190,6 +190,7 @@ public function testDisplayErrors(): void
 
         $result = $this->object->displayErrors();
 
+        $this->assertIsString($result);
         $this->assertStringContainsString('<dt>Servers/1/test2</dt>', $result);
         $this->assertStringContainsString('<dd>e1</dd>', $result);
         $this->assertStringContainsString('<dt>Form_foobar</dt>', $result);

diff --git a/test/classes/Gis/GisFactoryTest.php b/test/classes/Gis/GisFactoryTest.php
@@ -28,6 +28,8 @@ class GisFactoryTest extends AbstractTestCase
      * @param string $type geometry type
      * @param string $geom geometry object
      *
+     * @psalm-param class-string $geom
+     *
      * @dataProvider providerForTestFactory
      */
     public function testFactory(string $type, string $geom): void

diff --git a/test/classes/Navigation/NavigationTreeTest.php b/test/classes/Navigation/NavigationTreeTest.php
@@ -74,6 +74,7 @@ public function testRenderState(): void
     public function testRenderPath(): void
     {
         $result = $this->object->renderPath();
+        $this->assertIsString($result);
         $this->assertStringContainsString('list_container', $result);
     }
 

diff --git a/test/classes/Plugins/Auth/AuthenticationConfigTest.php b/test/classes/Plugins/Auth/AuthenticationConfigTest.php
@@ -101,6 +101,8 @@ public function testAuthFails(): void
         $this->object->showFailure('');
         $html = ob_get_clean();
 
+        $this->assertIsString($html);
+
         $this->assertStringContainsString(
             'You probably did not create a configuration file. You might want ' .
             'to use the <a href="setup/">setup script</a> to create one.',

diff --git a/test/classes/Plugins/Auth/AuthenticationHttpTest.php b/test/classes/Plugins/Auth/AuthenticationHttpTest.php
@@ -421,6 +421,8 @@ public function testAuthFails(): void
         $this->object->showFailure('');
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             '<p>error 123</p>',
             $result

diff --git a/test/classes/Plugins/Auth/AuthenticationSignonTest.php b/test/classes/Plugins/Auth/AuthenticationSignonTest.php
@@ -63,6 +63,8 @@ public function testAuth(): void
         $this->object->showLoginForm();
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             'You must set SignonURL!',
             $result

diff --git a/test/classes/Plugins/Export/ExportCodegenTest.php b/test/classes/Plugins/Export/ExportCodegenTest.php
@@ -241,6 +241,8 @@ public function testExportData(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             '<?xml version="1.0" encoding="utf-8" ?>',
             $result

diff --git a/test/classes/Plugins/Export/ExportLatexTest.php b/test/classes/Plugins/Export/ExportLatexTest.php
@@ -489,6 +489,8 @@ public function testExportHeader(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             "\n% Host: localhost:80",
             $result
@@ -647,6 +649,8 @@ public function testExportData(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             '{datalabel} \\\\\\\\ \hlinefoo',
             $result
@@ -658,10 +662,6 @@ public function testExportData(): void
      */
     public function testExportStructure(): void
     {
-        // $this->object = $this->getMockBuilder(ExportHtmlword::class)
-        //     ->setMethods(array('formatOneColumnDefinition'))
-        //     ->getMock();
-
         $keys = [
             [
                 'Non_unique' => 0,
@@ -875,6 +875,8 @@ public function testExportStructure(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             '\\textbf{\\textit{name1}} & set(abc) & Yes & NULL & ' .
             'ftable (ffield) &  &  \\\\ \\hline',
@@ -948,6 +950,8 @@ public function testExportStructure(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             '\\caption{latexstructure} \\label{latexlabel}',
             $result

diff --git a/test/classes/Plugins/Export/ExportPhparrayTest.php b/test/classes/Plugins/Export/ExportPhparrayTest.php
@@ -141,6 +141,8 @@ public function testExportHeader(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             '<?php ',
             $result
@@ -170,6 +172,8 @@ public function testExportDBHeader(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             "/**\n * Database `db`\n */",
             $result
@@ -291,6 +295,8 @@ public function testExportData(): void
         );
         $result = ob_get_clean();
 
+        $this->assertIsString($result);
+
         $this->assertStringContainsString(
             '$_0_932table',
             $result