Merge callProtectedMethod and callPrivateFunction into callFunction

Signed-off-by: William Desportes <williamdes@wdes.fr>
phpmyadmin · May 21, 2020 · 7e81b0b · 7e81b0b
1 parent 5c270d8
commit 7e81b0b
Show file tree

Hide file tree

Showing 19 changed files with 1,306 additions and 1,025 deletions.
diff --git a/test/classes/AbstractTestCase.php b/test/classes/AbstractTestCase.php
@@ -183,21 +183,20 @@ protected function tearDown(): void
         }
     }
 
-
     /**
      * Call protected functions by setting visibility to public.
      *
-     * @param mixed $object       The object to inspect
-     * @param string $className   The class name
-     * @param string $name   method name
-     * @param array  $params parameters for the invocation
+     * @param object|null  $object     The object to inspect, pass null for static objects()
+     * @param class-string $className  The class name
+     * @param string       $methodName The method name
+     * @param array        $params     The parameters for the invocation
      *
      * @return mixed the output from the protected method.
      */
-    protected function callProtectedFunction($object, string $className, string $name, array $params)
+    protected function callFunction(?object $object, string $className, string $methodName, array $params)
     {
         $class = new ReflectionClass($className);
-        $method = $class->getMethod($name);
+        $method = $class->getMethod($methodName);
         $method->setAccessible(true);
 
         return $method->invokeArgs($object, $params);

diff --git a/test/classes/BrowseForeignersTest.php b/test/classes/BrowseForeignersTest.php
@@ -9,7 +9,6 @@
 use PhpMyAdmin\BrowseForeigners;
 use PhpMyAdmin\Template;
 use PhpMyAdmin\Tests\AbstractTestCase;
-use ReflectionClass;
 
 /**
  * Tests for PhpMyAdmin\BrowseForeigners
@@ -32,27 +31,6 @@ protected function setUp(): void
         $this->browseForeigners = new BrowseForeigners(new Template());
     }
 
-    /**
-     * Call protected functions by setting visibility to public.
-     *
-     * @param string           $name   method name
-     * @param array            $params parameters for the invocation
-     * @param BrowseForeigners $object BrowseForeigners instance object
-     *
-     * @return mixed the output from the protected method.
-     */
-    private function callProtectedMethod($name, $params, BrowseForeigners $object = null)
-    {
-        $class = new ReflectionClass(BrowseForeigners::class);
-        $method = $class->getMethod($name);
-        $method->setAccessible(true);
-
-        return $method->invokeArgs(
-            $object ?? $this->browseForeigners,
-            $params
-        );
-    }
-
     /**
      * Test for BrowseForeigners::getForeignLimit
      *
@@ -99,7 +77,9 @@ public function testGetHtmlForGotoPage()
     {
         $this->assertEquals(
             '',
-            $this->callProtectedMethod(
+            $this->callFunction(
+                $this->browseForeigners,
+                BrowseForeigners::class,
                 'getHtmlForGotoPage',
                 [null]
             )
@@ -112,14 +92,18 @@ public function testGetHtmlForGotoPage()
 
         $this->assertEquals(
             '',
-            $this->callProtectedMethod(
+            $this->callFunction(
+                $this->browseForeigners,
+                BrowseForeigners::class,
                 'getHtmlForGotoPage',
                 [$foreignData]
             )
         );
 
         $foreignData['the_total'] = 30;
-        $result = $this->callProtectedMethod(
+        $result = $this->callFunction(
+            $this->browseForeigners,
+            BrowseForeigners::class,
             'getHtmlForGotoPage',
             [$foreignData]
         );
@@ -165,7 +149,9 @@ public function testGetDescriptionAndTitle()
                 'foobar&lt;baz',
                 '',
             ],
-            $this->callProtectedMethod(
+            $this->callFunction(
+                $this->browseForeigners,
+                BrowseForeigners::class,
                 'getDescriptionAndTitle',
                 [$desc]
             )
@@ -179,10 +165,11 @@ public function testGetDescriptionAndTitle()
                 'fooba...',
                 'foobar&lt;baz',
             ],
-            $this->callProtectedMethod(
+            $this->callFunction(
+                $browseForeigners,
+                BrowseForeigners::class,
                 'getDescriptionAndTitle',
-                [$desc],
-                $browseForeigners
+                [$desc]
             )
         );
     }

diff --git a/test/classes/CentralColumnsTest.php b/test/classes/CentralColumnsTest.php
@@ -15,7 +15,6 @@
 use PhpMyAdmin\Util;
 use PhpMyAdmin\Message;
 use PhpMyAdmin\Tests\AbstractTestCase;
-use ReflectionClass;
 use function array_slice;
 use function ceil;
 
@@ -166,30 +165,6 @@ protected function setUp(): void
         $this->centralColumns = new CentralColumns($dbi);
     }
 
-    /**
-     * Call protected functions by setting visibility to public.
-     *
-     * @param string         $name   method name
-     * @param array          $params parameters for the invocation
-     * @param CentralColumns $object CentralColumns instance object
-     *
-     * @return mixed the output from the protected method.
-     */
-    private function callProtectedMethod(
-        $name,
-        array $params = [],
-        CentralColumns $object = null
-    ) {
-        $class = new ReflectionClass(CentralColumns::class);
-        $method = $class->getMethod($name);
-        $method->setAccessible(true);
-
-        return $method->invokeArgs(
-            $object ?? $this->centralColumns,
-            $params
-        );
-    }
-
     /**
      * Test for getParams
      *
@@ -551,13 +526,17 @@ public function testGetHtmlForEditingPage()
             __('A_I'),
         ];
         $this->assertStringContainsString(
-            $this->callProtectedMethod(
+            $this->callFunction(
+                $this->centralColumns,
+                CentralColumns::class,
                 'getEditTableHeader',
                 [$header_cells]
             ),
             $result
         );
-        $list_detail_cols = $this->callProtectedMethod(
+        $list_detail_cols = $this->callFunction(
+            $this->centralColumns,
+            CentralColumns::class,
             'findExistingColNames',
             [
                 'phpmyadmin',
@@ -566,7 +545,9 @@ public function testGetHtmlForEditingPage()
             ]
         );
         $this->assertStringContainsString(
-            $this->callProtectedMethod(
+            $this->callFunction(
+                $this->centralColumns,
+                CentralColumns::class,
                 'getHtmlForEditTableRow',
                 [
                     $list_detail_cols[0],
@@ -576,7 +557,7 @@ public function testGetHtmlForEditingPage()
             $result
         );
         $this->assertStringContainsString(
-            $this->callProtectedMethod('getEditTableFooter'),
+            $this->callFunction($this->centralColumns, CentralColumns::class, 'getEditTableFooter', []),
             $result
         );
     }
@@ -734,7 +715,7 @@ public function testConfigErrorMessage()
     {
         $this->assertInstanceOf(
             Message::class,
-            $this->callProtectedMethod('configErrorMessage')
+            $this->callFunction($this->centralColumns, CentralColumns::class, 'configErrorMessage', [])
         );
     }
 
@@ -759,7 +740,9 @@ public function testFindExistingColNames()
             );
         $this->assertEquals(
             array_slice($this->modifiedColumnData, 1, 1),
-            $this->callProtectedMethod(
+            $this->callFunction(
+                $this->centralColumns,
+                CentralColumns::class,
                 'findExistingColNames',
                 [
                     'phpmyadmin',

diff --git a/test/classes/Controllers/Server/VariablesControllerTest.php b/test/classes/Controllers/Server/VariablesControllerTest.php
@@ -6,15 +6,13 @@
 
 namespace PhpMyAdmin\Tests\Controllers\Server;
 
-use PhpMyAdmin\Config;
 use PhpMyAdmin\Controllers\Server\VariablesController;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Html\Generator;
 use PhpMyAdmin\Response;
 use PhpMyAdmin\Template;
 use PhpMyAdmin\Tests\Stubs\Response as ResponseStub;
 use PhpMyAdmin\Tests\AbstractTestCase;
-use ReflectionClass;
 use Williamdes\MariaDBMySQLKBS\Search as KBSearch;
 use Williamdes\MariaDBMySQLKBS\SlimData as KBSlimData;
 use function htmlspecialchars;
@@ -140,10 +138,6 @@ public function testIndex(): void
      */
     public function testFormatVariable(): void
     {
-        $class = new ReflectionClass(VariablesController::class);
-        $method = $class->getMethod('formatVariable');
-        $method->setAccessible(true);
-
         $controller = new VariablesController(
             Response::getInstance(),
             $GLOBALS['dbi'],
@@ -163,7 +157,12 @@ public function testFormatVariable(): void
             $nameForValueByte,
             '3',
         ];
-        [$formattedValue, $isHtmlFormatted] = $method->invokeArgs($controller, $args);
+        [$formattedValue, $isHtmlFormatted] = $this->callFunction(
+            $controller,
+            VariablesController::class,
+            'formatVariable',
+            $args
+        );
         $this->assertEquals(
             '<abbr title="3">3 B</abbr>',
             $formattedValue
@@ -175,7 +174,12 @@ public function testFormatVariable(): void
             $nameForValueNotByte,
             '3',
         ];
-        [$formattedValue, $isHtmlFormatted] = $method->invokeArgs($controller, $args);
+        [$formattedValue, $isHtmlFormatted] = $this->callFunction(
+            $controller,
+            VariablesController::class,
+            'formatVariable',
+            $args
+        );
         $this->assertEquals(
             '3',
             $formattedValue
@@ -187,7 +191,12 @@ public function testFormatVariable(): void
             $nameForValueNotByte,
             'value',
         ];
-        [$formattedValue, $isHtmlFormatted] = $method->invokeArgs($controller, $args);
+        [$formattedValue, $isHtmlFormatted] = $this->callFunction(
+            $controller,
+            VariablesController::class,
+            'formatVariable',
+            $args
+        );
         $this->assertEquals(
             'value',
             $formattedValue