Merge pull request symfony#90 from dunglas/fix-createGoutte

dunglas · web-flow · commit 8c921ad5f4ce · 2018-09-23T19:50:13.000+02:00
Fix createGoutteClient signature. Document how to use custom servers.
diff --git a/README.md b/README.md
@@ -97,6 +97,7 @@ to authenticate to an external SSO server, do I want to access the kernel of the
 <?php
 
 use Symfony\Component\Panther\PantherTestCase;
+use Symfony\Component\Panther\Client;
 
 class E2eTest extends PantherTestCase
 {
@@ -105,9 +106,13 @@ class E2eTest extends PantherTestCase
         $symfonyClient = static::createClient(); // A cute kitty: the Symfony's functional test too
         $goutteClient = static::createGoutteClient(); // An agile lynx: Goutte
         $pantherClient = static::createPantherClient(); // A majestic Panther
-        
         // Both Goutte and Panther benefits from the built-in HTTP server
-        
+
+        $customChromeClient = Client::createChromeClient(null, null, [], 'https://example.com'); // Create a custom Chrome client
+        $customSeleniumClient = Client::createSeleniumClient('http://127.0.0.1:4444/wd/hub', null, 'https://example.com'); // Create a custom Selenium client
+        // When initializing a custom client, the integrated web server IS NOT started automatically.
+        // Use PantherTestCase::startWebServer() or WebServerManager if you want to start it manually.
+
         // enjoy the same API for the 3 felines
         // $*client->request('GET', '...')
 
@@ -177,6 +182,7 @@ php:
 script:
   - phpunit
 ```
+
 ## AppVeyor Integration
 
 Panther will work out of the box with AppVeyor as long as Google Chrome is installed. Here is a minimal `appveyor.yml`
diff --git a/src/PantherTestCaseTrait.php b/src/PantherTestCaseTrait.php
@@ -98,13 +98,13 @@ protected static function createPantherClient(string $hostname = '127.0.0.1', in
         return self::$pantherClient;
     }
 
-    protected static function createGoutteClient(): GoutteClient
+    protected static function createGoutteClient(string $hostname = '127.0.0.1', int $port = 9000): GoutteClient
     {
         if (!\class_exists(GoutteClient::class)) {
             throw new \RuntimeException('Goutte is not installed. Run "composer req fabpot/goutte".');
         }
 
-        self::startWebServer();
+        self::startWebServer(null, $hostname, $port);
         if (null === self::$goutteClient) {
             $goutteClient = new GoutteClient();
             $goutteClient->setClient(new GuzzleClient(['base_uri' => self::$baseUri]));

Original file line number	Diff line number	Diff line change
`@@ -98,13 +98,13 @@ protected static function createPantherClient(string $hostname = '127.0.0.1', in`
`98`	`98`	`return self::$pantherClient;`
`99`	`99`	`}`
`100`	`100`
`101`		`- protected static function createGoutteClient(): GoutteClient`
	`101`	`+ protected static function createGoutteClient(string $hostname = '127.0.0.1', int $port = 9000): GoutteClient`
`102`	`102`	`{`
`103`	`103`	`if (!\class_exists(GoutteClient::class)) {`
`104`	`104`	`throw new \RuntimeException('Goutte is not installed. Run "composer req fabpot/goutte".');`
`105`	`105`	`}`
`106`	`106`
`107`		`- self::startWebServer();`
	`107`	`+ self::startWebServer(null, $hostname, $port);`
`108`	`108`	`if (null === self::$goutteClient) {`
`109`	`109`	`$goutteClient = new GoutteClient();`
`110`	`110`	`$goutteClient->setClient(new GuzzleClient(['base_uri' => self::$baseUri]));`