Fixed Watchdog trait not scanning for messages of type other than 'php'.

Author: Alex Skrypnyk

src/D7/WatchdogTrait.php

@@ -21,6 +21,13 @@ trait WatchdogTrait {
    */
   protected $watchdogScenarioStartTime;
 
+  /**
+   * Array of watchdog message types.
+   *
+   * @var array
+   */
+  protected $watchdogMessageTypes = [];
+
   /**
    * Store current time.
    *
@@ -33,6 +40,34 @@ public function watchdogSetScenarioStartTime(BeforeScenarioScope $scope) {
     }
 
     $this->watchdogScenarioStartTime = time();
+
+    $this->watchdogMessageTypes = $this->watchdogParseMessageTypes($scope->getScenario()->getTags());
+  }
+
+  /**
+   * Parse scenario tags into message types.
+   *
+   * @code
+   * @watchdog:my_module_type @watchdog:my_other_module_type
+   * @endcode
+   *
+   * @param array $tags
+   *   Array of scenario tags.
+   * @param string $prefix
+   *   Optional tag prefix to filter by.
+   *
+   * @return array
+   *   Array of message types. 'php' is always added to the list.
+   */
+  protected function watchdogParseMessageTypes(array $tags = [], $prefix = 'watchdog:') {
+    $types = [];
+    foreach ($tags as $tag) {
+      if (strpos($tag, $prefix) === 0 && strlen($tag) > strlen($prefix)) {
+        $types[] = substr($tag, strlen($prefix));
+      }
+    }
+
+    return array_unique(array_merge($types, ['php']));
   }
 
   /**
@@ -64,7 +99,7 @@ public function watchdogAssertErrors(AfterScenarioScope $scope) {
     // of the scenario.
     $entries = db_select('watchdog', 'w')
       ->fields('w')
-      ->condition('w.type', 'php', '=')
+      ->condition('w.type', $this->watchdogMessageTypes, 'IN')
       ->condition('w.timestamp', $this->watchdogScenarioStartTime, '>=')
       ->execute()
       ->fetchAll();

src/WatchdogTrait.php

@@ -22,6 +22,13 @@ trait WatchdogTrait {
    */
   protected $watchdogScenarioStartTime;
 
+  /**
+   * Array of watchdog message types.
+   *
+   * @var array
+   */
+  protected $watchdogMessageTypes = [];
+
   /**
    * Store current time.
    *
@@ -34,6 +41,34 @@ public function watchdogSetScenarioStartTime(BeforeScenarioScope $scope) {
     }
 
     $this->watchdogScenarioStartTime = time();
+
+    $this->watchdogMessageTypes = $this->watchdogParseMessageTypes($scope->getScenario()->getTags());
+  }
+
+  /**
+   * Parse scenario tags into message types.
+   *
+   * @code
+   * @watchdog:my_module_type @watchdog:my_other_module_type
+   * @endcode
+   *
+   * @param array $tags
+   *   Array of scenario tags.
+   * @param string $prefix
+   *   Optional tag prefix to filter by.
+   *
+   * @return array
+   *   Array of message types. 'php' is always added to the list.
+   */
+  protected function watchdogParseMessageTypes(array $tags = [], $prefix = 'watchdog:') {
+    $types = [];
+    foreach ($tags as $tag) {
+      if (strpos($tag, $prefix) === 0 && strlen($tag) > strlen($prefix)) {
+        $types[] = substr($tag, strlen($prefix));
+      }
+    }
+
+    return array_unique(array_merge($types, ['php']));
   }
 
   /**
@@ -65,7 +100,7 @@ public function watchdogAssertErrors(AfterScenarioScope $scope) {
     // of the scenario.
     $entries = $database->select('watchdog', 'w')
       ->fields('w')
-      ->condition('w.type', 'php', '=')
+      ->condition('w.type', $this->watchdogMessageTypes, 'IN')
       ->condition('w.timestamp', $this->watchdogScenarioStartTime, '>=')
       ->execute()
       ->fetchAll();

tests/behat/bootstrap/BehatCliTrait.php

@@ -88,17 +88,19 @@ public function throwTestException($message) {
   
   /**
    * @Given set Drupal7 watchdog error level :level
+   * @Given set Drupal7 watchdog error level :level of type :type
    */
-  public function setWatchdogErrorDrupal7($level) {
-    watchdog('php', 'test', [], $level);
-  }  
+  public function setWatchdogErrorDrupal7($level, $type = 'php') {
+    watchdog($type, 'test', [], $level);
+  }
 
   /**
    * @Given set watchdog error level :level
+   * @Given set watchdog error level :level of type :type
    */
-  public function setWatchdogErrorDrupal9($level) {
-    \Drupal::logger('php')->log($level, 'test');
-  }  
+  public function setWatchdogErrorDrupal9($level, $type = 'php') {
+    \Drupal::logger($type)->log($level, 'test');
+  }
       
 }
 EOL;

