ElasticSearch v8 support (#1662)

* ElasticSearch v8 support
* CI updates

Co-authored-by: Thomas Müller <mimmi20@live.de>

tests/Monolog/Formatter/ScalarFormatterTest.php

@@ -22,6 +22,13 @@ class ScalarFormatterTest extends \PHPUnit\Framework\TestCase
         $this->formatter = new ScalarFormatter();
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->formatter);
+    }
+
     public function buildTrace(\Exception $e)
     {
         $data = [];

tests/Monolog/Handler/AmqpHandlerTest.php

@@ -78,7 +78,7 @@ class AmqpHandlerTest extends TestCase
 
     public function testHandlePhpAmqpLib()
     {
-        if (!class_exists('PhpAmqpLib\Connection\AMQPConnection')) {
+        if (!class_exists('PhpAmqpLib\Channel\AMQPChannel')) {
             $this->markTestSkipped("php-amqplib not installed");
         }
 

tests/Monolog/Handler/DynamoDbHandlerTest.php

@@ -45,6 +45,13 @@ class DynamoDbHandlerTest extends TestCase
         $this->client = $clientMockBuilder->getMock();
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->client);
+    }
+
     public function testConstruct()
     {
         $this->assertInstanceOf('Monolog\Handler\DynamoDbHandler', new DynamoDbHandler($this->client, 'foo'));

tests/Monolog/Handler/ElasticaHandlerTest.php

@@ -19,6 +19,9 @@ use Elastica\Client;
 use Elastica\Request;
 use Elastica\Response;
 
+/**
+ * @group Elastica
+ */
 class ElasticaHandlerTest extends TestCase
 {
     /**
@@ -48,6 +51,13 @@ class ElasticaHandlerTest extends TestCase
             ->getMock();
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->client);
+    }
+
     /**
      * @covers Monolog\Handler\ElasticaHandler::write
      * @covers Monolog\Handler\ElasticaHandler::handleBatch
@@ -155,60 +165,6 @@ class ElasticaHandlerTest extends TestCase
         ];
     }
 
-    /**
-     * Integration test using localhost Elastic Search server version <7
-     *
-     * @covers Monolog\Handler\ElasticaHandler::__construct
-     * @covers Monolog\Handler\ElasticaHandler::handleBatch
-     * @covers Monolog\Handler\ElasticaHandler::bulkSend
-     * @covers Monolog\Handler\ElasticaHandler::getDefaultFormatter
-     */
-    public function testHandleIntegration()
-    {
-        $msg = [
-            'level' => Logger::ERROR,
-            'level_name' => 'ERROR',
-            'channel' => 'meh',
-            'context' => ['foo' => 7, 'bar', 'class' => new \stdClass],
-            'datetime' => new \DateTimeImmutable("@0"),
-            'extra' => [],
-            'message' => 'log',
-        ];
-
-        $expected = $msg;
-        $expected['datetime'] = $msg['datetime']->format(\DateTime::ISO8601);
-        $expected['context'] = [
-            'class' => '[object] (stdClass: {})',
-            'foo' => 7,
-            0 => 'bar',
-        ];
-
-        $client = new Client();
-        $handler = new ElasticaHandler($client, $this->options);
-
-        try {
-            $handler->handleBatch([$msg]);
-        } catch (\RuntimeException $e) {
-            $this->markTestSkipped("Cannot connect to Elastic Search server on localhost");
-        }
-
-        // check document id from ES server response
-        $documentId = $this->getCreatedDocId($client->getLastResponse());
-        $this->assertNotEmpty($documentId, 'No elastic document id received');
-
-        // retrieve document source from ES and validate
-        $document = $this->getDocSourceFromElastic(
-            $client,
-            $this->options['index'],
-            $this->options['type'],
-            $documentId
-        );
-        $this->assertEquals($expected, $document);
-
-        // remove test index from ES
-        $client->request("/{$this->options['index']}", Request::DELETE);
-    }
-
     /**
      * Integration test using localhost Elastic Search server version 7+
      *
@@ -237,7 +193,9 @@ class ElasticaHandlerTest extends TestCase
             0 => 'bar',
         ];
 
-        $client = new Client();
+        $clientOpts = ['url' => 'http://elastic:changeme@127.0.0.1:9200'];
+        $client = new Client($clientOpts);
+
         $handler = new ElasticaHandler($client, $this->options);
 
         try {
@@ -271,9 +229,14 @@ class ElasticaHandlerTest extends TestCase
     protected function getCreatedDocId(Response $response)
     {
         $data = $response->getData();
-        if (!empty($data['items'][0]['create']['_id'])) {
-            return $data['items'][0]['create']['_id'];
+
+        if (!empty($data['items'][0]['index']['_id'])) {
+            return $data['items'][0]['index']['_id'];
         }
+
+        var_dump('Unexpected response: ', $data);
+
+        return null;
     }
 
     /**

tests/Monolog/Handler/ElasticsearchHandlerTest.php

@@ -11,17 +11,22 @@
 
 namespace Monolog\Handler;
 
-use Elasticsearch\ClientBuilder;
 use Monolog\Formatter\ElasticsearchFormatter;
 use Monolog\Formatter\NormalizerFormatter;
 use Monolog\Test\TestCase;
 use Monolog\Logger;
 use Elasticsearch\Client;
+use Elastic\Elasticsearch\Client as Client8;
+use Elasticsearch\ClientBuilder;
+use Elastic\Elasticsearch\ClientBuilder as ClientBuilder8;
 
+/**
+ * @group Elasticsearch
+ */
 class ElasticsearchHandlerTest extends TestCase
 {
     /**
-     * @var Client mock
+     * @var Client|Client8 mock
      */
     protected $client;
 
@@ -35,63 +40,23 @@ class ElasticsearchHandlerTest extends TestCase
 
     public function setUp(): void
     {
-        // Elasticsearch lib required
-        if (!class_exists('Elasticsearch\Client')) {
-            $this->markTestSkipped('elasticsearch/elasticsearch not installed');
-        }
+        $hosts = ['http://elastic:changeme@127.0.0.1:9200'];
+        $this->client = $this->getClientBuilder()
+            ->setHosts($hosts)
+            ->build();
 
-        // base mock Elasticsearch Client object
-        $this->client = $this->getMockBuilder('Elasticsearch\Client')
-            ->onlyMethods(['bulk'])
-            ->disableOriginalConstructor()
-            ->getMock();
+        try {
+            $this->client->info();
+        } catch (\Throwable $e) {
+            $this->markTestSkipped('Could not connect to Elasticsearch on 127.0.0.1:9200');
+        }
     }
 
-    /**
-     * @covers Monolog\Handler\ElasticsearchHandler::write
-     * @covers Monolog\Handler\ElasticsearchHandler::handleBatch
-     * @covers Monolog\Handler\ElasticsearchHandler::bulkSend
-     * @covers Monolog\Handler\ElasticsearchHandler::getDefaultFormatter
-     */
-    public function testHandle()
+    public function tearDown(): void
     {
-        // log message
-        $msg = [
-            'level' => Logger::ERROR,
-            'level_name' => 'ERROR',
-            'channel' => 'meh',
-            'context' => ['foo' => 7, 'bar', 'class' => new \stdClass],
-            'datetime' => new \DateTimeImmutable("@0"),
-            'extra' => [],
-            'message' => 'log',
-        ];
+        parent::tearDown();
 
-        // format expected result
-        $formatter = new ElasticsearchFormatter($this->options['index'], $this->options['type']);
-        $data = $formatter->format($msg);
-        unset($data['_index'], $data['_type']);
-
-        $expected = [
-            'body' => [
-                [
-                    'index' => [
-                        '_index' => $this->options['index'],
-                        '_type' => $this->options['type'],
-                    ],
-                ],
-                $data,
-            ],
-        ];
-
-        // setup ES client mock
-        $this->client->expects($this->any())
-            ->method('bulk')
-            ->with($expected);
-
-        // perform tests
-        $handler = new ElasticsearchHandler($this->client, $this->options);
-        $handler->handle($msg);
-        $handler->handleBatch([$msg]);
+        unset($this->client);
     }
 
     /**
@@ -108,7 +73,7 @@ class ElasticsearchHandlerTest extends TestCase
     }
 
     /**
-     * @covers                   Monolog\Handler\ElasticsearchHandler::setFormatter
+     * @covers Monolog\Handler\ElasticsearchHandler::setFormatter
      */
     public function testSetFormatterInvalid()
     {
@@ -132,6 +97,11 @@ class ElasticsearchHandlerTest extends TestCase
             'type' => $this->options['type'],
             'ignore_error' => false,
         ];
+
+        if ($this->client instanceof Client8 || $this->client::VERSION[0] === '7') {
+            $expected['type'] = '_doc';
+        }
+
         $handler = new ElasticsearchHandler($this->client, $this->options);
         $this->assertEquals($expected, $handler->getOptions());
     }
@@ -142,10 +112,10 @@ class ElasticsearchHandlerTest extends TestCase
      */
     public function testConnectionErrors($ignore, $expectedError)
     {
-        $hosts = [['host' => '127.0.0.1', 'port' => 1]];
-        $client = ClientBuilder::create()
-                    ->setHosts($hosts)
-                    ->build();
+        $hosts = ['http://127.0.0.1:1'];
+        $client = $this->getClientBuilder()
+            ->setHosts($hosts)
+            ->build();
 
         $handlerOpts = ['ignore_error' => $ignore];
         $handler = new ElasticsearchHandler($client, $handlerOpts);
@@ -178,7 +148,7 @@ class ElasticsearchHandlerTest extends TestCase
      * @covers Monolog\Handler\ElasticsearchHandler::bulkSend
      * @covers Monolog\Handler\ElasticsearchHandler::getDefaultFormatter
      */
-    public function testHandleIntegration()
+    public function testHandleBatchIntegration()
     {
         $msg = [
             'level' => Logger::ERROR,
@@ -198,21 +168,26 @@ class ElasticsearchHandlerTest extends TestCase
             0 => 'bar',
         ];
 
-        $hosts = [['host' => '127.0.0.1', 'port' => 9200]];
-        $client = ClientBuilder::create()
+        $hosts = ['http://elastic:changeme@127.0.0.1:9200'];
+        $client = $this->getClientBuilder()
             ->setHosts($hosts)
             ->build();
         $handler = new ElasticsearchHandler($client, $this->options);
-
-        try {
-            $handler->handleBatch([$msg]);
-        } catch (\RuntimeException $e) {
-            $this->markTestSkipped('Cannot connect to Elasticsearch server on localhost');
-        }
+        $handler->handleBatch([$msg]);
 
         // check document id from ES server response
-        $documentId = $this->getCreatedDocId($client->transport->getLastConnection()->getLastRequestInfo());
-        $this->assertNotEmpty($documentId, 'No elastic document id received');
+        if ($client instanceof Client8) {
+            $messageBody = $client->getTransport()->getLastResponse()->getBody();
+
+            $info = json_decode((string) $messageBody, true);
+            $this->assertNotNull($info, 'Decoding failed');
+
+            $documentId = $this->getCreatedDocIdV8($info);
+            $this->assertNotEmpty($documentId, 'No elastic document id received');
+        } else {
+            $documentId = $this->getCreatedDocId($client->transport->getLastConnection()->getLastRequestInfo());
+            $this->assertNotEmpty($documentId, 'No elastic document id received');
+        }
 
         // retrieve document source from ES and validate
         $document = $this->getDocSourceFromElastic(
@@ -241,25 +216,45 @@ class ElasticsearchHandlerTest extends TestCase
         if (!empty($data['items'][0]['index']['_id'])) {
             return $data['items'][0]['index']['_id'];
         }
+
+        return null;
+    }
+
+    /**
+     * Return last created document id from ES response
+     *
+     * @param  array       $data Elasticsearch last request info
+     * @return string|null
+     */
+    protected function getCreatedDocIdV8(array $data)
+    {
+        if (!empty($data['items'][0]['index']['_id'])) {
+            return $data['items'][0]['index']['_id'];
+        }
+
+        return null;
     }
 
     /**
      * Retrieve document by id from Elasticsearch
      *
-     * @param  Client $client     Elasticsearch client
+     * @param  Client|Client8 $client     Elasticsearch client
      * @param  string $index
      * @param  string $type
      * @param  string $documentId
      * @return array
      */
-    protected function getDocSourceFromElastic(Client $client, $index, $type, $documentId)
+    protected function getDocSourceFromElastic($client, $index, $type, $documentId)
     {
         $params = [
             'index' => $index,
-            'type' => $type,
             'id' => $documentId,
         ];
 
+        if (!$client instanceof Client8 && $client::VERSION[0] !== '7') {
+            $params['type'] = $type;
+        }
+
         $data = $client->get($params);
 
         if (!empty($data['_source'])) {
@@ -268,4 +263,16 @@ class ElasticsearchHandlerTest extends TestCase
 
         return [];
     }
+
+    /**
+     * @return ClientBuilder|ClientBuilder8
+     */
+    private function getClientBuilder()
+    {
+        if (class_exists(ClientBuilder8::class)) {
+            return ClientBuilder8::create();
+        }
+
+        return ClientBuilder::create();
+    }
 }

tests/Monolog/Handler/FlowdockHandlerTest.php

@@ -38,6 +38,13 @@ class FlowdockHandlerTest extends TestCase
         }
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->res);
+    }
+
     public function testWriteHeader()
     {
         $this->createHandler();

tests/Monolog/Handler/HandlerWrapperTest.php

@@ -32,6 +32,13 @@ class HandlerWrapperTest extends TestCase
         $this->wrapper = new HandlerWrapper($this->handler);
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->wrapper);
+    }
+
     /**
      * @return array
      */

tests/Monolog/Handler/InsightOpsHandlerTest.php

@@ -30,6 +30,13 @@ class InsightOpsHandlerTest extends TestCase
      */
     private $handler;
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->resource);
+    }
+
     public function testWriteContent()
     {
         $this->createHandler();

tests/Monolog/Handler/LogEntriesHandlerTest.php

@@ -29,6 +29,13 @@ class LogEntriesHandlerTest extends TestCase
      */
     private $handler;
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->res);
+    }
+
     public function testWriteContent()
     {
         $this->createHandler();

tests/Monolog/Handler/LogmaticHandlerTest.php

@@ -29,6 +29,13 @@ class LogmaticHandlerTest extends TestCase
      */
     private $handler;
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->res);
+    }
+
     public function testWriteContent()
     {
         $this->createHandler();

tests/Monolog/Handler/PHPConsoleHandlerTest.php

@@ -56,6 +56,13 @@ class PHPConsoleHandlerTest extends TestCase
         $this->connector->setErrorsDispatcher($this->errorDispatcher);
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->connector, $this->debugDispatcher, $this->errorDispatcher);
+    }
+
     protected function initDebugDispatcherMock(Connector $connector)
     {
         return $this->getMockBuilder('PhpConsole\Dispatcher\Debug')

tests/Monolog/Handler/PushoverHandlerTest.php

@@ -25,6 +25,13 @@ class PushoverHandlerTest extends TestCase
     private $res;
     private $handler;
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->res);
+    }
+
     public function testWriteHeader()
     {
         $this->createHandler();

tests/Monolog/Handler/RollbarHandlerTest.php

@@ -44,6 +44,13 @@ class RollbarHandlerTest extends TestCase
         $this->setupRollbarLoggerMock();
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->rollbarLogger, $this->reportedExceptionArguments);
+    }
+
     /**
      * When reporting exceptions to Rollbar the
      * level has to be set in the payload data

tests/Monolog/Handler/RotatingFileHandlerTest.php

@@ -39,6 +39,18 @@ class RotatingFileHandlerTest extends TestCase
         });
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        foreach (glob(__DIR__.'/Fixtures/*.rot') as $file) {
+            unlink($file);
+        }
+        restore_error_handler();
+
+        unset($this->lastError);
+    }
+
     private function assertErrorWasTriggered($code, $message)
     {
         if (empty($this->lastError)) {
@@ -239,12 +251,4 @@ class RotatingFileHandlerTest extends TestCase
         $handler->handle($this->getRecord());
         $this->assertEquals('footest', file_get_contents($log));
     }
-
-    public function tearDown(): void
-    {
-        foreach (glob(__DIR__.'/Fixtures/*.rot') as $file) {
-            unlink($file);
-        }
-        restore_error_handler();
-    }
 }

tests/Monolog/Handler/SlackHandlerTest.php

@@ -39,6 +39,13 @@ class SlackHandlerTest extends TestCase
         }
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->res);
+    }
+
     public function testWriteHeader()
     {
         $this->createHandler();

tests/Monolog/Handler/SocketHandlerTest.php

@@ -30,6 +30,13 @@ class SocketHandlerTest extends TestCase
      */
     private $res;
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->res);
+    }
+
     public function testInvalidHostname()
     {
         $this->expectException(\UnexpectedValueException::class);

tests/Monolog/Handler/StreamHandlerTest.php

@@ -271,20 +271,20 @@ STRING;
             $this->markTestSkipped('We could not set a memory limit that would trigger the error.');
         }
 
