Issue #2961548 by jrockowitz: Add 'Test' to contextual links

Author: jrockowitz

js/webform.contextual.js

@@ -12,8 +12,13 @@
   // @see webform_contextual_links_view_alter()
   // @see Drupal.behaviors.contextual
   $(document).on('click', '.contextual', function() {
-    $(this).find('a.webform-contextual').each(function() {
+    $(this).find('a.webform-contextual').once('webform-contextual').each(function() {
       this.href = this.href.split('?')[0];
+
+      // Add ?_webform_test={webform} to the current page's URL.
+      if (/webform\/([^\/]+)\/test/.test(this.href)) {
+        this.href = window.location.pathname + '?_webform_test=' + RegExp.$1;
+      }
     });
   });
 

src/Tests/WebformSubmissionGenerateTest.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Drupal\webform\Tests;
+
+use Drupal\webform\Entity\Webform;
+use Drupal\webform\Entity\WebformSubmission;
+
+/**
+ * Tests for webform submission generator.
+ *
+ * @group Webform
+ */
+class WebformSubmissionGenerateTest extends WebformTestBase {
+
+  /**
+   * Tests webform submission entity.
+   */
+  public function testWebformSubmissionGenerate() {
+    $this->drupalLogin($this->rootUser);
+
+    $webform = Webform::load('contact');
+
+    /**************************************************************************/
+    // Test tab.
+    /**************************************************************************/
+
+    // Check test form.
+    $sid = $this->postSubmissionTest($webform);
+    $webform_submission = WebformSubmission::load($sid);
+    // Note that only 'message' and 'subject' have predefined #test values.
+    $test_data = [
+      'message' => 'Please ignore this email.',
+      'subject' => 'Testing contact webform from Drupal',
+    ];
+    $data = $webform_submission->getData();
+    $this->assertEqual($data['message'], $test_data['message']);
+    $this->assertEqual($data['subject'], $test_data['subject']);
+
+    // Check test form classes and values.
+    $this->drupalGet('webform/contact/test');
+    $this->assertCssSelect('.webform-submission-form.webform-submission-test-form.webform-submission-contact-form.webform-submission-contact-test-form');
+    foreach ($test_data as $name => $value) {
+      $this->assertFieldByName($name, $value);
+    }
+
+    /**************************************************************************/
+    // Test querystring parameter.
+    /**************************************************************************/
+
+    // Check add form classes and empty values.
+    $this->drupalGet('webform/contact');
+    $this->assertCssSelect('.webform-submission-form.webform-submission-add-form.webform-submission-contact-form.webform-submission-contact-add-form');
+    foreach ($test_data as $name => $value) {
+      $this->assertNoFieldByName($name, $value);
+    }
+
+    // Check add form classes and values with querystring parameter.
+    $this->drupalGet('webform/contact', ['query' => ['_webform_test' => 'contact']]);
+    $this->assertCssSelect('.webform-submission-form.webform-submission-test-form.webform-submission-contact-form.webform-submission-contact-test-form');
+    foreach ($test_data as $name => $value) {
+      $this->assertFieldByName($name, $value);
+    }
+  }
+
+}

src/Tests/WebformTestBase.php

@@ -365,13 +365,15 @@ protected function postSubmission(WebformInterface $webform, array $edit = [], $
    *   Submission values.
    * @param string $submit
    *   Value of the submit button whose click is to be emulated.
+   * @param $options
+   *   Options to be forwarded to the url generator.
    *
    * @return int
    *   The created test submission's sid.
    */
-  protected function postSubmissionTest(WebformInterface $webform, array $edit = [], $submit = NULL) {
+  protected function postSubmissionTest(WebformInterface $webform, array $edit = [], $submit = NULL, $options = []) {
     $submit = $this->getWebformSubmitButtonLabel($webform, $submit);
-    $this->drupalPostForm('webform/' . $webform->id() . '/test', $edit, $submit);
+    $this->drupalPostForm('webform/' . $webform->id() . '/test', $edit, $submit, $options);
     return $this->getLastSubmissionId($webform);
   }
 

src/WebformSubmissionForm.php

@@ -110,6 +110,13 @@ class WebformSubmissionForm extends ContentEntityForm {
    */
   protected $webformEntityReferenceManager;
 
+  /**
+   * The webform submission generation service.
+   *
+   * @var \Drupal\webform\WebformSubmissionGenerateInterface
+   */
+  protected $generate;
+
   /**
    * The webform settings.
    *
@@ -156,8 +163,10 @@ class WebformSubmissionForm extends ContentEntityForm {
    *   The webform submission conditions (#states) validator.
    * @param \Drupal\webform\WebformEntityReferenceManagerInterface $webform_entity_reference_manager
    *   The webform entity reference manager.
+   * @param \Drupal\webform\WebformSubmissionGenerateInterface $submission_generate
+   *   The webform submission generation service.
    */
-  public function __construct(EntityManagerInterface $entity_manager, RendererInterface $renderer, AliasManagerInterface $alias_manager, PathValidatorInterface $path_validator, WebformRequestInterface $request_handler, WebformElementManagerInterface $element_manager, WebformThirdPartySettingsManagerInterface $third_party_settings_manager, WebformMessageManagerInterface $message_manager, WebformTokenManagerInterface $token_manager, WebformSubmissionConditionsValidator $conditions_validator, WebformEntityReferenceManagerInterface $webform_entity_reference_manager) {
+  public function __construct(EntityManagerInterface $entity_manager, RendererInterface $renderer, AliasManagerInterface $alias_manager, PathValidatorInterface $path_validator, WebformRequestInterface $request_handler, WebformElementManagerInterface $element_manager, WebformThirdPartySettingsManagerInterface $third_party_settings_manager, WebformMessageManagerInterface $message_manager, WebformTokenManagerInterface $token_manager, WebformSubmissionConditionsValidator $conditions_validator, WebformEntityReferenceManagerInterface $webform_entity_reference_manager, WebformSubmissionGenerateInterface $submission_generate) {
     parent::__construct($entity_manager);
     $this->renderer = $renderer;
     $this->requestHandler = $request_handler;
@@ -170,6 +179,8 @@ public function __construct(EntityManagerInterface $entity_manager, RendererInte
     $this->tokenManager = $token_manager;
     $this->conditionsValidator = $conditions_validator;
     $this->webformEntityReferenceManager = $webform_entity_reference_manager;
+    $this->generate = $submission_generate;
+
   }
 
   /**
@@ -187,7 +198,9 @@ public static function create(ContainerInterface $container) {
       $container->get('webform.message_manager'),
       $container->get('webform.token_manager'),
       $container->get('webform_submission.conditions_validator'),
-      $container->get('webform.entity_reference_manager')
+      $container->get('webform.entity_reference_manager'),
+      $container->get('webform_submission.generate')
+
     );
   }
 
@@ -217,11 +230,26 @@ public function getFormId() {
 
   /**
    * {@inheritdoc}
+   *
+   * This is the best place to override an entity form's default settings
+   * because is is called immediately after the form object is initialized.
+   *
+   * @see \Drupal\Core\Entity\EntityFormBuilder::getForm
    */
   public function setEntity(EntityInterface $entity) {
     /** @var \Drupal\webform\WebformSubmissionInterface $entity */
     $webform = $entity->getWebform();
 
+    // If ?_webform_test is defined for the current webform, override
+    // the 'add' operation with 'test' operation and generate test data.
+    if ($this->operation === 'add' &&
+      $this->getRequest()->query->get('_webform_test') === $webform->id() &&
+      $webform->access('test')
+    ) {
+      $this->operation = 'test';
+      $entity->setData($this->generate->getData($webform));
+    }
+
     // Get the source entity and allow webform submission to be used as a source
     // entity.
     $this->sourceEntity = $this->requestHandler->getCurrentSourceEntity(['webform']);

webform.libraries.yml

@@ -134,6 +134,8 @@ webform.contextual:
   version: VERSION
   js:
     js/webform.contextual.js:  {}
+  dependencies:
+    - core/jquery.once
 
 # Help.
 

webform.links.contextual.yml

@@ -1,17 +1,23 @@
+entity.webform.test_form:
+  title: Test
+  route_name: entity.webform.test_form
+  group: webform
+  weight: 0
+
 entity.webform.results_submissions:
   title: Results
   route_name: entity.webform.results_submissions
   group: webform
-  weight: 0
+  weight: 10
 
 entity.webform.edit_form:
   title: Build
   route_name: entity.webform.edit_form
   group: webform
-  weight: 10
+  weight: 20
 
 entity.webform.settings:
   title: Settings
   route_name: entity.webform.settings
   group: webform
-  weight: 20
+  weight: 30

webform.module

@@ -641,9 +641,15 @@ function webform_file_download($uri) {
 
 /**
  * Implements hook_contextual_links_view_alter().
+ *
+ * Add .webform-contextual class to all webform context links.
+ *
+ * @see webform.links.contextual.yml
+ * @see js/webform.contextual.js
  */
 function webform_contextual_links_view_alter(&$element, $items) {
   $links = [
+    'entitywebformtest-form',
     'entitywebformresults-submissions',
     'entitywebformedit-form',
     'entitywebformsettings',