[FEATURE] Development and testing web server

The server can be started using this command:

bin/console server:run

Also document the use of the different environments.

Fixes #25

Author: Oliver Klee

Classes/Core/ApplicationKernel.php

@@ -5,6 +5,7 @@
 
 use PhpList\PhpList4\ApplicationBundle\PhpListApplicationBundle;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\WebServerBundle\WebServerBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
 use Symfony\Component\HttpKernel\Kernel;
@@ -31,6 +32,10 @@ public function registerBundles(): array
             new PhpListApplicationBundle(),
         ];
 
+        if ($this->shouldHaveDevelopmentBundles()) {
+            $bundles[] = new WebServerBundle();
+        }
+
         // This will later be changed so that the REST API package can register itself to the core.
         if ($this->isRestBundleInstalled()) {
             $className = $this->getRestBundleClassName();
@@ -123,4 +128,12 @@ private function getRestBundleClassName(): string
     {
         return 'PhpList\\RestBundle\\PhpListRestBundle';
     }
+
+    /**
+     * @return bool
+     */
+    private function shouldHaveDevelopmentBundles(): bool
+    {
+        return $this->environment !== Environment::PRODUCTION;
+    }
 }

README.md

@@ -58,6 +58,37 @@ this code.
   a [description of the domain entities](Documentation/DomainModel/Entities.md)
 
 
+## Running the web server
+
+The phpList application is configured that the built-in PHP web server can run
+in development and testing mode, while Apache can run in production mode.
+
+### Development
+
+For running the application in development mode using the build-in PHP server,
+use this command:
+
+    bin/console server:run
+
+The server will then listen on `http://127.0.0.1:8000` (or, if port 8000 is
+already in use, on the next free port after 8000).
+
+You can stop the server with CTRL + C.
+
+### Testing
+
+To run the server in testing mode (which normally will only be needed for the
+automated tests, provide the `--dev` option:
+
+    bin/console server:run --env=test
+
+### Production
+
+For documentation on running the application in production mode using Apache,
+please see the
+[phpList base distribution README](https://github.com/phpList/base-distribution).
+
+
 ## Changing the database schema
 
 Any changes to the database schema must always be done both in phpList 3 and

Tests/Support/Traits/ContainsInstanceAssertionTrait.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace PhpList\PhpList4\Tests\Support\Traits;
+
+/**
+ * This trait provides the assertContainsInstanceOf method.
+ *
+ * @author Oliver Klee <[email protected]>
+ */
+trait ContainsInstanceAssertionTrait
+{
+    /**
+     * @param string $className
+     * @param array $haystack
+     * @param string $message
+     *
+     * @return void
+     */
+    public static function assertContainsInstanceOf(string $className, array $haystack, string $message = '')
+    {
+        $found = false;
+        foreach ($haystack as $element) {
+            if (is_object($element) && $element instanceof $className) {
+                $found = true;
+                break;
+            }
+        }
+
+        $defaultMessage = 'Failed asserting that an array contains an instance of ' . $className;
+        self::assertTrue($found, $message ?: $defaultMessage);
+    }
+}

Tests/Unit/Core/ApplicationKernelTest.php

@@ -3,10 +3,15 @@
 
 namespace PhpList\PhpList4\Tests\Unit\Core;
 
+use PhpList\PhpList4\ApplicationBundle\PhpListApplicationBundle;
 use PhpList\PhpList4\Core\ApplicationKernel;
 use PhpList\PhpList4\Core\Bootstrap;
 use PhpList\PhpList4\Core\Environment;
+use PhpList\PhpList4\Tests\Support\Traits\ContainsInstanceAssertionTrait;
 use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\WebServerBundle\WebServerBundle;
+use Symfony\Component\HttpKernel\Bundle\BundleInterface;
 use Symfony\Component\HttpKernel\Kernel;
 
 /**
@@ -16,6 +21,8 @@
  */
 class ApplicationKernelTest extends TestCase
 {
+    use ContainsInstanceAssertionTrait;
+
     /**
      * @var ApplicationKernel
      */
@@ -38,4 +45,38 @@ public function isKernelInstance()
     {
         self::assertInstanceOf(Kernel::class, $this->subject);
     }
+
+    /**
+     * @test
+     */
+    public function registerBundlesReturnsBundlesOnly()
+    {
+        $bundles = $this->subject->registerBundles();
+
+        self::assertContainsOnlyInstancesOf(BundleInterface::class, $bundles);
+    }
+
+    /**
+     * @return string[][]
+     */
+    public function requiredBundlesDataProvider(): array
+    {
+        return [
+            'framework' => [FrameworkBundle::class],
+            'phpList default bundle' => [PhpListApplicationBundle::class],
+            'web server' => [WebServerBundle::class],
+        ];
+    }
+
+    /**
+     * @test
+     * @param string $className
+     * @dataProvider requiredBundlesDataProvider
+     */
+    public function registerBundlesHasAllRequiredBundles(string $className)
+    {
+        $bundles = $this->subject->registerBundles();
+
+        self::assertContainsInstanceOf($className, $bundles);
+    }
 }

composer.json

@@ -30,6 +30,7 @@
 
         "doctrine/orm": "^2.5.6",
         "symfony/symfony": "^3.3.2",
+        "symfony/monolog-bundle": "^3.1.0",
         "sensio/framework-extra-bundle": "^3.0.26"
     },
     "require-dev": {