odysseyMigrTest.prg

#!/usr/bin/php
<?php
/**
 * File: odysseyMigrTest.prg
 * Purpose: Tests the mammoth endpoint: mOdysseyMigrExp.prg.
 */

error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED);

// Includes necessary files
$sharedLibrary = "/var/www/html/shared/library";
require_once("$sharedLibrary/hcuCommon.i");

// Command line only takes one argument: the test to run.
if (count($argv) >= 2) {
    switch($argv[1]) {
        case "settings":
            TestGetSettings();
            break;
        case "member":
        case "members":
        case "memdata":
            TestMemberMigration();
            break;
        case "createhistoryfile":
        case "gethistoryfile":
        case "history":
            TestHistoryMigration();
            break;
        case "admin":
        case "info":
            TestAdminMigration();
            break;
        case "adhoc":
            TestAdhoc($argv);
            break;
        case "all":
        case "regression":
            $sepLength = GetSeparatorLength();

            print "\n\nTest Settings\n" . str_repeat("+", $sepLength) . "\n" . str_repeat("=", $sepLength) . "\n\n\n";
            TestGetSettings();
            print "\n\nTest Member Migration\n" . str_repeat("+", $sepLength) . "\n" . str_repeat("=", $sepLength) . "\n";
            TestMemberMigration();
            print "\n\nTest Admin Migration\n" . str_repeat("+", $sepLength) . "\n" . str_repeat("=", $sepLength) . "\n";
            TestAdminMigration();
            print "\n\nTest History Migration\n" . str_repeat("+", $sepLength) . "\n" . str_repeat("=", $sepLength) . "\n";
            TestHistoryMigration();
            break;
        default:
            print "Test is not valid.\n";
    }
} else {
    print "Command line only takes one argument: the test to run.\n";
}

/**
 * function GetSeparatorLength()
 * @return the number of characters to spit out for the dividers between tests.
 */
function GetSeparatorLength() {
    return 40;
}

/**
 * function GetSecret()
 * @return The secret string to create / verify the passphrase.
 */
function GetSecret() {
    return "n3c3s1t@m0\$Mud@rT0d@\$L@\$C0\$@\$!";
}

/**
 * function CreateHash($action, $cu)
 * @return sha1 of the action, cu, and the secret string.
 */
function CreateHash($action, $cu) {
    return sha1("${action}${cu}" . GetSecret());
}

/**
 * function RunMigrCurl($server, $cu, $action, $hash)
 * Calls the Mammoth endpoint for the export.
 *
 * @param $server -- www4, www3, www5, or www6.  www doesn't return anything specific to the Credit Union.
 * @param $cu -- the Credit Union code (uppercase.)
 * @param $action -- the action to perform.
 * @param $hash -- the passphrase to check.
 * @param $parameters -- any additional parameters that need to be passed to Mammoth.
 *
 * @return array of the response.  Mammoth endpoint returns data in a JSON encoded structure.
 */
function RunMigrCurl($server, $cu, $action, $hash, $parameters = array()) {

    if (!isset($parameters) || !is_array($parameters)) {
        $parameters = array();
    }
    $parameters["passphrase"] = $hash;
    $parameters["action"] = $action;

    $parameters = http_build_query($parameters);

    $url = "${server}.homecu.net/hcuadm/mOdysseyMigrExp.prg?cu=" . urlencode($cu) . "&" . $parameters;
    $ch = curl_init($url);

    curl_setopt($ch, CURLOPT_USERPWD, "nobody:no1home");
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); // get response as string
    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
    curl_setopt($ch, CURLOPT_FORBID_REUSE, true); // For testing, there are a lot of the same calls but make sure that it is fresh.
    curl_setopt($ch, CURLOPT_FRESH_CONNECT, true); // For testing, there are a lot of the same calls but make sure that it is fresh.

    $response = curl_exec($ch);

    if ($action !== "gethistoryfile") {
      $response = isset($response) && trim($response) != "" ? HCU_JsonDecode($response)
                                                            : array("action" => $action, "error" => "CURL call didn't return anything. (" . __FILE__ . ":" . __LINE__ . ")", "data" => array());
    }

    return $response;
}

/**
 * function AssertEquals($title, $testThis, $needsToEqual)
 * Tests if two strings or numbers are equal.  Prints out the results.
 *
 * @param $title -- the title of the test.
 * @param $testThis -- the variable to check.
 * @param $needsToEqual -- the literal that the variable needs to equal for success.
 */
