cuNotifyTest.php

<?php
/**
 * FILE: cuNotifyTest
 * Tests the internal functions of cu_notify.data.  (Full tests cannot be run due to database and AWS interface.)
 */

use PHPUnit\Framework\TestCase;

class cuNotifyTest extends TestCase {
    function setUp() {
        $sharedLibrary = "/var/www/html/shared/library";
        $admIncludes = "/var/www/html/admcom/includes";
        require_once("$sharedLibrary/hcuFunctions.i");
        require_once("$admIncludes/cu_notify.data");
    }

    // ------------------------------------------------
    // These functions are broken up from UpdateVerifiedEmailList
    // -------------------------------------------------

    function test_ModifyVerifiedEmailListWithUsedEmails() {

        // Invalid inputs.
        $usedEmailList = array();
        $verifiedEmailList = null; // Invalid.  Needs to be an array.
        $deletedEmails = array();
        $results = _ModifyVerifiedEmailListWithUsedEmails ($usedEmailList, $verifiedEmailList, $deletedEmails);
        $this->assertEquals($results["error"], "Inputs are not valid.");

        // Invalid used email list.
        $usedEmailList = array(array("noemail" => true, "used" => true)); // Invalid.  There is no "email" attribute.
        $verifiedEmailList = array();
        $deletedEmails = array();
        $results = _ModifyVerifiedEmailListWithUsedEmails ($usedEmailList, $verifiedEmailList, $deletedEmails);
        $this->assertEquals($results["error"], "UsedEmailList is not valid.");

        // Invalid email
        $usedEmailList = array(array("email" => "invalidemail", "used" => true)); // Invalid.  Email is invalid.
        $verifiedEmailList = array();
        $deletedEmails = array();
        $results = _ModifyVerifiedEmailListWithUsedEmails ($usedEmailList, $verifiedEmailList, $deletedEmails);
        $this->assertEquals($results["error"], "One or more emails are not valid.");

        // Used flag is updated.
        $usedEmailList = array("email1@homecu.net" => array("email" => "email1@homecu.net", "used" => true));
        $verifiedEmailList = array("email1@homecu.net" => array("email" => "email1@homecu.net", "used" => false),
                                   "email2@homecu.net" => array("email" => "email2@homecu.net", "used" => false));
        $deletedEmails = array();
        $results = _ModifyVerifiedEmailListWithUsedEmails ($usedEmailList, $verifiedEmailList, $deletedEmails);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["verifiedEmailList"]["email1@homecu.net"]["used"], true); // First email changes.
        $this->assertEquals($results["data"]["verifiedEmailList"]["email2@homecu.net"]["used"], false); // Second email doesn't change.

