Test all the things!

This merge request improves the code coverage of the project's unit tests.

I broke up this rather large set of changes into separate commits. See the individual commit messages for details.

• 75773b6d - Use PHPUnit provided by Composer instead of downloading a PHAR
• 737771f2 - Convert dashes to underscores when converting to HTTP headers
• 08aaa966 - Group conditional logic for clarity
• 1477621c - Create missing tests for PreauthUserDetailsProvider, introduce an EnvironmentHelper
• b74fd618 - Federated preauth tests made consistent with new preauth tests, improved coverage, moved test data from JSON to source code
• 09d36d36 - LocalUserDetailsProvider throws Exception if JSON is invalid, returns null if JSON is missing
• d021fd72 - Verify missing attributes are set as false
• e29430a9 - Docblock and PSR-2 formatting improvements

PHP Trait

In 1477621c, I introduced a lesser-known feature of PHP called a trait. It allows one to "inject" common methods into any class without requiring inheritance.

@andrew-summers @weizhong-wang @KJOYNER

src/test/edu/wisc/doit/uwphps/preauth/FederatedPreauthUserDetailsProviderTest.php

+<?php
+namespace edu\wisc\doit\uwphps\preauth;
+
+use edu\wisc\doit\uwphps\EnvironmentHelper;
+
+/**
+ * Tests for {@link FederatedPreauthUserDetailsProvider}.
+ */
+class FederatedPreauthUserDetailsProviderTest extends \PHPUnit_Framework_TestCase
+{
+
+    use EnvironmentHelper;
+
+    /** @var array */
+    private $attributes;
+
+    /** @var FederatedPreauthUserDetailsProvider */
+    private $userProvider;
+
+    /** @var FederatedPreauthUserDetailsProvider  configured to use HTTP headers */
+    private $userProviderHttp;
+
+    /** @var array  environment variables to be set when testing */
+    private $environment;
+
+    protected function setUp()
+    {
+
+        $this->userProvider = new FederatedPreauthUserDetailsProvider(false);
+        $this->userProviderHttp = new FederatedPreauthUserDetailsProvider(true);
+
+        // Default environment variables
+        $this->environment = [
+            FederatedPreauthUserDetailsProvider::FULL_NAME => 'BUCKINGHAM BADGER',
+            FederatedPreauthUserDetailsProvider::EPPN => 'bbadger@wisc.edu',
+            FederatedPreauthUserDetailsProvider::FIRST_NAME => 'BUCKINGHAM',
+            FederatedPreauthUserDetailsProvider::EMAIL => 'bucky.badger@wisc.edu',
+            FederatedPreauthUserDetailsProvider::SHIB_SESSION_ID => '1234567890',
+            FederatedPreauthUserDetailsProvider::LAST_NAME => 'BADGER',
+            FederatedPreauthUserDetailsProvider::SOURCE => 'a_source',
+            FederatedPreauthUserDetailsProvider::SPVI => 'UW123A456',
+            FederatedPreauthUserDetailsProvider::ISIS_EMPLID => '123456789'
+        ];
+    }
+
+    /** @test */
+    public function loadsNullUserWhenNoSession()
+    {
+        $this->removeEnvironmentVariable(FederatedPreauthUserDetailsProvider::SHIB_SESSION_ID);
+        $this->removeEnvironmentVariable(FederatedPreauthUserDetailsProvider::SHIB_SESSION_ID_HTTP);
+        static::assertNull($this->userProvider->loadUser());
+        static::assertNull($this->userProviderHttp->loadUser());
+    }
+
+    /** @test */
+    public function loadsUser()
+    {
+        $this->setEnvironment($this->environment);
+        $user = $this->userProvider->loadUser();
+
+        static::assertNotNull($user);
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::EPPN], $user->getEppn());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::SPVI], $user->getPvi());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::FULL_NAME], $user->getFullName());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::EMAIL], $user->getEmailAddress());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::SOURCE], $user->getSource());
+        static::assertEquals(
+            $this->environment[FederatedPreauthUserDetailsProvider::ISIS_EMPLID],
+            $user->getIsisEmplid()
+        );
+        static::assertEquals(
+            $this->environment[FederatedPreauthUserDetailsProvider::FIRST_NAME],
+            $user->getFirstName()
+        );
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::LAST_NAME], $user->getLastName());
+    }
+
+    /** @test */
+    public function loadsUserWithHttpHeaders()
+    {
+        $this->setEnvironment($this->toHttpHeaders($this->environment));
+        $user = $this->userProviderHttp->loadUser();
+
+        static::assertNotNull($user);
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::EPPN], $user->getEppn());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::SPVI], $user->getPvi());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::FULL_NAME], $user->getFullName());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::EMAIL], $user->getEmailAddress());
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::SOURCE], $user->getSource());
+        static::assertEquals(
+            $this->environment[FederatedPreauthUserDetailsProvider::ISIS_EMPLID],
+            $user->getIsisEmplid()
+        );
+        static::assertEquals(
+            $this->environment[FederatedPreauthUserDetailsProvider::FIRST_NAME],
+            $user->getFirstName()
+        );
+        static::assertEquals($this->environment[FederatedPreauthUserDetailsProvider::LAST_NAME], $user->getLastName());
+    }
+
+    /** @test */
+    public function missingAttributeIsFalse()
+    {
+        $this->setEnvironment($this->environment);
+        $this->removeEnvironmentVariable(FederatedPreauthUserDetailsProvider::EMAIL);
+        $user = $this->userProvider->loadUser();
+        static::assertNotNull($user);
+        static::assertFalse($user->getEmailAddress());
+    }
+}