function AssertEquals($title, $testThis, $needsToEqual) {
    $testThis = trim($testThis);
    $needsToEqual = trim($needsToEqual);
    if ($testThis == $needsToEqual) {
        print "$title was successful.\n";
    } else {
        print "$title failed.\n";
        print "Expected: '$needsToEqual'\n";
        print "Received: '$testThis'\n";
    }
}

/**
 * function AssertStartsWith($title, $testThis, $needsToEqual)
 * Tests if one string starts with string.  Prints out the results.
 *
 * @param $title -- the title of the test.
 * @param $testThis -- the variable to check.
 * @param $needsToEqual -- the literal that the variable needs to equal for success.
 */
function AssertStartsWith($title, $testThis, $needsToEqual) {
    $testThis = trim($testThis);
    $needsToEqual = trim($needsToEqual);
    if (substr($testThis, 0, strlen($needsToEqual)) == $needsToEqual) {
        print "$title was successful.\n";
    } else {
        print "$title failed.\n";
        print "Expected: '$needsToEqual'\n";
        print "Received: '$testThis'\n";
    }
}

/**
 * function AssertNotContains($title, $testThis, $needsToEqual)
 * Tests if one string starts with string.  Prints out the results.
 *
 * @param $title -- the title of the test.
 * @param $testThis -- the variable to check.
 * @param $needsToEqual -- the literal that the variable needs to equal for success.
 */
function AssertNotContains($title, $testThis, $contains) {
    $testThis = trim($testThis);
    $needsToEqual = trim($needsToEqual);
    if (strpos($testThis, $contains) === false) {
        print "$title was successful.\n";
    } else {
        print "$title failed.\n";
        print "Expected: '$needsToEqual'\n";
        print "Received: '$testThis'\n";
    }
}

/**
 * function TestGetSettings()
 * Tests the GetSettings data call from the Mammoth endpoint.
 */
function TestGetSettings() {
    $server = "www4";
    $cu = "STARKCU";
    $action = "settings";
    $correctHash = CreateHash($action, $cu);

    $results = RunMigrCurl($server, $cu, $action, "hash");
    AssertStartsWith("Test 1: using wrong hash", $results["error"], "Invalid passphrase.");

    $unusedAction = "unusedAction";
    $wrongActionHash = CreateHash($unusedAction, $cu);
    $results = RunMigrCurl($server, $cu, $unusedAction, $wrongActionHash);
    AssertStartsWith("Test 2: using wrong action", $results["error"], "Action is unrecognized.");

    $results = RunMigrCurl($server, $cu, $action, $correctHash);
    AssertEquals("Test 3: using right hash", $results["error"], "");

    // Assert that cuadmin export works
    AssertEquals("Test 4: cuadmin count", count($results["data"]["cuadmin"]), 1);
    AssertEquals("Test 5: cuadmin verify cu", $results["data"]["cuadmin"][0]["cu"], "STARKCU");

    // Assert that custom-content export works
    AssertEquals("Test 6: custom-content count", count($results["data"]["custom-content"]), 26);
    AssertEquals("Test 7: custom-content verify docsid", $results["data"]["custom-content"][0]["docsid"], 29);

    // Assert that menu export works
    AssertEquals("Test 8: menu count", count($results["data"]["menu"]), 8);
    AssertEquals("Test 9: menu verify display", $results["data"]["menu"][0]["display"]["en_US"], "Accounts");

    // Assert that branding export works
    $branding = $results["data"]["branding"];
    $branding = strtok(base64_decode($branding), "\n");
    AssertEquals("Test 10: branding exists", $branding, "/* STARKCU Brand file");
}

/**
 * function TestAdhoc($argv)
 * Allows the user to just get the data on a particular test.
 *
 * @param $argv -- this is the arguments from the command line.  It needs three more arguments: server, cu, and action.  @see RunMigrCurl.
 * For "memdata" and "memhist", also have another parameter for the member.
 */
function TestAdhoc($argv) {
    if (count($argv) < 5) {
        print "Not enough arguments.  Needs {server cu action}.\n";
    } else {
        $server = $argv [2];
        $cu = $argv [3];
        $action = $argv [4];
        $parameters = array(); // Additional parameters.  At this point, it is just member.
        if (count($argv) > 5) {
            switch($action) {
                case "memdata":
                case "switchaccounts":
                    $parameters["members"] = $argv[5];
                    break;
                case "createhistoryfile":
                    $parameters["restart"] = $argv[5];
                    break;
            }
        }
        $hash = CreateHash($action, $cu);

        $results = RunMigrCurl($server, $cu, $action, $hash, $parameters);
        print print_r($results, true) . "\n";
    }
}

/**
 * function TestMemberMigration()
 * Tests the data calls "members" and "memdata"
 */
