From 0b2fd272ab474867ef870b5680d78ab8de4bb36b Mon Sep 17 00:00:00 2001
From: Wim Leers <44946-wimleers@users.noreply.drupalcode.org>
Date: Wed, 16 Nov 2022 17:21:26 -0500
Subject: [PATCH] Issue #3319768 by Wim Leers: Document why using dblog to
 query logged messages in build tests is justified

---
 tests/src/Build/CoreUpdateTest.php | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 49333abbe1..6f8f1f0d22 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -130,6 +130,12 @@ class CoreUpdateTest extends UpdateTestBase {
   public function testCron(string $template): void {
     $this->createTestProject($template);
     // Install dblog so we can check if any errors were logged during the update.
+    // This implies one can only retrieve log entries through the dblog UI. This
+    // seems non-ideal but it is the choice that requires least custom
+    // configuration or custom code. Using the `syslog` or `syslog_test` module
+    // or the `@RestResource=dblog` plugin for the `rest` module require
+    // more additional code than the inflexible log querying via
+    // `/admin/reports/dblog` below.
     $this->installModules(['dblog']);
 
     $this->visit('/admin/reports/status');
-- 
GitLab