Fix tests and deprecations (#266)

Author: norkunas

.gitignore

@@ -3,3 +3,4 @@ composer.phar
 phpunit.xml
 vendor/
 .php_cs.cache
+.phpunit.result.cache

.travis.yml

@@ -14,28 +14,31 @@ env:
 matrix:
     fast_finish: true
     include:
-          # Minimum supported dependencies with the latest and oldest PHP version
-        - php: 7.2
-          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
+          # Minimum supported dependencies with the oldest PHP version
         - php: 7.1
-          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
+          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest" SYMFONY_PHPUNIT_VERSION=7.5
 
           # Test the latest stable release
         - php: 7.1
         - php: 7.2
         - php: 7.3
+        - php: 7.4
           env: COVERAGE=true PHPUNIT_FLAGS="-v --testsuite main --coverage-text --coverage-clover=build/coverage.xml"
 
         - php: 7.1
           # We need `--prefer-source`, otherwise the `Doctrine\Tests\OrmTestCase` class won't be found.
-          env: PHPUNIT_FLAGS="-v --testsuite doctrine" COMPOSER_FLAGS="--prefer-source" DEPENDENCIES="dunglas/symfony-lock:^3"
-        - php: 7.2
-          env: DEPENDENCIES="dunglas/symfony-lock:^3"
-        - php: 7.2
-          env: DEPENDENCIES="dunglas/symfony-lock:^4"
+          env: PHPUNIT_FLAGS="-v --testsuite doctrine" COMPOSER_FLAGS="--prefer-source" SYMFONY_VERSION=3.4.* SYMFONY_PHPUNIT_VERSION=7.5
+        - php: 7.4
+          env: SYMFONY_VERSION=3.4.*
+        - php: 7.4
+          env: SYMFONY_VERSION=4.3.*
+        - php: 7.4
+          env: SYMFONY_VERSION=4.4.*
+        - php: 7.4
+          env: SYMFONY_VERSION=5.0.*
 
           # Latest commit to master
-        - php: 7.2
+        - php: 7.4
           env: STABILITY="dev"
 
     allow_failures:
@@ -45,7 +48,7 @@ matrix:
 before_install:
     - if [[ $COVERAGE != true ]]; then phpenv config-rm xdebug.ini || true; fi
     - if ! [ -z "$STABILITY" ]; then composer config minimum-stability ${STABILITY}; fi;
-    - if ! [ -v "$DEPENDENCIES" ]; then composer require --no-update ${DEPENDENCIES}; fi;
+    - if [ "$SYMFONY_VERSION" != "" ]; then composer require "symfony/symfony:${SYMFONY_VERSION}" --no-update; fi;
 
 install:
     - composer update ${COMPOSER_FLAGS} --prefer-dist --no-interaction

Command/GeocodeCommand.php

@@ -92,6 +92,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 is_array($value) ? json_encode($value) : $value
             ));
         }
+
+        return 0;
     }
 
     private function humanize(string $text): string

DataCollector/DataCollectorSymfonyCompatibilityTrait.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\DataCollector;
+
+use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Kernel;
+
+if (Kernel::VERSION_ID >= 40308) {
+    trait DataCollectorSymfonyCompatibilityTrait
+    {
+        /**
+         * {@inheritdoc}
+         */
+        public function collect(Request $request, Response $response, \Throwable $exception = null)
+        {
+            if (!empty($this->data['queries'])) {
+                // To avoid collection more that once.
+                return;
+            }
+
+            /** @var ProfilingPlugin[] $instances */
+            $instances = $this->instances;
+
+            foreach ($instances as $instance) {
+                foreach ($instance->getQueries() as $query) {
+                    $query['query'] = $this->cloneVar($query['query']);
+                    $query['result'] = $this->cloneVar($query['result']);
+                    $this->data['queries'][] = $query;
+                }
+            }
+        }
+    }
+} else {
+    trait DataCollectorSymfonyCompatibilityTrait
+    {
+        /**
+         * {@inheritdoc}
+         */
+        public function collect(Request $request, Response $response, \Exception $exception = null)
+        {
+            if (!empty($this->data['queries'])) {
+                // To avoid collection more that once.
+                return;
+            }
+
+            /** @var ProfilingPlugin[] $instances */
+            $instances = $this->instances;
+
+            foreach ($instances as $instance) {
+                foreach ($instance->getQueries() as $query) {
+                    $query['query'] = $this->cloneVar($query['query']);
+                    $query['result'] = $this->cloneVar($query['result']);
+                    $this->data['queries'][] = $query;
+                }
+            }
+        }
+    }
+}

DataCollector/GeocoderDataCollector.php