function TestMemberMigration() {
    $server = "www4";
    $cu = "STARKCU";
    $testNum = 1;
    $sepLength = GetSeparatorLength();

    // GetMembers
    $action = "members";
    $hash = CreateHash($action, $cu);

    print "\n\nTesting GetMembers...\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash);
    AssertEquals("Test " . ($testNum++) . ": get starkcu members count", $results["data"]["count"], 25);
    AssertEquals("Test " . ($testNum++) . ": get starkcu members", $results["data"]["list"][0]["user_name"], "1103");

    // GetMemberData
    $action = "memdata";
    $members = array(555);
    $members = json_encode($members);
    $hash = CreateHash($action, $cu);

    print "\n\nTesting GetMemberData using $members on $cu...\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash, array("members" => $members));
    AssertEquals("Test " . ($testNum++) . ": get cuusers data", $results["data"]["account"][555]["cuusers"]["email"], "samuel@homecu.net");
    AssertEquals("Test " . ($testNum++) . ": get cuquestselect data", $results["data"]["account"][555]["cuquestselect"][0]["answer"], "A");
    AssertEquals("Test " . ($testNum++) . ": get accountbalance data", $results["data"]["account"][555]["accountbalance"][0]["amount"], 85);
    AssertEquals("Test " . ($testNum++) . ": get loanbalance data", $results["data"]["account"][555]["loanbalance"][0]["payoff"], 2400.90);
    AssertEquals("Test " . ($testNum++) . ": get holds data", count($results["data"]["account"][555]["holds"]), 0); // STARKCUHolds table doesn't exist.
    AssertEquals("Test " . ($testNum++) . ": get culogtrack data", $results["data"]["account"][555]["culogtrack"][0]["yearmo"], 201806);
    AssertEquals("Test " . ($testNum++) . ": get userlogins data", $results["data"]["account"][555]["userlogins"][0]["remote_ip"], "199.184.207.194");

    $members = array(779999, 6680);
    $members = json_encode($members);
    $cu = "SCRUBCU";
    $hash = CreateHash($action, $cu); // The only accountnumbers on all of the alert tables is 779999 and 1103 on SCRUBCU and SAMCU.

    print "\n\nTesting GetMemberData using $members on $cu...\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash, array("members" => $members));

    AssertEquals("Test " . ($testNum++) . ": get holds data", count($results["data"]["account"][779999]["holds"]), 0); // No records in SAMCUholds for 779999.
    AssertEquals("Test " . ($testNum++) . ": get cualertbal data", $results["data"]["account"][779999]["cualertbal"][0]["accounttype"], "779999=3");
    AssertEquals("Test " . ($testNum++) . ": get cualertcheck data", $results["data"]["account"][779999]["cualertcheck"][0]["notifyto"], "test@test.com");
    AssertStartsWith("Test " . ($testNum++) . ": get cualertloan data", $results["data"]["account"][779999]["cualertloan"][0]["notifymsg"], "Overdue asdf");
    AssertEquals("Test " . ($testNum++) . ": get cualerttrans data", $results["data"]["account"][779999]["cualerttrans"][0]["accounttype"], "779999=50");
    AssertStartsWith("Test " . ($testNum++) . ": get cuadmeco data", $results["data"]["account"][779999]["cuadmeco"][0]["messagetext"], "234 fdsiofbdsf");
    AssertEquals("Test " . ($testNum++) . ": get cusurveysays data", $results["data"]["account"][779999]["cusurveysays"][0]["answerid"], 1589);
    AssertEquals("Test " . ($testNum++) . ": get cucmsresponse data", $results["data"]["account"][779999]["cucmsresponse"][0]["responseon"], "2014-12-30");

    AssertEquals("Test " . ($testNum++) . ": get cusms data", $results["data"]["account"][6680]["cusms"][0]["provider_id"], "vtext.com");
    AssertEquals("Test " . ($testNum++) . ": get cusmstrack data", $results["data"]["account"][6680]["cusmstrack"][0]["yearmo"], 201204);

    $members = array(25198);
    $members = json_encode($members);
    $cu = "CRUISECU";
    $hash = CreateHash($action, $cu); // Very few items are in the holds tables.

    print "\n\nTesting GetMemberData using $members on $cu...\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash, array("members" => $members));

    AssertEquals("Test " . ($testNum++) . ": get holds data", $results["data"]["account"][25198]["holds"][0]["amount"], -19.95);
    AssertEquals("Test " . ($testNum++) . ": get curepeattx data", $results["data"]["account"][25198]["curepeattx"][0]["amount"], 5.12);

    $members = array(251189);
    $members = json_encode($members);
    $cu = "STARKCU";
    $hash = CreateHash($action, $cu);

    print "\n\nTesting GetMemberData using $members on $cu...\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash, array("members" => $members));

    AssertEquals("Test " . ($testNum++) . ": get cuauditusers data", $results["data"]["account"][251189]["cuauditusers"][0]["action"], "ADD");
    AssertEquals("Test " . ($testNum++) . ": get cuauditusers data", $results["data"]["account"][251189]["cuauditusers"][0]["auditrecbefore"], "{\"cuusers\":[[]]}");
    AssertEquals("Test " . ($testNum++) . ": get cuauditusers data", $results["data"]["account"][251189]["cuauditusers"][0]["auditrecafter"], "{\"cuusers\":[{\"cu\":\"STARKCU   \","
                 . "\"user_name\":\"251189      \",\"passwd\":\"\$1\$xeKrZHBI\$zd2jHnzYFRdW7Zg1U79pu1\",\"pktdate\":null,\"pktstamp\":null,\"email\":\"miki@homecu.net\","
                 . "\"estmt_flag\":\"N\",\"egenl_flag\":\"N\",\"failedremain\":\"4\",\"forcechange\":\"N\",\"forceremain\":\"3\",\"lastlogin\":null,\"priorlogin\":null,"
                 . "\"failedlogin\":null,\"pwchange\":\"2016-06-21 13:41:25.677453-06\",\"msg_tx\":\"0\",\"billpayid\":null,\"employee\":\"N\",\"depositlimit\":\"0.00\","
                 . "\"userflags\":\"2\",\"user_alias\":null,\"challenge_quest_id\":\"0\"}]}");
}

