Convert exceptions to static methods

Author: GromNaN

lib/Doctrine/ODM/MongoDB/Configuration.php

@@ -180,7 +180,7 @@ public function getDriverOptions(): array
     public function getClientEncryptionOptions(): array
     {
         if (! isset($this->attributes['kmsProvider'])) {
-            throw new ConfigurationException('MongoDB client encryption options are not set in configuration');
+            throw ConfigurationException::clientEncryptionOptionsNotSet();
         }
 
         return array_intersect_key($this->getAutoEncryptionOptions(), [
@@ -719,11 +719,11 @@ public function isLazyGhostObjectEnabled(): bool
     public function setKmsProvider(array $kmsProvider): void
     {
         if (! isset($kmsProvider['name'])) {
-            throw new ConfigurationException('The "name" KMS provider option is required.');
+            throw ConfigurationException::kmsProviderNameRequired();
         }
 
         if (! is_string($kmsProvider['name'])) {
-            throw new ConfigurationException('The "name" KMS provider option must be a non-empty string.');
+            throw ConfigurationException::kmsProviderNameMustBeString();
         }
 
         $this->attributes['kmsProvider'] = $kmsProvider;
@@ -749,7 +749,7 @@ public function setDefaultMasterKey(?array $masterKey): void
     public function setAutoEncryption(array $options): void
     {
         if (isset($options['kmsProviders'])) {
-            throw new ConfigurationException('The "kmsProviders" encryption option must be set using the "setKmsProvider()" method.');
+            throw ConfigurationException::kmsProvidersOptionMustUseSetter();
         }
 
         $this->attributes['autoEncryption'] = $options;
@@ -774,7 +774,7 @@ public function getDefaultMasterKey(): ?array
             return null;
         }
 
-        return $this->attributes['defaultMasterKey'] ?? throw new ConfigurationException(sprintf('The "masterKey" configuration is required for the KMS provider "%s".', $this->attributes['kmsProvider']['name']));
+        return $this->attributes['defaultMasterKey'] ?? throw ConfigurationException::masterKeyRequired($this->attributes['kmsProvider']['name']);
     }
 
     private static function getVersion(): string

lib/Doctrine/ODM/MongoDB/ConfigurationException.php

@@ -28,8 +28,28 @@ public static function proxyDirMissing(): self
         return new self('No proxy directory was configured. Please set a target directory first!');
     }
 
-    public static function kmsProvidersNotSupported(): self
+    public static function clientEncryptionOptionsNotSet(): self
     {
-        return new self('Setting multiple KMS providers is not supported. Please set a single KMS provider in your configuration.');
+        return new self('MongoDB client encryption options are not set in configuration');
+    }
+
+    public static function kmsProviderNameRequired(): self
+    {
+        return new self('The KMS provider "name" is required.');
+    }
+
+    public static function kmsProviderNameMustBeString(): self
+    {
+        return new self('The KMS provider "name" must be a non-empty string.');
+    }
+
+    public static function kmsProvidersOptionMustUseSetter(): self
+    {
+        return new self('The "kmsProviders" encryption option must be set using the "setKmsProvider()" method.');
+    }
+
+    public static function masterKeyRequired(string $provider): self
+    {
+        return new self(sprintf('The "masterKey" configuration is required for the KMS provider "%s".', $provider));
     }
 }

tests/Doctrine/ODM/MongoDB/Tests/ConfigurationTest.php

@@ -118,6 +118,7 @@ public function testMissingDefaultMasterKey(): void
         $c->setKmsProvider(['name' => 'aws', 'accessKeyId' => 'AKIA', 'secretAccessKey' => 'SECRET']);
 
         self::expectException(ConfigurationException::class);
+        self::expectExceptionMessage('The "masterKey" configuration is required for the KMS provider "aws".');
         $c->getDefaultMasterKey();
     }
 
@@ -126,6 +127,35 @@ public function testKmsProvidersIsForbiddenInAutoEncryptionOptions(): void
         $c = new Configuration();
 
         self::expectException(ConfigurationException::class);
+        self::expectExceptionMessage('The "kmsProviders" encryption option must be set using the "setKmsProvider()" method.');
         $c->setAutoEncryption(['kmsProviders' => ['aws' => ['accessKeyId' => 'AKIA', 'secretAccessKey' => 'SECRET']]]);
     }
+
+    public function testClientEncryptionOptionsNotSet(): void
+    {
+        $c = new Configuration();
+        self::expectException(ConfigurationException::class);
+        self::expectExceptionMessage('MongoDB client encryption options are not set in configuration');
+        $c->getClientEncryptionOptions();
+    }
+
+    public function testKmsProviderNameRequired(): void
+    {
+        $c = new Configuration();
+        self::expectException(ConfigurationException::class);
+        self::expectExceptionMessage('The KMS provider "name" is required.');
+
+        // @phpstan-ignore argument.type
+        $c->setKmsProvider(['foo' => 'bar']);
+    }
+
+    public function testKmsProviderNameMustBeString(): void
+    {
+        $c = new Configuration();
+        self::expectException(ConfigurationException::class);
+        self::expectExceptionMessage('The KMS provider "name" must be a non-empty string.');
+
+        // @phpstan-ignore argument.type
+        $c->setKmsProvider(['name' => ['not', 'a', 'string']]);
+    }
 }