Add integration test for Email authentication; fix case-sensitivity bug. (vufind-org#3778)

Co-authored-by: Ere Maijala <ere.maijala@helsinki.fi>

Author: demiankatz

build.xml

@@ -467,6 +467,8 @@
 
     <!-- set up appropriate read/write permissions for Apache -->
     <exec command="chmod -R a+w ${localdir}/cache" />
+    <exec command="touch ${srcdir}/vufind-mail.log" />
+    <exec command="chmod a+w ${srcdir}/vufind-mail.log" />
     <exec command="touch ${srcdir}/vufind-exception.log" />
     <exec command="chmod a+w ${srcdir}/vufind-exception.log" />
 
@@ -824,6 +826,12 @@ ${git_status}
         <delete file="${srcdir}/vufind-exception.log" failonerror="true" />
       </then>
     </if>
+    <if>
+      <available file="${srcdir}/vufind-mail.log" />
+      <then>
+        <delete file="${srcdir}/vufind-mail.log" failonerror="true" />
+      </then>
+    </if>
     <delete dir="${srcdir}/vendor" includeemptydirs="true" failonerror="false" />
     <if>
       <available file="${localdir}" type="dir" />

module/VuFind/src/VuFind/Auth/Email.php

@@ -88,7 +88,7 @@ public function authenticate($request)
                 $this->emailAuthenticator->sendAuthenticationLink(
                     $user['email'],
                     $loginData,
-                    ['auth_method' => 'email']
+                    ['auth_method' => 'Email']
                 );
             }
             // Don't reveal the result

module/VuFind/src/VuFindTest/Feature/EmailTrait.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * Trait adding the ability to inspect sent emails.
+ *
+ * PHP version 8
+ *
+ * Copyright (C) Villanova University 2024.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Tests
+ * @author   Demian Katz <demian.katz@villanova.edu>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:testing:unit_tests Wiki
+ */
+
+namespace VuFindTest\Feature;
+
+/**
+ * Trait adding the ability to inspect sent emails.
+ *
+ * @category VuFind
+ * @package  Tests
+ * @author   Demian Katz <demian.katz@villanova.edu>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:testing:unit_tests Wiki
+ */
+trait EmailTrait
+{
+    /**
+     * Get the path to the email message log file.
+     *
+     * @return string
+     */
+    protected function getEmailLogPath(): string
+    {
+        return APPLICATION_PATH . '/vufind-mail.log';
+    }
+
+    /**
+     * Clear out the email log to eliminate any past contents.
+     *
+     * @return void
+     */
+    protected function resetEmailLog(): void
+    {
+        file_put_contents($this->getEmailLogPath(), '');
+    }
+}

module/VuFind/tests/integration-tests/src/VuFindTest/Mink/ChoiceAuthTest.php

@@ -42,6 +42,7 @@
  */
 final class ChoiceAuthTest extends \VuFindTest\Integration\MinkTestCase
 {
+    use \VuFindTest\Feature\EmailTrait;
     use \VuFindTest\Feature\LiveDatabaseTrait;
     use \VuFindTest\Feature\UserCreationTrait;
 
@@ -60,7 +61,7 @@ public static function setUpBeforeClass(): void
      *
      * @return array
      */
-    public function getConfigIniOverrides()
+    protected function getConfigIniOverrides(): array
     {
         return [
             'Catalog' => [
@@ -80,7 +81,7 @@ public function getConfigIniOverrides()
      *
      * @return array
      */
-    public function getConfigIniSSOOverrides()
+    protected function getConfigIniSSOOverrides(): array
     {
         return [
             'ChoiceAuth' => [
@@ -90,13 +91,29 @@ public function getConfigIniSSOOverrides()
     }
 
     /**
-     * Get Demo.ini override settings for testing ILS functions.
+     * Get config.ini override settings for testing ChoiceAuth with Email authentication.
      *
-     * @param string $bibId Bibliographic record ID to create fake item info for.
+     * @return array
+     */
+    protected function getConfigIniEmailOverrides(): array
+    {
+        return [
+            'ChoiceAuth' => [
+                'choice_order' => 'Database, Email',
+            ],
+            'Mail' => [
+                'testOnly' => true,
+                'message_log' => $this->getEmailLogPath(),
+            ],
+        ];
+    }
+
+    /**
+     * Get Demo.ini override settings for testing ILS functions.
      *
      * @return array
      */
-    public function getDemoIniOverrides($bibId = 'testsample1')
+    protected function getDemoIniOverrides(): array
     {
         return [
             'Users' => ['catuser' => 'catpass'],
@@ -108,7 +125,7 @@ public function getDemoIniOverrides($bibId = 'testsample1')
      *
      * @return array
      */
-    public function getSimulatedSSOIniOverrides()
+    protected function getSimulatedSSOIniOverrides(): array
     {
         return [
             'General' => [
@@ -122,7 +139,7 @@ public function getSimulatedSSOIniOverrides()
      *
      * @return void
      */
-    public function testCreateDatabaseUser()
+    public function testCreateDatabaseUser(): void
     {
         $this->changeConfigs(
             [
@@ -161,7 +178,7 @@ public function testCreateDatabaseUser()
      *
      * @return void
      */
-    public function testProfile()
+    public function testProfile(): void
     {
         $this->changeConfigs(
             [
@@ -193,7 +210,7 @@ public function testProfile()
      *
      * @return void
      */
-    public function testRecordPageWithILSAndSSO()
+    public function testRecordPageWithILSAndSSO(): void
     {
         // Set up configs and session
         $this->changeConfigs(
@@ -212,7 +229,6 @@ public function testRecordPageWithILSAndSSO()
         $this->clickCss($page, '#loginOptions a');
 
         // login with ILS
-        $this->clickCss($page, '#loginOptions a');
         $this->fillInLoginForm($page, 'catuser', 'catpass', false, '.authmethod0 ');
         $this->submitLoginForm($page, false, '.authmethod0 ');
 
@@ -241,6 +257,43 @@ public function testRecordPageWithILSAndSSO()
         $this->clickCss($page, '.logoutOptions a.logout');
     }
 
+    /**
+     * Test login with Email authentication.
+     *
+     * @return void
+     */
+    public function testEmailAuthentication(): void
+    {
+        // Set up configs, session and message logging:
+        $this->changeConfigs(
+            [
+                'config' => $this->getConfigIniEmailOverrides() + $this->getConfigIniOverrides(),
+            ]
+        );
+        $session = $this->getMinkSession();
+        $session->visit($this->getVuFindUrl());
+        $page = $session->getPage();
+        $this->resetEmailLog();
+
+        // Click login and request email:
+        $this->clickCss($page, '#loginOptions a');
+        $this->findCssAndSetValue($page, '#login_Email_username', 'username1@ignore.com');
+        $this->clickCss($page, '.authmethod1 input[type="submit"]');
+        $this->assertEquals(
+            'We have sent a login link to your email address. It may take a few moments for the link to arrive. '
+            . "If you don't receive the link shortly, please check also your spam filter.",
+            $this->findCssAndGetText($page, '.modal .alert-success')
+        );
+
+        // Extract the link from the provided message:
+        $email = file_get_contents($this->getEmailLogPath());
+        preg_match('/Link to login: <(http.*)>/', $email, $matches);
+        $session->visit($matches[1]);
+
+        // Log out
+        $this->clickCss($page, '.logoutOptions a.logout');
+    }
+
     /**
      * Standard teardown method.
      *