Configurable global log level.

Author: guncha25

src/Codeception/Module/DrupalUser.php

@@ -72,7 +72,7 @@ public function createUserWithRoles(array $roles = [], $password = FALSE) {
   /**
    * Log in user by username.
    *
-   * @param string|int $uid
+   * @param string|int $username
    *   User id.
    */
   public function logInAs($username) {
@@ -151,7 +151,7 @@ public function userCleanup() {
   /**
    * Delete user created entities.
    *
-   * @param $uid
+   * @param string|int $uid
    *   User id.
    *
    * @throws \Drupal\Core\Entity\EntityStorageException

src/Codeception/Module/DrupalWatchdog.php

@@ -19,9 +19,8 @@ class DrupalWatchdog extends Module {
    * @var array
    */
   protected $config = [
-    'channels' => [
-      'php' => 'notice',
-    ],
+    'channels' => [],
+    'level' => 'ERROR',
   ];
 
   /**
@@ -48,32 +47,69 @@ public function _beforeSuite($settings = []) { // @codingStandardsIgnoreLine
       // Clear log entries from the database log.
       \Drupal::database()->truncate('watchdog')->execute();
     }
+    else {
+      $this->fail('Database loging is not enabled.');
+    }
   }
 
   /**
-   * Tear down after tests.
+   * {@inheritdoc}
    */
   public function _afterSuite() { // @codingStandardsIgnoreLine
-    if (\Drupal::moduleHandler()->moduleExists('dblog')) {
-      foreach ($this->config['channels'] as $channel => $level) {
+    $channels = $this->_getConfig('channels');
+    if (!empty($channels) && is_array($channels)) {
+      foreach ($this->_getConfig('channels') as $channel => $level) {
         if (is_string($level) && !empty($this->logLevels[strtoupper($level)])) {
-          // Load any database log entries of level WARNING or more serious.
-          $query = \Drupal::database()->select('watchdog', 'w');
-          $query->fields('w', ['type', 'severity', 'message', 'variables'])
-            ->condition('severity', $this->logLevels[strtoupper($level)], '<=')
-            ->condition('type', $channel);
-          $result = $query->execute();
-          foreach ($result as $row) {
-            // Build a readable message and declare a failure.
-            $variables = @unserialize($row->variables);
-            $message = $row->type . ' - ';
-            $message .= RfcLogLevel::getLevels()[$row->severity] . ': ';
-            $message .= t(Xss::filterAdmin($row->message), $variables)->render(); // @codingStandardsIgnoreLine
-            $this->fail($message);
-          }
+          $this->processResult($this->getLogResults($level, $channel));
         }
       }
     }
+    if ($level = $this->_getConfig('level') && is_string($level) && isset($this->logLevels[strtoupper($level)])) {
+      $this->processResult($this->getLogResults($level));
+    }
+  }
+
+  /**
+   * Returns query result of log messages.
+   *
+   * @param string $level
+   *   Log level.
+   * @param string $channel
+   *   Log channel.
+   *
+   * @return \Drupal\Core\Database\StatementInterface|null
+   *   Query result.
+   */
+  private function getLogResults($level, $channel = NULL) {
+    $query = \Drupal::database()->select('watchdog', 'w');
+    $query->fields('w', ['type', 'severity', 'message', 'variables'])
+      ->condition('severity', $this->logLevels[strtoupper($level)], '<=');
+
+    if ($channel) {
+      $query->condition('type', $channel);
+    }
+    return $query->execute();
+  }
+
+  /**
+   * Process log results.
+   *
+   * @param mixed $result
+   *   Query result.
+   */
+  protected function processResult($result) {
+    $messages = [];
+    foreach ($result as $row) {
+      // Build a readable message and declare a failure.
+      $variables = @unserialize($row->variables);
+      $message = $row->type . ' - ';
+      $message .= RfcLogLevel::getLevels()[$row->severity] . ': ';
+      $message .= t(Xss::filterAdmin($row->message), $variables)->render(); // @codingStandardsIgnoreLine
+      $messages[] = $message;
+    }
+    if (!empty($messages)) {
+      $this->fail(implode(PHP_EOL, $messages));
+    }
   }
 
 }