LoggerTest::getSettingsArray() - Code Metrics - Inspection of "Issue #3301506 by webchick,reenaraghavan,fgm: Drup..." - FGM/mongodb - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 8.x-2.x ( 9af07d...3011f1 )

by Frédéric G.

created 2022-08-27 18:24 UTC

LoggerTest::getSettingsArray() A

↳ Parent: LoggerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	5
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	8
rs	10

<?php

declare(strict_types=1);

namespace Drupal\Tests\mongodb_watchdog\Kernel;

use Drupal\Core\Logger\RfcLogLevel;
filter:
    dependency_paths: ["lib/*"]
use Drupal\Core\StringTranslation\StringTranslationTrait;
filter:
    dependency_paths: ["lib/*"]
use Drupal\mongodb\MongoDb;
use Drupal\mongodb_watchdog\Logger;
use Drupal\Tests\mongodb\Kernel\MongoDbTestBase;

/**
 * Class LoggerTest tests the logging mechanism itself.
 *
 * @coversDefaultClass \Drupal\mongodb_watchdog\Logger
 *
 * @group MongoDB
 */
class LoggerTest extends MongoDbTestBase {
  use StringTranslationTrait;

  /**
   * The event templates collection.
   *
   * @var \MongoDB\Collection
   */
  protected $collection;

  /**
   * These modules need to be enabled.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    MongoDb::MODULE,
    Logger::MODULE,
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp(): void {
    parent::setUp();
    $this->installConfig(Logger::MODULE);
  }

  /**
   * {@inheritdoc}
   */
  protected function getSettingsArray(): array {
    $settings = parent::getSettingsArray();
    $settings['databases'][Logger::DB_LOGGER] = [
      static::CLIENT_TEST_ALIAS,
      $this->getDatabasePrefix(),
    ];

    return $settings;
  }

  /**
   * Assert that a given entry is present in the watchdog.
   *
   * @param string $message
   *   The message is present in the collection.
   */
  public function assertEntry($message) {
    $logged = $this->find($message);
    $this->assertNotNull($logged,
      (string) $this->t('Event %message is logged', ['%message' => $message]));
    $this->assertTrue(isset($logged['message']) && $logged['message'] == $message,
      (string) $this->t('Logged message is unchanged'));
  }

  /**
   * Assert that a given entry is not present in the watchdog.
   *
   * @param string $message
   *   The message which must not be present in the collection.
   */
  public function assertNoEntry($message) {
    $logged = $this->find($message);
    $this->assertNull($logged,
      (string) $this->t('Event %message is not logged', ['%message' => $message]));
  }

  /**
   * Replaces PSR-3 braces by angle brackets.
   *
   * Braces in log($l, $message, $c) will be interpreted as PSR-3 placeholders.
   * As such they need to be avoid when inserted randomly.
   *
   * @param string $message
   *   The raw message.
   *
   * @return string
   *   The replacement message.
   *
   * @see \Drupal\Core\Logger\LogMessageParserInterface::parseMessagePlaceholders()
   */
  public static function debrace(string $message): string {
    return str_replace(['{', '}'], ['<', '>'], $message);
  }

  /**
   * Simplified query to look for a logged message.
   *
   * @param string $message
   *   The message to look for.
   *
   * @return array|null
   *   The document containing the message, if any ; NULL otherwise.
   */
  protected function find($message) {
    $ret = $this->collection->findOne(['message' => $message]);
    return $ret;

  }

  /**
   * Ensure logging from a closure does not fail.
   *
   * @covers ::enhanceLogEntry
   *
   * @see https://www.drupal.org/project/mongodb/issues/3193195
   */
  public function testLogClosure() {
    $logger = $this->container->get(Logger::SERVICE_LOGGER);
    $closure = function () use ($logger) {
      $logger->notice("This fails on PHP below 7.0, and 5.6 needs to be supported for Drupal 8. The alcaeus adapter passes the version check, but does not address this.");
      return 1;
    };
    $this->assertEquals(1, $closure());
  }

