message_notify.test

<?php

/**
 * Test the Message notifier plugins handling.
 */
class MessageNotifyNotifierTest extends DrupalWebTestCase {

  public static function getInfo() {
    return array(
      'name' => 'Notifiers',
      'description' => 'Test message notifier behavior.',
      'group' => 'Message notify',
    );
  }

  function setUp() {
    parent::setUp('message_notify_test');

    // Add another message-text field.
    $field = array(
      'field_name' => 'message_text_another',
      'type' => 'text_long',
      'entity_types' => array('message_type'),
      'settings' => array(
        // Mark that this field can be rendered using Message::getText().
        'message_text' => TRUE,
      ),
    );
    $field = field_create_field($field);
    $instance = array(
      'field_name' => 'message_text_another',
      'bundle' => 'message_type',
      'entity_type' => 'message_type',
      'label' => t('Message text'),
      'required' => TRUE,
    );
    field_create_instance($instance);

    $message_type = message_type_create('foo');
    $wrapper = entity_metadata_wrapper('message_type', $message_type);
    $wrapper->{MESSAGE_FIELD_MESSAGE_TEXT}[] = array('value' => 'first partial', 'format' => 'plain_text');
    $wrapper->{MESSAGE_FIELD_MESSAGE_TEXT}[] = array('value' => 'second partial', 'format' => 'plain_text');
    $wrapper->message_text_another = 'another field';
    $wrapper->save();

    $this->message_type = $message_type;

    // Enable the Full view mode, hide the first partial,
    // and display the last partial first.
    $settings = field_bundle_settings('message', 'foo');
    $settings['view_modes']['full']['custom_settings'] = TRUE;
    $settings['extra_fields']['display']['message__message_text__0']['foo'] = array('weight' => 0, 'visible' => FALSE);
    $settings['extra_fields']['display']['message__message_text__1']['foo'] = array('weight' => 0, 'visible' => TRUE);
    $settings['extra_fields']['display']['message__message_text_another__0']['foo'] = array('weight' => 0, 'visible' => FALSE);

    $settings['extra_fields']['display']['message__message_text__0']['bar'] = array('weight' => 0, 'visible' => FALSE);
    $settings['extra_fields']['display']['message__message_text__1']['bar'] = array('weight' => 0, 'visible' => FALSE);
    $settings['extra_fields']['display']['message__message_text_another__0']['bar'] = array('weight' => 0, 'visible' => TRUE);
    field_bundle_settings('message', 'foo', $settings);
  }

  /**
   * Test send method.
   *
   * Check the correct info is sent to delivery.
   */
  function testDeliver() {
    $wrapper = entity_metadata_wrapper('message_type', $this->message_type);
    $message = message_create('foo');
    message_notify_send_message($message, array(), 'test');

    // The test notifier added the output to the message.
    $output = $message->output;
    $this->assertEqual($output['foo'], $wrapper->{MESSAGE_FIELD_MESSAGE_TEXT}->get(1)->value->value(), 'Correct values rendered in first view mode.');
    $this->assertEqual($output['bar'], $wrapper->message_text_another->value(), 'Correct values rendered in second view mode.');
  }

  /**
   * Test Message save on delivery.
   */
  function testPostSendMessageSave() {
    $message = message_create('foo');
    $message->fail = FALSE;
    message_notify_send_message($message, array(), 'test');
    $this->assertTrue($message->mid, 'Message not saved after successful delivery.');

    $message = message_create('foo');
    $message->fail = TRUE;
    message_notify_send_message($message, array(), 'test');
    $this->assertTrue($message->mid, 'Message not saved after unsuccessful delivery.');

    // Disable saving Message on delivery.
    $options = array(
      'save on fail' => FALSE,
      'save on success' => FALSE,
    );

    $message = message_create('foo');
    $message->fail = FALSE;
    message_notify_send_message($message, $options, 'test');
    $this->assertTrue($message->is_new, 'Message not saved after successful delivery.');

    $message = message_create('foo');
    $message->fail = TRUE;
    message_notify_send_message($message, $options, 'test');
    $this->assertTrue($message->is_new, 'Message not saved after unsuccessful delivery.');
  }

  /**
   * Test populating the rednered output to fields.
   */
  function testPostSendRenderedField() {
    $this->attachRenderedFields();

    // Test plain fields.
    $options = array(
      'rendered fields' => array(
        'foo' => 'rendered_foo',
        'bar' => 'rendered_bar',
      ),
    );
    $message = message_create('foo');
    message_notify_send_message($message, $options, 'test');
    $wrapper = entity_metadata_wrapper('message', $message);
    $this->assertTrue($wrapper->rendered_foo->value() && $wrapper->rendered_bar->value(), 'Message is rendered to fields.');

    // Test field with text-processing.
    $options = array(
      'rendered fields' => array(
        'foo' => 'rendered_baz',
        'bar' => 'rendered_bar',
      ),
    );
    $message = message_create('foo');
    message_notify_send_message($message, $options, 'test');
    $wrapper = entity_metadata_wrapper('message', $message);
    $this->assertTrue($wrapper->rendered_baz->value->value() && $wrapper->rendered_bar->value(), 'Message is rendered to fields with text-processing.');

    // Test missing view mode key in the rendered fields.
    $options = array(
      'rendered fields' => array(
        'foo' => 'rendered_foo',
        // No "bar" field.
      ),
    );
    $message = message_create('foo');
    try {
      message_notify_send_message($message, $options, 'test');
      $this->fail('Can save rendered message with missing view mode.');
    }
    catch (MessageNotifyException $e) {
      $this->pass('Cannot save rendered message with missing view mode.');
    }

    // Test invalid field name.
    $options = array(
      'rendered fields' => array(
        'foo' => 'wrong_field',
        'bar' => 'rendered_bar',
      ),
    );
    $message = message_create('foo');
    try {
      message_notify_send_message($message, $options, 'test');
      $this->fail('Can save rendered message to non-existing field.');
    }
    catch (MessageNotifyException $e) {
      $this->pass('Cannot save rendered message to non-existing field.');
    }
  }

  /**
   * Helper function to attach rendred fields.
   *
   * @see MessageNotifyNotifier::testPostSendRenderedField()
   */
  function attachRenderedFields() {
    foreach (array('rendered_foo', 'rendered_bar', 'rendered_baz') as $field_name) {
      $field = array(
        'field_name' => $field_name,
        'type' => 'text_long',
        'entity_types' => array('message'),
      );
      $field = field_create_field($field);
      $instance = array(
        'field_name' => $field_name,
        'bundle' => 'foo',
        'entity_type' => 'message',
        'label' => $field_name,
      );

      if ($field_name == 'rendered_baz') {
        $instance['settings'] = array(
          'text_processing' => 1,
        );
      }
      field_create_instance($instance);
    }
  }
}