@@ -13,15 +13,15 @@
 namespace Bazinga\GeocoderBundle\DataCollector;
 
 use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 
 /**
  * @author Michal Dabrowski <[email protected]>
  */
 class GeocoderDataCollector extends DataCollector
 {
+    use DataCollectorSymfonyCompatibilityTrait;
+
     /**
      * @var ProfilingPlugin[]
      */
@@ -43,24 +43,6 @@ public function reset()
         $this->data['providers'] = [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function collect(Request $request, Response $response, \Exception $exception = null)
-    {
-        if (!empty($this->data['queries'])) {
-            // To avoid collection more that once.
-            return;
-        }
-        foreach ($this->instances as $instance) {
-            foreach ($instance->getQueries() as $query) {
-                $query['query'] = $this->cloneVar($query['query']);
-                $query['result'] = $this->cloneVar($query['result']);
-                $this->data['queries'][] = $query;
-            }
-        }
-    }
-
     /**
      * Returns an array of collected requests.
      */

Resources/config/services.yml

@@ -25,12 +25,11 @@ services:
 
     Bazinga\GeocoderBundle\Command\GeocodeCommand:
         arguments: ['@Geocoder\ProviderAggregator']
-        tags: [{ name: 'console.command' }]
+        tags: ['console.command']
 
     Bazinga\GeocoderBundle\Validator\Constraint\AddressValidator:
         arguments: ['@geocoder']
-        tags:
-            - { name: 'validator.constraint_validator' }
+        tags: ['validator.constraint_validator']
 
     # Keep these aliases for BC purpose
     bazinga_geocoder.geocoder:

Tests/Command/GeocodeCommandTest.php

@@ -22,6 +22,8 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\HttpKernel\Kernel;
 
 /**
  * @author Markus Bachmann <[email protected]>
@@ -44,26 +46,24 @@ public function testExecute()
             'countryCode' => $country->getCode(),
         ]);
 
-        $geocoder = $this->getMockBuilder(ProviderAggregator::class)->getMock();
+        $geocoder = $this->createMock(ProviderAggregator::class);
         $query = GeocodeQuery::create(self::$address);
         $geocoder->expects($this->once())
             ->method('geocodeQuery')
             ->with($query)
-            ->will($this->returnValue(new AddressCollection([$address])));
+            ->willReturn(new AddressCollection([$address]));
 
-        $container = $this->getMockBuilder('Symfony\\Component\\DependencyInjection\\Container')->getMock();
+        $container = $this->createMock(Container::class);
 
-        $kernel = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Kernel')
-            ->disableOriginalConstructor()
-            ->getMock();
+        $kernel = $this->createMock(Kernel::class);
 
         $kernel->expects($this->any())
             ->method('getContainer')
             ->will($this->returnValue($container));
 
         $kernel->expects($this->any())
             ->method('getBundles')
-            ->will($this->returnValue([]));
+            ->willReturn([]);
 
         $app = new Application($kernel);
         $app->add(new GeocodeCommand($geocoder));

Tests/DependencyInjection/ConfigurationTest.php

@@ -34,7 +34,7 @@ public function testGetConfigTreeBuilder()
 
         $this->assertTrue($config['profiling']['enabled']);
         $this->assertTrue($config['fake_ip']['enabled']);
-        $this->assertEquals('33.33.33.11', $config['fake_ip']['ip']);
+        $this->assertSame('33.33.33.11', $config['fake_ip']['ip']);
     }
 
     public function testGetConfigTreeBuilderNoDebug()

Tests/Doctrine/ORM/GeocoderListenerTest.php

@@ -23,12 +23,15 @@
 use Doctrine\Tests\OrmTestCase;
 use Geocoder\Provider\Nominatim\Nominatim;
 use Http\Client\Curl\Client;
+use Symfony\Bridge\PhpUnit\SetUpTearDownTrait;
 
 /**
  * @author Markus Bachmann <[email protected]>
  */
 class GeocoderListenerTest extends OrmTestCase
 {
+    use SetUpTearDownTrait;
+
     /**
      * @var EntityManager
      */
@@ -39,7 +42,7 @@ class GeocoderListenerTest extends OrmTestCase
      */
     private $listener;
 
-    public static function setUpBeforeClass()
+    public static function doSetUpBeforeClass(): void
     {
         if (!class_exists(DoctrineTestCase::class)) {
             /*
@@ -48,10 +51,9 @@ public static function setUpBeforeClass()
              */
             static::fail('Doctrine\Tests\OrmTestCase was not found.');
         }
-        parent::setUpBeforeClass();
     }
 
-    protected function setUp()
+    protected function doSetUp(): void
     {
         AnnotationRegistry::registerLoader('class_exists');
 

Tests/Functional/BundleInitializationTest.php

@@ -27,12 +27,14 @@
 use Nyholm\BundleTest\BaseBundleTestCase;
 use Nyholm\BundleTest\CompilerPass\PublicServicePass;
 use Nyholm\NSA;
+use Symfony\Bridge\PhpUnit\SetUpTearDownTrait;
 
 class BundleInitializationTest extends BaseBundleTestCase
 {
-    protected function setUp()
+    use SetUpTearDownTrait;
+
+    protected function doSetUp(): void
     {
-        parent::setUp();
         $this->addCompilerPass(new PublicServicePass('|[Bb]azinga:*|'));
         $this->addCompilerPass(new PublicServicePass('|[gG]eocoder:*|'));
     }
@@ -50,9 +52,9 @@ public function testInitBundle()
         // Get the container
         $container = $this->getContainer();
 
-        // Test if you services exists
-        $this->assertTrue($container->has('Geocoder\ProviderAggregator'));
-        $service = $container->get('Geocoder\ProviderAggregator');
+        // Test if services exists
+        $this->assertTrue($container->has(ProviderAggregator::class));
+        $service = $container->get(ProviderAggregator::class);
         $this->assertInstanceOf(ProviderAggregator::class, $service);
     }