tripal/tests/tripal_chado/fields/sbo__relationship_widgetTest.php

<?php
namespace Tests\tripal_chado\fields;

use StatonLab\TripalTestSuite\DBTransaction;
use StatonLab\TripalTestSuite\TripalTestCase;

class sbo__relationship_widgetTest extends TripalTestCase {
  // Uncomment to auto start and rollback db transactions per test method.
  use DBTransaction;

  /**
   * Data Provider: provides entities matching important test cases.
   *
   * Specifically, we will cover three relationship tables, which represent
   * the diversity in the chado schema v1.3:
   *  organism_relationship: subject_id, type_id, object_id,
   *  stock_relationship: subject_id, type_id, object_id, value, rank,
   *  project_relationship: subject_project_id, type_id, object_project_id, rank
   *
   * @returns
   *   Returns an array where each item to be tested has the paramaters
   *   needed for initializeWidgetClass(). Specfically, $bundle_name,
   *   $field_name, $widget_name, $entity_id.
   */
  public function provideEntities() {
     $data = [];

     foreach (['organism', 'stock', 'project'] as $base_table) {

       $field_name = 'sbo__relationship';
       $widget_name = 'sbo__relationship_widget';

       // find a bundle which stores it's data in the given base table.
       // This will work on Travis since Tripal creates matching bundles by default.
       // @todo ideally we would create a fake bundle here.
       $bundle_id = db_query("
         SELECT bundle_id
         FROM chado_bundle b
         LEFT JOIN tripal_entity e ON e.bundle='bio_data_'||b.bundle_id
         WHERE data_table=:table AND id IS NOT NULL LIMIT 1",
           array(':table' => $base_table))->fetchField();

       if (!$bundle_id) {
         continue;
       }

       $bundle_name = 'bio_data_'.$bundle_id;

       // Find an entity from the above bundle.
       // @todo find a way to create a fake entity for use here.
       $entity_id = db_query('SELECT id FROM tripal_entity WHERE bundle=:bundle LIMIT 1',
         array(':bundle' => $bundle_name))->fetchField();

       // set variables to guide testing.
       $expect = [
         'has_rank' => TRUE,
         'has_value' => FALSE,
         'subject_key' => 'subject_id',
         'object_key' => 'object_id',
         'base_table' => $base_table,
         'relationship_table' => $base_table.'_relationship'
       ];
       if ($base_table == 'organism') { $expect['has_rank'] = FALSE; }
       if ($base_table == 'stock') { $expect['has_value'] = TRUE; }
       if ($base_table == 'project') {
         $expect['subject_key'] = 'subject_project_id';
         $expect['object_key'] = 'object_project_id';
       }

       $data[] = [$bundle_name, $field_name, $widget_name, $entity_id, $expect];
     }
     return $data;
  }

  /**
   * Test that we can initialize the widget properly.
   *
   * @dataProvider provideEntities()
   *
   * @group lacey-wip
   * @group widget
   * @group sbo__relationship
   */
  public function testWidgetClassInitialization($bundle_name, $field_name, $widget_name, $entity_id, $expect) {

    // Load the entity.
    $entity = entity_load('TripalEntity', [$entity_id]);
    $entity = $entity[$entity_id];

    // Initialize the widget class via the TripalFieldTestHelper class.
    $machine_names = array(
      'field_name' => $field_name,
      'widget_name' => $widget_name,
    );
    module_load_include('php', 'tripal_chado', '../tests/TripalFieldTestHelper');
    $helper = new \TripalFieldTestHelper($bundle_name, $machine_names, $entity);
    $widget_class = $helper->getInitializedClass();

    // Check we have the variables we initialized.
    $this->assertNotEmpty($helper->bundle,
      "Could not load the bundle.");
    $this->assertNotEmpty($helper->getFieldInfo(),
      "Could not lookup the field information.");
    $this->assertNotEmpty($helper->getInstanceInfo(),
      "Could not lookup the instance information.");
    $this->assertNotEmpty($widget_class,
      "Couldn't create a widget class instance.");
    $this->assertNotEmpty($entity,
      "Couldn't load an entity.");

    // Check a little deeper...
    $this->assertEquals($helper->instance_info['settings']['chado_table'], $expect['relationship_table'],
      "Instance settings were not initialized fully.");

  }