  /**
   * Test the default and non-default mongodb_watchdog insertion behaviours.
   *
   * Make sure the module applies the watchdog_limit variable,
   *
   * @covers ::log
   */
  public function testWatchdogLimit() {
    $config = $this->config(Logger::CONFIG_NAME);
    $limit = $config->get(Logger::CONFIG_LIMIT);
    $this->assertEquals(RfcLogLevel::DEBUG, $limit,
      (string) $this->t('%name defaults to @level', [
        '%name' => Logger::CONFIG_LIMIT,
        '@level' => RfcLogLevel::DEBUG,
      ]));

    $logger = $this->container->get(Logger::SERVICE_LOGGER);
    $database = $this->container->get(MongoDb::SERVICE_DB_FACTORY)
      ->get(Logger::DB_LOGGER);
    $this->collection = $database->selectCollection(Logger::TEMPLATE_COLLECTION);
    $this->collection->drop();

    $message = static::debrace($this->randomString(32));
    $logger->log($limit, $message);
    $this->assertEntry($message);

    // Now request a higher level: unimportant events should be ignored. For
    // this to work, ensure limit is not the maximum level already.
    $logger->setLimit(RfcLogLevel::INFO);
    $this->collection->drop();

    $message = $this->randomMachineName(32);
    $logger->debug($message);
    $this->assertNoEntry($message);

    // ... but events at the limit or more important should be logged.
    $message = $this->randomMachineName(32);
    $logger->notice($message);
    $this->assertEntry($message);

    $message = $this->randomMachineName(32);
    $logger->error($message);
    $this->assertEntry($message);
  }

}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Drupal\Tests\mongodb_watchdog\Kernel;
6
7			use Drupal\Core\Logger\RfcLogLevel;
			0 ignored issues – show Bug introduced 2022-08-27 18:14 UTC by Report Bug Copy Issue Report The type `Drupal\Core\Logger\RfcLogLevel` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use Drupal\Core\StringTranslation\StringTranslationTrait;
			0 ignored issues – show Bug introduced 2022-08-27 18:14 UTC by Report Bug Copy Issue Report The type `Drupal\Core\StringTransl...\StringTranslationTrait` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9			use Drupal\mongodb\MongoDb;
