TestCompassSingleNodeSelection.php

<?php

use PHPUnit\Framework\TestCase;

require_once('hcuTranslate.i');
require_once('menu-creators/CreateMenu.php');
require_once('menu-creators/CompassMenu.php');

/**
 * Unit test for the Compass Menu functionality, a WIP. Test that the single node selection
 * works, whether top level or nested selections. AssertSame() used over assertEquals()
 * because it is more strict(ish,) unit compares both type and value.
 */
class TestCompassSingleNodeSelection extends TestCase
{
  /** @var object CompassMenu class */
  protected $CompassObj = null;

  /** @var array just the items we need to instantiate the class and run our tests. */
  protected $HB_ENV = [
    'MC' => null,
    'Cu' => 'SCRUBCU',
    'Cn' => 'BongoBob',
    'Uid' => 19,
    'loginpath' => 'http://localhost:8000/banking',
    'cuquery' => 'cu=SCRUBCU',
  ];
  /** @var string  Mock of JSON returned by hcuFunctions.i->CompassMenuJson(). */
  protected $json = '';
  /**
   * @var string The compass menu config for unit testing. Would rather have a copy of
   * this so unit tests don't break if it changes, but in one scenario that is what
   * we want. Uses PHP path info.
   */
  protected $json_path = 'banking/library/menu-creators/compass-menu-config.json';

  /**
   * Set the properties used by all tests. HB_ENV is an injected dependency for CompassMenu.
   */
  public function setUp()
  {
    $this->json = $this->mockJson();
    $this->HB_ENV['MC'] = new hcu_talk_base('en_US');
    $this->CompassObj =  new CompassMenu($this->HB_ENV);
  }

