internals.test in Hierarchical Select 7.3

This file contains the unit tests of the internals.

File

tests/internals.test

<?php

/**
 * @file
 * This file contains the unit tests of the internals.
 */
define('SEP', '|');
define('EURO', 'europe');
define('EURO_BE', 'belgium');
define('EURO_BE_BRU', 'brussels');
define('EURO_BE_HAS', 'hasselt');
define('EURO_FR', 'france');
define('ASIA', 'asia');
define('ASIA_CH', 'china');
define('ASIA_JP', 'japan');
define('ASIA_JP_TOK', 'tokyo');
define('LABEL_EURO', 'Europe');
define('LABEL_EURO_BE', 'Belgium');
define('LABEL_EURO_BE_BRU', 'Brussels');
define('LABEL_EURO_BE_HAS', 'Hasselt');
define('LABEL_EURO_FR', 'France');
define('LABEL_ASIA', 'Asia');
define('LABEL_ASIA_CH', 'China');
define('LABEL_ASIA_JP', 'Japan');
define('LABEL_ASIA_JP_TOK', 'tokyo');
define('LINEAGE_EURO', implode(SEP, array(
  EURO,
)));
define('LINEAGE_EURO_BE', implode(SEP, array(
  EURO,
  EURO_BE,
)));
define('LINEAGE_EURO_BE_BRU', implode(SEP, array(
  EURO,
  EURO_BE,
  EURO_BE_BRU,
)));
define('LINEAGE_EURO_BE_HAS', implode(SEP, array(
  EURO,
  EURO_BE,
  EURO_BE_HAS,
)));
define('LINEAGE_EURO_FR', implode(SEP, array(
  EURO,
  EURO_FR,
)));
define('LINEAGE_ASIA', implode(SEP, array(
  ASIA,
)));
define('LINEAGE_ASIA_CH', implode(SEP, array(
  ASIA,
  ASIA_CH,
)));
define('LINEAGE_ASIA_JP', implode(SEP, array(
  ASIA,
  ASIA_JP,
)));
define('LINEAGE_ASIA_JP_TOK', implode(SEP, array(
  ASIA,
  ASIA_JP,
  ASIA_JP_TOK,
)));

/**
 * Tests for the internals of Hierarchical Select.
 */
class HierarchicalSelectInternals extends DrupalWebTestCase {
  private $smallHierarchy = array(
    EURO => array(
      'label' => LABEL_EURO,
      'children' => array(
        EURO_BE => array(
          'label' => LABEL_EURO_BE,
          'children' => array(
            EURO_BE_BRU => array(
              'label' => LABEL_EURO_BE_BRU,
            ),
            EURO_BE_HAS => array(
              'label' => LABEL_EURO_BE_HAS,
            ),
          ),
        ),
        EURO_FR => array(
          'label' => LABEL_EURO_FR,
        ),
      ),
    ),
    ASIA => array(
      'label' => LABEL_ASIA,
      'children' => array(
        ASIA_CH => array(
          'label' => LABEL_ASIA_CH,
        ),
        ASIA_JP => array(
          'label' => LABEL_ASIA_JP,
          'children' => array(
            ASIA_JP_TOK => array(
              'label' => LABEL_ASIA_JP_TOK,
            ),
          ),
        ),
      ),
    ),
  );

  /**
   * Implementation of getInfo().
   */
  public static function getInfo() {
    return array(
      'name' => 'Internals',
      'description' => 'Checks whether all internals are working: the
                        building of the hierarchy and dropbox objects.',
      'group' => 'Hierarchical Select',
    );
  }

  /**
   * Implementation of setUp().
   */
  public function setUp() {
    parent::setUp('hierarchical_select', 'hs_smallhierarchy');
  }

