Add new env vars to ease Docker usage and debug (#52)

* Add new env vars to ease Docker usage and debug

* AppVeyor

Author: dunglas

README.md

@@ -138,6 +138,28 @@ Since Panthère implements the API of popular, it already has an extensive docum
 * For the `Crawler` class, read [the DomCrawler's documentation](https://symfony.com/doc/current/components/dom_crawler.html)
 * For Webdriver, read [the Facebook's PHP WebDriver documentation](https://github.com/facebook/php-webdriver)
 
+## Environment Variables
+
+The following environment variables can be set to change some Panthère behaviors:
+
+* `PANTHERE_NO_HEADLESS`: to disable browsers's headless mode (will display the testing window, useful to debug)
+* `PANTHERE_NO_SANDBOX`: to disable [Chrome's sandboxing](https://chromium.googlesource.com/chromium/src/+/b4730a0c2773d8f6728946013eb812c6d3975bec/docs/design/sandbox.md) (unsafe, but allows to use Panthère in containers)
+* `PANTHERE_WEB_SERVER_DIR`: to change the project's document root (default to `public/`)
+
+## Docker Integration
+
+Here is a minimal Docker image that can run Panthère:
+
+```
+FROM php:latest
+
+RUN apt-get update && apt-get install -y zlib1g-dev chromium && docker-php-ext-install zip
+ENV PANTHERE_NO_SANDBOX 1
+```
+
+Build it with `docker build . -t myproject`
+Run it with `docker run -it -v "$PWD":/srv/myproject -w /srv/myproject myproject bin/phpunit`
+
 ## Travis CI Integration
 
 Panthère will work out of the box with Travis if you add the Chrome addon. Here is a minimal `.travis.yml` file to run
@@ -154,6 +176,38 @@ php:
 script:
   - phpunit
 ```
+## AppVeyor Integration
+
+Panthère will work out of the box with AppVeyor as long as Google Chrome is installed. Here is a minimal `appveyor.yml`
+file to run Panthère tests:
+
+```yaml
+build: false
+platform: x86
+clone_folder: c:\projects\myproject
+
+cache:
+  - '%LOCALAPPDATA%\Composer\files'
+
+install:
+  - ps: Set-Service wuauserv -StartupType Manual
+  - cinst -y php composer googlechrome
+  - refreshenv
+  - cd c:\tools\php72
+  - copy php.ini-production php.ini /Y
+  - echo date.timezone="UTC" >> php.ini
+  - echo extension_dir=ext >> php.ini
+  - echo extension=php_openssl.dll >> php.ini
+  - echo extension=php_mbstring.dll >> php.ini
+  - echo extension=php_curl.dll >> php.ini
+  - echo memory_limit=3G >> php.ini
+  - cd %APPVEYOR_BUILD_FOLDER%
+  - composer install --no-interaction --no-progress
+
+test_script:
+  - cd %APPVEYOR_BUILD_FOLDER%
+  - php vendor\phpunit\phpunit\phpunit
+```
 
 ## Limitations
 

src/PanthereTestCaseTrait.php

@@ -79,7 +79,7 @@ protected static function startWebServer(?string $webServerDir = null, string $h
 
         if (null === $webServerDir) {
             // Try the local $webServerDir property, or the PANTHERE_WEB_SERVER_DIR env var or default to the Flex directory structure
-            $webServerDir = static::$webServerDir ?? $_ENV['PANTHERE_WEB_SERVER_DIR'] ?? __DIR__.'/../../../../public';
+            $webServerDir = static::$webServerDir ?? $_SERVER['PANTHERE_WEB_SERVER_DIR'] ?? __DIR__.'/../../../../public';
         }
 
         self::$webServerManager = new WebServerManager($webServerDir, $hostname, $port);

src/ProcessManager/ChromeManager.php

@@ -80,10 +80,11 @@ private function findChromeDriverBinary(): string
 
     private function getDefaultArguments(): array
     {
-        // Enable the headless mode
-        $args = ['--headless', 'window-size=1200,1100', '--disable-gpu'];
+        // Enable the headless mode unless PANTHERE_NO_HEADLESS is defined
+        $args = ($_SERVER['PANTHERE_NO_HEADLESS'] ?? false) ? [] : ['--headless', 'window-size=1200,1100', '--disable-gpu'];
 
-        if ($_SERVER['HAS_JOSH_K_SEAL_OF_APPROVAL'] ?? false) {
+        // Disable Chrome's sandbox if PANTHERE_NO_SANDBOX is defined or if running in Travis
+        if ($_SERVER['PANTHERE_NO_SANDBOX'] ?? $_SERVER['HAS_JOSH_K_SEAL_OF_APPROVAL'] ?? false) {
             // Running in Travis, disabling the sandbox mode
             $args[] = '--no-sandbox';
         }