Further improve unit tests

tvdijen · thijskh · commit 22ca8fee74d0 · 2025-06-04T14:38:17.000+02:00
diff --git a/modules/cron/src/Controller/Cron.php b/modules/cron/src/Controller/Cron.php
@@ -135,7 +135,7 @@ public function run(string $tag, string $key, string $output = 'xhtml'): Respons
             $key,
             $configKey,
             'Cron: Wrong key %s provided. Cron will not run.',
-            Error\ConfigurationError::class,
+            Error\Exception::class,
         );
 
         $cron = new \SimpleSAML\Module\cron\Cron();
diff --git a/tests/modules/cron/src/Controller/CronTest.php b/tests/modules/cron/src/Controller/CronTest.php
@@ -5,6 +5,7 @@
 namespace SimpleSAML\Test\Module\cron\Controller;
 
 use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use SimpleSAML\Configuration;
 use SimpleSAML\Error;
@@ -98,7 +99,7 @@ public function testInfo(): void
 
     /**
      */
-    public function testRun(): void
+    public function testRunCorrectKey(): void
     {
         $_SERVER['REQUEST_URI'] = '/module.php/cron/run/daily/verysecret';
 
@@ -117,16 +118,75 @@ public function testRun(): void
 
     /**
      */
-    public function testRunConfiguredSecret(): void
+    public function testRunWrongKey(): void
     {
-        $_SERVER['REQUEST_URI'] = '/module.php/cron/run/daily/secret';
+        $_SERVER['REQUEST_URI'] = '/module.php/cron/run/daily/nodice';
+
+        $c = new Controller\Cron($this->config, $this->session);
+
+        $this->expectException(Error\Exception::class);
+        $this->expectExceptionMessage('Cron: Wrong key "nodice" provided. Cron will not run.');
+
+        $c->run('daily', 'nodice');
+    }
+
+
+    /**
+     */
+    #[DataProvider('provideDefaultSecret')]
+    public function testRunDefaultSecret(string $secret): void
+    {
+        $_SERVER['REQUEST_URI'] = '/module.php/cron/run/daily/' . $secret;
 
         $c = new Controller\Cron($this->config, $this->session);
 
         $this->expectException(Error\ConfigurationError::class);
         $this->expectExceptionMessage('Cron: Possible malicious attempt to run cron tasks with default secret');
 
-        $response = $c->run('daily', 'secret');
-        $this->assertFalse($response->isSuccessful());
+        $c->run('daily', $secret);
+    }
+
+
+    /**
+     */
+    #[DataProvider('provideDefaultSecret')]
+    public function testRunDefaultConfigSecret(string $configKey): void
+    {
+        Configuration::setPreLoadedConfig(
+            Configuration::loadFromArray(
+                [
+                    'key' => $configKey,
+                    'allowed_tags' => ['daily'],
+                    'sendemail' => false,
+                ],
+                '[ARRAY]',
+                'simplesaml',
+            ),
+            'module_cron.php',
+            'simplesaml',
+        );
+
+        $_SERVER['REQUEST_URI'] = '/module.php/cron/run/daily/verysecret';
+
+        $c = new Controller\Cron($this->config, $this->session);
+
+        $this->expectException(Error\ConfigurationError::class);
+        $this->expectExceptionMessage('Cron: no proper key has been configured.');
+
+        $c->run('daily', 'verysecret');
+    }
+
+
+    /**
+     * @return array<int, array{0: string}>
+     */
+    public static function provideDefaultSecret(): array
+    {
+        return [
+            // Config template
+            ['secret'],
+            // Documentation inside several modules
+            ['RANDOM_KEY'],
+        ];
     }
 }
