From f172ec3d756ba62a16370f90c7a708ad492db209 Mon Sep 17 00:00:00 2001
From: nod_ <nod_@598310.no-reply.drupal.org>
Date: Mon, 3 Feb 2025 11:40:14 +0100
Subject: [PATCH] Issue #3503908 by quietone, borisson_: Fix
Drupal.Commenting.FunctionComment.Missing in FunctionalJavascript tests
---
.../src/FunctionalJavascript/ImageTestBaselineTrait.php | 3 +++
.../src/FunctionalJavascript/ImageTestProviderTrait.php | 6 ++++++
.../tests/src/FunctionalJavascript/ImageTestTestBase.php | 3 +++
.../tests/src/FunctionalJavascript/MediaLinkabilityTest.php | 6 ++++++
.../src/FunctionalJavascript/ToolbarStoredStateTest.php | 3 +++
.../src/FunctionalJavascript/Plugin/BulkOperationsTest.php | 3 +++
.../FunctionalJavascript/Plugin/views/Handler/FieldTest.php | 3 +++
core/phpcs.xml.dist | 2 +-
.../OpenTelemetryAuthenticatedPerformanceTest.php | 3 +++
9 files changed, 31 insertions(+), 1 deletion(-)
diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBaselineTrait.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBaselineTrait.php
index 9f78fa983eee..9f6be924c24c 100644
--- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBaselineTrait.php
+++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBaselineTrait.php
@@ -276,6 +276,9 @@ public function testLinkability(): void {
}
}
+ /**
+ * Returns data for testLinkability() and testImageArbitraryHtml().
+ */
protected function providerLinkability(): array {
return [
'BLOCK image, restricted' => ['block', FALSE],
diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php
index fa6652781540..85f9b4e9e7a1 100644
--- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php
+++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php
@@ -110,6 +110,9 @@ public function testAltTextRequired(bool $unrestricted): void {
$this->assertVisibleBalloon('.ck-text-alternative-form');
}
+ /**
+ * Providers data for testAltTextRequired().
+ */
public static function providerAltTextRequired(): array {
return [
'Restricted' => [FALSE],
@@ -179,6 +182,9 @@ public function testAlignment(string $image_type): void {
$this->assertFalse($drupal_media_element->hasAttribute('data-align'));
}
+ /**
+ * Data provider for testAlignment().
+ */
public static function providerAlignment() {
return [
'Block image' => ['block'],
diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php
index ed3cbf2ec255..c60b8d4e8f9a 100644
--- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php
+++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php
@@ -124,6 +124,9 @@ protected function imageAttributes(): array {
];
}
+ /**
+ * Uploads a test image.
+ */
protected function addImage() {
$page = $this->getSession()->getPage();
$this->assertNotEmpty($image_upload_field = $page->find('css', '.ck-file-dialog-button input[type="file"]'));
diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/MediaLinkabilityTest.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/MediaLinkabilityTest.php
index d22a37057988..d5b780dcfc41 100644
--- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/MediaLinkabilityTest.php
+++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/MediaLinkabilityTest.php
@@ -220,6 +220,12 @@ public function testLinkability(bool $unrestricted): void {
$this->assertEmpty($xpath->query('//a'));
}
+ /**
+ * Returns data for multiple tests.
+ *
+ * Provides data for testLinkability(), testLinkManualDecorator() and
+ * testLinkedMediaArbitraryHtml().
+ */
public static function providerLinkability(): array {
return [
'restricted' => [FALSE],
diff --git a/core/modules/toolbar/tests/src/FunctionalJavascript/ToolbarStoredStateTest.php b/core/modules/toolbar/tests/src/FunctionalJavascript/ToolbarStoredStateTest.php
index b6be1e816e08..432dd8c85227 100644
--- a/core/modules/toolbar/tests/src/FunctionalJavascript/ToolbarStoredStateTest.php
+++ b/core/modules/toolbar/tests/src/FunctionalJavascript/ToolbarStoredStateTest.php
@@ -24,6 +24,9 @@ class ToolbarStoredStateTest extends WebDriverTestBase {
*/
protected $defaultTheme = 'stark';
+ /**
+ * Tests different states of the toolbar.
+ */
public function testToolbarStoredState(): void {
$admin_user = $this->drupalCreateUser([
'access toolbar',
diff --git a/core/modules/views/tests/src/FunctionalJavascript/Plugin/BulkOperationsTest.php b/core/modules/views/tests/src/FunctionalJavascript/Plugin/BulkOperationsTest.php
index ca9c4ee5eb41..fb6bcab6de73 100644
--- a/core/modules/views/tests/src/FunctionalJavascript/Plugin/BulkOperationsTest.php
+++ b/core/modules/views/tests/src/FunctionalJavascript/Plugin/BulkOperationsTest.php
@@ -38,6 +38,9 @@ protected function setUp(): void {
$this->drupalLogin($this->createUser(['bypass node access', 'administer nodes', 'access content overview']));
}
+ /**
+ * Tests views bulk operations.
+ */
public function testBulkOperations(): void {
$node_1 = $this->drupalCreateNode([
'type' => 'page',
diff --git a/core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FieldTest.php b/core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FieldTest.php
index 0eb4a9f91c20..1224c5785940 100644
--- a/core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FieldTest.php
+++ b/core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FieldTest.php
@@ -112,6 +112,9 @@ public function testModalDialogTitle(): void {
$this->assertEquals('Content', $web_assert->waitForElement('css', '.ui-dialog-title')->getText());
}
+ /**
+ * Tests changing the formatter.
+ */
public function testFormatterChanging(): void {
$web_assert = $this->assertSession();
$url = '/admin/structure/views/view/test_field_body';
diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist
index 1d17feda708d..e10cb8a57c5b 100644
--- a/core/phpcs.xml.dist
+++ b/core/phpcs.xml.dist
@@ -79,7 +79,7 @@
<include-pattern>core/modules/*/Plugin/views/pager/*</include-pattern>
<include-pattern>core/modules/*/Plugin/views/style/*</include-pattern>
<include-pattern>*/Database/*</include-pattern>
- <exclude-pattern>*/tests/*</exclude-pattern>
+ <include-pattern>*/FunctionalJavascript/*</include-pattern>
</rule>
<rule ref="Drupal.Commenting.FunctionComment.MissingParamType"/>
<rule ref="Drupal.Commenting.FunctionComment.MissingReturnComment">
diff --git a/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php b/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php
index f0a6312984af..b6dc3a500a33 100644
--- a/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php
+++ b/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php
@@ -20,6 +20,9 @@ class OpenTelemetryAuthenticatedPerformanceTest extends PerformanceTestBase {
*/
protected $profile = 'demo_umami';
+ /**
+ * {@inheritdoc}
+ */
protected function setUp(): void {
parent::setUp();
$user = $this->drupalCreateUser();
--
GitLab