10			use Drupal\mongodb_watchdog\Logger;
11			use Drupal\Tests\mongodb\Kernel\MongoDbTestBase;
12
13			/**
14			* Class LoggerTest tests the logging mechanism itself.
15			*
16			* @coversDefaultClass \Drupal\mongodb_watchdog\Logger
17			*
18			* @group MongoDB
19			*/
20			class LoggerTest extends MongoDbTestBase {
21			use StringTranslationTrait;
22
23			/**
24			* The event templates collection.
25			*
26			* @var \MongoDB\Collection
27			*/
28			protected $collection;
29
30			/**
31			* These modules need to be enabled.
32			*
33			* @var array
34			*/
35			protected static $modules = [
36			'system',
37			MongoDb::MODULE,
38			Logger::MODULE,
39			];
40
41			/**
42			* {@inheritdoc}
43			*/
44			public function setUp(): void {
45			parent::setUp();
46			$this->installConfig(Logger::MODULE);
47			}
48
49			/**
50			* {@inheritdoc}
51			*/
52			protected function getSettingsArray(): array {
53			$settings = parent::getSettingsArray();
54			$settings['databases'][Logger::DB_LOGGER] = [
55			static::CLIENT_TEST_ALIAS,
56			$this->getDatabasePrefix(),
57			];
58
59			return $settings;
60			}
61
62			/**
63			* Assert that a given entry is present in the watchdog.
64			*
65			* @param string $message
66			* The message is present in the collection.
67			*/
68			public function assertEntry($message) {
69			$logged = $this->find($message);
70			$this->assertNotNull($logged,
71			(string) $this->t('Event %message is logged', ['%message' => $message]));
72			$this->assertTrue(isset($logged['message']) && $logged['message'] == $message,
73			(string) $this->t('Logged message is unchanged'));
74			}
75
76			/**
77			* Assert that a given entry is not present in the watchdog.
78			*
79			* @param string $message
80			* The message which must not be present in the collection.
81			*/
82			public function assertNoEntry($message) {
83			$logged = $this->find($message);
84			$this->assertNull($logged,
85			(string) $this->t('Event %message is not logged', ['%message' => $message]));
86			}
87
88			/**
89			* Replaces PSR-3 braces by angle brackets.
90			*
91			* Braces in log($l, $message, $c) will be interpreted as PSR-3 placeholders.
92			* As such they need to be avoid when inserted randomly.
93			*
94			* @param string $message
95			* The raw message.
96			*
97			* @return string
98			* The replacement message.
99			*
100			* @see \Drupal\Core\Logger\LogMessageParserInterface::parseMessagePlaceholders()
101			*/
102			public static function debrace(string $message): string {
103			return str_replace(['{', '}'], ['<', '>'], $message);
104			}
105
106			/**
107			* Simplified query to look for a logged message.
108			*
109			* @param string $message
110			* The message to look for.
111			*
112			* @return array\|null
113			* The document containing the message, if any ; NULL otherwise.
114			*/
115			protected function find($message) {
116			$ret = $this->collection->findOne(['message' => $message]);
117			return $ret;
			0 ignored issues – show Bug Best Practice introduced 2022-08-27 18:14 UTC by Report Bug Copy Issue Report The expression `return $ret` also could return the type `object` which is incompatible with the documented return type `array\|null`. Loading history...
118			}
119
120			/**
121			* Ensure logging from a closure does not fail.
122			*
123			* @covers ::enhanceLogEntry
124			*
125			* @see https://www.drupal.org/project/mongodb/issues/3193195
126			*/
127			public function testLogClosure() {
128			$logger = $this->container->get(Logger::SERVICE_LOGGER);
129			$closure = function () use ($logger) {
130			$logger->notice("This fails on PHP below 7.0, and 5.6 needs to be supported for Drupal 8. The alcaeus adapter passes the version check, but does not address this.");
131			return 1;
132			};
133			$this->assertEquals(1, $closure());
134			}
135
136			/**
137			* Test the default and non-default mongodb_watchdog insertion behaviours.
138			*
139			* Make sure the module applies the watchdog_limit variable,
140			*
141			* @covers ::log
142			*/
143			public function testWatchdogLimit() {
144			$config = $this->config(Logger::CONFIG_NAME);
145			$limit = $config->get(Logger::CONFIG_LIMIT);
146			$this->assertEquals(RfcLogLevel::DEBUG, $limit,
147			(string) $this->t('%name defaults to @level', [
148			'%name' => Logger::CONFIG_LIMIT,
149			'@level' => RfcLogLevel::DEBUG,
150			]));
151
152			$logger = $this->container->get(Logger::SERVICE_LOGGER);
153			$database = $this->container->get(MongoDb::SERVICE_DB_FACTORY)
154			->get(Logger::DB_LOGGER);
155			$this->collection = $database->selectCollection(Logger::TEMPLATE_COLLECTION);
156			$this->collection->drop();
157
158			$message = static::debrace($this->randomString(32));
159			$logger->log($limit, $message);
160			$this->assertEntry($message);
161
162			// Now request a higher level: unimportant events should be ignored. For
163			// this to work, ensure limit is not the maximum level already.
164			$logger->setLimit(RfcLogLevel::INFO);
165			$this->collection->drop();
166
167			$message = $this->randomMachineName(32);
168			$logger->debug($message);
169			$this->assertNoEntry($message);
170
171			// ... but events at the limit or more important should be logged.
172			$message = $this->randomMachineName(32);
173			$logger->notice($message);
174			$this->assertEntry($message);
175
176			$message = $this->randomMachineName(32);
177			$logger->error($message);
178			$this->assertEntry($message);
179			}
180
181			}
182

FGM / mongodb

Push — 8.x-2.x ( 9af07d...3011f1 )

LoggerTest::getSettingsArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like