/**
 * function TestAdminMigration()
 * Tests the data calls "admin" and "info."
 */
function TestAdminMigration() {
    $server = "www4";
    $cu = "STARKCU";
    $testNum = 1;
    $sepLength = GetSeparatorLength();

    // GetAdmin
    $action = "admin";
    $hash = CreateHash($action, $cu);

    print "\n\nTesting GetAdmin... ($cu)\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash);

    AssertEquals("Test " . ($testNum++) . ": get cuadminusers data", $results["data"]["adminusers"][0]["cuadminusers"]["user_name"], "mark4stark");
    AssertEquals("Test " . ($testNum++) . ": get cuadmquestselect data", count($results["data"]["adminusers"][0]["cuadmquestselect"]), 0);
    AssertEquals("Test " . ($testNum++) . ": get cuadminallow data", $results["data"]["adminusers"][0]["cuadminallow"][0]["program"], "AddChange");
    AssertStartsWith("Test " . ($testNum++) . ": get cuauditadmin data", $results["data"]["adminusers"][0]["cuauditadmin"][0]["chdate"], "2012-11-13");

    // Audit new tests
    AssertEquals("Test " . ($testNum++) . ": get cuauditadmin data", $results["data"]["adminusers"][0]["cuauditadmin"][0]["auditrecbefore"], "{\"cuadminusers\":[[]]}");
    AssertEquals("Test " . ($testNum++) . ": get cuauditadmin data", $results["data"]["adminusers"][0]["cuauditadmin"][0]["auditrecafter"], "{\"cuadminusers\":[{\"cu\":\"STARKCU   \","
                 . "\"user_name\":\"mark4stark\",\"passwd\":\"\$1\$Csg2wOl3\$dn8OFwGOc3LmwmnEnietL\/\",\"realname\":\"Mark Devel 4 Stark\",\"failedremain\":\"4\",\"forcechange\":\"Y\","
                 . "\"forceremain\":\"3\",\"lastlogin\":null,\"priorlogin\":null,\"failedlogin\":null,\"pwchange\":\"2012-11-13 11:41:44.354901-07\",\"email\":\"mark@homecu.net\","
                 . "\"userflags\":\"0\",\"confidence\":null}]}");
    AssertEquals("Test " . ($testNum++) . ": get cuauditadmin data", $results["data"]["adminusers"][0]["cuauditadmin"][1]["action"], "PROGS_A");
    AssertEquals("Test " . ($testNum++) . ": get cuauditadmin data", $results["data"]["adminusers"][0]["cuauditadmin"][1]["auditrecbefore"], "{\"cuadminallow\":[]}");
    AssertEquals("Test " . ($testNum++) . ": get cuauditadmin data", $results["data"]["adminusers"][0]["cuauditadmin"][1]["auditrecafter"], "{\"cuadminallow\":[{\"cu\":\"STARKCU   \","
                 . "\"user_name\":\"mark4stark\",\"program\":\"AppAdm\"}]}");

    AssertEquals("Test " . ($testNum++) . ": get cutrusteddetail data", $results["data"]["cutrusteddetail"][0]["trustedid"], "ACCSOFT");
    AssertEquals("Test " . ($testNum++) . ": get cuhavetrans data", $results["data"]["cuhavetrans"][0]["trancode"], "AT");
    AssertEquals("Test " . ($testNum++) . ": get cuadmnotify data", $results["data"]["cuadmnotify"][0]["email"], "mike@homecu.com");
    AssertEquals("Test " . ($testNum++) . ": get cucmsfrags data", $results["data"]["cucmsfrags"][0]["docsid"], 1);
    AssertStartsWith("Test " . ($testNum++) . ": get cusurveymaster data", $results["data"]["cusurveymaster"][0]["question"], "<iframe src='https://olb.deeptarget.com/acclaimfcu/trgtframe.aspx?");
    AssertEquals("Test " . ($testNum++) . ": get cusurveydetail data", $results["data"]["cusurveydetail"][0]["answertext"], "Yes");
    AssertEquals("Test " . ($testNum++) . ": get cusurveyquest data", $results["data"]["cusurveyquest"][0]["question"], "Would it be nice to win the lottery?");
    AssertEquals("Test " . ($testNum++) . ": get cucontact data", $results["data"]["cucontact"][0]["phone"], "208-866-6789");
    AssertEquals("Test " . ($testNum++) . ": get cusurveyintro data", $results["data"]["cusurveyintro"][0]["surveyintro"], "There is now a STARKCU Survey Intro!!");

    $cu = "SCRUBCU";
    $hash = CreateHash($action, $cu);

    print "\n\nTesting GetAdmin... ($cu)\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash);

    AssertEquals("Test " . ($testNum++) . ": get cuadminexclude data", $results["data"]["adminusers"][1]["cuadminexclude"][0]["program"], "fullupload");
    AssertEquals("Test " . ($testNum++) . ": get cualertmsgs data", $results["data"]["cualertmsgs"][0]["message"], "This is a test of email");
    AssertEquals("Test " . ($testNum++) . ": get extkey data", $results["data"]["extkey"][0]["accountnumber"], "666665");

    $cu = "STARKCU";
    $action = "info";
    $hash = CreateHash($action, $cu);

    // GetInfo
    print "\n\nTesting GetInfo... ($cu)\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash);

    AssertEquals("Test " . ($testNum++) . ": get cuinfo data", $results["data"]["cuinfo"][0]["addr1"], "123 W Tree Lane");
    AssertEquals("Test " . ($testNum++) . ": get cuinfo_notes data", $results["data"]["cuinfo_notes"][0]["messagetext"], "This is a test of the national broadcast system.");
}

