From 830646e662bd16760831ff929bb51c14719d9c82 Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Wed, 19 Oct 2022 12:03:31 +0100
Subject: [PATCH] Issue #3309047 by mondrake: Fix 'should return {type} but
return statement is missing' PHPStan L0 errors in test code
---
.../Plugin/Derivative/DeriverInterface.php | 2 +-
.../lib/Drupal/Core/Test/TestRunnerKernel.php | 3 +
.../tests/config_test/src/ConfigTestForm.php | 1 +
.../Plugin/migrate/source/NoSourceModule.php | 12 ++-
.../Plugin/Search/SearchExtraTypeSearch.php | 1 +
.../src/Entity/EntityTestMulChanged.php | 2 +-
.../entity_test/src/EntityTestForm.php | 3 +-
.../Operation/test/OperationBase.php | 1 +
.../mock_block/MockLayoutBlockDeriver.php | 1 +
.../mock_block/MockMenuBlockDeriver.php | 1 +
.../src/TestFileUsage.php | 1 +
.../src/Plugin/views/filter/FilterTest.php | 4 +-
core/phpstan-baseline.neon | 85 -------------------
13 files changed, 23 insertions(+), 94 deletions(-)
diff --git a/core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php b/core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php
index 32b59ef7484f..ff13b0fbc698 100644
--- a/core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php
+++ b/core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php
@@ -20,7 +20,7 @@ interface DeriverInterface {
* is derived. It is maybe an entire object or just some array, depending
* on the discovery mechanism.
*
- * @return array
+ * @return array|null
* The full definition array of the derivative plugin, typically a merge of
* $base_plugin_definition with extra derivative-specific information. NULL
* if the derivative doesn't exist.
diff --git a/core/lib/Drupal/Core/Test/TestRunnerKernel.php b/core/lib/Drupal/Core/Test/TestRunnerKernel.php
index c8736a303e04..eb7f5d7f8e67 100644
--- a/core/lib/Drupal/Core/Test/TestRunnerKernel.php
+++ b/core/lib/Drupal/Core/Test/TestRunnerKernel.php
@@ -83,6 +83,8 @@ public function boot() {
if (!is_dir('public://simpletest') && !@mkdir('public://simpletest', 0777, TRUE) && !is_dir('public://simpletest')) {
throw new \RuntimeException('Unable to create directory: public://simpletest');
}
+
+ return $this;
}
/**
@@ -93,6 +95,7 @@ public function discoverServiceProviders() {
// The test runner does not require an installed Drupal site to exist.
// Therefore, its environment is identical to that of the early installer.
$this->serviceProviderClasses['app']['Test'] = 'Drupal\Core\Installer\InstallerServiceProvider';
+ return $this->serviceProviderClasses;
}
}
diff --git a/core/modules/config/tests/config_test/src/ConfigTestForm.php b/core/modules/config/tests/config_test/src/ConfigTestForm.php
index 19d297881383..6f1eac0b99f3 100644
--- a/core/modules/config/tests/config_test/src/ConfigTestForm.php
+++ b/core/modules/config/tests/config_test/src/ConfigTestForm.php
@@ -146,6 +146,7 @@ public function save(array $form, FormStateInterface $form_state) {
}
$form_state->setRedirectUrl($this->entity->toUrl('collection'));
+ return $status;
}
/**
diff --git a/core/modules/migrate_drupal_ui/tests/modules/migration_provider_test/src/Plugin/migrate/source/NoSourceModule.php b/core/modules/migrate_drupal_ui/tests/modules/migration_provider_test/src/Plugin/migrate/source/NoSourceModule.php
index 0fc3063bb66a..6971bbe4f4c7 100644
--- a/core/modules/migrate_drupal_ui/tests/modules/migration_provider_test/src/Plugin/migrate/source/NoSourceModule.php
+++ b/core/modules/migrate_drupal_ui/tests/modules/migration_provider_test/src/Plugin/migrate/source/NoSourceModule.php
@@ -16,16 +16,22 @@ class NoSourceModule extends DrupalSqlBase {
/**
* {@inheritdoc}
*/
- public function query() {}
+ public function query() {
+ throw new \BadMethodCallException('This method should never be called');
+ }
/**
* {@inheritdoc}
*/
- public function fields() {}
+ public function fields() {
+ throw new \BadMethodCallException('This method should never be called');
+ }
/**
* {@inheritdoc}
*/
- public function getIds() {}
+ public function getIds() {
+ throw new \BadMethodCallException('This method should never be called');
+ }
}
diff --git a/core/modules/search/tests/modules/search_extra_type/src/Plugin/Search/SearchExtraTypeSearch.php b/core/modules/search/tests/modules/search_extra_type/src/Plugin/Search/SearchExtraTypeSearch.php
index 6037653f750b..5726e247f656 100644
--- a/core/modules/search/tests/modules/search_extra_type/src/Plugin/Search/SearchExtraTypeSearch.php
+++ b/core/modules/search/tests/modules/search_extra_type/src/Plugin/Search/SearchExtraTypeSearch.php
@@ -26,6 +26,7 @@ public function setSearch($keywords, array $parameters, array $attributes) {
$parameters['search_conditions'] = '';
}
parent::setSearch($keywords, $parameters, $attributes);
+ return $this;
}
/**
diff --git a/core/modules/system/tests/modules/entity_test/src/Entity/EntityTestMulChanged.php b/core/modules/system/tests/modules/entity_test/src/Entity/EntityTestMulChanged.php
index 4cede02bcafa..4c2fd40b04ab 100644
--- a/core/modules/system/tests/modules/entity_test/src/Entity/EntityTestMulChanged.php
+++ b/core/modules/system/tests/modules/entity_test/src/Entity/EntityTestMulChanged.php
@@ -72,7 +72,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
public function save() {
// Ensure a new timestamp.
sleep(1);
- parent::save();
+ return parent::save();
}
}
diff --git a/core/modules/system/tests/modules/entity_test/src/EntityTestForm.php b/core/modules/system/tests/modules/entity_test/src/EntityTestForm.php
index d471d6058200..3ea354d54993 100644
--- a/core/modules/system/tests/modules/entity_test/src/EntityTestForm.php
+++ b/core/modules/system/tests/modules/entity_test/src/EntityTestForm.php
@@ -57,7 +57,7 @@ public function save(array $form, FormStateInterface $form_state) {
}
$is_new = $entity->isNew();
- $entity->save();
+ $status = $entity->save();
if ($is_new) {
$message = t('%entity_type @id has been created.', ['@id' => $entity->id(), '%entity_type' => $entity->getEntityTypeId()]);
@@ -83,6 +83,7 @@ public function save(array $form, FormStateInterface $form_state) {
catch (\Exception $e) {
\Drupal::state()->set('entity_test.form.save.exception', get_class($e) . ': ' . $e->getMessage());
}
+ return $status ?? FALSE;
}
}
diff --git a/core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/OperationBase.php b/core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/OperationBase.php
index e978f2a07082..1e0b2def1dc8 100644
--- a/core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/OperationBase.php
+++ b/core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/OperationBase.php
@@ -21,6 +21,7 @@ public function arguments() {
*/
public function execute(array $arguments) {
// Nothing to do.
+ return TRUE;
}
}
diff --git a/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockLayoutBlockDeriver.php b/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockLayoutBlockDeriver.php
index 9f25c046faca..c575dd0b5881 100644
--- a/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockLayoutBlockDeriver.php
+++ b/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockLayoutBlockDeriver.php
@@ -22,6 +22,7 @@ public function getDerivativeDefinition($derivative_id, $base_plugin_definition)
if (isset($derivatives[$derivative_id])) {
return $derivatives[$derivative_id];
}
+ return NULL;
}
/**
diff --git a/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php b/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php
index 254bbdb71330..d8031a7cf901 100644
--- a/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php
+++ b/core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php
@@ -22,6 +22,7 @@ public function getDerivativeDefinition($derivative_id, $base_plugin_definition)
if (isset($derivatives[$derivative_id])) {
return $derivatives[$derivative_id];
}
+ return NULL;
}
/**
diff --git a/core/modules/system/tests/modules/service_provider_test/src/TestFileUsage.php b/core/modules/system/tests/modules/service_provider_test/src/TestFileUsage.php
index 4189e498f901..c75b8cb11844 100644
--- a/core/modules/system/tests/modules/service_provider_test/src/TestFileUsage.php
+++ b/core/modules/system/tests/modules/service_provider_test/src/TestFileUsage.php
@@ -23,6 +23,7 @@ public function delete(FileInterface $file, $module, $type = NULL, $id = NULL, $
* {@inheritdoc}
*/
public function listUsage(FileInterface $file) {
+ return [];
}
}
diff --git a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php
index 5bc7a190cd6e..b9557d2ef003 100644
--- a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php
+++ b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php
@@ -23,9 +23,7 @@ protected function defineOptions() {
}
/**
- * Overrides Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
- *
- * @return array
+ * {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
diff --git a/core/phpstan-baseline.neon b/core/phpstan-baseline.neon
index e61ca1c182b5..beb105701dc4 100644
--- a/core/phpstan-baseline.neon
+++ b/core/phpstan-baseline.neon
@@ -225,11 +225,6 @@ parameters:
count: 1
path: lib/Drupal/Core/Entity/KeyValueStore/KeyValueContentEntityStorage.php
- -
- message: "#^Method Drupal\\\\Core\\\\Entity\\\\Plugin\\\\DataType\\\\Deriver\\\\EntityDeriver\\:\\:getDerivativeDefinition\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php
-
-
message: "#^Method Drupal\\\\Core\\\\Entity\\\\Query\\\\QueryBase\\:\\:getClass\\(\\) should return string but return statement is missing\\.$#"
count: 1
@@ -280,11 +275,6 @@ parameters:
count: 1
path: lib/Drupal/Core/Field/FieldTypePluginManager.php
- -
- message: "#^Method Drupal\\\\Core\\\\Field\\\\Plugin\\\\DataType\\\\Deriver\\\\FieldItemDeriver\\:\\:getDerivativeDefinition\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: lib/Drupal/Core/Field/Plugin/DataType/Deriver/FieldItemDeriver.php
-
-
message: "#^Call to deprecated constant REQUEST_TIME\\: Deprecated in drupal\\:8\\.3\\.0 and is removed from drupal\\:10\\.0\\.0\\. Use \\\\Drupal\\:\\:time\\(\\)\\-\\>getRequestTime\\(\\); $#"
count: 1
@@ -385,16 +375,6 @@ parameters:
count: 1
path: lib/Drupal/Core/Template/TwigPhpStorageCache.php
- -
- message: "#^Method Drupal\\\\Core\\\\Test\\\\TestRunnerKernel\\:\\:boot\\(\\) should return \\$this\\(Drupal\\\\Core\\\\Test\\\\TestRunnerKernel\\) but return statement is missing\\.$#"
- count: 1
- path: lib/Drupal/Core/Test/TestRunnerKernel.php
-
- -
- message: "#^Method Drupal\\\\Core\\\\Test\\\\TestRunnerKernel\\:\\:discoverServiceProviders\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: lib/Drupal/Core/Test/TestRunnerKernel.php
-
-
message: "#^Method Drupal\\\\Core\\\\Theme\\\\ThemeInitialization\\:\\:resolveStyleSheetPlaceholders\\(\\) should return string but return statement is missing\\.$#"
count: 1
@@ -550,11 +530,6 @@ parameters:
count: 1
path: modules/comment/tests/src/Functional/Views/DefaultViewRecentCommentsTest.php
- -
- message: "#^Method Drupal\\\\config_test\\\\ConfigTestForm\\:\\:save\\(\\) should return int but return statement is missing\\.$#"
- count: 1
- path: modules/config/tests/config_test/src/ConfigTestForm.php
-
-
message: "#^Call to deprecated constant REQUEST_TIME\\: Deprecated in drupal\\:8\\.3\\.0 and is removed from drupal\\:10\\.0\\.0\\. Use \\\\Drupal\\:\\:time\\(\\)\\-\\>getRequestTime\\(\\); $#"
count: 1
@@ -895,21 +870,6 @@ parameters:
count: 1
path: modules/migrate_drupal_ui/src/Form/ReviewForm.php
- -
- message: "#^Method Drupal\\\\migration_provider_test\\\\Plugin\\\\migrate\\\\source\\\\NoSourceModule\\:\\:fields\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: modules/migrate_drupal_ui/tests/modules/migration_provider_test/src/Plugin/migrate/source/NoSourceModule.php
-
- -
- message: "#^Method Drupal\\\\migration_provider_test\\\\Plugin\\\\migrate\\\\source\\\\NoSourceModule\\:\\:getIds\\(\\) should return array\\<array\\> but return statement is missing\\.$#"
- count: 1
- path: modules/migrate_drupal_ui/tests/modules/migration_provider_test/src/Plugin/migrate/source/NoSourceModule.php
-
- -
- message: "#^Method Drupal\\\\migration_provider_test\\\\Plugin\\\\migrate\\\\source\\\\NoSourceModule\\:\\:query\\(\\) should return Drupal\\\\Core\\\\Database\\\\Query\\\\SelectInterface but return statement is missing\\.$#"
- count: 1
- path: modules/migrate_drupal_ui/tests/modules/migration_provider_test/src/Plugin/migrate/source/NoSourceModule.php
-
-
message: "#^Call to an undefined method Drupal\\\\Tests\\\\migrate_drupal_ui\\\\Functional\\\\CredentialFormTest\\:\\:installEntitySchema\\(\\)\\.$#"
count: 8
@@ -1045,11 +1005,6 @@ parameters:
count: 1
path: modules/responsive_image/src/ResponsiveImageStyleForm.php
- -
- message: "#^Method Drupal\\\\rest\\\\Plugin\\\\Deriver\\\\EntityDeriver\\:\\:getDerivativeDefinition\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: modules/rest/src/Plugin/Deriver/EntityDeriver.php
-
-
message: "#^Method Drupal\\\\rest\\\\Routing\\\\ResourceRoutes\\:\\:onDynamicRouteEvent\\(\\) should return array but return statement is missing\\.$#"
count: 1
@@ -1080,11 +1035,6 @@ parameters:
count: 1
path: modules/search/src/SearchPageRepository.php
- -
- message: "#^Method Drupal\\\\search_extra_type\\\\Plugin\\\\Search\\\\SearchExtraTypeSearch\\:\\:setSearch\\(\\) should return \\$this\\(Drupal\\\\search_extra_type\\\\Plugin\\\\Search\\\\SearchExtraTypeSearch\\) but return statement is missing\\.$#"
- count: 1
- path: modules/search/tests/modules/search_extra_type/src/Plugin/Search/SearchExtraTypeSearch.php
-
-
message: "#^Call to deprecated constant REQUEST_TIME\\: Deprecated in drupal\\:8\\.3\\.0 and is removed from drupal\\:10\\.0\\.0\\. Use \\\\Drupal\\:\\:time\\(\\)\\-\\>getRequestTime\\(\\); $#"
count: 1
@@ -1160,16 +1110,6 @@ parameters:
count: 2
path: modules/system/tests/modules/entity_test/entity_test.install
- -
- message: "#^Method Drupal\\\\entity_test\\\\Entity\\\\EntityTestMulChanged\\:\\:save\\(\\) should return int but return statement is missing\\.$#"
- count: 1
- path: modules/system/tests/modules/entity_test/src/Entity/EntityTestMulChanged.php
-
- -
- message: "#^Method Drupal\\\\entity_test\\\\EntityTestForm\\:\\:save\\(\\) should return int but return statement is missing\\.$#"
- count: 1
- path: modules/system/tests/modules/entity_test/src/EntityTestForm.php
-
-
message: "#^Call to deprecated constant REQUEST_TIME\\: Deprecated in drupal\\:8\\.3\\.0 and is removed from drupal\\:10\\.0\\.0\\. Use \\\\Drupal\\:\\:time\\(\\)\\-\\>getRequestTime\\(\\); $#"
count: 1
@@ -1180,31 +1120,11 @@ parameters:
count: 1
path: modules/system/tests/modules/hold_test/src/EventSubscriber/HoldTestSubscriber.php
- -
- message: "#^Method Drupal\\\\image_test\\\\Plugin\\\\ImageToolkit\\\\Operation\\\\test\\\\OperationBase\\:\\:execute\\(\\) should return bool but return statement is missing\\.$#"
- count: 1
- path: modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/OperationBase.php
-
-
message: "#^Configuration entity must define a `config_export` key\\. See https\\://www\\.drupal\\.org/node/2481909$#"
count: 1
path: modules/system/tests/modules/module_installer_config_test/src/Entity/TestConfigType.php
- -
- message: "#^Method Drupal\\\\plugin_test\\\\Plugin\\\\plugin_test\\\\mock_block\\\\MockLayoutBlockDeriver\\:\\:getDerivativeDefinition\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockLayoutBlockDeriver.php
-
- -
- message: "#^Method Drupal\\\\plugin_test\\\\Plugin\\\\plugin_test\\\\mock_block\\\\MockMenuBlockDeriver\\:\\:getDerivativeDefinition\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php
-
- -
- message: "#^Method Drupal\\\\service_provider_test\\\\TestFileUsage\\:\\:listUsage\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: modules/system/tests/modules/service_provider_test/src/TestFileUsage.php
-
-
message: "#^Instantiated class Drupal\\\\Tests\\\\system\\\\Functional\\\\FileTransfer\\\\Exception not found\\.$#"
count: 1
@@ -1450,11 +1370,6 @@ parameters:
count: 1
path: modules/views/tests/modules/views_config_entity_test/src/Entity/ViewsConfigEntityTest.php
- -
- message: "#^Method Drupal\\\\views_test_data\\\\Plugin\\\\views\\\\filter\\\\FilterTest\\:\\:buildOptionsForm\\(\\) should return array but return statement is missing\\.$#"
- count: 1
- path: modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php
-
-
message: "#^Call to deprecated constant REQUEST_TIME\\: Deprecated in drupal\\:8\\.3\\.0 and is removed from drupal\\:10\\.0\\.0\\. Use \\\\Drupal\\:\\:time\\(\\)\\-\\>getRequestTime\\(\\); $#"
count: 1
--
GitLab