Add type hints and test cases for ParameterBagUtils

scheb · Oct 25, 2018 · 8c1d371 · 8c1d371
1 parent 5296fb0
commit 8c1d371
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 3 deletions.
diff --git a/Security/Http/ParameterBagUtils.php b/Security/Http/ParameterBagUtils.php
@@ -24,7 +24,7 @@ class ParameterBagUtils
      *
      * @throws \InvalidArgumentException when the given path is malformed
      */
-    public static function getRequestParameterValue(Request $request, $path)
+    public static function getRequestParameterValue(Request $request, string $path): ?string
     {
         if (false === $pos = strpos($path, '[')) {
             return $request->get($path);
@@ -33,7 +33,7 @@ public static function getRequestParameterValue(Request $request, $path)
         $root = substr($path, 0, $pos);
 
         if (null === $value = $request->get($root)) {
-            return;
+            return null;
         }
 
         if (null === self::$propertyAccessor) {
@@ -43,7 +43,7 @@ public static function getRequestParameterValue(Request $request, $path)
         try {
             return self::$propertyAccessor->getValue($value, substr($path, $pos));
         } catch (AccessException $e) {
-            return;
+            return null;
         }
     }
 }
diff --git a/Tests/Security/Http/ParameterBagUtilsTest.php b/Tests/Security/Http/ParameterBagUtilsTest.php
@@ -0,0 +1,51 @@
+<?php
+
+namespace Scheb\TwoFactorBundle\Tests\Security\Http;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use Scheb\TwoFactorBundle\Security\Http\ParameterBagUtils;
+use Scheb\TwoFactorBundle\Tests\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+
+class ParameterBagUtilsTest extends TestCase
+{
+    /**
+     * @var MockObject|Request
+     */
+    private $request;
+
+    protected function setUp()
+    {
+        $this->request = new Request([
+            'topLevelField' => 'topLevelValue',
+            'arrayArrayField' => ['nestedField' => 'nestedValue'],
+        ]);
+    }
+
+    /**
+     * @test
+     */
+    public function getRequestParameterValue_nonExistentField_returnNull(): void
+    {
+        $returnValue = ParameterBagUtils::getRequestParameterValue($this->request, 'nonExistentField');
+        $this->assertNull($returnValue);
+    }
+
+    /**
+     * @test
+     */
+    public function getRequestParameterValue_topLevelField_returnValue(): void
+    {
+        $returnValue = ParameterBagUtils::getRequestParameterValue($this->request, 'topLevelField');
+        $this->assertEquals('topLevelValue', $returnValue);
+    }
+
+    /**
+     * @test
+     */
+    public function getRequestParameterValue_arrayArrayField_returnValue(): void
+    {
+        $returnValue = ParameterBagUtils::getRequestParameterValue($this->request, 'arrayArrayField[nestedField]');
+        $this->assertEquals('nestedValue', $returnValue);
+    }
+}