  /**
   * Test the widget Form.
   *
   * @dataProvider provideEntities()
   *
   * @group widget
   * @group sbo__relationship
   */
  public function testWidgetForm($bundle_name, $field_name, $widget_name, $entity_id, $expect) {

    // Load the entity.
    $entity = entity_load('TripalEntity', [$entity_id]);
    $entity = $entity[$entity_id];

    // Initialize the widget class via the TripalFieldTestHelper class.
    $machine_names = array(
      'field_name' => $field_name,
      'widget_name' => $widget_name,
    );
    module_load_include('php', 'tripal_chado', '../tests/TripalFieldTestHelper');
    $helper = new \TripalFieldTestHelper($bundle_name, $machine_names, $entity);
    $widget_class = $helper->getInitializedClass();

    $base_table = $entity->chado_table;

    // Stub out a fake $widget object.
    $widget = [
      '#entity_type' => 'TripalEntity',
      '#entity' => $entity,
      '#bundle' => $helper->bundle,
      '#field_name' => $field_name,
      '#language' => LANGUAGE_NONE,
      '#field_parents' => [],
      '#columns' => [],
      '#title' => '',
      '#description' => '',
      '#required' => FALSE,
      '#delta' => 0,
      '#weight' => 0, //same as delta.
      'value' => [
        '#type' => 'value',
        '#value' => '',
      ],
      '#field' => $helper->field_info,
      '#instance' => $helper->instance_info,
      '#theme' => 'tripal_field_default',
      'element_validate' => ['tripal_field_widget_form_validate']
    ];

    // Stub out the form and form_state.
    $form = [
      '#parents' => [],
      '#entity' => $entity,
    ];
    $form_state = [
      'build_info' => [
        'args' => [
          0 => NULL,
          1 => $entity,
        ],
        'form_id' => 'tripal_entity_form',
      ],
      'rebuild' => FALSE,
      'rebuild_info' => [],
      'redirect' => NULL,
      'temporary' => [],
      'submitted' => FALSE,
    ];

    // stub out the data for the field.
    $langcode = LANGUAGE_NONE;
    $items = [
      'value' => '',
      'chado-'.$base_table.'_relationship__organism_relationship_id' => '',
      'chado-'.$base_table.'_relationship__subject_id' => '',
      'chado-'.$base_table.'_relationship__object_id' => '',
      'chado-'.$base_table.'_relationship__type_id' => '',
      'object_name' => '',
      'subject_name' => '',
      'type_name' => '',
    ];
    $delta = 0;

    // Stub out the widget element.
    $element = [
      '#entity_type' => 'TripalEntity',
      '#entity' => $entity,
      '#bundle' => $bundle_name,
      '#field_name' => $field_name,
      '#language' => LANGUAGE_NONE,
      '#field_parents' => [],
      '#columns' => [],
      '#title' => '',
      '#description' => '',
      '#required' => FALSE,
      '#delta' => 0,
      '#weight' => 0,
    ];

    // Execute the form method.
    $widget_class->form($widget, $form, $form_state, $langcode, $items, $delta, $element);

    // Check the resulting for array
    $this->assertArrayHasKey('subject_name', $widget,
      "The form for $bundle_name($base_table) does not have a subject element.");
    $this->assertArrayHasKey('type_name', $widget,
      "The form for $bundle_name($base_table) does not have a type element.");
    $this->assertArrayHasKey('object_name', $widget,
      "The form for $bundle_name($base_table) does not have a object element.");

    //@ debug print_r($widget);

    // Check the subject/object keys were correctly determined.
    $this->assertEquals($expect['subject_key'], $widget['#subject_id_key'],
      "The form didn't determine the subject key correctly.");
    $this->assertEquals($expect['object_key'], $widget['#object_id_key'],
      "The form didn't determine the object key correctly.");
  }

  /**
   * Test the Relationship Type Options.
   * Specfically, sbo__relationship_widget->get_rtype_select_options().
   *
   * @dataProvider provideEntities()
   *
   * @group widget
   * @group sbo__relationship
   */
  public function testGetRTypeSelectOptions($bundle_name, $field_name, $widget_name, $entity_id, $expect) {

    // The different options are set in the instance.
    // Therefore we want to make a fake instance to control this setting.
    $fake_instance = field_info_instance('TripalEntity', $field_name, $bundle_name);
    //$fake_instance['settings']['relationships']['option1_vocabs'] = 5;

    $this->assertTrue(true);
  }
}