tests/behat/bootstrap/FeatureContextD7Trait.php

@@ -78,9 +78,10 @@ public function fileObjectExist($file_name) {
 
   /**
    * @Given set Drupal7 watchdog error level :level
+   * @Given set Drupal7 watchdog error level :level of type :type
    */
-  public function setWatchdogErrorDrupal7($level) {
-    watchdog('php', 'test', [], $level);
+  public function setWatchdogErrorDrupal7($level, $type = 'php') {
+    watchdog($type, 'test', [], $level);
   }
 
   /**

tests/behat/bootstrap/FeatureContextTrait.php

@@ -58,9 +58,10 @@ public function userDoesNotExist($name) {
 
   /**
    * @Given set watchdog error level :level
+   * @Given set watchdog error level :level of type :type
    */
-  public function setWatchdogErrorDrupal9($level) {
-    \Drupal::logger('php')->log($level, 'test');
+  public function setWatchdogErrorDrupal9($level, $type = 'php') {
+    \Drupal::logger($type)->log($level, 'test');
   }
 
   /**

tests/behat/features/d7.watchdog.feature

@@ -14,6 +14,29 @@ Feature: Check that WatchdogTrait works for D7
       PHP errors were logged to watchdog during scenario "Stub scenario title" (line 3):
       """
 
+  @trait:D7\WatchdogTrait
+  Scenario: Assert that watchdog does not fail when a custom message type is triggered
+    Given some behat configuration
+    And scenario steps:
+      """
+      Given set Drupal7 watchdog error level 4 of type "custom_type"
+      """
+    When I run "behat --no-colors"
+    Then it should pass
+
+  @trait:D7\WatchdogTrait
+  Scenario: Assert that watchdog fails when a custom message type is triggered
+    Given some behat configuration
+    And scenario steps tagged with "@api @watchdog:custom_type":
+      """
+      Given set Drupal7 watchdog error level 4 of type "custom_type"
+      """
+    When I run "behat --no-colors"
+    Then it should fail with an error:
+      """
+      PHP errors were logged to watchdog during scenario "Stub scenario title" (line 3):
+      """
+
   @api
   Scenario: Assert that watchdog does not track errors with level below threshold
     Given set Drupal7 watchdog error level 5

tests/behat/features/watchdog.feature

@@ -14,6 +14,29 @@ Feature: Check that WatchdogTrait works for or D9
       PHP errors were logged to watchdog during scenario "Stub scenario title" (line 3):
       """
 
+  @trait:WatchdogTrait
+  Scenario: Assert that watchdog does not fail when a custom message type is triggered
+    Given some behat configuration
+    And scenario steps:
+      """
+      Given set watchdog error level "warning" of type "custom_type"
+      """
+    When I run "behat --no-colors"
+    Then it should pass
+
+  @trait:WatchdogTrait
+  Scenario: Assert that watchdog fails when a custom message type is triggered
+    Given some behat configuration
+    And scenario steps tagged with "@api @watchdog:custom_type":
+      """
+      Given set watchdog error level "warning" of type "custom_type"
+      """
+    When I run "behat --no-colors"
+    Then it should fail with an error:
+      """
+      PHP errors were logged to watchdog during scenario "Stub scenario title" (line 3):
+      """
+
   @api
   Scenario: Assert that watchdog does not track errors with level below threshold
     Given set watchdog error level "notice"