Do not allow getUserRoles() to be nullable

Should always return an array.

Author: weierophinney

src/UserInterface.php

@@ -16,7 +16,7 @@ public function getUsername() : string;
     /**
      * Get all user roles
      *
-     * @return string[]|null
+     * @return string[]
      */
-    public function getUserRoles() : ?array;
+    public function getUserRoles() : array;
 }

src/UserRepository/Htpasswd.php

@@ -66,9 +66,9 @@ public function authenticate(string $credential, string $password = null) : ?Use
     /**
      * {@inheritDoc}
      */
-    public function getRolesFromUser(string $username): ?array
+    public function getRolesFromUser(string $username) : array
     {
-        return null;
+        return [];
     }
 
     /**

src/UserRepository/HtpasswdFactory.php

@@ -17,12 +17,16 @@ class HtpasswdFactory
      */
     public function __invoke(ContainerInterface $container) : Htpasswd
     {
-        $htpasswd = $container->get('config')['authentication']['htpasswd'] ?? null;
+        $config = $container->has('config') ? $container->get('config') : [];
+        $htpasswd = $config['authentication']['htpasswd'] ?? null;
+
         if (null === $htpasswd) {
-            throw new Exception\InvalidConfigException(
-                'Htpasswd file name is not present in user_register config'
-            );
+            throw new Exception\InvalidConfigException(sprintf(
+                'Config key authentication.htpasswd is not present; cannot create %s user repository adapter',
+                Htpasswd::class
+            ));
         }
+
         return new Htpasswd($htpasswd);
     }
 }

src/UserRepository/PdoDatabase.php

@@ -46,36 +46,43 @@ public function authenticate(string $credential, string $password = null) : ?Use
             $this->config['table'],
             $this->config['field']['username']
         );
+
         $stmt = $this->pdo->prepare($sql);
         $stmt->bindParam(':username', $credential);
+
         if (! $stmt->execute()) {
             return null;
         }
+
         $result = $stmt->fetchObject();
 
-        return password_verify($password, $result->{$this->config['field']['password']}) ?
-               $this->generateUser($credential, $this->getRolesFromUser($credential)) :
-               null;
+        return password_verify($password, $result->{$this->config['field']['password']})
+            ? $this->generateUser($credential, $this->getRolesFromUser($credential))
+            : null;
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getRolesFromUser(string $username): ?array
+    public function getRolesFromUser(string $username) : array
     {
         if (! isset($this->config['sql_get_roles'])) {
-            return null;
+            return [];
         }
+
         if (false === strpos($this->config['sql_get_roles'], ':username')) {
             throw new Exception\InvalidConfigException(
-                'The sql_get_roles must include a :username parameter'
+                'The sql_get_roles configuration setting must include a :username parameter'
             );
         }
+
         $stmt = $this->pdo->prepare($this->config['sql_get_roles']);
         $stmt->bindParam(':username', $username);
+
         if (! $stmt->execute()) {
-            return null;
+            return [];
         }
+
         $roles = [];
         foreach ($stmt->fetchAll(PDO::FETCH_NUM) as $role) {
             $roles[] = $role[0];

src/UserRepository/UserTrait.php

@@ -23,15 +23,15 @@ protected function generateUser(string $username, ?array $roles = null) : UserIn
             public function __construct(string $username, $roles)
             {
                 $this->username = $username;
-                $this->roles = $roles;
+                $this->roles = $roles ?: [];
             }
 
             public function getUsername() : string
             {
                 return $this->username;
             }
 
-            public function getUserRoles() : ?array
+            public function getUserRoles() : array
             {
                 return $this->roles;
             }

src/UserRepositoryInterface.php

@@ -21,7 +21,7 @@ public function authenticate(string $credential, string $password = null) : ?Use
      * Get the user roles if present.
      *
      * @param string $username
-     * @return string[]|null
+     * @return string[]
      */
-    public function getRolesFromUser(string $username) : ?array;
+    public function getRolesFromUser(string $username) : array;
 }

test/UserRepository/HtpasswdFactoryTest.php

@@ -8,6 +8,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
+use Zend\Expressive\Authentication\Exception\InvalidConfigException;
 use Zend\Expressive\Authentication\UserRepository\Htpasswd;
 use Zend\Expressive\Authentication\UserRepository\HtpasswdFactory;
 
@@ -19,30 +20,40 @@ protected function setUp()
         $this->factory = new HtpasswdFactory();
     }
 
-    /**
-     * @expectedException Zend\Expressive\Authentication\Exception\InvalidConfigException
-     */
+    public function testInvokeWithMissingConfig()
+    {
+        $this->container->has('config')->willReturn(false);
+        $this->container->get('config')->shouldNotBeCalled();
+
+        $this->expectException(InvalidConfigException::class);
+        $htpasswd = ($this->factory)($this->container->reveal());
+    }
+
     public function testInvokeWithEmptyConfig()
     {
+        $this->container->has('config')->willReturn(true);
         $this->container->get('config')->willReturn([]);
+
+        $this->expectException(InvalidConfigException::class);
         $htpasswd = ($this->factory)($this->container->reveal());
     }
 
-    /**
-     * @expectedException Zend\Expressive\Authentication\Exception\InvalidConfigException
-     */
     public function testInvokeWithInvalidConfig()
     {
+        $this->container->has('config')->willReturn(true);
         $this->container->get('config')->willReturn([
             'authentication' => [
                 'htpasswd' => 'foo'
             ]
         ]);
+
+        $this->expectException(InvalidConfigException::class);
         $htpasswd = ($this->factory)($this->container->reveal());
     }
 
     public function testInvokeWithValidConfig()
     {
+        $this->container->has('config')->willReturn(true);
         $this->container->get('config')->willReturn([
             'authentication' => [
                 'htpasswd' => __DIR__ . '/../TestAssets/htpasswd'