  /**
   * Test the user activity top level node without the node wrapper <li>.
   * @return void
   */
  public function test_top_level_user_activity_node_without_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'user-activity');
    $expected = $this->topLevelUserActivityNode();
    //echo "\n\n EXPECTED\n\n->$expected<-\n\nACTUAL ->$result<-\n\n";
    $this->assertSame($expected, $result);
  }

  /**
   * Test the user activity top level node with the full wrapper <li>.
   * @return void
   */
  public function test_top_level_user_activity_node_with_full_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'user-activity', true);
    $expected = $this->topLevelUserActivityNodeWithWrapper();

    $this->assertSame($expected, $result);
  }

  /**
   * Test the secure email top level node without the node wrapper <li>.
   * $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'secure-email-item');
   * @return void
   */
  public function test_top_level_secure_email_node_without_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'secure-email-item');
    $expected = $this->topLevelSecureEmailNode();

    $this->assertSame($expected, $result);
  }

  /**
   * Test thesecure email top level node with the full wrapper <li>.
   * @return void
   */
  public function test_top_level_secure_email_node_with_full_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'secure-email-item', true);
    $expected = $this->topLevelSecureEmailNodeWithWrapper();

    $this->assertSame($expected, $result);
  }

  /**
   * Test that the single node works and returns just the content of the user info node with a nested element.
   * This eliminates the <li> wrapper and just returns its content.
   * @return void
   */
  public function test_single_nested_node_user_info_without_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'dropdown-user-menu-ul-li');
    $expected = $this->singleNestedNodeUserInfo();

    $this->assertSame($expected, $result);
  }

  /**
   * Test that the single node works and returns the full wrapper of the user info node with a nested element.
   * @return void
   */
  public function test_single_nested_node_user_info_with_full_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'dropdown-user-menu-ul-li', true);
    $expected = $this->fullSingleNestedNodeUserInfo();

    $this->assertSame($expected, $result);
  }

  /**
   * Test that the single node works and returns just the content of the failed login node with a nested element.
   * Note it has three other nested elements, testing covers an inner one below.
   * @return void
   */
  public function test_single_nested_node_failed_login_without_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'failed-login');
    $expected = $this->singleNestedNodeFailedLogin();

    $this->assertSame($expected, $result);
  }

  /**
   * Test that the single node works and returns the full wrapper of the failed login node with a nested element.
   * Note it has three other nested elements, testing covers an inner one below.
   * @return void
   */
  public function test_single_nested_node_failed_login_with_full_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'failed-login', true);
    $expected = $this->singleNestedNodeWithWrapperFailedLogin();

    $this->assertSame($expected, $result);
  }



  /**
   * Test that the last-login node, which is nested inside the nested failed-login node, returns just the
   * content without the wrapper.
   * @return void
   */
  public function test_single_nested_node_last_login_without_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'last-login');
    $expected = $this->singleNestedNodeLastLogin();

    $this->assertSame($expected, $result);
  }

  /**
   * Test that the last-login node, which is nested inside the nested failed-login node, returns the
   * content with the full outer wrapper.
   * @return void
   */
  public function test_single_nested_node_last_login_with_full_wrapper()
  {
    $result = $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'last-login', true);
    $expected = $this->singleNestedNodeWithWrapperLastLogin();

    $this->assertSame($expected, $result);
  }


  /************************************************************************************************
   * Helpers - do not reformat, it will break the unit tests. Sloppy looking and ugly, yes,
   * this is how the data returns from the class on request.
   * **********************************************************************************************/

  /**
   * Mock the JSON returned from hcuFunctions.i->CompassMenuJson().
   * @return string
   */
  protected function mockJson()
  {
    return ' {"logout":{"display":"Sign Out","icon":"power-off","action":"exit","script":"hcuLogout.prg"},'
          . '"activity":{"display":"User Activity","icon":"bell","count":0,"menuid":"33","script":'
          . '"hcuUserActivity.prg","action":"menu"},"messages":{"display":"Secure Message","icon":'
          . '"comments","count":"0","menuid":"47","script":"hcuSecureMail.prg","action":"menu"},'
          . '"status":{"display":"Login Status","icon":"tasks","count":0,"endpoint":"http:\/\/localhost:'
          . '8000\/banking\/hcuAccountStatus.prg?cu=SCRUBCU","action":"popup","prior":{"title":'
          . '"Last Successful Login","date":"Tue Nov 12, 2019 09:17am","level":"info"},"fail":'
          . '{"title":"Last Failed Login","date":"Tue Nov 12, 2019 09:00am","level":"info"},'
          . '"system":{"title":"Account Status as of ","date":"Fri May 23, 2008 04:32pm","level":'
          . '"info"}},"user":{"display":"User Info","icon":"user","count":0,"action":"popup",'
          . '"email":{"title":"Current email is","message":"mike@homecu.net","icon":"envelope",'
          . '"level":"info","link":"Update Now","url":"http:\/\/localhost:8000\/banking\/'
          . 'hcuProfileEmail.prg?cu=SCRUBCU","script":"hcuProfileEmail.prg","menuid":"52","action":"menu"}}}';

  }

  /**
   * Expected response when we request the top level user activity node without the full_node param.
   * $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'user-activity');
   * @return string
   */
  protected function topLevelUserActivityNode()
  {
    return '<a id="user-activity-link"  href="http://localhost:8000/banking/hcuUserActivity.prg?cu=SCRUBCU"  aria-label="User Activity"  title="User Activity">
<i class="fa fa-bell fa-fw"></i><span id="activity-link-text" class="compass-link-text">User Activity</span></a>';
  }

  /**
   * Expected response when we request the top level user activity node with the full_node param set to true.
   * $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'user-activity', true);
   * @return string
   */
  protected function topLevelUserActivityNodeWithWrapper()
  {
    return '    <li id="user-activity" class="hcu-quick-nav-activity">
<a id="user-activity-link"  href="http://localhost:8000/banking/hcuUserActivity.prg?cu=SCRUBCU"  aria-label="User Activity"  title="User Activity">
<i class="fa fa-bell fa-fw"></i><span id="activity-link-text" class="compass-link-text">User Activity</span></a></li>
';
  }

  /**
   * Expected response when we request the top level secure email  node without the full_node param.
   * $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'secure-email-item');
   * @return string
   */
  protected function topLevelSecureEmailNode()
  {
    return '<a id="secure-email-link"  href="http://localhost:8000/banking/hcuSecureMail.prg?cu=SCRUBCU"  aria-label="Secure Messages"  title="Secure Messages">
<i class="fa fa-comments fa-fw"></i><span id="secure-email-link-text" class="compass-link-text">Secure Message</span></a>';
  }

  /**
   * Expected response when we request the top level secure email node with the full_node param set to true.
   * $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'secure-email-item', true);
   * @return string
   */
  protected function topLevelSecureEmailNodeWithWrapper()
  {
    return '    <li id="secure-email-item" class="hcu-quick-nav-secure-mail">
<a id="secure-email-link"  href="http://localhost:8000/banking/hcuSecureMail.prg?cu=SCRUBCU"  aria-label="Secure Messages"  title="Secure Messages">
<i class="fa fa-comments fa-fw"></i><span id="secure-email-link-text" class="compass-link-text">Secure Message</span></a></li>
';
  }

  /**
   * Expected response when we request a single nested node with the full_node param absent or false.
   * $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'dropdown-user-menu-ul-li');
   * @return string
   */
  protected function singleNestedNodeUserInfo()
  {
    return '    <div class="col-xs-12">
    <div id="update-email" class="k-block hcu-alert-block">
    <div id="email-alert-icon-block" class="hcu-alert-block-icon">
<i id="email-alert-icon" class="fa fa-2x fa-envelope"></i></div>
&nbsp;
    <div id="email-message-block-text" class="hcu-alert-block-text">
<span id="email-message-title">Current email is</span><br>
<label id="email-message-label">    <p id="email-message-p">
mike@homecu.net</p>
</label></div>
<hr>
<a id="update-email-link"  href="http://localhost:8000/banking/hcuProfileEmail.prg?cu=SCRUBCU">
Update Now</a></div>
</div>
';
  }

  /**
   * Expected response when we request a single nested node with the full_node param true.
   * $this->CompassObj->singleCompassMenuNode($this->json_path, $this->json, 'dropdown-user-menu-ul-li', true);
   * @return string
   */
  protected function fullSingleNestedNodeUserInfo()
  {
    return '    <li id="dropdown-user-menu-ul-li">
    <div class="col-xs-12">
    <div id="update-email" class="k-block hcu-alert-block">
    <div id="email-alert-icon-block" class="hcu-alert-block-icon">
<i id="email-alert-icon" class="fa fa-2x fa-envelope"></i></div>
&nbsp;
    <div id="email-message-block-text" class="hcu-alert-block-text">
<span id="email-message-title">Current email is</span><br>
<label id="email-message-label">    <p id="email-message-p">
mike@homecu.net</p>
</label></div>
<hr>
<a id="update-email-link"  href="http://localhost:8000/banking/hcuProfileEmail.prg?cu=SCRUBCU">
Update Now</a></div>
</div>
</li>
';
  }

  /**
   * This is the response for failed-login without a wrapper. Note it has sub-members tested in another test.
   * @return string
   */
  protected function singleNestedNodeFailedLogin()
  {
    return '    <div id="failed-login-col-xs" class="col-xs-12">
    <div id="failed-login-form-group" class="form-group">
    <div id="failed-login-k-b" class="k-block">
    <div id="failed-login-summary-block" class="hcu-summary-block">
    <div id="failed-login-summary-row" class="summary-row">
    <div id="failed-login-summary-desc" class="summary-desc">
<label id="failed-login-summary-desc-label" class="control-label">Last Failed Login</label></div>
    <div id="failed-login-summary-value" class="summary-value">
    <p id="failed-login-summary-desc-p" class="form-control-static">
Tue Nov 12, 2019 09:00am</p>
</div>
</div>
</div>
</div>
</div>
    <div id="last-login" class="form-group">
    <div id="last-login-k-block" class="k-block">
    <div id="last-login-summary-block" class="hcu-summary-block">
    <div id="last-login-summary-row" class="summary-row">
    <div id="last-login-summary-desc" class="summary-desc">
<label id="last-login-summary-desc-label" class="control-label">Last Successful Login</label></div>
    <div id="last-login-summary-value" class="summary-value">
    <p id="last-login-summary-value-label" class="form-control-static">
Tue Nov 12, 2019 09:17am</p>
</div>
</div>
</div>
</div>
</div>
    <div id="acct-status" class="form-group">
    <div id="acct-status-k-block" class="k-block">
    <div id="acct-status-summary-block" class="hcu-summary-block">
    <div id="acct-status-summary-row" class="summary-row">
    <div id="acct-status-summary-desc" class="summary-desc">
<label id="acct-status-summary-desc-label" class="control-label">Account Status as of </label></div>
    <div id="acct-status-summary-value" class="summary-value">
    <p id="acct-status-summary-p" class="form-control-static">
Fri May 23, 2008 04:32pm</p>
</div>
</div>
</div>
</div>
</div>
</div>
';
  }

  /**
   * This is the response for failed-login with the <li> wrapper. Note it has sub-members tested in another test.
   * @return string
   */
  protected function singleNestedNodeWithWrapperFailedLogin()
  {
    return '    <li id="failed-login">
    <div id="failed-login-col-xs" class="col-xs-12">
    <div id="failed-login-form-group" class="form-group">
    <div id="failed-login-k-b" class="k-block">
    <div id="failed-login-summary-block" class="hcu-summary-block">
    <div id="failed-login-summary-row" class="summary-row">
    <div id="failed-login-summary-desc" class="summary-desc">
<label id="failed-login-summary-desc-label" class="control-label">Last Failed Login</label></div>
    <div id="failed-login-summary-value" class="summary-value">
    <p id="failed-login-summary-desc-p" class="form-control-static">
Tue Nov 12, 2019 09:00am</p>
</div>
</div>
</div>
</div>
</div>
    <div id="last-login" class="form-group">
    <div id="last-login-k-block" class="k-block">
    <div id="last-login-summary-block" class="hcu-summary-block">
    <div id="last-login-summary-row" class="summary-row">
    <div id="last-login-summary-desc" class="summary-desc">
<label id="last-login-summary-desc-label" class="control-label">Last Successful Login</label></div>
    <div id="last-login-summary-value" class="summary-value">
    <p id="last-login-summary-value-label" class="form-control-static">
Tue Nov 12, 2019 09:17am</p>
</div>
</div>
</div>
</div>
</div>
    <div id="acct-status" class="form-group">
    <div id="acct-status-k-block" class="k-block">
    <div id="acct-status-summary-block" class="hcu-summary-block">
    <div id="acct-status-summary-row" class="summary-row">
    <div id="acct-status-summary-desc" class="summary-desc">
<label id="acct-status-summary-desc-label" class="control-label">Account Status as of </label></div>
    <div id="acct-status-summary-value" class="summary-value">
    <p id="acct-status-summary-p" class="form-control-static">
Fri May 23, 2008 04:32pm</p>
</div>
</div>
</div>
</div>
</div>
</div>
</li>
';
  }

  /**
   * This is the response for last login without a wrapper. This is a sub-member of the previous
   * failed-login test; this is a single sub-member of failed-login.
   * @return string
   */
  protected function singleNestedNodeLastLogin()
  {
    return '    <div id="last-login-k-block" class="k-block">
    <div id="last-login-summary-block" class="hcu-summary-block">
    <div id="last-login-summary-row" class="summary-row">
    <div id="last-login-summary-desc" class="summary-desc">
<label id="last-login-summary-desc-label" class="control-label">Last Successful Login</label></div>
    <div id="last-login-summary-value" class="summary-value">
    <p id="last-login-summary-value-label" class="form-control-static">
Tue Nov 12, 2019 09:17am</p>
</div>
</div>
</div>
</div>
';
  }

  /**
   * As above, response for last login with the outer wrapper.
   * @return string
   */
  protected function singleNestedNodeWithWrapperLastLogin()
  {
    return '    <div id="last-login" class="form-group">
    <div id="last-login-k-block" class="k-block">
    <div id="last-login-summary-block" class="hcu-summary-block">
    <div id="last-login-summary-row" class="summary-row">
    <div id="last-login-summary-desc" class="summary-desc">
<label id="last-login-summary-desc-label" class="control-label">Last Successful Login</label></div>
    <div id="last-login-summary-value" class="summary-value">
    <p id="last-login-summary-value-label" class="form-control-static">
Tue Nov 12, 2019 09:17am</p>
</div>
</div>
</div>
</div>
</div>
';
  }
}