  /**
   * In this test, all settings are disabled.
   */
  public function testAllSettingsOff() {

    // Generate form item.
    $form_item = array(
      '#required' => FALSE,
      '#config' => array(
        'module' => 'hs_smallhierarchy',
        'params' => array(
          'hierarchy' => $this->smallHierarchy,
          'id' => 'driverpack_platforms',
          'separator' => '|',
        ),
        'save_lineage' => 0,
        'enforce_deepest' => 0,
        'resizable' => 1,
        'level_labels' => array(
          'status' => 0,
        ),
        'dropbox' => array(
          'status' => 0,
          'limit' => 0,
          'reset_hs' => 1,
        ),
        'editability' => array(
          'status' => 0,
          'item_types' => array(),
          'allowed_levels' => array(),
          'allow_new_levels' => 0,
          'max_levels' => 3,
        ),
        'entity_count' => array(
          'enabled' => 0,
          'require_entity' => 0,
          'settings' => array(
            'count_children' => 0,
            'entity_types' => array(),
          ),
        ),
        'animation_delay' => 400,
        'exclusive_lineages' => array(),
        'render_flat_select' => 0,
      ),
    );

    // No selection.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(), array());
    $reference = new stdClass();
    $reference->lineage = array(
      0 => 'label_0',
    );
    $reference->levels = array(
      0 => array(
        'label_0' => '',
        LINEAGE_EURO => LABEL_EURO,
        LINEAGE_ASIA => LABEL_ASIA,
      ),
    );
    $reference->childinfo = array(
      0 => array(
        LINEAGE_EURO => 2,
        LINEAGE_ASIA => 2,
      ),
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'no selection');

    // Europe.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_EURO,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_EURO,
      1 => 'label_1',
    );
    $reference->levels[1] = array(
      'label_1' => '',
      LINEAGE_EURO_BE => LABEL_EURO_BE,
      LINEAGE_EURO_FR => LABEL_EURO_FR,
    );
    $reference->childinfo[1] = array(
      LINEAGE_EURO_BE => 2,
      LINEAGE_EURO_FR => 0,
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'Europe');

