services_views.test in Services Views 7

File

tests/services_views.test

<?php

/**
 * @file
 * Helper classes for Services Views tests.
 */
module_load_include('test', 'views', 'tests/views_query');
module_load_include('test', 'services', 'tests/services');
abstract class ServicesViewsApiTestCase extends ServicesWebTestCase {

  /**
   * {@inheritdoc}
   */
  public function setUp(array $modules = array()) {
    parent::setUp(array(
      'services_views',
      'services_views_test',
      'views',
      'services',
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function saveNewEndpoint() {
    $endpoint = parent::saveNewEndpoint();
    $endpoint->resources['views'] = array(
      'operations' => array(
        'retrieve' => array(
          'enabled' => 1,
        ),
      ),
    );
    services_endpoint_save($endpoint);
    return services_endpoint_load($endpoint->name);
  }

  /**
   * Enable the endpoint resource related to a service type view display.
   *
   * @param object $endpoint
   *   An endpoint object as defined by services_endpoint_load().
   * @param string $resource_name
   *   The "path" display option on a Service view display.
   */
  public function enableServiceViewResource($endpoint, $resource_name) {
    $endpoint->resources[$resource_name] = array(
      'operations' => array(
        'index' => array(
          'enabled' => 1,
        ),
      ),
    );
    services_endpoint_save($endpoint);

    // Good ole objects are passed by reference.
    $endpoint = services_endpoint_load($endpoint->name);
  }

  // Below here is functionality yoinked from views_query.test.

  /**
   * Helper function: verify a result set returned by view.
   *
   * The comparison is done on the string representation of the columns of the
   * column map, taking the order of the rows into account, but not the order
   * of the columns.
   *
   * @param $view
   *  An executed View.
   * @param $expected_result
   *  An expected result set.
   * @param $column_map
   *  An associative array mapping the columns of the result set from the view
   *  (as keys) and the expected result set (as values).
   */
  protected function assertIdenticalResultset($view, $expected_result, $column_map = array(), $message = 'Identical result set') {
    return $this
      ->assertIdenticalResultsetHelper($view, $expected_result, $column_map, $message, 'assertIdentical');
  }

  /**
   * Helper function: verify a result set returned by view..
   *
   * Inverse of ViewsTestCase::assertIdenticalResultset().
   *
   * @param $view
   *  An executed View.
   * @param $expected_result
   *  An expected result set.
   * @param $column_map
   *  An associative array mapping the columns of the result set from the view
   *  (as keys) and the expected result set (as values).
   */
  protected function assertNotIdenticalResultset($view, $expected_result, $column_map = array(), $message = 'Identical result set') {
    return $this
      ->assertIdenticalResultsetHelper($view, $expected_result, $column_map, $message, 'assertNotIdentical');
  }
  protected function assertIdenticalResultsetHelper($view, $expected_result, $column_map, $message, $assert_method) {

    // Convert $view->result to an array of arrays.
    $result = array();
    foreach ($view->result as $key => $value) {
      $row = array();
      foreach ($column_map as $view_column => $expected_column) {

        // The comparison will be done on the string representation of the value.
        $row[$expected_column] = (string) $value->{$view_column};
      }
      $result[$key] = $row;
    }

    // Remove the columns we don't need from the expected result.
    foreach ($expected_result as $key => $value) {
      $row = array();
      foreach ($column_map as $expected_column) {

        // The comparison will be done on the string representation of the value.
        $row[$expected_column] = (string) (is_object($value) ? $value->{$expected_column} : $value[$expected_column]);
      }
      $expected_result[$key] = $row;
    }

    // Reset the numbering of the arrays.
    $result = array_values($result);
    $expected_result = array_values($expected_result);
    $this
      ->verbose('<pre>Returned data set: ' . print_r($result, TRUE) . "\n\nExpected: " . print_r($expected_result, TRUE));

    // Do the actual comparison.
    return $this
      ->{$assert_method}($result, $expected_result, $message);
  }

  /**
   * Helper function: order an array of array based on a column.
   */
  protected function orderResultSet($result_set, $column, $reverse = FALSE) {
    $this->sort_column = $column;
    $this->sort_order = $reverse ? -1 : 1;
    usort($result_set, array(
      $this,
      'helperCompareFunction',
    ));
    return $result_set;
  }
  protected $sort_column = NULL;
  protected $sort_order = 1;

  /**
   * Helper comparison function for orderResultSet().
   */
  protected function helperCompareFunction($a, $b) {
    $value1 = $a[$this->sort_column];
    $value2 = $b[$this->sort_column];
    if ($value1 == $value2) {
      return 0;
    }
    return $this->sort_order * ($value1 < $value2 ? -1 : 1);
  }

  /**
   * Helper function to check whether a button with a certain id exists and has a certain label.
   */
  protected function helperButtonHasLabel($id, $expected_label, $message = 'Label has the expected value: %label.') {
    return $this
      ->assertFieldById($id, $expected_label, t($message, array(
      '%label' => $expected_label,
    )));
  }

  /**
   * Helper function to execute a view with debugging.
   *
   * @param view $view
   * @param array $args
   */
  protected function executeView($view, $display = 'default', $args = array()) {
    $view
      ->set_display($display);
    $view
      ->pre_execute($args);
    $view
      ->execute();
    $this
      ->verbose('<pre>Executed view: ' . (string) $view->build_info['query'] . '</pre>');
  }

}

Classes

Name	Description
ServicesViewsApiTestCase