Issue #2920678 by phenaproxima, Wim Leers, dawehner, Gogowitsch, Sam152, dww,...

Issue #2920678 by phenaproxima, Wim Leers, dawehner, Gogowitsch, Sam152, dww, longwave, yogeshmpawar, alexpott, borisson_, tstoeckler, jibran, amateescu, larowlan, tedbow: Add config validation for the allowed characters of machine names

core/config/schema/core.data_types.schema.yml

@@ -94,6 +94,16 @@ color_hex:
   type: string
   label: 'Color'
 
+# Machine-readable identifier that can only contain certain characters.
+machine_name:
+  type: string
+  label: 'Machine name'
+  constraints:
+    Regex: '/^[a-z0-9_]+$/'
+    Length:
+      # @see \Drupal\Core\Config\Entity\ConfigEntityStorage::MAX_ID_LENGTH
+      max: 166
+
 # Complex extended data types:
 
 # Root of a configuration object.

core/modules/block/config/schema/block.schema.yml

@@ -5,8 +5,13 @@ block.block.*:
   label: 'Block'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
+      # Blocks have atypical machine names: they allow periods for historical reasons.
+      # @see https://www.drupal.org/project/drupal/issues/2685917
+      # @see https://www.drupal.org/project/drupal/issues/2043527
+      constraints:
+        Regex: '/^[a-z0-9_.]+$/'
     theme:
       type: string
       label: 'Theme'

core/modules/block/tests/src/Kernel/BlockValidationTest.php

@@ -39,4 +39,18 @@ public function testInvalidPluginId(): void {
     $this->assertValidationErrors(['plugin' => "The 'non_existent' plugin does not exist."]);
   }
 
+  /**
+   * Block names are atypical in that they allow periods in the machine name.
+   */
+  public function providerInvalidMachineNameCharacters(): array {
+    $cases = parent::providerInvalidMachineNameCharacters();
+    // Remove the existing test case that verifies a machine name containing
+    // periods is invalid.
+    $this->assertSame(['period.separated', FALSE], $cases['INVALID: period separated']);
+    unset($cases['INVALID: period separated']);
+    // And instead add a test case that verifies it is allowed for blocks.
+    $cases['VALID: period separated'] = ['period.separated', TRUE];
+    return $cases;
+  }
+
 }

core/modules/block_content/config/schema/block_content.schema.yml

@@ -5,7 +5,7 @@ block_content.type.*:
   label: 'Block type settings'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
     label:
       type: label

core/modules/comment/config/schema/comment.schema.yml

@@ -38,7 +38,7 @@ comment.type.*:
   label: 'Comment type settings'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
     label:
       type: label

core/modules/contact/config/schema/contact.schema.yml

@@ -5,8 +5,13 @@ contact.form.*:
   label: 'Contact form'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
+      constraints:
+        Length:
+          # Contact form IDs are specifically limited to 32 characters.
+          # @see \Drupal\contact\ContactFormEditForm::form()
+          max: 32
     label:
       type: label
       label: 'Label'

core/modules/filter/config/schema/filter.schema.yml

@@ -19,8 +19,13 @@ filter.format.*:
       type: label
       label: 'Name'
     format:
-      type: string
+      type: machine_name
       label: 'Machine name'
+      # Filter format machine names can be up to 255 characters.
+      # @see \Drupal\filter\FilterFormatFormBase::form()
+      constraints:
+        Length:
+          max: 255
     weight:
       type: integer
       label: 'Weight'

core/modules/image/config/schema/image.schema.yml

@@ -5,7 +5,7 @@ image.style.*:
   label: 'Image style'
   mapping:
     name:
-      type: string
+      type: machine_name
     label:
       type: label
       label: 'Label'

core/modules/media/config/schema/media.schema.yml

@@ -20,8 +20,13 @@ media.type.*:
   label: 'Media type'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'Machine name'
+      constraints:
+        Length:
+          # Media type IDs are specifically limited to 32 characters.
+          # @see \Drupal\media\MediaTypeForm::form()
+          max: 32
     label:
       type: label
       label: 'Name'

core/modules/media/tests/src/Kernel/MediaTypeValidationTest.php

@@ -24,7 +24,7 @@ class MediaTypeValidationTest extends ConfigEntityValidationTestBase {
    */
   protected function setUp(): void {
     parent::setUp();
-    $this->entity = $this->createMediaType('test');
+    $this->entity = $this->createMediaType('test', ['id' => 'test_media']);
   }
 
 }

core/modules/node/config/schema/node.schema.yml

@@ -16,8 +16,13 @@ node.type.*:
       type: label
       label: 'Name'
     type:
-      type: string
+      type: machine_name
       label: 'Machine-readable name'
+      constraints:
+        # Node type machine names are specifically limited to 32 characters.
+        # @see \Drupal\node\NodeTypeForm::form()
+        Length:
+          max: 32
     description:
       type: text
       label: 'Description'

core/modules/responsive_image/config/schema/responsive_image.schema.yml

@@ -5,7 +5,7 @@ responsive_image.styles.*:
   label: 'Responsive image style'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'Machine-readable name'
     label:
       type: label

core/modules/search/config/schema/search.schema.yml

@@ -72,7 +72,7 @@ search.page.*:
   label: 'Search page'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
     label:
       type: label

