ConfigDependenciesTest.php

<?php

namespace Drupal\Tests\hal\Kernel\rest\Entity;

use Drupal\KernelTests\KernelTestBase;
use Drupal\rest\Entity\ConfigDependencies;
use Drupal\rest\Entity\RestResourceConfig;
use Drupal\rest\RestResourceConfigInterface;

/**
 * @coversDefaultClass \Drupal\rest\Entity\ConfigDependencies
 *
 * @group hal
 * @group legacy
 */
class ConfigDependenciesTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'rest',
        'entity_test',
        'serialization',
    ];
    
    /**
     * @covers ::calculateDependencies
     *
     * @dataProvider providerBasicDependencies
     */
    public function testCalculateDependencies(array $configuration) {
        $config_dependencies = new ConfigDependencies([
            'hal_json' => 'hal',
            'json' => 'serialization',
        ], [
            'basic_auth' => 'basic_auth',
        ]);
        $rest_config = RestResourceConfig::create($configuration);
        $result = $config_dependencies->calculateDependencies($rest_config);
        $this->assertEquals([
            'module' => [
                'basic_auth',
                'serialization',
                'hal',
            ],
        ], $result);
    }
    
    /**
     * @covers ::onDependencyRemoval
     * @covers ::onDependencyRemovalForMethodGranularity
     * @covers ::onDependencyRemovalForResourceGranularity
     *
     * @dataProvider providerBasicDependencies
     */
    public function testOnDependencyRemovalRemoveUnrelatedDependency(array $configuration) {
        $config_dependencies = new ConfigDependencies([
            'hal_json' => 'hal',
            'json' => 'serialization',
        ], [
            'basic_auth' => 'basic_auth',
        ]);
        $rest_config = RestResourceConfig::create($configuration);
        $this->assertFalse($config_dependencies->onDependencyRemoval($rest_config, [
            'module' => [
                'node',
            ],
        ]));
        $this->assertEquals($configuration['configuration'], $rest_config->get('configuration'));
    }
    
    /**
     * @return array
     *   An array with numerical keys:
     *   0. The original REST resource configuration.
     */
    public function providerBasicDependencies() {
        return [
            'method' => [
                [
                    'plugin_id' => 'entity:entity_test',
                    'granularity' => RestResourceConfigInterface::METHOD_GRANULARITY,
                    'configuration' => [
                        'GET' => [
                            'supported_auth' => [
                                'basic_auth',
                            ],
                            'supported_formats' => [
                                'json',
                            ],
                        ],
                        'POST' => [
                            'supported_auth' => [
                                'cookie',
                            ],
                            'supported_formats' => [
                                'hal_json',
                            ],
                        ],
                    ],
                ],
            ],
            'resource' => [
                [
                    'plugin_id' => 'entity:entity_test',
                    'granularity' => RestResourceConfigInterface::RESOURCE_GRANULARITY,
                    'configuration' => [
                        'methods' => [
                            'GET',
                            'POST',
                        ],
                        'formats' => [
                            'json',
                            'hal_json',
                        ],
                        'authentication' => [
                            'cookie',
                            'basic_auth',
                        ],
                    ],
                ],
            ],
        ];
    }
    
    /**
     * @covers ::onDependencyRemoval
     * @covers ::onDependencyRemovalForMethodGranularity
     */
    public function testOnDependencyRemovalRemoveFormatForMethodGranularity() {
        $config_dependencies = new ConfigDependencies([
            'hal_json' => 'hal',
            'json' => 'serialization',
        ], [
            'basic_auth' => 'basic_auth',
        ]);
        $rest_config = RestResourceConfig::create([
            'plugin_id' => 'entity:entity_test',
            'granularity' => RestResourceConfigInterface::METHOD_GRANULARITY,
            'configuration' => [
                'GET' => [
                    'supported_auth' => [
                        'cookie',
                    ],
                    'supported_formats' => [
                        'json',
                    ],
                ],
                'POST' => [
                    'supported_auth' => [
                        'basic_auth',
                    ],
                    'supported_formats' => [
                        'hal_json',
                    ],
                ],
            ],
        ]);
        $this->assertTrue($config_dependencies->onDependencyRemoval($rest_config, [
            'module' => [
                'hal',
            ],
        ]));
        $this->assertEquals([
            'json',
        ], $rest_config->getFormats('GET'));
        $this->assertEquals([], $rest_config->getFormats('POST'));
        $this->assertEquals([
            'GET' => [
                'supported_auth' => [
                    'cookie',
                ],
                'supported_formats' => [
                    'json',
                ],
            ],
            'POST' => [
                'supported_auth' => [
                    'basic_auth',
                ],
            ],
        ], $rest_config->get('configuration'));
    }
    
    /**
     * @covers ::onDependencyRemoval
     * @covers ::onDependencyRemovalForMethodGranularity
     */
    public function testOnDependencyRemovalRemoveAuth() {
        $config_dependencies = new ConfigDependencies([
            'hal_json' => 'hal',
            'json' => 'serialization',
        ], [
            'basic_auth' => 'basic_auth',
        ]);
        $rest_config = RestResourceConfig::create([
            'plugin_id' => 'entity:entity_test',
            'granularity' => RestResourceConfigInterface::METHOD_GRANULARITY,
            'configuration' => [
                'GET' => [
                    'supported_auth' => [
                        'cookie',
                    ],
                    'supported_formats' => [
                        'json',
                    ],
                ],
                'POST' => [
                    'supported_auth' => [
                        'basic_auth',
                    ],
                    'supported_formats' => [
                        'hal_json',
                    ],
                ],
            ],
        ]);
        $this->assertTrue($config_dependencies->onDependencyRemoval($rest_config, [
            'module' => [
                'basic_auth',
            ],
        ]));
        $this->assertEquals([
            'cookie',
        ], $rest_config->getAuthenticationProviders('GET'));
        $this->assertEquals([], $rest_config->getAuthenticationProviders('POST'));
        $this->assertEquals([
            'GET' => [
                'supported_auth' => [
                    'cookie',
                ],
                'supported_formats' => [
                    'json',
                ],
            ],
            'POST' => [
                'supported_formats' => [
                    'hal_json',
                ],
            ],
        ], $rest_config->get('configuration'));
    }
    
    /**
     * @covers ::onDependencyRemoval
     * @covers ::onDependencyRemovalForMethodGranularity
     */
    public function testOnDependencyRemovalRemoveAuthAndFormats() {
        $config_dependencies = new ConfigDependencies([
            'hal_json' => 'hal',
            'json' => 'serialization',
        ], [
            'basic_auth' => 'basic_auth',
        ]);
        $rest_config = RestResourceConfig::create([
            'plugin_id' => 'entity:entity_test',
            'granularity' => RestResourceConfigInterface::METHOD_GRANULARITY,
            'configuration' => [
                'GET' => [
                    'supported_auth' => [
                        'cookie',
                    ],
                    'supported_formats' => [
                        'json',
                    ],
                ],
                'POST' => [
                    'supported_auth' => [
                        'basic_auth',
                    ],
                    'supported_formats' => [
                        'hal_json',
                    ],
                ],
            ],
        ]);
        $this->assertTrue($config_dependencies->onDependencyRemoval($rest_config, [
            'module' => [
                'basic_auth',
                'hal',
            ],
        ]));
        $this->assertEquals([
            'json',
        ], $rest_config->getFormats('GET'));
        $this->assertEquals([
            'cookie',
        ], $rest_config->getAuthenticationProviders('GET'));
        $this->assertEquals([], $rest_config->getFormats('POST'));
        $this->assertEquals([], $rest_config->getAuthenticationProviders('POST'));
        $this->assertEquals([
            'GET' => [
                'supported_auth' => [
                    'cookie',
                ],
                'supported_formats' => [
                    'json',
                ],
            ],
        ], $rest_config->get('configuration'));
    }
    
    /**
     * @covers ::onDependencyRemoval
     * @covers ::onDependencyRemovalForResourceGranularity
     *
     * @dataProvider providerOnDependencyRemovalForResourceGranularity
     */
    public function testOnDependencyRemovalForResourceGranularity(array $configuration, $module, $expected_configuration) {
        assert(is_string($module));
        assert($expected_configuration === FALSE || is_array($expected_configuration));
        $config_dependencies = new ConfigDependencies([
            'hal_json' => 'hal',
            'json' => 'serialization',
        ], [
            'basic_auth' => 'basic_auth',
        ]);
        $rest_config = RestResourceConfig::create($configuration);
        $this->assertSame(!empty($expected_configuration), $config_dependencies->onDependencyRemoval($rest_config, [
            'module' => [
                $module,
            ],
        ]));
        if (!empty($expected_configuration)) {
            $this->assertEquals($expected_configuration, $rest_config->get('configuration'));
        }
    }
    
    /**
     * @return array
     *   An array with numerical keys:
     *   0. The original REST resource configuration.
     *   1. The module to uninstall (the dependency that is about to be removed).
     *   2. The expected configuration after uninstalling this module.
     */
    public function providerOnDependencyRemovalForResourceGranularity() {
        return [
            'resource with multiple formats' => [
                [
                    'plugin_id' => 'entity:entity_test',
                    'granularity' => RestResourceConfigInterface::RESOURCE_GRANULARITY,
                    'configuration' => [
                        'methods' => [
                            'GET',
                            'POST',
                        ],
                        'formats' => [
                            'json',
                            'hal_json',
                        ],
                        'authentication' => [
                            'cookie',
                            'basic_auth',
                        ],
                    ],
                ],
                'hal',
                [
                    'methods' => [
                        'GET',
                        'POST',
                    ],
                    'formats' => [
                        'json',
                    ],
                    'authentication' => [
                        'cookie',
                        'basic_auth',
                    ],
                ],
            ],
            'resource with only HAL+JSON format' => [
                [
                    'plugin_id' => 'entity:entity_test',
                    'granularity' => RestResourceConfigInterface::RESOURCE_GRANULARITY,
                    'configuration' => [
                        'methods' => [
                            'GET',
                            'POST',
                        ],
                        'formats' => [
                            'hal_json',
                        ],
                        'authentication' => [
                            'cookie',
                            'basic_auth',
                        ],
                    ],
                ],
                'hal',
                FALSE,
            ],
            'resource with multiple authentication providers' => [
                [
                    'plugin_id' => 'entity:entity_test',
                    'granularity' => RestResourceConfigInterface::RESOURCE_GRANULARITY,
                    'configuration' => [
                        'methods' => [
                            'GET',
                            'POST',
                        ],
                        'formats' => [
                            'json',
                            'hal_json',
                        ],
                        'authentication' => [
                            'cookie',
                            'basic_auth',
                        ],
                    ],
                ],
                'basic_auth',
                [
                    'methods' => [
                        'GET',
                        'POST',
                    ],
                    'formats' => [
                        'json',
                        'hal_json',
                    ],
                    'authentication' => [
                        'cookie',
                    ],
                ],
            ],
            'resource with only basic_auth authentication' => [
                [
                    'plugin_id' => 'entity:entity_test',
                    'granularity' => RestResourceConfigInterface::RESOURCE_GRANULARITY,
                    'configuration' => [
                        'methods' => [
                            'GET',
                            'POST',
                        ],
                        'formats' => [
                            'json',
                            'hal_json',
                        ],
                        'authentication' => [
                            'basic_auth',
                        ],
                    ],
                ],
                'basic_auth',
                FALSE,
            ],
        ];
    }

}