monitoring.services.test in Monitoring 7

Contains \MonitoringServicesTest.

File

test/tests/monitoring.services.test

<?php

/**
 * @file
 * Contains \MonitoringServicesTest.
 */
use Drupal\monitoring\Sensor\SensorInfo;

/**
 * Tests for cron sensor.
 */
class MonitoringServicesTest extends MonitoringTestBase {

  /**
   * User account created.
   *
   * @var object
   */
  protected $servicesAccount;
  public static function getInfo() {
    return array(
      'name' => 'Monitoring services',
      'description' => 'Monitoring services tests.',
      'group' => 'Monitoring',
      'dependencies' => array(
        'services',
        'rest_server',
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp(array(
      'dblog',
      'services',
      'rest_server',
    ));
    $this->servicesAccount = $this
      ->drupalCreateUser(array(
      'monitoring reports',
    ));
  }

  /**
   * Test sensor info API calls.
   */
  function testSensorInfo() {
    $this
      ->drupalLogin($this->servicesAccount);
    $response_data = $this
      ->doRequest('sensor-info');
    $this
      ->assertResponse(200);
    foreach (monitoring_sensor_info() as $sensor_name => $sensor_info) {
      $this
        ->assertEqual($response_data[$sensor_name]['sensor'], $sensor_info
        ->getName());
      $this
        ->assertEqual($response_data[$sensor_name]['label'], $sensor_info
        ->getLabel());
      $this
        ->assertEqual($response_data[$sensor_name]['category'], $sensor_info
        ->getCategory());
      $this
        ->assertEqual($response_data[$sensor_name]['description'], $sensor_info
        ->getDescription());
      $this
        ->assertEqual($response_data[$sensor_name]['numeric'], $sensor_info
        ->isNumeric());
      $this
        ->assertEqual($response_data[$sensor_name]['value_label'], $sensor_info
        ->getValueLabel());
      $this
        ->assertEqual($response_data[$sensor_name]['caching_time'], $sensor_info
        ->getCachingTime());
      $this
        ->assertEqual($response_data[$sensor_name]['time_interval'], $sensor_info
        ->getTimeIntervalValue());
      $this
        ->assertEqual($response_data[$sensor_name]['enabled'], $sensor_info
        ->isEnabled());
      $this
        ->assertEqual($response_data[$sensor_name]['uri'], url('monitoring/v1/sensor-info/' . $sensor_info
        ->getName(), array(
        'absolute' => TRUE,
      )));
      if ($sensor_info
        ->isDefiningThresholds()) {
        $this
          ->assertEqual($response_data[$sensor_name]['thresholds'], $sensor_info
          ->getSetting('thresholds'));
      }
    }
    $sensor_name = 'sensor_that_does_not_exist';
    $this
      ->doRequest('sensor-info/' . $sensor_name);
    $this
      ->assertResponse(404);
    $sensor_name = 'dblog_event_severity_error';
    $response_data = $this
      ->doRequest('sensor-info/' . $sensor_name);
    $this
      ->assertResponse(200);
    $sensor_info = monitoring_sensor_manager()
      ->getSensorInfoByName($sensor_name);
    $this
      ->assertEqual($response_data['sensor'], $sensor_info
      ->getName());
    $this
      ->assertEqual($response_data['label'], $sensor_info
      ->getLabel());
    $this
      ->assertEqual($response_data['category'], $sensor_info
      ->getCategory());
    $this
      ->assertEqual($response_data['description'], $sensor_info
      ->getDescription());
    $this
      ->assertEqual($response_data['numeric'], $sensor_info
      ->isNumeric());
    $this
      ->assertEqual($response_data['value_label'], $sensor_info
      ->getValueLabel());
    $this
      ->assertEqual($response_data['caching_time'], $sensor_info
      ->getCachingTime());
    $this
      ->assertEqual($response_data['time_interval'], $sensor_info
      ->getTimeIntervalValue());
    $this
      ->assertEqual($response_data['enabled'], $sensor_info
      ->isEnabled());
    $this
      ->assertEqual($response_data['uri'], url('monitoring/v1/sensor-info/' . $sensor_info
      ->getName(), array(
      'absolute' => TRUE,
    )));
    if ($sensor_info
      ->isDefiningThresholds()) {
      $this
        ->assertEqual($response_data['thresholds'], $sensor_info
        ->getSetting('thresholds'));
    }
  }

  /**
   * Test sensor result API calls.
   */
  function testSensorResult() {
    $this
      ->drupalLogin($this->servicesAccount);

    // Test request for sensor results with expanded sensor info.
    $response_data = $this
      ->doRequest('sensor-result', array(
      'expand' => 'sensor_info',
    ));
    $this
      ->assertResponse(200);
    foreach (monitoring_sensor_manager()
      ->getEnabledSensorInfo() as $sensor_name => $sensor_info) {
      $this
        ->assertTrue(isset($response_data[$sensor_name]['sensor_info']));
      $this
        ->assertSensorResult($response_data[$sensor_name], $sensor_info);
    }

    // Try a request without expanding the sensor info and check that it is not
    // present.
    $response_data = $this
      ->doRequest('sensor-result');
    $this
      ->assertResponse(200);
    $sensor_result = reset($response_data);
    $this
      ->assertTrue(!isset($sensor_result['sensor_info']));

    // Make sure the response contains expected count of results.
    $this
      ->assertEqual(count($response_data), count(monitoring_sensor_manager()
      ->getEnabledSensorInfo()));

    // Test non existing sensor.
    $sensor_name = 'sensor_that_does_not_exist';
    $this
      ->doRequest('sensor-result/' . $sensor_name);
    $this
      ->assertResponse(404);

    // Test disabled sensor - note that monitoring_git_dirty_tree is disabled
    // by default.
    $sensor_name = 'monitoring_git_dirty_tree';
    $this
      ->doRequest('sensor-result/' . $sensor_name);
    $this
      ->assertResponse(404);
    $sensor_name = 'dblog_event_severity_error';
    $response_data = $this
      ->doRequest('sensor-result/' . $sensor_name, array(
      'expand' => 'sensor_info',
    ));
    $this
      ->assertResponse(200);

    // The response must contain the sensor_info.
    $this
      ->assertTrue(isset($response_data['sensor_info']));
    $this
      ->assertSensorResult($response_data, monitoring_sensor_manager()
      ->getSensorInfoByName($sensor_name));

    // Try a request without expanding the sensor info and check that it is not
    // present.
    $response_data = $this
      ->doRequest('sensor-result/' . $sensor_name);
    $this
      ->assertResponse(200);
    $this
      ->assertTrue(!isset($response_data['sensor_info']));
  }

  /**
   * Do sensor result assertions.
   *
   * @param array $response_result
   *   Result received via response.
   * @param \Drupal\monitoring\Sensor\SensorInfo $sensor_info
   *   Sensor info for which we have the result.
   */
  protected function assertSensorResult($response_result, SensorInfo $sensor_info) {
    $this
      ->assertEqual($response_result['sensor_name'], $sensor_info
      ->getName());

    // Test the uri - the hardcoded endpoint is defined in the
    // monitoring_test.default_services.inc.
    $this
      ->assertEqual($response_result['uri'], url('monitoring/v1/sensor-result/' . $sensor_info
      ->getName(), array(
      'absolute' => TRUE,
    )));

    // If the result is cached test also for the result values. In case of
    // result which is not cached we might not get the same values.
    if ($sensor_info
      ->getCachingTime()) {

      // Cannot use $this->runSensor() as the cache needs to remain.
      $result = monitoring_sensor_run($sensor_info
        ->getName());
      $this
        ->assertEqual($response_result['status'], $result
        ->getStatus());
      $this
        ->assertEqual($response_result['value'], $result
        ->getValue());
      $this
        ->assertEqual($response_result['expected_value'], $result
        ->getExpectedValue());
      $this
        ->assertEqual($response_result['numeric_value'], $result
        ->toNumber());
      $this
        ->assertEqual($response_result['message'], $result
        ->getMessage());
      $this
        ->assertEqual($response_result['timestamp'], $result
        ->getTimestamp());
      $this
        ->assertEqual($response_result['execution_time'], $result
        ->getExecutionTime());
    }
    if (isset($response_result['sensor_info'])) {
      $this
        ->assertEqual($response_result['sensor_info'], $sensor_info
        ->toArray());
    }
  }

  /**
   * Do the request.
   *
   * @param string $action
   *   Action to perform.
   * @param array $query
   *   Path query key - value pairs.
   *
   * @return array
   *   Decoded json object.
   */
  protected function doRequest($action, $query = array()) {
    $url = url('monitoring/v1/' . $action, array(
      'absolute' => TRUE,
      'query' => $query,
    ));
    return drupal_json_decode($this
      ->curlExec(array(
      CURLOPT_HTTPGET => TRUE,
      CURLOPT_URL => $url,
      CURLOPT_NOBODY => FALSE,
      CURLOPT_HTTPHEADER => array(
        "Accept: application/json",
      ),
    )));
  }

}

Classes

Name	Description
MonitoringServicesTest	Tests for cron sensor.