    // Europe > France.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_EURO_FR,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_EURO,
      1 => LINEAGE_EURO_FR,
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'Europe > France');

    // Europe > Belgium.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_EURO_BE,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_EURO,
      1 => LINEAGE_EURO_BE,
      2 => 'label_2',
    );
    $reference->levels[1] = array(
      'label_1' => '',
      LINEAGE_EURO_BE => LABEL_EURO_BE,
      LINEAGE_EURO_FR => LABEL_EURO_FR,
    );
    $reference->levels[2] = array(
      'label_2' => '',
      LINEAGE_EURO_BE_BRU => LABEL_EURO_BE_BRU,
      LINEAGE_EURO_BE_HAS => LABEL_EURO_BE_HAS,
    );
    $reference->childinfo[1] = array(
      LINEAGE_EURO_BE => 2,
      LINEAGE_EURO_FR => 0,
    );
    $reference->childinfo[2] = array(
      LINEAGE_EURO_BE_BRU => 0,
      LINEAGE_EURO_BE_HAS => 0,
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'Europe > Belgium');

    // Asia.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_ASIA,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_ASIA,
      1 => 'label_1',
    );
    $reference->levels[1] = array(
      'label_1' => '',
      LINEAGE_ASIA_CH => LABEL_ASIA_CH,
      LINEAGE_ASIA_JP => LABEL_ASIA_JP,
    );
    unset($reference->levels[2]);
    $reference->childinfo[1] = array(
      LINEAGE_ASIA_CH => 0,
      LINEAGE_ASIA_JP => 1,
    );
    unset($reference->childinfo[2]);
    $this
      ->assertHierarchy($hierarchy, $reference, 'Asia');

    // Asia > Japan > Tokyo.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_ASIA_JP_TOK,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_ASIA,
      1 => LINEAGE_ASIA_JP,
      2 => LINEAGE_ASIA_JP_TOK,
    );
    $reference->levels[2] = array(
      'label_2' => '',
      LINEAGE_ASIA_JP_TOK => LABEL_ASIA_JP_TOK,
    );
    $reference->childinfo[2] = array(
      LINEAGE_ASIA_JP_TOK => 0,
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'Asia > Japan > Tokyo');
  }

  /**
   * In this test, only enforce_deepest enabled.
   */
  public function testEnforceDeepest() {

    // Generate form item.
    $form_item = array(
      '#required' => FALSE,
      '#config' => array(
        'module' => 'hs_smallhierarchy',
        'params' => array(
          'hierarchy' => $this->smallHierarchy,
          'id' => 'driverpack_platforms',
          'separator' => '|',
        ),
        'save_lineage' => 0,
        'enforce_deepest' => 1,
        'resizable' => 1,
        'level_labels' => array(
          'status' => 0,
        ),
        'dropbox' => array(
          'status' => 0,
          'limit' => 0,
          'reset_hs' => 1,
        ),
        'editability' => array(
          'status' => 0,
          'item_types' => array(),
          'allowed_levels' => array(),
          'allow_new_levels' => 0,
          'max_levels' => 3,
        ),
        'entity_count' => array(
          'enabled' => 0,
          'require_entity' => 0,
          'settings' => array(
            'count_children' => 0,
            'entity_types' => array(),
          ),
        ),
        'animation_delay' => 400,
        'exclusive_lineages' => array(),
        'render_flat_select' => 0,
      ),
    );

    // No selection.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(), array());
    $reference = new stdClass();
    $reference->lineage = array(
      0 => 'label_0',
    );
    $reference->levels = array(
      0 => array(
        LINEAGE_EURO => LABEL_EURO,
        LINEAGE_ASIA => LABEL_ASIA,
      ),
    );
    $reference->childinfo = array(
      0 => array(
        LINEAGE_EURO => 2,
        LINEAGE_ASIA => 2,
      ),
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'no selection (deepest)');

    // Europe.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_EURO,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_EURO,
      1 => LINEAGE_EURO_BE,
      2 => LINEAGE_EURO_BE_BRU,
    );
    $reference->levels[1] = array(
      LINEAGE_EURO_BE => LABEL_EURO_BE,
      LINEAGE_EURO_FR => LABEL_EURO_FR,
    );
    $reference->levels[2] = array(
      LINEAGE_EURO_BE_BRU => LABEL_EURO_BE_BRU,
      LINEAGE_EURO_BE_HAS => LABEL_EURO_BE_HAS,
    );
    $reference->childinfo[1] = array(
      LINEAGE_EURO_BE => 2,
      LINEAGE_EURO_FR => 0,
    );
    $reference->childinfo[2] = array(
      LINEAGE_EURO_BE_BRU => 0,
      LINEAGE_EURO_BE_HAS => 0,
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'Europe (deepest)');

    // Europe > France.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_EURO_FR,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_EURO,
      1 => LINEAGE_EURO_FR,
    );
    unset($reference->levels[2]);
    unset($reference->childinfo[2]);
    $this
      ->assertHierarchy($hierarchy, $reference, 'Europe > France (deepest)');

    // Europe > Belgium.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_EURO_BE,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_EURO,
      1 => LINEAGE_EURO_BE,
      2 => LINEAGE_EURO_BE_BRU,
    );
    $reference->levels[1] = array(
      LINEAGE_EURO_BE => LABEL_EURO_BE,
      LINEAGE_EURO_FR => LABEL_EURO_FR,
    );
    $reference->levels[2] = array(
      LINEAGE_EURO_BE_BRU => LABEL_EURO_BE_BRU,
      LINEAGE_EURO_BE_HAS => LABEL_EURO_BE_HAS,
    );
    $reference->childinfo[1] = array(
      LINEAGE_EURO_BE => 2,
      LINEAGE_EURO_FR => 0,
    );
    $reference->childinfo[2] = array(
      LINEAGE_EURO_BE_BRU => 0,
      LINEAGE_EURO_BE_HAS => 0,
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'Europe > Belgium (deepest)');

    // Asia.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_ASIA,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_ASIA,
      1 => LINEAGE_ASIA_CH,
    );
    $reference->levels[1] = array(
      LINEAGE_ASIA_CH => LABEL_ASIA_CH,
      LINEAGE_ASIA_JP => LABEL_ASIA_JP,
    );
    unset($reference->levels[2]);
    $reference->childinfo[1] = array(
      LINEAGE_ASIA_CH => 0,
      LINEAGE_ASIA_JP => 1,
    );
    unset($reference->childinfo[2]);
    $this
      ->assertHierarchy($hierarchy, $reference, 'Asia (deepest)');

    // Asia > Japan > Tokyo.
    list($hierarchy, $dropbox) = $this
      ->generate($form_item, array(
      LINEAGE_ASIA_JP_TOK,
    ), array());
    $reference->lineage = array(
      0 => LINEAGE_ASIA,
      1 => LINEAGE_ASIA_JP,
      2 => LINEAGE_ASIA_JP_TOK,
    );
    $reference->levels[2] = array(
      LINEAGE_ASIA_JP_TOK => LABEL_ASIA_JP_TOK,
    );
    $reference->childinfo[2] = array(
      LINEAGE_ASIA_JP_TOK => 0,
    );
    $this
      ->assertHierarchy($hierarchy, $reference, 'Asia > Japan > Tokyo (deepest)');
  }

  /**
   * Generate the $hierarchy and $dropbox objects.
   *
   * This uses the selections that were just calculated.
   */
  private function generate($element, $hs_selection, $db_selection, $op = 'Update') {
    $config = $element['#config'];
    $dropbox = !$config['dropbox']['status'] ? FALSE : _hierarchical_select_dropbox_generate($config, $db_selection);
    $hierarchy = _hierarchical_select_hierarchy_generate($config, $hs_selection, $element['#required'], $dropbox);
    return array(
      $hierarchy,
      $dropbox,
    );
  }

  /**
   * Group multiple assertions into a single check.
   */
  private function assertHierarchy($hierarchy, $reference, $test = 'this test') {
    $this
      ->assertIdentical($hierarchy->lineage, $reference->lineage, t('Hierarchy lineage for @test is correct.', array(
      '@test' => $test,
    )));
    $this
      ->assertIdentical($hierarchy->levels, $reference->levels, t('Hierarchy levels for @test is correct.', array(
      '@test' => $test,
    )));
    $this
      ->assertIdentical($hierarchy->childinfo, $reference->childinfo, t('Hierarchy child info for @test is correct.', array(
      '@test' => $test,
    )));
  }

  /**
   * Test sanitized HS Config var names.
   */
  public function testHsConfigVarNames() {
    module_load_include('inc', 'hierarchical_select', 'includes/common');

    // Save an empty array.
    $name = 'hs-config-var';
    hierarchical_select_common_config_set($name, array(
      TRUE,
    ));

    // Manually fetch the variable we expect.
    $sane_name = 'hs_config_hs_config_var';
    $test = variable_get($sane_name, NULL);
    $this
      ->assertNotNull($test, 'HS Config Vars are being sanitized.');
  }

}

Constants

Name	Description
ASIA
ASIA_CH
ASIA_JP
ASIA_JP_TOK
EURO
EURO_BE
EURO_BE_BRU
EURO_BE_HAS
EURO_FR
LABEL_ASIA
LABEL_ASIA_CH
LABEL_ASIA_JP
LABEL_ASIA_JP_TOK
LABEL_EURO
LABEL_EURO_BE
LABEL_EURO_BE_BRU
LABEL_EURO_BE_HAS
LABEL_EURO_FR
LINEAGE_ASIA
LINEAGE_ASIA_CH
LINEAGE_ASIA_JP
LINEAGE_ASIA_JP_TOK
LINEAGE_EURO
LINEAGE_EURO_BE
LINEAGE_EURO_BE_BRU
LINEAGE_EURO_BE_HAS
LINEAGE_EURO_FR
SEP	@file This file contains the unit tests of the internals.

Classes

Name	Description
HierarchicalSelectInternals	Tests for the internals of Hierarchical Select.