[TASK] Trait for database test, base class for web tests (#264)

The trait DatabaseTestTrait and the class abstractWebTest now are
available to be used in other packages as well, reducing code
duplication.

Also whitelist two more static calls in the PHPMD configuration and break
a long line in the PHPMD configuration file.

Author: oliverklee

CHANGELOG.md

@@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## x.y.z
 
 ### Added
+- Trait for database tests and abstract web test (#264)
 - Repository methods for querying subscriptions (#253)
 - Bidirectional m:n association Subscribers/SubscriberLists (#254)
 

Classes/TestingSupport/AbstractWebTest.php

@@ -0,0 +1,40 @@
+<?php
+declare(strict_types=1);
+
+namespace PhpList\PhpList4\TestingSupport;
+
+use PhpList\PhpList4\Core\Bootstrap;
+use PhpList\PhpList4\Core\Environment;
+use Symfony\Bundle\FrameworkBundle\Client;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+/**
+ * Base class for integration tests for controllers.
+ *
+ * If you have your own setUp method, make sure to call $this->setUpWebTest() first thing in your setUp method.
+ *
+ * @author Oliver Klee <[email protected]>
+ */
+abstract class AbstractWebTest extends WebTestCase
+{
+    /**
+     * @var Client
+     */
+    protected $client = null;
+
+    protected function setUp()
+    {
+        $this->setUpWebTest();
+    }
+
+    protected function setUpWebTest()
+    {
+        // This makes sure that all DateTime instances use the same time zone, thus making the dates in the
+        // JSON provided by the REST API easier to test.
+        date_default_timezone_set('UTC');
+
+        Bootstrap::getInstance()->setEnvironment(Environment::TESTING)->configure();
+
+        $this->client = static::createClient(['environment' => Environment::TESTING]);
+    }
+}

Tests/Integration/Fixtures/TouchTable.csv renamed to Classes/TestingSupport/Fixtures/TouchTable.csv

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace PhpList\PhpList4\Tests\Integration;
+namespace PhpList\PhpList4\TestingSupport\Traits;
 
 use Doctrine\ORM\EntityManagerInterface;
 use PhpList\PhpList4\Core\Bootstrap;
@@ -11,17 +11,18 @@
 use PHPUnit\DbUnit\Operation\Factory;
 use PHPUnit\DbUnit\Operation\Operation;
 use PHPUnit\DbUnit\TestCaseTrait;
-use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * This is the base class for integration tests that use database records.
+ * This is a trait for integration tests that use database records.
  *
- * Make sure to call parent::setUp() first thing in your setUp method.
+ * If you have your own setUp method, make sure to call $this->setUpDatabaseTest() first thing in your setUp method.
+ *
+ * And if you have your own tearDown method, call $this->tearDownDatabaseTest() first thing in your tearDown method.
  *
  * @author Oliver Klee <[email protected]>
  */
-abstract class AbstractDatabaseTest extends TestCase
+trait DatabaseTestTrait
 {
     use TestCaseTrait;
 
@@ -56,6 +57,11 @@ abstract class AbstractDatabaseTest extends TestCase
     protected $container = null;
 
     protected function setUp()
+    {
+        $this->setUpDatabaseTest();
+    }
+
+    protected function setUpDatabaseTest()
     {
         $this->initializeDatabaseTester();
         $this->bootstrap = Bootstrap::getInstance()->setEnvironment(Environment::TESTING)->configure();
@@ -78,6 +84,11 @@ protected function initializeDatabaseTester()
     }
 
     protected function tearDown()
+    {
+        $this->tearDownDatabaseTest();
+    }
+
+    protected function tearDownDatabaseTest()
     {
         $this->entityManager->close();
         $this->getDatabaseTester()->setTearDownOperation($this->getTearDownOperation());
@@ -159,6 +170,6 @@ protected function applyDatabaseChanges()
      */
     protected function touchDatabaseTable(string $tableName)
     {
-        $this->getDataSet()->addTable($tableName, __DIR__ . '/Fixtures/TouchTable.csv');
+        $this->getDataSet()->addTable($tableName, __DIR__ . '/../Fixtures/TouchTable.csv');
     }
 }

Tests/Integration/AbstractDatabaseTest.php renamed to Classes/TestingSupport/Traits/DatabaseTestTrait.php

@@ -8,8 +8,16 @@
     <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag"/>
     <rule ref="rulesets/cleancode.xml/StaticAccess">
         <properties>
-            <property name="exceptions"
-                      value="\Doctrine\ORM\EntityManager,\Doctrine\ORM\Tools\Setup,\Symfony\Component\Debug\Debug,PhpList\PhpList4\Core\Environment,Symfony\Component\Yaml\Yaml,\FOS\RestBundle\View\View"/>
+            <property name="exceptions" value="
+                      \Doctrine\ORM\EntityManager,
+                      \Doctrine\ORM\Tools\Setup,
+                      \FOS\RestBundle\View\View,
+                      \PhpList\PhpList4\Core\Bootstrap,
+                      \PhpList\PhpList4\Core\Environment,
+                      \PHPUnit\DbUnit\Operation\Factory,
+                      \Symfony\Component\Debug\Debug,
+                      \Symfony\Component\Yaml\Yaml,
+            "/>
         </properties>
     </rule>
 

Configuration/PHPMD/rules.xml

@@ -5,16 +5,18 @@
 
 use PhpList\PhpList4\Domain\Model\Identity\Administrator;
 use PhpList\PhpList4\Domain\Repository\Identity\AdministratorRepository;
+use PhpList\PhpList4\TestingSupport\Traits\DatabaseTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
-use PhpList\PhpList4\Tests\Integration\AbstractDatabaseTest;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Testcase.
  *
  * @author Oliver Klee <[email protected]>
  */
-class AdministratorRepositoryTest extends AbstractDatabaseTest
+class AdministratorRepositoryTest extends TestCase
 {
+    use DatabaseTestTrait;
     use SimilarDatesAssertionTrait;
 
     /**
@@ -29,7 +31,7 @@ class AdministratorRepositoryTest extends AbstractDatabaseTest
 
     protected function setUp()
     {
-        parent::setUp();
+        $this->setUpDatabaseTest();
 
         $this->subject = $this->container->get(AdministratorRepository::class);
     }

Tests/Integration/Domain/Repository/Identity/AdministratorRepositoryTest.php

@@ -8,16 +8,18 @@
 use PhpList\PhpList4\Domain\Model\Identity\AdministratorToken;
 use PhpList\PhpList4\Domain\Repository\Identity\AdministratorRepository;
 use PhpList\PhpList4\Domain\Repository\Identity\AdministratorTokenRepository;
+use PhpList\PhpList4\TestingSupport\Traits\DatabaseTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
-use PhpList\PhpList4\Tests\Integration\AbstractDatabaseTest;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Testcase.
  *
  * @author Oliver Klee <[email protected]>
  */
-class AdministratorTokenRepositoryTest extends AbstractDatabaseTest
+class AdministratorTokenRepositoryTest extends TestCase
 {
+    use DatabaseTestTrait;
     use SimilarDatesAssertionTrait;
 
     /**
@@ -37,7 +39,7 @@ class AdministratorTokenRepositoryTest extends AbstractDatabaseTest
 
     protected function setUp()
     {
-        parent::setUp();
+        $this->setUpDatabaseTest();
 
         $this->subject = $this->container->get(AdministratorTokenRepository::class);
     }

Tests/Integration/Domain/Repository/Identity/AdministratorTokenRepositoryTest.php

@@ -10,16 +10,18 @@
 use PhpList\PhpList4\Domain\Repository\Identity\AdministratorRepository;
 use PhpList\PhpList4\Domain\Repository\Messaging\SubscriberListRepository;
 use PhpList\PhpList4\Domain\Repository\Subscription\SubscriberRepository;
+use PhpList\PhpList4\TestingSupport\Traits\DatabaseTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
-use PhpList\PhpList4\Tests\Integration\AbstractDatabaseTest;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Testcase.
  *
  * @author Oliver Klee <[email protected]>
  */
-class SubscriberListRepositoryTest extends AbstractDatabaseTest
+class SubscriberListRepositoryTest extends TestCase
 {
+    use DatabaseTestTrait;
     use SimilarDatesAssertionTrait;
 
     /**
@@ -59,7 +61,7 @@ class SubscriberListRepositoryTest extends AbstractDatabaseTest
 
     protected function setUp()
     {
-        parent::setUp();
+        $this->setUpDatabaseTest();
 
         $this->subject = $this->container->get(SubscriberListRepository::class);
         $this->administratorRepository = $this->container->get(AdministratorRepository::class);

Tests/Integration/Domain/Repository/Messaging/SubscriberListRepositoryTest.php

@@ -8,16 +8,18 @@
 use PhpList\PhpList4\Domain\Model\Subscription\Subscription;
 use PhpList\PhpList4\Domain\Repository\Messaging\SubscriberListRepository;
 use PhpList\PhpList4\Domain\Repository\Subscription\SubscriberRepository;
+use PhpList\PhpList4\TestingSupport\Traits\DatabaseTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
-use PhpList\PhpList4\Tests\Integration\AbstractDatabaseTest;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Testcase.
  *
  * @author Oliver Klee <[email protected]>
  */
-class SubscriberRepositoryTest extends AbstractDatabaseTest
+class SubscriberRepositoryTest extends TestCase
 {
+    use DatabaseTestTrait;
     use SimilarDatesAssertionTrait;
 
     /**
@@ -52,7 +54,7 @@ class SubscriberRepositoryTest extends AbstractDatabaseTest
 
     protected function setUp()
     {
-        parent::setUp();
+        $this->setUpDatabaseTest();
 
         $this->subject = $this->container->get(SubscriberRepository::class);
         $this->subscriberListRepository = $this->container->get(SubscriberListRepository::class);

Tests/Integration/Domain/Repository/Subscription/SubscriberRepositoryTest.php

@@ -10,16 +10,18 @@
 use PhpList\PhpList4\Domain\Repository\Messaging\SubscriberListRepository;
 use PhpList\PhpList4\Domain\Repository\Subscription\SubscriberRepository;
 use PhpList\PhpList4\Domain\Repository\Subscription\SubscriptionRepository;
+use PhpList\PhpList4\TestingSupport\Traits\DatabaseTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
-use PhpList\PhpList4\Tests\Integration\AbstractDatabaseTest;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Testcase.
  *
  * @author Oliver Klee <[email protected]>
  */
-class SubscriptionRepositoryTest extends AbstractDatabaseTest
+class SubscriptionRepositoryTest extends TestCase
 {
+    use DatabaseTestTrait;
     use SimilarDatesAssertionTrait;
 
     /**
@@ -59,7 +61,7 @@ class SubscriptionRepositoryTest extends AbstractDatabaseTest
 
     protected function setUp()
     {
-        parent::setUp();
+        $this->setUpDatabaseTest();
 
         $this->subject = $this->container->get(SubscriptionRepository::class);