You are here

Home » API reference » Webform 8.5 » WebformHandlerTest.php » WebformHandlerTest

public function WebformHandlerTest::testWebformHandler in Webform 8.5

Same name and namespace in other branches
  1. 6.x tests/src/Functional/Handler/WebformHandlerTest.php \Drupal\Tests\webform\Functional\Handler\WebformHandlerTest::testWebformHandler()

Tests webform handler plugin.

File

tests/src/Functional/Handler/WebformHandlerTest.php, line 33

Class

WebformHandlerTest
Tests for webform handler plugin.

Namespace

Drupal\Tests\webform\Functional\Handler

Code

public function testWebformHandler() {
  $this
    ->drupalLogin($this->rootUser);

  // Get the webform test handler.

  /** @var \Drupal\webform\WebformInterface $webform_handler_test */
  $webform_handler_test = Webform::load('test_handler_test');

  // Check new submission plugin invoking.
  $this
    ->drupalGet('/webform/test_handler_test');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:accessSubmission');

  // Check validate submission plugin invoked and displaying an error.
  $this
    ->postSubmission($webform_handler_test, [
    'element' => 'a value',
  ]);
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:accessSubmission');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:validateForm');
  $this
    ->assertRaw('The element must be empty. You entered <em class="placeholder">a value</em>.');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:accessSubmission');
  $this
    ->assertNoRaw('One two one two this is just a test');

  // Check submit submission plugin invoking.
  $sid = $this
    ->postSubmission($webform_handler_test);
  $webform_submission = WebformSubmission::load($sid);
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:validateForm');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:submitForm');
  $this
    ->assertRaw('One two one two this is just a test');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:confirmForm');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preSave');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postSave insert');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postLoad');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preprocessConfirmation');
  $this
    ->assertRaw('<div class="webform-confirmation__message">::preprocessConfirmation</div>');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:accessSubmission');

  // Check confirmation with token.
  $this
    ->drupalGet('/webform/test_handler_test/confirmation', [
    'query' => [
      'token' => $webform_submission
        ->getToken(),
    ],
  ]);
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preSave');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postLoad');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preprocessConfirmation');
  $this
    ->assertRaw('<div class="webform-confirmation__message">::preprocessConfirmation</div>');

  // Check confirmation without token.
  $this
    ->drupalGet('/webform/test_handler_test/confirmation');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postLoad');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preprocessConfirmation');
  $this
    ->assertRaw('<div class="webform-confirmation__message">::preprocessConfirmation</div>');

  // Check update submission plugin invoking.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/submission/' . $sid . '/edit', [], 'Save');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:accessSubmission');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postSave update');

  // Check delete submission plugin invoking.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/submission/' . $sid . '/delete', [], 'Delete');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:accessSubmission');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postLoad');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preDelete');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postDelete');
  $this
    ->assertRaw('<em class="placeholder">Test: Handler: Test invoke methods: Submission #' . $webform_submission
    ->serial() . '</em> has been deleted.');

  // Check submission access returns forbidden when element value is set to 'submission_access_denied'.
  $sid = $this
    ->postSubmission($webform_handler_test, [
    'element' => 'submission_access_denied',
  ]);
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/submission/' . $sid);
  $this
    ->assertResponse(403);
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/submission/' . $sid . '/edit');
  $this
    ->assertResponse(403);
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/submission/' . $sid . '/delete');
  $this
    ->assertResponse(403);

  // Check allowed access when element value is set to 'access_allowed'.
  $sid = $this
    ->postSubmission($webform_handler_test, [
    'element' => 'access_allowed',
  ]);
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/submission/' . $sid);
  $this
    ->assertResponse(200);
  $this
    ->assertNoRaw('<label>element</label>');
  $this
    ->assertRaw('access_allowed');
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/submission/' . $sid . '/edit');
  $this
    ->assertResponse(200);
  $this
    ->assertFieldByName('element', 'access_allowed');

  // Check element access returns forbidden when element value is set to 'element_access_denied'.
  $sid = $this
    ->postSubmission($webform_handler_test, [
    'element' => 'element_access_denied',
  ]);
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/submission/' . $sid);
  $this
    ->assertResponse(200);
  $this
    ->assertNoRaw('<label>element</label>');
  $this
    ->assertNoRaw('element_access_denied');
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/submission/' . $sid . '/edit');
  $this
    ->assertResponse(200);
  $this
    ->assertNoFieldByName('element', 'element_access_denied');

  // Check configuration settings.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/handlers/test/edit', [
    'settings[message]' => '{message}',
  ], 'Save');
  $this
    ->postSubmission($webform_handler_test);
  $this
    ->assertRaw('{message}');

  // Check disabling a handler.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/handlers/test/edit', [
    'status' => FALSE,
  ], 'Save');
  $this
    ->drupalGet('/webform/test_handler_test');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');

  // Enable the handler and disable the saving of results.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/handlers/test/edit', [
    'status' => TRUE,
  ], 'Save');
  $webform_handler_test
    ->setSettings([
    'results_disabled' => TRUE,
  ]);
  $webform_handler_test
    ->save();

  // Check webform disabled with saving of results is disabled and handler does
  // not process results.
  $this
    ->drupalLogout();
  $this
    ->drupalGet('/webform/test_handler_test');
  $this
    ->assertNoFieldByName('op', 'Submit');
  $this
    ->assertNoRaw('This webform is not saving or handling any submissions. All submitted data will be lost.');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');

  // Check admin can still post submission.
  $this
    ->drupalLogin($this->rootUser);
  $this
    ->drupalGet('/webform/test_handler_test');
  $this
    ->assertFieldByName('op', 'Submit');
  $this
    ->assertRaw('This webform is currently not saving any submitted data.');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');

  // Check submit submission plugin invoking when saving results is disabled.
  $webform_handler_test
    ->setSetting('results_disabled', TRUE);
  $webform_handler_test
    ->save();
  $this
    ->postSubmission($webform_handler_test);
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:validateForm');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:submitForm');
  $this
    ->assertRaw('One two one two this is just a test');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:confirmForm');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preSave');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postSave insert');

  // Check that post load is not executed when saving results is disabled.
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postLoad');

  /**************************************************************************/

  // Handler.

  /**************************************************************************/

  // Check update handler.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/handlers/test/edit', [], 'Save');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:updateHandler');
  $this
    ->assertRaw('The webform handler was successfully updated.');

  // Check delete handler.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/handlers/test/delete', [], 'Delete');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:deleteHandler');

  // Check create handler.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/handlers/add/test', [
    'handler_id' => 'test',
  ], 'Save');
  $this
    ->assertRaw('The webform handler was successfully added.');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:createHandler');

  /**************************************************************************/

  // Single handler.

  /**************************************************************************/

  // Check test handler is executed.
  $this
    ->drupalGet('/webform/test_handler_test/test');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterForm');

  // Check test handler is enabled and debug handler is disabled.
  $this
    ->drupalPostForm('/webform/test_handler_test/test', [
    'element' => '',
  ], 'Submit');
  $this
    ->assertRaw('One two one two this is just a test');
  $this
    ->assertNoRaw("element: ''");

  // Check test handler is disabled.
  $this
    ->drupalGet('/webform/test_handler_test/test', [
    'query' => [
      '_webform_handler' => 'debug',
    ],
  ]);
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:preCreate');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:postCreate');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElements');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:alterElement');
  $this
    ->assertNoRaw('Invoked test: Drupal\\webform_test_handler\\Plugin\\WebformHandler\\TestWebformHandler:overrideSettings');
  $this
    ->assertRaw('Testing the <em class="placeholder">Test: Handler: Test invoke methods</em> webform <em class="placeholder">Debug</em> handler. <strong>All other emails/handlers are disabled.</strong>');

  // Check test handler is now disabled and debug handler is enabled.
  $this
    ->drupalPostForm('/webform/test_handler_test/test', [
    'element' => '',
  ], 'Submit', [
    'query' => [
      '_webform_handler' => 'debug',
    ],
  ]);
  $this
    ->assertNoRaw('One two one two this is just a test');
  $this
    ->assertRaw("element: ''");

  // Check 403 access denied for missing handler.
  $this
    ->drupalGet('/webform/test_handler_test/test', [
    'query' => [
      '_webform_handler' => 'missing',
    ],
  ]);
  $this
    ->assertResponse(403);
  $this
    ->assertRaw('The <em class="placeholder">missing</em> email/handler for the <em class="placeholder">Test: Handler: Test invoke methods</em> webform does not exist.');

  /**************************************************************************/

  // Off-canvas width.

  /**************************************************************************/

  // Check add off-canvas element width is 800.
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/handlers/add');
  $this
    ->assertCssSelect('[href$="/admin/structure/webform/manage/test_handler_test/handlers/add/test_offcanvas_width"][data-dialog-options*="800"]');
  $this
    ->assertNoCssSelect('[href$="/admin/structure/webform/manage/test_handler_test/handlers/add/test_offcanvas_width"][data-dialog-options*="550"]');

  // Add handler.
  $this
    ->drupalPostForm('/admin/structure/webform/manage/test_handler_test/handlers/add/test_offcanvas_width', [
    'handler_id' => 'test_offcanvas_width',
  ], 'Save');

  // Check edit off-canvas element width is 800.
  $this
    ->drupalGet('/admin/structure/webform/manage/test_handler_test/handlers');
  $this
    ->assertCssSelect('[href$="/admin/structure/webform/manage/test_handler_test/handlers/test_offcanvas_width/edit"][data-dialog-options*="800"]');
  $this
    ->assertNoCssSelect('[href$="/admin/structure/webform/manage/test_handler_test/handlers/test_offcanvas_width/edit"][data-dialog-options*="550"]');
}