Ddfbra 222 update webform module

cypress/e2e/webforms.cy.ts

@@ -0,0 +1,83 @@
+describe('Webforms', () => {
+  before(() => {
+    cy.enableDevelMailLog();
+  });
+
+  beforeEach(() => {
+    Cypress.session.clearAllSavedSessions();
+  });
+
+  it('Go to the default contact webform page and fill it out successfully.', () => {
+    cy.visit('/kontakt');
+    cy.url().should('match', /kontakt/);
+    cy.get('[data-cy="name"]').type('John Doe');
+    cy.get('[data-cy="email"]').type('[email protected]');
+    cy.get('[data-cy="category"]').select(1);
+    cy.get('[data-cy="subject"]').type('Test');
+    cy.get('[data-cy="message"]').type('Lorem ipsum');
+    // We bypass the linting here, as we need to force waiting as we need to
+    // wait for the honeypot timer to run out.
+    // eslint-disable-next-line cypress/no-unnecessary-waiting
+    cy.wait(6000);
+    cy.get('[data-cy="op"]').click();
+    cy.url().should('match', /kontakt/);
+    cy.get('.status-message__description').contains(
+      'Your submission has been received. You will receive a confirmation mail soon.',
+    );
+  });
+
+  it('Go to the default contact webform page and check that required fields are working.', () => {
+    cy.visit('/kontakt');
+    cy.url().should('match', /kontakt/);
+    cy.get('[data-cy="op"]').click();
+    cy.url().should('match', /kontakt/);
+  });
+
+  it('Check that antibot_key and honeypot_time input elements exists.', () => {
+    cy.visit('/kontakt');
+    cy.url().should('match', /kontakt/);
+    cy.get('[data-cy="honeypot_time"]').should('exist');
+    cy.get('[data-cy="antibot_key"]').should('exist');
+  });
+
+  it('Check that the honeypot timer is working by submitting form before timer (5000ms) is up.', () => {
+    cy.visit('/kontakt');
+    cy.url().should('match', /kontakt/);
+    cy.get('[data-cy="name"]').type('John Doe');
+    cy.get('[data-cy="email"]').type('[email protected]');
+    cy.get('[data-cy="category"]').select(1);
+    cy.get('[data-cy="subject"]').type('Test');
+    cy.get('[data-cy="message"]').type('Lorem ipsum');
+    cy.get('[data-cy="op"]').click();
+    cy.get('.error-message__description').contains(
+      'There was a problem with your form submission.',
+    );
+  });
+
+  it('Check that the honeypot field is working by filling in hidden honeypot field.', () => {
+    cy.visit('/kontakt');
+    cy.url().should('match', /kontakt/);
+    cy.get('[data-cy="name"]').type('John Doe');
+    cy.get('[data-cy="email"]').type('[email protected]');
+    cy.get('[data-cy="category"]').select(1);
+    cy.get('[data-cy="subject"]').type('Test');
+    cy.get('[data-cy="message"]').type('Lorem ipsum');
+    cy.get('[data-cy="url"]').type('John Doe', { force: true });
+    // We bypass the linting here, as we need to force waiting as we need to
+    // wait for the honeypot timer to run out.
+    // eslint-disable-next-line cypress/no-unnecessary-waiting
+    cy.wait(6000);
+    cy.get('[data-cy="op"]').click();
+    cy.get('.error-message__description').contains(
+      'There was a problem with your form submission.',
+    );
+  });
+
+  beforeEach(() => {
+    cy.resetMappings();
+  });
+
+  afterEach(() => {
+    cy.logMappingRequests();
+  });
+});

cypress/support/commands.ts

@@ -105,17 +105,26 @@ Cypress.Commands.add('drupalLogout', () => {
 
 Cypress.Commands.add('drupalCron', () => {
   // Because we run Wiremock as a proxy only services configured with the
-  //  proxy will use it. We need to proxy requests during cron and only the
-  // web container is configured to use the proxy and thus we have to run
+  // proxy will use it. We need to proxy requests during cron and only the
+  // web container is configured to use the proxy, and thus we have to run
   // cron through the web frontend. Using the proxy with the CLI container would
-  // cause too many irrelevant requests to pass throuh the proxy.
+  // cause too many irrelevant requests to pass through the proxy.
   cy.drupalLogin();
   cy.visit('/admin/config/system/cron');
   cy.get('[value="Run cron"]').click();
   cy.contains('Cron ran successfully.');
   cy.drupalLogout();
 });
 
+Cypress.Commands.add('enableDevelMailLog', () => {
+  cy.drupalLogin();
+  cy.visit('/admin/config/system/mailsystem');
+  cy.get('[data-cy="mailsystem[default_formatter]"]').select('devel_mail_log');
+  cy.get('[data-cy="mailsystem[default_sender]"]').select('devel_mail_log');
+  cy.get('[data-drupal-selector="edit-submit"]').click();
+  cy.drupalLogout();
+});
+
 const adgangsplatformenLoginOauthMappings = ({
   userIsAlreadyRegistered,
   authorizationCode,
@@ -346,6 +355,7 @@ declare global {
       drupalLogin(url?: string): Chainable<null>;
       drupalLogout(): Chainable<null>;
       drupalCron(): Chainable<null>;
+      enableDevelMailLog(): Chainable<null>;
       adgangsplatformenLogin(params: {
         authorizationCode: string;
         accessToken: string;

web/modules/custom/dpl_webform/dpl_webform.module

@@ -23,6 +23,39 @@ function dpl_webform_webform_create(Webform $webform): void {
   $webform->setSetting('confirmation_type', 'message');
 }
 
+/**
+ * Implements hook_preprocess_HOOK().
+ */
+function dpl_webform_preprocess_input(array &$variables): void {
+
+  // Add data-cy attributes to all input elements for cypress testing.
+  if (isset($variables['attributes']['name'])) {
+    $variables['attributes']['data-cy'] = $variables['attributes']['name'];
+  }
+}
+
+/**
+ * Implements hook_preprocess_HOOK().
+ */
+function dpl_webform_preprocess_textarea(array &$variables): void {
+
+  // Add data-cy attributes to all input elements for cypress testing.
+  if (isset($variables['attributes']['name'])) {
+    $variables['attributes']['data-cy'] = $variables['attributes']['name'];
+  }
+}
+
+/**
+ * Implements hook_preprocess_HOOK().
+ */
+function dpl_webform_preprocess_select(array &$variables): void {
+
+  // Add data-cy attributes to all input elements for cypress testing.
+  if (isset($variables['attributes']['name'])) {
+    $variables['attributes']['data-cy'] = $variables['attributes']['name'];
+  }
+}
+
 /**
  * Implements hook_preprocess_HOOK().
  */
@@ -38,6 +71,11 @@ function dpl_webform_preprocess_input__submit(array &$variables): void {
       'dpl-button',
     ]);
   }
+
+  // Add data-cy attributes to all input elements for cypress testing.
+  if (isset($variables['attributes']['name'])) {
+    $variables['attributes']['data-cy'] = $variables['attributes']['name'];
+  }
 }
 
 /**