Merge pull request #134 from aik099/uknown-driver-usage-error

Improve error, when unknown driver is being used
minkphp · Mar 17, 2024 · 7142faa · 7142faa
2 parents a3be254 + fb1f217
commit 7142faa
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 3 deletions.
diff --git a/library/aik099/PHPUnit/MinkDriver/DriverFactoryRegistry.php b/library/aik099/PHPUnit/MinkDriver/DriverFactoryRegistry.php
@@ -52,7 +52,14 @@ public function add(IMinkDriverFactory $driver_factory)
 	public function get($driver_name)
 	{
 		if ( !isset($this->_registry[$driver_name]) ) {
-			throw new \OutOfBoundsException(sprintf('No driver factory for "%s" driver.', $driver_name));
+			$error_msg = 'The "' . $driver_name . '" driver is unknown.';
+
+			if ( $this->_registry ) {
+				$drivers = '"' . implode('", "', array_keys($this->_registry)) . '"';
+				$error_msg .= ' Please instead use any of these supported drivers: ' . $drivers . '.';
+			}
+
+			throw new \OutOfBoundsException($error_msg);
 		}
 
 		return $this->_registry[$driver_name];

diff --git a/tests/aik099/PHPUnit/MinkDriver/DriverFactoryRegistryTest.php b/tests/aik099/PHPUnit/MinkDriver/DriverFactoryRegistryTest.php
@@ -60,10 +60,28 @@ public function testAddingExisting()
 		$this->_driverFactoryRegistry->add($factory);
 	}
 
-	public function testGettingNonExisting()
+	public function testGettingNonExistingWithoutAlternatives()
 	{
 		$this->expectException('OutOfBoundsException');
-		$this->expectExceptionMessage('No driver factory for "test" driver.');
+		$this->expectExceptionMessage('The "test" driver is unknown.');
+
+		$this->_driverFactoryRegistry->get('test');
+	}
+
+	public function testGettingNonExistingWithAlternatives()
+	{
+		$this->expectException('OutOfBoundsException');
+		$this->expectExceptionMessage(
+			'The "test" driver is unknown. Please instead use any of these supported drivers: "driver1", "driver2".'
+		);
+
+		$factory1 = m::mock(IMinkDriverFactory::class);
+		$factory1->shouldReceive('getDriverName')->once()->andReturn('driver1');
+		$this->_driverFactoryRegistry->add($factory1);
+
+		$factory2 = m::mock(IMinkDriverFactory::class);
+		$factory2->shouldReceive('getDriverName')->once()->andReturn('driver2');
+		$this->_driverFactoryRegistry->add($factory2);
 
 		$this->_driverFactoryRegistry->get('test');
 	}