        // Trying to delete an email in use.
        $usedEmailList = array("email1@homecu.net" => array("email" => "email1@homecu.net", "used" => true)); // Invalid.  Email is invalid.
        $verifiedEmailList = array();
        $deletedEmails = array("email1@homecu.net" => true);
        $results = _ModifyVerifiedEmailListWithUsedEmails ($usedEmailList, $verifiedEmailList, $deletedEmails);
        $this->assertEquals($results["error"], "Cannot delete an email in use.");
    }

    function test_GetInfoForEmailList() {
        // Updated and deleted emails are empty.
        $deletedEmails = array();
        $unverifiedEmails = array();
        $results = _GetInfoForEmailList($deletedEmails, $unverifiedEmails);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals(count($results["data"]["info"]), 1);
        $this->assertEquals($results["data"]["info"][0], "Email list saved successfully.");

        $deletedEmails = array("test1@homecu.net" => "test1@homecu.net", "test2@homecu.net" => "test2@homecu.net");
        $unverifiedEmails = array("test3@homecu.net" => "test3@homecu.net");
        $results = _GetInfoForEmailList($deletedEmails, $unverifiedEmails);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["info"], array("Email list saved successfully.", "&nbsp;", "Verification emails were sent to:", "test3@homecu.net",
            "&nbsp;", "The following emails were removed:", "test1@homecu.net", "test2@homecu.net"));
    }

    function test_TransformKendoEmailList() {
        $emailList = "Invalid.";
        $results = _TransformKendoEmailList($emailList);
        $this->assertEquals($results["status"], 1);
        $this->assertEquals($results["error"], "Email list is not valid.");

        $emailList = HCU_JsonEncode(array(array("email" => "is there", "but status" => "is not")));
        $results = _TransformKendoEmailList($emailList);
        $this->assertEquals($results["status"], 2);
        $this->assertEquals($results["error"], "Email list is not valid.");

        $emailList = HCU_JsonEncode(array(array("email" => "is there", "status" => "is not in list")));
        $results = _TransformKendoEmailList($emailList);
        $this->assertEquals($results["status"], 3);
        $this->assertEquals($results["error"], "Email list is not valid.");

        $emailList = HCU_JsonEncode(array(array("email" => "is not valid", "status" => "Success")));
        $results = _TransformKendoEmailList($emailList);
        $this->assertEquals($results["status"], 4);
        $this->assertEquals($results["error"], "Email list is not valid.");

        $emailList = HCU_JsonEncode(array(array("email" => "test1@homecu.net", "status" => "Success"), array("email" => "test2@homecu.net", "status" => ""),
            array("email" => "test3@homecu.net", "status" => "Pending"), array("email" => "test4@homecu.net", "status" => "Success", "deleted" => true),
            array("email" => "test5@homecu.net", "status" => "Pending", "deleted" => false),
            array("email" => "test6@homecu.net", "status" => "", "deleted" => true, "itsNew" => true),
            array("email" => "TEst5@homecu.net", "status" => "Success"), array("email" => "TeSt6@homecu.net", "status" => "Pending", "itsNew" => true)));
        $results = _TransformKendoEmailList($emailList);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals(count($results["data"]["allEmails"]), 8);
        $this->assertEquals(count($results["data"]["unverifiedEmails"]), 1);
        $this->assertEquals($results["data"]["unverifiedEmails"]["test2@homecu.net"], "test2@homecu.net");
        $this->assertEquals(count($results["data"]["deletedEmails"]), 1);
        $this->assertEquals($results["data"]["deletedEmails"]["test4@homecu.net"], "test4@homecu.net");
        $this->assertEquals(count($results["data"]["verifiedEmailList"]), 5);
        $this->assertEquals($results["data"]["verifiedEmailList"]["test2@homecu.net"]["status"], "Pending");
        $this->assertEquals(count($results["data"]["databaseEmailList"]), 5);
        $this->assertEquals($results["data"]["databaseEmailList"]["test1@homecu.net"]["verified"], true);
        $this->assertEquals($results["data"]["databaseEmailList"]["test3@homecu.net"]["verified"], false);
    }

    // ------------------------------------------------
    // These functions are broken up from ReadVerifiedEmailList
    // -------------------------------------------------

    function test_TransformEmailsNoSES() {
        $dataFromNotifies = array(array("role" => "role", "email" => "test1@homecu.net"));
        $dataFromTemplate = array(array("email" => "teST1@homecu.net"), array("email" => "test3@homecu.net"));

        $expectedResults = array(
            "test1@homecu.net" => array("email" => "test1@homecu.net", "status" => "", "used" => true, "isDirty" => true),
            "test3@homecu.net" => array("email" => "test3@homecu.net", "status" => "", "used" => true, "isDirty" => true)
        );

        $results = _TransformEmailsNoSES($dataFromNotifies, $dataFromTemplate);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["verifiedEmailList"], $expectedResults);
    }

    function test_TransformEmailStatuses() {
        $emailStatuses = array("homecutester2@gmail.com" => array("VerificationStatus" => "Pending"),
                               "homecutester1@gmail.com" => array("VerificationStatus" => "Success"),
                               "homecutester3@gmail.com" => array("VerificationStatus" => "Failed"));
        $verifiedEmailList = array("homecutester2@gmail.com" => array("email" => "homecutester2@gmail.com", "status" => ""),
                                   "homecutester1@gmail.com" => array("email" => "homecutester1@gmail.com"),
                                   "homecutester3@gmail.com" => array("email" => "homecutester3@gmail.com"),
                                   "homecutester4@gmail.com" => array("email" => "homecutester4@gmail.com", "status" => "Pending"));
        $databaseEmailList = array("homecutester2@gmail.com" => array("email" => "homecutester2@gmail.com", "verified" => false),
                                   "homecutester1@gmail.com" => array("email" => "homecutester1@gmail.com", "verified" => false),
                                   "homecutester3@gmail.com" => array("email" => "homecutester3@gmail.com", "verified" => false),
                                   "homecutester4@gmail.com" => array("email" => "homecutester4@gmail.com", "verified" => false));

        $expectedVerifiedEmailList = array("homecutester2@gmail.com" => array("email" => "homecutester2@gmail.com", "status" => "Pending"),
                                   "homecutester1@gmail.com" => array("email" => "homecutester1@gmail.com", "status" => "Success", "resend" => false),
                                   "homecutester3@gmail.com" => array("email" => "homecutester3@gmail.com", "status" => "Failed"),
                                   "homecutester4@gmail.com" => array("email" => "homecutester4@gmail.com", "status" => "Pending"));
        $expectedDatabaseEmailList = array("homecutester2@gmail.com" => array("email" => "homecutester2@gmail.com", "verified" => false),
                                   "homecutester1@gmail.com" => array("email" => "homecutester1@gmail.com", "verified" => true),
                                   "homecutester3@gmail.com" => array("email" => "homecutester3@gmail.com", "verified" => false),
                                   "homecutester4@gmail.com" => array("email" => "homecutester4@gmail.com", "verified" => false));

        $results = _TransformEmailStatuses($emailStatuses, $verifiedEmailList, $databaseEmailList);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["verifiedEmailList"], $expectedVerifiedEmailList);
        $this->assertEquals($results["data"]["databaseEmailList"], $expectedDatabaseEmailList);
        $this->assertEquals($results["data"]["updateDatabase"], true);
    }

    function test_TransformDatabaseEmailList() {
        $emailList = HCU_JsonEncode(array(array("email" => "homecutesteR1@homecu.net", "verified" => false), array("email" => "homecutesTer2@", "verified" => true)));

        $results = _TransformDatabaseEmailList($emailList);
        $this->assertEquals($results["error"], "Email list is not valid.");

        $emailList = HCU_JsonEncode(array(array("email" => "homecuteSTer1@homecu.net", "verified" => false),
                                          array("email" => "homecutesTer2@homecu.net", "verified" => true)));

        $expectedVerifiedEmailList = array("homecutester1@homecu.net" => array("email" => "homecutester1@homecu.net", "status" => "", "used" => false, "resend" => true),
                                           "homecutester2@homecu.net" => array("email" => "homecutester2@homecu.net", "status" => "Success", "used" => false,
                                                                               "resend" => false));
        $expectedDatabaseEmailList = array("homecutester1@homecu.net" => array("email" => "homecutester1@homecu.net", "verified" => false),
                                           "homecutester2@homecu.net" => array("email" => "homecutester2@homecu.net", "verified" => true));
        $results = _TransformDatabaseEmailList($emailList);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["verifiedEmailList"], $expectedVerifiedEmailList);
        $this->assertEquals($results["data"]["databaseEmailList"], $expectedDatabaseEmailList);
        $this->assertEquals(count($results["data"]["unverifiedEmails"]), 1);
        $this->assertEquals($results["data"]["unverifiedEmails"]["homecutester1@homecu.net"], "homecutester1@homecu.net");
        $this->assertEquals(count($results["data"]["allEmails"]), 2);
    }

    function test_ValidateAWSStatusReturn() {
        $response = "";
        $results = _ValidateAWSStatusReturn($response);
        $this->assertEquals($results["status"], 11);
        $this->assertEquals($results["error"], "Invalid response from script.");

        $response = HCU_JsonEncode(array());
        $results = _ValidateAWSStatusReturn($response);
        $this->assertEquals($results["status"], 3);
        $this->assertEquals($results["error"], "Invalid response from script.");

        $response = HCU_JsonEncode(array("status" => "08"));
        $results = _ValidateAWSStatusReturn($response);
        $this->assertEquals($results["status"], 5);
        $this->assertEquals($results["error"], "Invalid response from script.");

        $response = HCU_JsonEncode(array("status" => "08", "error" => "There's an error somewhere.", "response" => array()));
        $results = _ValidateAWSStatusReturn($response);
        $this->assertEquals($results["status"], 4);
        $this->assertEquals($results["error"], "There's an error somewhere.");

        $response = HCU_JsonEncode(array("status" => "000", "error" => "", "response" => array()));
        $results = _ValidateAWSStatusReturn($response);
        $this->assertEquals($results["status"], 6);
        $this->assertEquals($results["error"], "Invalid response from script.");

        $response = HCU_JsonEncode(array("status" => "000", "error" => "",
                                         "response" => array("VerificationAttributes" => "Anything.  It is handled by the next small function.")));
        $results = _ValidateAWSStatusReturn($response);
        $this->assertEquals($results["status"], "000"); // Finally!
        $this->assertEquals($results["data"]["emailStatuses"], "Anything.  It is handled by the next small function.");
    }

    // ------------------------------------------------
    // These functions are broken up from CheckIfEmailIsUsed
    // -------------------------------------------------

    function test_TransformUsedEmailList() {
        $usedEmailData = array(array("email" => "     teST1@homecu.net   ", "used" => "t"), array("email" => "  tEst2@homecu.net", "used" => "f"));
        $expectedUsedEmailData = array("test1@homecu.net" => array("email" => "test1@homecu.net", "used" => true),
                                       "test2@homecu.net" => array("email" => "test2@homecu.net", "used" => false));
        $results = _TransformUsedEmailList($usedEmailData);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["usedEmailList"], $expectedUsedEmailData);
    }

    function test_GetInvalidRoles() {
        $roles = array("Role1" => array("hidden" => true),
                       "Role2" => array("hidden" => false, "single" => true),
                       "Role3" => array(),
                       "Role4" => array("single" => true),
                       "Role5" => array("single" => false));
        $expectedInvalidRoles = array("Role1", "Role3", "Role5");
        $results = _GetInvalidRoles($roles);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["invalidRoles"], $expectedInvalidRoles);
    }

    // ------------------------------------------------
    // This function is broken up from ReadEmailNotify
    // -------------------------------------------------

    function test_TransformReadEmailNotify() {
        $roles = array(
            "achnotify" => array("desc" => "A"),
            "required" => array("desc" => "B", "clear" => false),
            "another" => array("desc" => "C", "single" => true),
            "hidden" => array("desc" => "D", "hidden" => true)
        );
        $roleData = array(
            array("role" => "nomatch", "email" => " "),
            array("role" => "achnotify", "email" => " "),
            array("role" => "required", "email" => "test1@homecu.net"),
            array("role" => "another", "email" => "test2@homecu.net"),
            array("role" => "hidden", "email" => "test3@homecu.net")
        );
        $featureList = array("data" => array("ACHCOL"));
        $expectedResults = array(
            array("roleId" => "achnotify", "roleText" => "A", "required" => false, "single" => false, "email" => ""),
            array("roleId" => "required", "roleText" => "B", "required" => true, "single" => false, "email" => "test1@homecu.net"),
            array("roleId" => "another", "roleText" => "C", "required" => true, "single" => true, "email" => "test2@homecu.net")
        );
        $results = _TransformReadEmailNotify($roles, $roleData, $featureList);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["records"], $expectedResults);

        $featureList = array("data" => array());
        $results = _TransformReadEmailNotify($roles, $roleData, $featureList);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals(count($results["data"]["records"]), 2); // Now the "achnotify" role is not in the list.
    }

    // ------------------------------------------------
    // These functions are broken up from UpdateEmailNotify
    // -------------------------------------------------

    function test_TransformRoleForUpdate() {
        $roles = array(
            "cannot be cleared" => array("clear" => false, "desc" => "A"),
            "Email cannot be cleared" => array(),
            "one address" => array("single" => true),
        );

        $role = "doesn't exist";
        $email = "";
        $results = _TransformRoleForUpdate($role, $roles, $email);
        $this->assertEquals($results["status"], 1);
        $this->assertEquals($results["error"], "role record not found.");

        $role = "cannot be cleared";
        $results = _TransformRoleForUpdate($role, $roles, $email);
        $this->assertEquals($results["status"], 2);
        $this->assertEquals($results["error"], "Email cannot be cleared.");

        $role = "Email cannot be cleared";
        $email = "invalid email";
        $results = _TransformRoleForUpdate($role, $roles, $email);
        $this->assertEquals($results["status"], 3);
        $this->assertEquals($results["error"], "One of the emails is invalid.");

        $email = " ; ;   ;";
        $results = _TransformRoleForUpdate($role, $roles, $email);
        $this->assertEquals($results["status"], 4);
        $this->assertEquals($results["error"], "Email cannot be cleared.");

        $email = "test1@homecu.net; test2@homecu.net;;;;";
        $role = "one address";
        $results = _TransformRoleForUpdate($role, $roles, $email);
        $this->assertEquals($results["status"], 5);
        $this->assertEquals($results["error"], "Only one address is allowed.");

        $role = "cannot be cleared";
        $expectedResults = array("roleId" => "cannot be cleared", "roleText" => "A", "email" => "test1@homecu.net;test2@homecu.net",
                                 "required" => true, "recordExists" => "Y");
        $results = _TransformRoleForUpdate($role, $roles, $email);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["returnRecord"], $expectedResults);
    }

    function test_CreateUpdateTableForUpdateAudit() {
        // From the CU email notification screen, update.
        $Cu = "MYCU";
        $role = "role";
        $email = "email1@homecu.net";
        $recordExists = true;
        $userEmail = "email2@homecu.net";
        $specialEmailUpdate = false;
        $results = _CreateUpdateTableForUpdateAudit($Cu, $role, $email, $recordExists, $userEmail, $specialEmailUpdate);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["updateTable"], array("cuadmnotify" => array(array("cu" => "MYCU", "role" => "role",
                                                                                                "email" => "email1@homecu.net", "_action" => "update"))));
        $this->assertEquals($results["data"]["shortLabel"], "UPD_NOTI");
        $this->assertEquals($results["data"]["longLabel"], "Update Notification Emails");

        // From the welcome screen, update.
        $specialEmailUpdate = true;
        $results = _CreateUpdateTableForUpdateAudit($Cu, $role, $email, $recordExists, $userEmail, $specialEmailUpdate);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["shortLabel"], "UPD_SNOTI");
        $this->assertEquals($results["data"]["longLabel"], "Update Special Email Notification");

        // From the welcome screen, add.
        $recordExists = false;
        $results = _CreateUpdateTableForUpdateAudit($Cu, $role, $email, $recordExists, $userEmail, $specialEmailUpdate);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["shortLabel"], "ADD_SNOTI");
        $this->assertEquals($results["data"]["longLabel"], "Add Special Email Notification");

        // From the CU email notification screen, add.
        $specialEmailUpdate = false;
        $results = _CreateUpdateTableForUpdateAudit($Cu, $role, $email, $recordExists, $userEmail, $specialEmailUpdate);
        $this->assertEquals($results["status"], "000");
        $this->assertEquals($results["data"]["shortLabel"], "ADD_NOTI");
        $this->assertEquals($results["data"]["longLabel"], "Add Notification Emails");
    }
}