TestBase lacks a config method to be used consistently in tests

Relating issues

+++ b/core/modules/shortcut/src/Tests/ShortcutLinksTest.php
@@ -100,7 +100,7 @@ public function testShortcutLinkAdd() {
     $this->container->get('config.factory')->get('node.settings')->set('use_admin_theme', '1')->save();

We should convert direct accesses to the config.factory get method too. For example the above code.

+++ b/core/modules/simpletest/src/TestBase.php
@@ -1516,4 +1516,23 @@ public function copyConfig(StorageInterface $source_storage, StorageInterface $t
+  /**
+   * Configuration accessor for tests. Returns non-overriden configuration.
+   *
+   * @param $name
+   *   Configuration name.
+   *
+   * @return \Drupal\Core\Config\Config
+   *   The configuration object with original configuration data.
+   */
+  public function config($name) {
+    $config_factory = \Drupal::configFactory();
+    $old_state = $config_factory->getOverrideState();
+    $config_factory->setOverrideState(FALSE);
+    $config = $config_factory->get($name);
+    $config_factory->setOverrideState($old_state);
+    return $config;
+  }

Perhaps we should have some documentation about how to get overridden configuration if you need to. I've thought about making the overridden-ness determined by a parameter but I think maybe that is overkill - if you need to work with overrides this should be documented and the test can use the config factory directly.

FIxed code so that tests will run and so that phpunit passes. This is blocked on #2395511: Config static cache is not cleared properly on rename (for sure - Drupal\config\Tests\ConfigCRUDTest will fail due to this bug) and maybe #2395515: Config static cache is not cleared properly on delete.

Also given the plan outlined in #2392319-23: Config objects (but not config entities) should by default be immutable this issue might become implement ConfigEdittableTrait as use it in tests.

Blockers have landed.

Fixed tests failures from #12. I think this patch is good to go now. We might still have some problems in tests when implementing #2392319: Config objects (but not config entities) should by default be immutable but this should mean that we don't have to put the \Drupal::config and ConfigFactory::get() hacks to determine if being called from a test in.

core/modules/aggregator/src/Tests/FeedParserTest.php
core/modules/basic_auth/src/Tests/Authentication/BasicAuthTest.php
core/modules/block/src/Tests/BlockConfigSchemaTest.php
core/modules/block/src/Tests/BlockHiddenRegionTest.php
core/modules/block/src/Tests/BlockLanguageTest.php
core/modules/block/src/Tests/BlockStorageUnitTest.php
core/modules/block/src/Tests/BlockSystemBrandingTest.php
core/modules/block/src/Tests/BlockTest.php
core/modules/block/src/Tests/BlockTestBase.php
core/modules/block/src/Tests/BlockTitleXSSTest.php
core/modules/block/src/Tests/NewDefaultThemeBlocksTest.php
core/modules/block/src/Tests/Views/DisplayBlockTest.php
core/modules/block_content/src/Tests/BlockContentCreationTest.php
core/modules/block_content/src/Tests/BlockContentFieldTest.php
core/modules/block_content/src/Tests/BlockContentTypeTest.php
core/modules/book/src/Tests/BookTest.php
core/modules/book/src/Tests/BookUninstallTest.php
core/modules/ckeditor/src/Tests/CKEditorTest.php
core/modules/color/src/Tests/ColorTest.php
core/modules/comment/src/Tests/CommentLinksTest.php
core/modules/comment/src/Tests/CommentPreviewTest.php
core/modules/config/src/Tests/ConfigCRUDTest.php
core/modules/config/src/Tests/ConfigDependencyTest.php
core/modules/config/src/Tests/ConfigEntityNormalizeTest.php
core/modules/config/src/Tests/ConfigExportImportUITest.php
core/modules/config/src/Tests/ConfigFileContentTest.php
core/modules/config/src/Tests/ConfigImportAllTest.php
core/modules/config/src/Tests/ConfigImportRenameValidationTest.php
core/modules/config/src/Tests/ConfigImportUITest.php
core/modules/config/src/Tests/ConfigImporterTest.php
core/modules/config/src/Tests/ConfigInstallTest.php
core/modules/config/src/Tests/ConfigInstallWebTest.php
core/modules/config/src/Tests/ConfigLanguageOverrideWebTest.php
core/modules/config/src/Tests/ConfigModuleOverridesTest.php
core/modules/config/src/Tests/ConfigOtherModuleTest.php
core/modules/config/src/Tests/ConfigSchemaTest.php
core/modules/config/src/Tests/ConfigSingleImportExportTest.php
core/modules/config/src/Tests/ConfigSnapshotTest.php
core/modules/config/src/Tests/SchemaCheckTestTrait.php
core/modules/config/src/Tests/SchemaCheckTraitTest.php
core/modules/config/src/Tests/SchemaConfigListenerTest.php
core/modules/config/src/Tests/SchemaConfigListenerWebTest.php
core/modules/config/src/Tests/Storage/FileStorageTest.php
core/modules/config_translation/src/Tests/ConfigTranslationListUiTest.php
core/modules/config_translation/src/Tests/ConfigTranslationUiTest.php
core/modules/contact/src/Tests/ContactPersonalTest.php
core/modules/contact/src/Tests/ContactSitewideTest.php
core/modules/contact/src/Tests/ContactStorageTest.php
core/modules/content_translation/src/Tests/Views/ContentTranslationViewsUITest.php
core/modules/datetime/src/Tests/DateTimeFieldTest.php
core/modules/dblog/src/Tests/DbLogTest.php
core/modules/entity_reference/src/Tests/EntityReferenceFieldDefaultValueTest.php
core/modules/entity_reference/src/Tests/EntityReferenceSelectionAccessTest.php
core/modules/field/src/Tests/FieldCrudTest.php
core/modules/field/src/Tests/FieldImportDeleteUninstallTest.php
core/modules/field/src/Tests/FieldImportDeleteUninstallUiTest.php
core/modules/field/src/Tests/FieldStorageCrudTest.php
core/modules/field/src/Tests/FormTest.php
core/modules/field_ui/src/Tests/EntityDisplayTest.php
core/modules/field_ui/src/Tests/EntityFormDisplayTest.php
core/modules/field_ui/src/Tests/ManageFieldsTest.php
core/modules/file/src/Tests/DeleteTest.php
core/modules/file/src/Tests/DownloadTest.php
core/modules/file/src/Tests/FileFieldRevisionTest.php
core/modules/file/src/Tests/RemoteFileSaveUploadTest.php
core/modules/file/src/Tests/SaveUploadTest.php
core/modules/file/src/Tests/UsageTest.php
core/modules/filter/src/Tests/FilterAPITest.php
core/modules/filter/src/Tests/FilterAdminTest.php
core/modules/filter/src/Tests/FilterUnitTest.php
core/modules/forum/src/Tests/ForumTest.php
core/modules/forum/src/Tests/ForumUninstallTest.php
core/modules/image/src/Tests/ImageStylesPathAndUrlTest.php
core/modules/language/src/Tests/LanguageConfigSchemaTest.php
core/modules/language/src/Tests/LanguageConfigurationElementTest.php
core/modules/language/src/Tests/LanguageConfigurationTest.php
core/modules/language/src/Tests/LanguageDependencyInjectionTest.php
core/modules/language/src/Tests/LanguageNegotiationInfoTest.php
core/modules/language/src/Tests/LanguageUILanguageNegotiationTest.php
core/modules/language/src/Tests/LanguageUrlRewritingTest.php
core/modules/locale/src/Tests/LocaleConfigTranslationTest.php
core/modules/locale/src/Tests/LocaleImportFunctionalTest.php
core/modules/locale/src/Tests/LocaleLocaleLookupTest.php
core/modules/locale/src/Tests/LocalePathTest.php
core/modules/locale/src/Tests/LocaleTranslationUiTest.php
core/modules/locale/src/Tests/LocaleUpdateCronTest.php
core/modules/locale/src/Tests/LocaleUpdateTest.php
core/modules/menu_ui/src/Tests/MenuLanguageTest.php
core/modules/menu_ui/src/Tests/MenuTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateActionConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateAggregatorConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateBlockTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateBookConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateContactConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateDblogConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateDrupal6Test.php
core/modules/migrate_drupal/src/Tests/d6/MigrateFileConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateForumConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateLocaleConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateMenuConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateNodeConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSearchConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSimpletestConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateStatisticsConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSyslogConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemCronTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemFileTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemFilterTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemImageGdTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemImageTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemLoggingTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemMaintenanceTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemPerformanceTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemRssTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateSystemSiteTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateTaxonomyConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateTextConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateUpdateConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateUserConfigsTest.php
core/modules/migrate_drupal/src/Tests/d6/MigrateUserTest.php
core/modules/node/src/Tests/NodeAccessPagerTest.php
core/modules/node/src/Tests/NodeAccessTest.php
core/modules/node/src/Tests/NodeCreationTest.php
core/modules/node/src/Tests/Views/FrontPageTest.php
core/modules/node/src/Tests/Views/NodeLanguageTest.php
core/modules/rest/src/Tests/RESTTestBase.php
core/modules/rest/src/Tests/ResourceTest.php
core/modules/search/src/Tests/SearchMatchTest.php
core/modules/search/src/Tests/SearchMultilingualEntityTest.php
core/modules/search/src/Tests/SearchPageTextTest.php
core/modules/search/src/Tests/SearchRankingTest.php
core/modules/search/src/Tests/SearchTokenizerTest.php
core/modules/shortcut/src/Tests/ShortcutLinksTest.php
core/modules/simpletest/src/KernelTestBase.php
core/modules/simpletest/src/TestBase.php
core/modules/simpletest/src/Tests/KernelTestBaseTest.php
core/modules/simpletest/src/Tests/SimpleTestBrowserTest.php
core/modules/simpletest/src/WebTestBase.php
core/modules/statistics/src/Tests/StatisticsAdminTest.php
core/modules/statistics/src/Tests/StatisticsLoggingTest.php
core/modules/statistics/src/Tests/StatisticsTestBase.php
core/modules/statistics/src/Tests/Views/IntegrationTest.php
core/modules/system/src/Tests/Ajax/AjaxFormPageCacheTest.php
core/modules/system/src/Tests/Ajax/FrameworkTest.php
core/modules/system/src/Tests/Batch/PageTest.php
core/modules/system/src/Tests/Bootstrap/PageCacheTest.php
core/modules/system/src/Tests/Cache/PageCacheTagsIntegrationTest.php
core/modules/system/src/Tests/Cache/PageCacheTagsTestBase.php
core/modules/system/src/Tests/Common/AttachedAssetsTest.php
core/modules/system/src/Tests/Common/FormatDateTest.php
core/modules/system/src/Tests/Condition/CurrentThemeConditionTest.php
core/modules/system/src/Tests/Datetime/DrupalDateTimeTest.php
core/modules/system/src/Tests/Entity/ConfigEntityImportTest.php
core/modules/system/src/Tests/Extension/ThemeHandlerTest.php
core/modules/system/src/Tests/File/DirectoryTest.php
core/modules/system/src/Tests/File/NameMungingTest.php
core/modules/system/src/Tests/File/RemoteFileDirectoryTest.php
core/modules/system/src/Tests/File/RemoteFileScanDirectoryTest.php
core/modules/system/src/Tests/File/RemoteFileUnmanagedCopyTest.php
core/modules/system/src/Tests/File/RemoteFileUnmanagedDeleteRecursiveTest.php
core/modules/system/src/Tests/File/RemoteFileUnmanagedDeleteTest.php
core/modules/system/src/Tests/File/RemoteFileUnmanagedMoveTest.php
core/modules/system/src/Tests/File/RemoteFileUnmanagedSaveDataTest.php
core/modules/system/src/Tests/File/StreamWrapperTest.php
core/modules/system/src/Tests/Form/ConfirmFormTest.php
core/modules/system/src/Tests/Form/FormStoragePageCacheTest.php
core/modules/system/src/Tests/Image/ToolkitSetupFormTest.php
core/modules/system/src/Tests/Mail/MailTest.php
core/modules/system/src/Tests/Menu/BreadcrumbTest.php
core/modules/system/src/Tests/Menu/MenuRouterTest.php
core/modules/system/src/Tests/Module/DependencyTest.php
core/modules/system/src/Tests/Module/InstallTest.php
core/modules/system/src/Tests/Module/InstallUninstallTest.php
core/modules/system/src/Tests/Module/ModuleTestBase.php
core/modules/system/src/Tests/Path/UrlAlterFunctionalTest.php
core/modules/system/src/Tests/Routing/ExceptionHandlingTest.php
core/modules/system/src/Tests/Session/SessionTest.php
core/modules/system/src/Tests/System/AccessDeniedTest.php
core/modules/system/src/Tests/System/CronRunTest.php
core/modules/system/src/Tests/System/DateTimeTest.php
core/modules/system/src/Tests/System/ErrorHandlerTest.php
core/modules/system/src/Tests/System/FrontPageTest.php
core/modules/system/src/Tests/System/SiteMaintenanceTest.php
core/modules/system/src/Tests/System/SystemConfigFormTestBase.php
core/modules/system/src/Tests/System/ThemeTest.php
core/modules/system/src/Tests/System/TokenReplaceUnitTest.php
core/modules/system/src/Tests/Theme/EnginePhpTemplateTest.php
core/modules/system/src/Tests/Theme/EngineTwigTest.php
core/modules/system/src/Tests/Theme/EntityFilteringThemeTest.php
core/modules/system/src/Tests/Theme/ThemeInfoTest.php
core/modules/system/src/Tests/Theme/ThemeSuggestionsAlterTest.php
core/modules/system/src/Tests/Theme/ThemeTest.php
core/modules/system/src/Tests/Theme/TwigDebugMarkupTest.php
core/modules/system/src/Tests/Theme/TwigExtensionTest.php
core/modules/system/src/Tests/Theme/TwigTransTest.php
core/modules/system/src/Tests/Update/UpdateScriptTest.php
core/modules/taxonomy/src/Tests/TermLanguageTest.php
core/modules/taxonomy/src/Tests/TermTest.php
core/modules/taxonomy/src/Tests/ThemeTest.php
core/modules/taxonomy/src/Tests/Views/RelationshipNodeTermDataTest.php
core/modules/taxonomy/src/Tests/VocabularyUiTest.php
core/modules/tracker/src/Tests/TrackerTest.php
core/modules/update/src/Tests/UpdateContribTest.php
core/modules/update/src/Tests/UpdateCoreTest.php
core/modules/update/src/Tests/UpdateDeleteFileIfStaleTest.php
core/modules/update/src/Tests/UpdateTestBase.php
core/modules/update/src/Tests/UpdateUploadTest.php
core/modules/user/src/Tests/UserAccountFormFieldsTest.php
core/modules/user/src/Tests/UserAccountLinksTests.php
core/modules/user/src/Tests/UserActionConfigSchemaTest.php
core/modules/user/src/Tests/UserAdminTest.php
core/modules/user/src/Tests/UserAutocompleteTest.php
core/modules/user/src/Tests/UserCancelTest.php
core/modules/user/src/Tests/UserCreateFailMailTest.php
core/modules/user/src/Tests/UserCreateTest.php
core/modules/user/src/Tests/UserEditTest.php
core/modules/user/src/Tests/UserEditedOwnAccountTest.php
core/modules/user/src/Tests/UserEntityCallbacksTest.php
core/modules/user/src/Tests/UserLoginTest.php
core/modules/user/src/Tests/UserPasswordResetTest.php
core/modules/user/src/Tests/UserPictureTest.php
core/modules/user/src/Tests/UserRegistrationTest.php
core/modules/user/src/Tests/UserSignatureTest.php
core/modules/user/src/Tests/UserTimeZoneTest.php
core/modules/user/src/Tests/Views/BulkFormTest.php
core/modules/user/src/Tests/Views/HandlerArgumentUserUidTest.php
core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php
core/modules/views/src/Tests/Entity/ViewEntityDependenciesTest.php
core/modules/views/src/Tests/Handler/HandlerTest.php
core/modules/views/src/Tests/Plugin/BlockDependenciesTest.php
core/modules/views/src/Tests/Plugin/DisplayExtenderTest.php
core/modules/views/src/Tests/Plugin/DisplayFeedTest.php
core/modules/views/src/Tests/Plugin/DisplayTest.php
core/modules/views/src/Tests/ViewStorageTest.php
core/modules/views/src/Tests/ViewsThemeIntegrationTest.php
core/modules/views/src/Tests/Wizard/BasicTest.php
core/modules/views/src/Tests/Wizard/ItemsPerPageTest.php
core/modules/views/src/Tests/Wizard/WizardPluginBaseUnitTest.php
core/modules/views_ui/src/Tests/DefaultViewsTest.php
core/modules/views_ui/src/Tests/DisplayCRUDTest.php
core/modules/views_ui/src/Tests/DisplayExtenderUITest.php
core/modules/views_ui/src/Tests/DisplayTest.php
core/modules/views_ui/src/Tests/OverrideDisplaysTest.php
core/profiles/standard/src/Tests/StandardTest.php

As we can see only test code is changing so a green result should mean we are good to go here.

The patch needed a reroll - hence the pseudo interdiff.

I'm still reviewing, but here's a reroll in the meantime.

A few more conversions.

Most of the 280K patch is straightforward conversions of \Drupal::config() and $this->container->get('config.factory')->get() to $this->config() within tests.

Here I'm attaching the hunks of the patch that are not that. This is the only part that could use a little more thorough human review.

TestBase will have a new config method to be used internally in tests.

How about we make it protected then? Done in this patch.

Other than that, I think this ready, but will wait for feedback on my interdiffs before RTBC'ing.

@effulgentsia nice finds and happy to see the method protected - not sure that this really matters since tests, but it's for the best. Would be really happy to see this get done quickly so we can proceed with discussions, investigations and patches on #2392319: Config objects (but not config entities) should by default be immutable.

Great!

A new one crept in in #2393577: Access issue with default settings set to disabled.

Committed/pushed to 8.0.x, thanks!