/**
 * function TestHistoryMigration
 * Tests the "createhistoryfile" and "gethistoryfile" calls.
 */
function TestHistoryMigration() {
    $server = "www4";
    $cu = "STARKCU";
    $testNum = 1;
    $sepLength = GetSeparatorLength();

    // CreateHistoryFile
    $action = "createhistoryfile";
    $hash = CreateHash($action, $cu);

    print "\n\nTesting CreateHistoryFile... ($cu)\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash, array("restart" => "Y"));

    AssertEquals("Test " . ($testNum++) . ": create history file", $results["error"], "");
    AssertEquals("Test " . ($testNum++) . ": create history file", $results["file"], "/home/starkcu/tmp/memhist");

    $results = RunMigrCurl($server, $cu, $action, $hash);
    AssertStartsWith("Test " . ($testNum++) . ": create history file (2nd time)", $results["error"], "Process is already started.");

    $sleepTime = 5;
    print "\n\nSleeping for $sleepTime seconds.\n";
    sleep($sleepTime);

    // GetHistoryFile
    $action = "gethistoryfile";
    $hash = CreateHash($action, $cu);

    print "\n\nTesting GetHistoryFile... ($cu)\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash);

    AssertStartsWith("Test " . ($testNum++) . ": get history file size", strlen($results), 175655);

    $sleepTime = 5;
    print "\n\nSleeping for $sleepTime seconds.\n";
    sleep($sleepTime);

    // GetHistoryFile
    $action = "gethistoryfile";
    $cu = "ILFCU";
    $hash = CreateHash($action, $cu);

    print "\n\nTesting GetHistoryFile... ($cu)\n" . str_repeat("*", $sepLength) . "\n";
    $results = RunMigrCurl($server, $cu, $action, $hash);

    AssertStartsWith ("Test " . ($testNum++) . ": get history file size", strlen($results), 12214968);
    AssertNotContains("Test " . ($testNum++) . ": no memory problem", $results, "tried to allocate");
}