PB-29148 Remove config endpoints from selenium api plugin

Author: stripthis

config/bootstrap.php

@@ -13,16 +13,7 @@
  * @since         2.0.0
  */
 use Cake\Core\Configure;
-use Cake\Core\Configure\Engine\PhpConfig;
 
-/*
- * Load Selenium testing extra config if any
- * This allow redefining server config on the fly when running integration tests
- */
 if (Configure::read('debug') && Configure::read('passbolt.selenium.active')) {
     Configure::load('PassboltSeleniumApi.config', 'default', true);
-    if (file_exists(TMP . 'selenium' . DS . 'core_extra_config.php')) {
-        Configure::config('extra_config', new PhpConfig(TMP . 'selenium' . DS));
-        Configure::load('core_extra_config', 'extra_config', true);
-    }
 }

config/config.php

@@ -9,6 +9,11 @@
                         'unlockedActions' => [
                             'Config' => ['setExtraConfig']
                         ]
+                    ],
+                    'endpoints' => [
+                        'reset' => filter_var(env('PASSBOLT_PLUGIN_SELENIUM_API_SECURITY_ENDPOINTS_RESET', false), FILTER_VALIDATE_BOOLEAN),
+                        'error' => filter_var(env('PASSBOLT_PLUGIN_SELENIUM_API_SECURITY_ENDPOINTS_ERROR', true), FILTER_VALIDATE_BOOLEAN),
+                        'email' => filter_var(env('PASSBOLT_PLUGIN_SELENIUM_API_SECURITY_ENDPOINTS_EMAIL', true), FILTER_VALIDATE_BOOLEAN),
                     ]
                 ],
             ]

config/routes.php

@@ -14,44 +14,43 @@
  */
 
 /** @var \Cake\Routing\RouteBuilder $routes */
+use Cake\Core\Configure;
 
 /**
  * Selenium tests routes
  */
 $routes->plugin('PassboltSeleniumApi', ['path' => '/seleniumtests'], function ($routes) {
     $routes->setExtensions(['json']);
 
-    $routes->connect('/resetInstance/{dataset}', ['controller' => 'ResetInstance', 'action' => 'resetInstance'])
-        ->setPass(['dataset'])
-        ->setMethods(['GET']);
+    if (Configure::read('passbolt.plugins.selenium_api.security.endpoints.reset')) {
+        $routes->connect('/resetInstance/{dataset}', ['controller' => 'ResetInstance', 'action' => 'resetInstance'])
+            ->setPass(['dataset'])
+            ->setMethods(['GET']);
+    }
 
-    $routes->connect('/config', ['controller' => 'Config', 'action' => 'index'])
-        ->setMethods(['GET']);
+    if (Configure::read('passbolt.plugins.selenium_api.security.endpoints.error')) {
+        $routes->connect('/error400', ['controller' => 'SimulateError', 'action' => 'error400'])
+            ->setMethods(['GET']);
 
-    $routes->connect('/setExtraConfig', ['controller' => 'Config', 'action' => 'setExtraConfig'])
-        ->setMethods(['POST']);
+        $routes->connect('/error404', ['controller' => 'SimulateError', 'action' => 'error404'])
+            ->setMethods(['GET']);
 
-    $routes->connect('/resetExtraConfig', ['controller' => 'Config', 'action' => 'resetExtraConfig'])
-        ->setMethods(['GET']);
+        $routes->connect('/error403', ['controller' => 'SimulateError', 'action' => 'error403'])
+            ->setMethods(['GET']);
 
-    $routes->connect('/error400', ['controller' => 'SimulateError', 'action' => 'error400'])
-        ->setMethods(['GET']);
+        $routes->connect('/error500', ['controller' => 'SimulateError', 'action' => 'error500'])
+            ->setMethods(['GET']);
+    }
 
-    $routes->connect('/error404', ['controller' => 'SimulateError', 'action' => 'error404'])
-        ->setMethods(['GET']);
+    if (Configure::read('passbolt.plugins.selenium_api.security.endpoints.email')) {
+        $routes->connect('/showlastemail/{username}', ['controller' => 'Email', 'action' => 'showLastEmail'])
+            ->setPass(['username'])
+            ->setMethods(['GET']);
 
-    $routes->connect('/error403', ['controller' => 'SimulateError', 'action' => 'error403'])
-        ->setMethods(['GET']);
+        // Legacy v1 backward compatibility routes
+        $routes->connect('/showLastEmail/{username}', ['controller' => 'Email', 'action' => 'showLastEmail'])
+            ->setPass(['username'])
+            ->setMethods(['GET']);
+    }
 
-    $routes->connect('/error500', ['controller' => 'SimulateError', 'action' => 'error500'])
-        ->setMethods(['GET']);
-
-    $routes->connect('/showlastemail/{username}', ['controller' => 'Email', 'action' => 'showLastEmail'])
-        ->setPass(['username'])
-        ->setMethods(['GET']);
-
-    // Legacy v1 backward compatibility routes
-    $routes->connect('/showLastEmail/{username}', ['controller' => 'Email', 'action' => 'showLastEmail'])
-        ->setPass(['username'])
-        ->setMethods(['GET']);
 });

src/Controller/ConfigController.php

@@ -16,9 +16,34 @@
 
 use App\Test\Lib\AppIntegrationTestCase;
 use Cake\Core\Configure;
+use PassboltSeleniumApi\Controller\ConfigController;
 
 class SimulateErrorsControllerTest extends AppIntegrationTestCase
 {
+    /** @var bool error endpoint flag */
+    private $default;
+
+    /**
+     * @return void
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->default = Configure::read('passbolt.plugins.selenium_api.security.endpoints.error');
+        Configure::write('passbolt.plugins.selenium_api.security.endpoints.error', true);
+    }
+
+    /**
+     * Clears the state used for tests.
+     *
+     * @return void
+     */
+    public function tearDown(): void
+    {
+        Configure::write('passbolt.plugins.selenium_api.security.endpoints.error', $this->default);
+        parent::tearDown();
+    }
+
     public function testSimulateError404()
     {
         $this->getJson('/seleniumtests/error404.json');