From 2cde5b67c69b3be2d64785f427b8b2b3f0bbafcd Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Sun, 23 Oct 2016 14:13:05 -0700
Subject: [PATCH] Issue #2821320 by michielnugter, droplet, Lendude: Add test
coverage for machine-name.js
---
.../modules/form_test/form_test.routing.yml | 8 ++
.../src/Form/FormTestMachineNameForm.php | 63 ++++++++++
.../Core/MachineNameTest.php | 116 ++++++++++++++++++
3 files changed, 187 insertions(+)
create mode 100644 core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php
create mode 100644 core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php
diff --git a/core/modules/system/tests/modules/form_test/form_test.routing.yml b/core/modules/system/tests/modules/form_test/form_test.routing.yml
index 790b9ce2105f..2250a0bb2fce 100644
--- a/core/modules/system/tests/modules/form_test/form_test.routing.yml
+++ b/core/modules/system/tests/modules/form_test/form_test.routing.yml
@@ -358,6 +358,14 @@ form_test.label:
requirements:
_access: 'TRUE'
+form_test.machine_name:
+ path: '/form-test/machine-name'
+ defaults:
+ _form: '\Drupal\form_test\Form\FormTestMachineNameForm'
+ _title: 'Machine name fields'
+ requirements:
+ _access: 'TRUE'
+
form_test.state_persistence:
path: '/form-test/state-persist'
defaults:
diff --git a/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php b/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php
new file mode 100644
index 000000000000..542edc8a76f1
--- /dev/null
+++ b/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace Drupal\form_test\Form;
+
+use Drupal\Core\Form\FormBase;
+use Drupal\Core\Form\FormStateInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+/**
+ * Form constructor for testing #type 'machine_name' elements.
+ */
+class FormTestMachineNameForm extends FormBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getFormId() {
+ return 'form_test_machine_name';
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function buildForm(array $form, FormStateInterface $form_state) {
+ $form['machine_name_1_label'] = [
+ '#type' => 'textfield',
+ '#title' => 'Machine name 1 label',
+ ];
+ $form['machine_name_1'] = [
+ '#type' => 'machine_name',
+ '#title' => 'Machine name 1',
+ '#description' => 'A machine name.',
+ '#machine_name' => [
+ 'source' => ['machine_name_1_label']
+ ],
+ ];
+ $form['machine_name_2_label'] = [
+ '#type' => 'textfield',
+ '#title' => 'Machine name 2 label',
+ ];
+ $form['machine_name_2'] = [
+ '#type' => 'machine_name',
+ '#title' => 'Machine name 2',
+ '#description' => 'Another machine name.',
+ '#machine_name' => [
+ 'source' => ['machine_name_2_label']
+ ],
+ ];
+ $form['submit'] = [
+ '#type' => 'submit',
+ '#value' => 'Submit',
+ ];
+ return $form;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function submitForm(array &$form, FormStateInterface $form_state) {
+ $form_state->setResponse(new JsonResponse($form_state->getValues()));
+ }
+
+}
diff --git a/core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php b/core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php
new file mode 100644
index 000000000000..23c2f0bb9ab0
--- /dev/null
+++ b/core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php
@@ -0,0 +1,116 @@
+<?php
+
+namespace Drupal\FunctionalJavascriptTests\Core;
+
+use Drupal\FunctionalJavascriptTests\JavascriptTestBase;
+
+/**
+ * Tests for the machine name field.
+ *
+ * @group field
+ */
+class MachineNameTest extends JavascriptTestBase {
+
+ /**
+ * Required modules.
+ *
+ * Node is required because the machine name callback checks for
+ * access_content.
+ *
+ * @var array
+ */
+ public static $modules = ['node', 'form_test'];
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp() {
+ parent::setUp();
+
+ $account = $this->drupalCreateUser(array(
+ 'access content',
+ ));
+ $this->drupalLogin($account);
+ }
+
+ /**
+ * Tests that machine name field functions.
+ *
+ * Makes sure that the machine name field automatically provides a valid
+ * machine name and that the manual editing mode functions.
+ */
+ public function testMachineName() {
+ // Visit the machine name test page which contains two machine name fields.
+ $this->drupalGet('form-test/machine-name');
+
+ // Test values for conversion.
+ $test_values = [
+ [
+ 'input' => 'Test value !0-9@',
+ 'message' => 'A title that should be transliterated must be equal to the php generated machine name',
+ 'expected' => 'test_value_0_9_',
+ ],
+ [
+ 'input' => 'Test value',
+ 'message' => 'A title that should not be transliterated must be equal to the php generated machine name',
+ 'expected' => 'test_value',
+ ],
+ ];
+
+ // Get page and session.
+ $page = $this->getSession()->getPage();
+ $assert_session = $this->assertSession();
+
+ // Get elements from the page.
+ $title_1 = $page->findField('machine_name_1_label');
+ $machine_name_1_field = $page->findField('machine_name_1');
+ $machine_name_2_field = $page->findField('machine_name_2');
+ $machine_name_1_wrapper = $machine_name_1_field->getParent();
+ $machine_name_2_wrapper = $machine_name_2_field->getParent();
+ $machine_name_1_value = $page->find('css', '#edit-machine-name-1-label-machine-name-suffix .machine-name-value');
+ $machine_name_2_value = $page->find('css', '#edit-machine-name-2-label-machine-name-suffix .machine-name-value');
+ $button_1 = $page->find('css', '#edit-machine-name-1-label-machine-name-suffix button.link');
+
+ // Assert both fields are initialized correctly.
+ $this->assertNotEmpty($machine_name_1_value, 'Machine name field 1 must be initialized');
+ $this->assertNotEmpty($machine_name_2_value, 'Machine name field 2 must be initialized');
+
+ // Field must be present for the rest of the test to work.
+ if (empty($machine_name_1_value)) {
+ $this->fail('Cannot finish test, missing machine name field');
+ }
+
+ // Test each value for conversion to a machine name.
+ foreach ($test_values as $test_info) {
+ // Set the value for the field, triggering the machine name update.
+ $title_1->setValue($test_info['input']);
+
+ // Wait the set timeout for fetching the machine name.
+ $this->getSession()->wait(1000, 'jQuery("#edit-machine-name-1-label-machine-name-suffix .machine-name-value").html() == "' . $test_info['expected'] . '"');
+
+ // Validate the generated machine name.
+ $this->assertEquals($test_info['expected'], $machine_name_1_value->getHtml(), $test_info['message']);
+
+ // Validate the second machine name field is empty.
+ $this->assertEmpty($machine_name_2_value->getHtml(), 'The second machine name field should still be empty');
+ }
+
+ // Validate the machine name field is hidden. Elements are visually hidden
+ // using positioning, isVisible() will therefore not work.
+ $this->assertEquals(TRUE, $machine_name_1_wrapper->hasClass('visually-hidden'), 'The ID field must not be visible');
+ $this->assertEquals(TRUE, $machine_name_2_wrapper->hasClass('visually-hidden'), 'The ID field must not be visible');
+
+ // Test switching back to the manual editing mode by clicking the edit link.
+ $button_1->click();
+
+ // Validate the visibility of the machine name field.
+ $this->assertEquals(FALSE, $machine_name_1_wrapper->hasClass('visually-hidden'), 'The ID field must now be visible');
+
+ // Validate the visibility of the second machine name field.
+ $this->assertEquals(TRUE, $machine_name_2_wrapper->hasClass('visually-hidden'), 'The ID field must not be visible');
+
+ // Validate if the element contains the correct value.
+ $this->assertEquals($test_values[1]['expected'], $machine_name_1_field->getValue(), 'The ID field value must be equal to the php generated machine name');
+ }
+
+}
--
GitLab