core/modules/shortcut/config/schema/shortcut.schema.yml

@@ -5,8 +5,15 @@ shortcut.set.*:
   label: 'Shortcut settings'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
+      # Shortcut set IDs are specifically limited to 23 characters, and allow
+      # dashes but not underscores.
+      # @see \Drupal\shortcut\ShortcutSetForm::form()
+      constraints:
+        Regex: '/^[a-z0-9-]+$/'
+        Length:
+          max: 23
     label:
       type: label
       label: 'Label'

core/modules/shortcut/tests/src/Kernel/ShortcutSetValidationTest.php

@@ -26,10 +26,35 @@ protected function setUp(): void {
     $this->installEntitySchema('shortcut');
 
     $this->entity = ShortcutSet::create([
-      'id' => 'test',
+      'id' => 'test-shortcut-set',
       'label' => 'Test',
     ]);
     $this->entity->save();
   }
 
+  /**
+   * Shortcut set IDs are atypical: they allow dashes and disallow underscores.
+   */
+  public function providerInvalidMachineNameCharacters(): array {
+    $cases = parent::providerInvalidMachineNameCharacters();
+
+    // Remove the existing test case that verifies a machine name containing
+    // dashes is invalid.
+    $this->assertSame(['dash-separated', FALSE], $cases['INVALID: dash separated']);
+    unset($cases['INVALID: dash separated']);
+    // And instead add a test case that verifies it is allowed for shortcut
+    // sets.
+    $cases['VALID: dash separated'] = ['dash-separated', TRUE];
+
+    // Remove the existing test case that verifies a machine name containing
+    // underscores is valid.
+    $this->assertSame(['underscore_separated', TRUE], $cases['VALID: underscore separated']);
+    unset($cases['VALID: underscore separated']);
+    // And instead add a test case that verifies it is disallowed for shortcut
+    // sets.
+    $cases['INVALID: underscore separated'] = ['underscore_separated', FALSE];
+
+    return $cases;
+  }
+
 }

core/modules/system/config/schema/system.schema.yml

@@ -212,8 +212,15 @@ system.menu.*:
   label: 'Menu'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
+      # Menu IDs are specifically limited to 32 characters, and allow dashes but not
+      # underscores.
+      # @see \Drupal\menu_ui\MenuForm::form()
+      constraints:
+        Regex: '/^[a-z0-9-]+$/'
+        Length:
+          max: 32
     label:
       type: label
       label: 'Label'
@@ -229,7 +236,7 @@ system.action.*:
   label: 'System action'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
     label:
       type: label

core/modules/system/tests/src/Kernel/Entity/MenuValidationTest.php

@@ -19,10 +19,33 @@ protected function setUp(): void {
     parent::setUp();
 
     $this->entity = Menu::create([
-      'id' => 'test',
+      'id' => 'test-menu',
       'label' => 'Test',
     ]);
     $this->entity->save();
   }
 
+  /**
+   * Menu IDs are atypical: they allow dashes and disallow underscores.
+   */
+  public function providerInvalidMachineNameCharacters(): array {
+    $cases = parent::providerInvalidMachineNameCharacters();
+
+    // Remove the existing test case that verifies a machine name containing
+    // dashes is invalid.
+    $this->assertSame(['dash-separated', FALSE], $cases['INVALID: dash separated']);
+    unset($cases['INVALID: dash separated']);
+    // And instead add a test case that verifies it is allowed for menus.
+    $cases['VALID: dash separated'] = ['dash-separated', TRUE];
+
+    // Remove the existing test case that verifies a machine name containing
+    // underscores is valid.
+    $this->assertSame(['underscore_separated', TRUE], $cases['VALID: underscore separated']);
+    unset($cases['VALID: underscore separated']);
+    // And instead add a test case that verifies it is disallowed for menus.
+    $cases['INVALID: underscore separated'] = ['underscore_separated', FALSE];
+
+    return $cases;
+  }
+
 }

core/modules/taxonomy/config/schema/taxonomy.schema.yml

@@ -22,8 +22,13 @@ taxonomy.vocabulary.*:
       type: label
       label: 'Name'
     vid:
-      type: string
+      type: machine_name
       label: 'Machine name'
+      # Vocabulary machine names are specifically limited to 32 characters.
+      # @see \Drupal\taxonomy\VocabularyForm::form()
+      constraints:
+        Length:
+          max: 32
     description:
       type: label
       label: 'Description'

core/modules/tour/config/schema/tour.schema.yml

@@ -5,7 +5,7 @@ tour.tour.*:
   label: 'Tour settings'
   mapping:
     id:
-      type: string
+      type: machine_name
       label: 'ID'
     label:
       type: label

core/modules/tour/tests/src/Kernel/TourValidationTest.php

+<?php
+
+namespace Drupal\Tests\tour\Kernel;
+
+use Drupal\KernelTests\Core\Config\ConfigEntityValidationTestBase;
+use Drupal\tour\Entity\Tour;
+
+/**
+ * Tests validation of tour entities.
+ *
+ * @group tour
+ */
+class TourValidationTest extends ConfigEntityValidationTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = ['tour'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp(): void {
+    parent::setUp();
+
+    $this->entity = Tour::create([
+      'id' => 'test',
+      'label' => 'Test',
+      'module' => 'system',
+    ]);
+    $this->entity->save();
+  }
+
+}