function LegacySettingsRewriteTest::testDrupalRewriteSettings

Tests the drupal_rewrite_settings() function.

File

core/tests/Drupal/KernelTests/Core/Site/LegacySettingsRewriteTest.php, line 22

Class

LegacySettingsRewriteTest

Tests the drupal_rewrite_settings() function.

Namespace

Code

public function testDrupalRewriteSettings() : void {
    include_once $this->root . '/core/includes/install.inc';
    $site_path = $this->container
        ->getParameter('site.path');
    $tests = [
        [
            'original' => '$no_index_value_scalar = TRUE;',
            'settings' => [
                'no_index_value_scalar' => (object) [
                    'value' => FALSE,
                    'comment' => 'comment',
                ],
            ],
            'expected' => '$no_index_value_scalar = false; // comment',
        ],
        [
            'original' => '$no_index_value_scalar = TRUE;',
            'settings' => [
                'no_index_value_foo' => [
                    'foo' => [
                        'value' => (object) [
                            'value' => NULL,
                            'required' => TRUE,
                            'comment' => 'comment',
                        ],
                    ],
                ],
            ],
            'expected' => <<<'EXPECTED'
$no_index_value_scalar = TRUE;
$no_index_value_foo['foo']['value'] = NULL; // comment
EXPECTED
,
        ],
        [
            'original' => '$no_index_value_array = array("old" => "value");',
            'settings' => [
                'no_index_value_array' => (object) [
                    'value' => FALSE,
                    'required' => TRUE,
                    'comment' => 'comment',
                ],
            ],
            'expected' => '$no_index_value_array = array("old" => "value");
$no_index_value_array = false; // comment',
        ],
        [
            'original' => '$has_index_value_scalar["foo"]["bar"] = NULL;',
            'settings' => [
                'has_index_value_scalar' => [
                    'foo' => [
                        'bar' => (object) [
                            'value' => FALSE,
                            'required' => TRUE,
                            'comment' => 'comment',
                        ],
                    ],
                ],
            ],
            'expected' => '$has_index_value_scalar["foo"]["bar"] = false; // comment',
        ],
        [
            'original' => '$has_index_value_scalar["foo"]["bar"] = "foo";',
            'settings' => [
                'has_index_value_scalar' => [
                    'foo' => [
                        'value' => (object) [
                            'value' => [
                                'value' => 2,
                            ],
                            'required' => TRUE,
                            'comment' => 'comment',
                        ],
                    ],
                ],
            ],
            'expected' => <<<'EXPECTED'
$has_index_value_scalar["foo"]["bar"] = "foo";
$has_index_value_scalar['foo']['value'] = array (
  'value' => 2,
); // comment
EXPECTED
,
        ],
    ];
    foreach ($tests as $test) {
        $filename = Settings::get('file_public_path', $site_path . '/files') . '/mock_settings.php';
        file_put_contents($filename, "<?php\n" . $test['original'] . "\n");
        $this->expectDeprecation('drupal_rewrite_settings() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use SettingsEditor::rewrite() instead. The order of the arguments has also changed: $settings_file is now required and is the first argument of the method. See https://www.drupal.org/node/3244583');
        drupal_rewrite_settings($test['settings'], $filename);
        $this->assertEquals("<?php\n" . $test['expected'] . "\n", file_get_contents($filename));
    }
    // Test that <?php gets added to the start of an empty settings file.
    // Set the array of settings that will be written to the file.
    $test = [
        'settings' => [
            'no_index' => (object) [
                'value' => TRUE,
                'required' => TRUE,
            ],
        ],
        'expected' => '$no_index = true;',
    ];
    // Make an empty file.
    $filename = Settings::get('file_public_path', $site_path . '/files') . '/mock_settings.php';
    file_put_contents($filename, "");
    $this->expectDeprecation('drupal_rewrite_settings() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use SettingsEditor::rewrite() instead. The order of the arguments has also changed: $settings_file is now required and is the first argument of the method. See https://www.drupal.org/node/3244583');
    // Write the setting to the file.
    drupal_rewrite_settings($test['settings'], $filename);
    // Check that the result is just the php opening tag and the settings.
    $this->assertEquals("<?php\n" . $test['expected'] . "\n", file_get_contents($filename));
}