-        $stream = tmpfile();
+        try {
+            $stream = tmpfile();
 
-        if ($stream === false) {
-            $this->markTestSkipped('We could not create a temp file to be use as a stream.');
+            if ($stream === false) {
+                $this->markTestSkipped('We could not create a temp file to be use as a stream.');
+            }
+
+            $handler = new StreamHandler($stream);
+            stream_get_contents($stream, 1024);
+
+            $this->assertEquals($expectedChunkSize, $handler->getStreamChunkSize());
+        } finally {
+            ini_set('memory_limit', $previousValue);
         }
-
-        $exceptionRaised = false;
-
-        $handler = new StreamHandler($stream);
-        stream_get_contents($stream, 1024);
-
-        ini_set('memory_limit', $previousValue);
-
-        $this->assertEquals($expectedChunkSize, $handler->getStreamChunkSize());
     }
 
     /**
@@ -298,10 +298,13 @@ STRING;
             $this->markTestSkipped('We could not set a memory limit that would trigger the error.');
         }
 
-        $stream = tmpfile();
-        new StreamHandler($stream);
-        stream_get_contents($stream);
-        ini_set('memory_limit', $previousValue);
-        $this->assertTrue(true);
+        try {
+            $stream = tmpfile();
+            new StreamHandler($stream);
+            stream_get_contents($stream);
+            $this->assertTrue(true);
+        } finally {
+            ini_set('memory_limit', $previousValue);
+        }
     }
 }

tests/Monolog/Handler/SwiftMailerHandlerTest.php

@@ -28,6 +28,13 @@ class SwiftMailerHandlerTest extends TestCase
             ->getMock();
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->mailer);
+    }
+
     public function testMessageCreationIsLazyWhenUsingCallback()
     {
         $this->mailer->expects($this->never())

tests/Monolog/Handler/SymfonyMailerHandlerTest.php

@@ -30,6 +30,13 @@ class SymfonyMailerHandlerTest extends TestCase
             ->getMock();
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->mailer);
+    }
+
     public function testMessageCreationIsLazyWhenUsingCallback()
     {
         $this->mailer->expects($this->never())

tests/Monolog/Handler/ZendMonitorHandlerTest.php

@@ -25,6 +25,13 @@ class ZendMonitorHandlerTest extends TestCase
         }
     }
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->zendMonitorHandler);
+    }
+
     /**
      * @covers  Monolog\Handler\ZendMonitorHandler::write
      */

tests/Monolog/PsrLogCompatTest.php

@@ -25,6 +25,13 @@ class PsrLogCompatTest extends TestCase
 {
     private $handler;
 
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->handler);
+    }
+
     public function getLogger(): LoggerInterface
     {
         $logger = new Logger('foo');

tests/Monolog/SignalHandlerTest.php

@@ -39,8 +39,10 @@ class SignalHandlerTest extends TestCase
         }
     }
 
-    protected function tearDown(): void
+    public function tearDown(): void
     {
+        parent::tearDown();
+
         if ($this->asyncSignalHandling !== null) {
             pcntl_async_signals($this->asyncSignalHandling);
         }
@@ -53,6 +55,8 @@ class SignalHandlerTest extends TestCase
                 pcntl_signal($signo, $handler);
             }
         }
+
+        unset($this->signalHandlers, $this->blockedSignals, $this->asyncSignalHandling);
     }
 
     private function setSignalHandler($signo, $handler = SIG_DFL)