From 63d48af6fb398c54d043de5c36809c4a23025167 Mon Sep 17 00:00:00 2001 From: Angie Byron Date: Wed, 18 Nov 2009 04:56:20 +0000 Subject: [PATCH] #633156 by rfay and effulgentsia: Added a baseline of tests for AJAX commands. --- modules/simpletest/drupal_web_test_case.php | 55 ++- modules/simpletest/tests/ajax.test | 76 +++- modules/simpletest/tests/ajax_forms_test.info | 8 + .../simpletest/tests/ajax_forms_test.module | 335 ++++++++++++++++++ 4 files changed, 462 insertions(+), 12 deletions(-) create mode 100644 modules/simpletest/tests/ajax_forms_test.info create mode 100644 modules/simpletest/tests/ajax_forms_test.module diff --git a/modules/simpletest/drupal_web_test_case.php b/modules/simpletest/drupal_web_test_case.php index 05d4e58281e..cb1deda30cf 100644 --- a/modules/simpletest/drupal_web_test_case.php +++ b/modules/simpletest/drupal_web_test_case.php @@ -1400,6 +1400,14 @@ class DrupalWebTestCase extends DrupalTestCase { return $out; } + /** + * Retrieve a Drupal path or an absolute path and JSON decode the result. + */ + function drupalGetAJAX($path, array $options = array(), array $headers = array()) { + $out = $this->drupalGet($path, $options, $headers); + return json_decode($out, TRUE); + } + /** * Execute a POST request on a Drupal page. * It will be done as usual POST request with SimpleBrowser. @@ -1409,6 +1417,7 @@ class DrupalWebTestCase extends DrupalTestCase { * NULL to post to the current page. For multi-stage forms you can set the * path to NULL and have it post to the last received page. Example: * + * @code * // First step in form. * $edit = array(...); * $this->drupalPost('some_url', $edit, t('Save')); @@ -1416,6 +1425,7 @@ class DrupalWebTestCase extends DrupalTestCase { * // Second step in form. * $edit = array(...); * $this->drupalPost(NULL, $edit, t('Save')); + * @endcode * @param $edit * Field data in an associative array. Changes the current input fields * (where possible) to the values indicated. A checkbox can be set to @@ -1425,10 +1435,28 @@ class DrupalWebTestCase extends DrupalTestCase { * * Multiple select fields can be set using name[] and setting each of the * possible values. Example: + * @code * $edit = array(); * $edit['name[]'] = array('value1', 'value2'); + * @endcode * @param $submit - * Value of the submit button. + * Value of the submit button whose click is to be emulated. For example, + * t('Save'). The processing of the request depends on this value. For + * example, a form may have one button with the value t('Save') and another + * button with the value t('Delete'), and execute different code depending + * on which one is clicked. + * + * This function can also be called to emulate an AJAX submission. In this + * case, this value needs to be an array with the following keys: + * - path: A path to submit the form values to for AJAX-specific processing, + * which is likely different than the $path parameter used for retrieving + * the initial form. Defaults to 'system/ajax'. + * - triggering_element: If the value for the 'path' key is 'system/ajax' or + * another generic AJAX processing path, this needs to be set to the '/' + * separated path to the element within the server's cached $form array. + * The callback for the generic AJAX processing path uses this to find + * the #ajax information for the element, including which specific + * callback to use for processing the request. * @param $options * Options to be forwarded to url(). * @param $headers @@ -1437,6 +1465,7 @@ class DrupalWebTestCase extends DrupalTestCase { */ protected function drupalPost($path, $edit, $submit, array $options = array(), array $headers = array()) { $submit_matches = FALSE; + $ajax = is_array($submit); if (isset($path)) { $html = $this->drupalGet($path, $options); } @@ -1449,8 +1478,15 @@ class DrupalWebTestCase extends DrupalTestCase { $edit = $edit_save; $post = array(); $upload = array(); - $submit_matches = $this->handleForm($post, $edit, $upload, $submit, $form); + $submit_matches = $this->handleForm($post, $edit, $upload, $ajax ? NULL : $submit, $form); $action = isset($form['action']) ? $this->getAbsoluteUrl($form['action']) : $this->getUrl(); + if ($ajax) { + $action = $this->getAbsoluteUrl(!empty($submit['path']) ? $submit['path'] : 'system/ajax'); + // AJAX callbacks verify the triggering element if necessary, so while + // we may eventually want extra code that verifies it in the + // handleForm() function, it's not currently a requirement. + $submit_matches = TRUE; + } // We post only if we managed to handle every field in edit and the // submit button matches. @@ -1474,6 +1510,9 @@ class DrupalWebTestCase extends DrupalTestCase { // http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1 $post[$key] = urlencode($key) . '=' . urlencode($value); } + if ($ajax && isset($submit['triggering_element'])) { + $post['ajax_triggering_element'] = 'ajax_triggering_element=' . urlencode($submit['triggering_element']); + } $post = implode('&', $post); } $out = $this->curlExec(array(CURLOPT_URL => $action, CURLOPT_POST => TRUE, CURLOPT_POSTFIELDS => $post, CURLOPT_HTTPHEADER => $headers)); @@ -1495,11 +1534,21 @@ class DrupalWebTestCase extends DrupalTestCase { foreach ($edit as $name => $value) { $this->fail(t('Failed to set field @name to @value', array('@name' => $name, '@value' => $value))); } - $this->assertTrue($submit_matches, t('Found the @submit button', array('@submit' => $submit))); + if (!$ajax) { + $this->assertTrue($submit_matches, t('Found the @submit button', array('@submit' => $submit))); + } $this->fail(t('Found the requested form fields at @path', array('@path' => $path))); } } + /** + * Execute a POST request on an AJAX path and JSON decode the result. + */ + protected function drupalPostAJAX($path, $edit, $triggering_element, $ajax_path = 'system/ajax', array $options = array(), array $headers = array()) { + $out = $this->drupalPost($path, $edit, array('path' => $ajax_path, 'triggering_element' => $triggering_element), $options, $headers); + return json_decode($out, TRUE); + } + /** * Runs cron in the Drupal installed by Simpletest. */ diff --git a/modules/simpletest/tests/ajax.test b/modules/simpletest/tests/ajax.test index 3a55dbb9714..cf688eb7651 100644 --- a/modules/simpletest/tests/ajax.test +++ b/modules/simpletest/tests/ajax.test @@ -3,12 +3,7 @@ class AJAXTestCase extends DrupalWebTestCase { function setUp() { - parent::setUp('ajax_test'); - } - - function drupalGetAJAX($path, $query = array()) { - $this->drupalGet($path, array('query' => $query)); - return json_decode($this->content, TRUE); + parent::setUp('ajax_test', 'ajax_forms_test'); } } @@ -47,7 +42,7 @@ class AJAXFrameworkTestCase extends AJAXTestCase { $edit = array( 'message' => 'Custom error message.', ); - $result = $this->drupalGetAJAX('ajax-test/render-error', $edit); + $result = $this->drupalGetAJAX('ajax-test/render-error', array('query' => $edit)); $this->assertEqual($result[0]['text'], $edit['message'], t('Custom error message is output.')); } } @@ -70,11 +65,74 @@ class AJAXCommandsTestCase extends AJAXTestCase { function testAJAXRender() { $commands = array(); $commands[] = ajax_command_settings(array('foo' => 42)); - $result = $this->drupalGetAJAX('ajax-test/render', array('commands' => $commands)); + $result = $this->drupalGetAJAX('ajax-test/render', array('query' => array('commands' => $commands))); // Verify that JavaScript settings are contained (always first). $this->assertIdentical($result[0]['command'], 'settings', t('drupal_add_js() settings are contained first.')); // Verify that the custom setting is contained. $this->assertEqual($result[1]['settings']['foo'], 42, t('Custom setting is output.')); } -} + /** + * Test the various AJAX Commands. + */ + function testAJAXCommands() { + $form_path = 'ajax_forms_test_ajax_commands_form'; + $web_user = $this->drupalCreateUser(array('access content')); + $this->drupalLogin($web_user); + + $edit = array(); + + // Tests the 'after' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'after_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'insert' && $command['method'] == 'after' && $command['data'] == 'This will be placed after', "'after' AJAX command issued with correct data"); + + // Tests the 'alert' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'alert_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'alert' && $command['text'] == 'Alert', "'alert' AJAX Command issued with correct text"); + + // Tests the 'append' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'append_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'insert' && $command['method'] == 'append' && $command['data'] == 'Appended text', "'append' AJAX command issued with correct data"); + + // Tests the 'before' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'before_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'insert' && $command['method'] == 'before' && $command['data'] == 'Before text', "'before' AJAX command issued with correct data"); + + // Tests the 'changed' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'changed_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'changed' && $command['selector'] == '#changed_div', "'changed' AJAX command issued with correct selector"); + + // 'css' command will go here when it is implemented. + + // Tests the 'data' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'data_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'data' && $command['name'] == 'testkey' && $command['value'] == 'testvalue', "'data' AJAX command issued with correct key and value"); + + // Tests the 'html' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'html_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'insert' && $command['method'] == 'html' && $command['data'] == 'replacement text', "'html' AJAX command issued with correct data"); + + // Tests the 'prepend' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'prepend_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'insert' && $command['method'] == 'prepend' && $command['data'] == 'prepended text', "'prepend' AJAX command issued with correct data"); + + // Tests the 'remove' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'remove_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'remove' && $command['selector'] == '#remove_text', "'remove' AJAX command issued with correct command and selector"); + + + // Tests the 'restripe' command. + $commands = $this->drupalPostAJAX($form_path, $edit, 'restripe_command_example'); + $command = $commands[1]; + $this->assertTrue($command['command'] == 'restripe' && $command['selector'] == '#restripe_table', "'restripe' AJAX command issued with correct selector"); + } +} diff --git a/modules/simpletest/tests/ajax_forms_test.info b/modules/simpletest/tests/ajax_forms_test.info new file mode 100644 index 00000000000..3b8f5f23edc --- /dev/null +++ b/modules/simpletest/tests/ajax_forms_test.info @@ -0,0 +1,8 @@ +; $Id$ +name = "AJAX form test mock module" +description = "Test for AJAX form calls." +core = 7.x +package = Testing +files[] = ajax_forms_test.module +version = VERSION +hidden = TRUE diff --git a/modules/simpletest/tests/ajax_forms_test.module b/modules/simpletest/tests/ajax_forms_test.module new file mode 100644 index 00000000000..ceb03dcc1be --- /dev/null +++ b/modules/simpletest/tests/ajax_forms_test.module @@ -0,0 +1,335 @@ + 'AJAX forms simple form test', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('ajax_forms_test_simple_form'), + 'access callback' => TRUE, + ); + $items['ajax_forms_test_ajax_commands_form'] = array( + 'title' => 'AJAX forms AJAX commands test', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('ajax_forms_test_ajax_commands_form'), + 'access callback' => TRUE, + ); + return $items; +} + + +/** + * A basic form used to test form_state['values'] during callback. + */ +function ajax_forms_test_simple_form($form, &$form_state) { + $form = array(); + $form['select'] = array( + '#type' => 'select', + '#options' => array( + 'red' => 'red', + 'green' => 'green', + 'blue' => 'blue'), + '#ajax' => array( + 'callback' => 'ajax_forms_test_simple_form_select_callback', + ), + '#suffix' => '
No color yet selected
', + ); + + $form['checkbox'] = array( + '#type' => 'checkbox', + '#title' => t('Test checkbox'), + '#ajax' => array( + 'callback' => 'ajax_forms_test_simple_form_checkbox_callback', + ), + '#suffix' => '
No action yet
', + ); + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('submit'), + ); + return $form; +} + +/** + * AJAX callback triggered by select. + */ +function ajax_forms_test_simple_form_select_callback($form, $form_state) { + $commands = array(); + $commands[] = ajax_command_html('#ajax_selected_color', $form_state['values']['select']); + $commands[] = ajax_command_data('#ajax_selected_color', 'form_state_value_select', $form_state['values']['select']); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback triggered by checkbox. + */ +function ajax_forms_test_simple_form_checkbox_callback($form, $form_state) { + $commands = array(); + $commands[] = ajax_command_html('#ajax_checkbox_value', (int)$form_state['values']['checkbox']); + $commands[] = ajax_command_data('#ajax_checkbox_value', 'form_state_value_select', (int)$form_state['values']['checkbox']); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + + +/** + * Form to display the AJAX Commands. + * @param $form + * @param $form_state + * @return unknown_type + */ +function ajax_forms_test_ajax_commands_form($form, &$form_state) { + $form = array(); + + // Shows the 'after' command with a callback generating commands. + $form['after_command_example'] = array( + '#value' => t("AJAX 'After': Click to put something after the div"), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_after_callback', + ), + '#suffix' => '
Something can be inserted after this
', + ); + + // Shows the 'alert' command. + $form['alert_command_example'] = array( + '#value' => t("AJAX 'Alert': Click to alert"), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_alert_callback', + ), + ); + + // Shows the 'append' command. + $form['append_command_example'] = array( + '#value' => t("AJAX 'Append': Click to append something"), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_append_callback', + ), + '#suffix' => '
Append inside this div
', + ); + + + // Shows the 'before' command. + $form['before_command_example'] = array( + '#value' => t("AJAX 'before': Click to put something before the div"), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_before_callback', + ), + '#suffix' => '
Insert something before this.
', + ); + + // Shows the 'changed' command. + $form['changed_command_example'] = array( + '#value' => t("AJAX changed: Click to mark div changed."), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_changed_callback', + ), + '#suffix' => '
This div can be marked as changed or not.
', + ); + + // Shows the AJAX 'css' command. + // @todo Note that this won't work until http://drupal.org/node/623320 lands. + $form['css_command_example'] = array( + '#title' => t("AJAX CSS: Choose the color you'd like the '#box' div to be."), + '#type' => 'select', + '#options' => array('green' => 'green', 'blue' => 'blue'), + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_css_callback', + ), + '#suffix' => '
box
', + ); + + + // Shows the AJAX 'data' command. But there is no use of this information, + // as this would require a javascript client to use the data. + $form['data_command_example'] = array( + '#value' => t("AJAX data command: Issue command."), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_data_callback', + ), + '#suffix' => '
Data attached to this div.
', + ); + + // Shows the AJAX 'html' command. + $form['html_command_example'] = array( + '#value' => t("AJAX html: Replace the HTML in a selector."), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_html_callback', + ), + '#suffix' => '
Original contents
', + ); + + // Shows the AJAX 'prepend' command. + $form['prepend_command_example'] = array( + '#value' => t("AJAX 'prepend': Click to prepend something"), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_prepend_callback', + ), + '#suffix' => '
Something will be prepended to this div.
', + ); + + // Shows the AJAX 'remove' command. + $form['remove_command_example'] = array( + '#value' => t("AJAX 'remove': Click to remove text"), + '#type' => 'submit', + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_remove_callback', + ), + '#suffix' => '
text to be removed
', + ); + + // Show off the AJAX 'restripe' command. + $form['restripe_command_example'] = array( + '#type' => 'submit', + '#value' => t("AJAX 'restripe' command"), + '#ajax' => array( + 'callback' => 'ajax_forms_test_advanced_commands_restripe_callback', + ), + '#suffix' => '
+ + + +
first row
second row
+
', + + + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Submit'), + ); + + return $form; +} + +/** + * AJAX callback for 'after'. + */ +function ajax_forms_test_advanced_commands_after_callback($form, $form_state) { + $selector = '#after_div'; + + $commands = array(); + $commands[] = ajax_command_after($selector, "This will be placed after"); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'alert'. + */ +function ajax_forms_test_advanced_commands_alert_callback($form, $form_state) { + $commands = array(); + $commands[] = ajax_command_alert("Alert"); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'append'. + */ +function ajax_forms_test_advanced_commands_append_callback($form, $form_state) { + $selector = '#append_div'; + $commands = array(); + $commands[] = ajax_command_append($selector, "Appended text"); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'before'. + */ +function ajax_forms_test_advanced_commands_before_callback($form, $form_state) { + $selector = '#before_div'; + + $commands = array(); + $commands[] = ajax_command_before($selector, "Before text"); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'changed'. + */ +function ajax_forms_test_advanced_commands_changed_callback($form, $form_state) { + $checkbox_value = $form_state['values']['changed_command_example']; + $checkbox_value_string = $checkbox_value ? "TRUE" : "FALSE"; + $commands = array(); + if ($checkbox_value) { + // @todo This does not yet exercise the 2nd arg (asterisk) so that should + // be added when it works. + $commands[] = ajax_command_changed( '#changed_div'); + } + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'css'. + */ +function ajax_forms_test_advanced_commands_css_callback($form, $form_state) { + $selector = '#css_div'; + $color = $form_state['values']['css_command_example']; + + $commands = array(); + $commands[] = ajax_command_css($selector, array('background-color' => $color)); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'data'. + */ +function ajax_forms_test_advanced_commands_data_callback($form, $form_state) { + $selector = '#data_div'; + + $commands = array(); + $commands[] = ajax_command_data($selector, 'testkey', 'testvalue'); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'html'. + */ +function ajax_forms_test_advanced_commands_html_callback($form, $form_state) { + $commands = array(); + $commands[] = ajax_command_html('#html_div', 'replacement text'); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'prepend'. + */ +function ajax_forms_test_advanced_commands_prepend_callback($form, $form_state) { + $commands = array(); + $commands[] = ajax_command_prepend('#prepend_div', "prepended text"); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'remove'. + */ +function ajax_forms_test_advanced_commands_remove_callback($form, $form_state) { + $commands = array(); + $commands[] = ajax_command_remove('#remove_text'); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +} + +/** + * AJAX callback for 'restripe'. + */ +function ajax_forms_test_advanced_commands_restripe_callback($form, $form_state) { + $commands = array(); + $commands[] = ajax_command_restripe('#restripe_table'); + return array('#type' => 'ajax_commands', '#ajax_commands' => $commands); +}