[5.3] Does check the server error logs in system tests (#45409)

* Does check the server error logs in system tests

* order

* Update tests/System/README.md

Co-authored-by: Brian Teeman <[email protected]>

---------

Co-authored-by: Brian Teeman <[email protected]>

Author: laoneo

cypress.config.dist.mjs

@@ -42,5 +42,6 @@ export default defineConfig({
     smtp_host: 'localhost',
     smtp_port: '1025',
     cmsPath: '.',
+    logFile: '',
   },
 });

tests/System/README.md

@@ -178,6 +178,8 @@ The Joomla System Tests come with some convenient [Cypress Tasks](https://docs.c
 - **writeRelativeFile** – Writes a file relative to the CMS root folder
 - **deleteRelativePath** – Deletes a file or folder relative to the CMS root folder
 - **copyRelativeFile** – Copies a file relative to the CMS root folder
+- **checkForLogs** – Checks the log file (path defined in configuration) for errors
+- **clearLogs** – Clears the logs in the log file from the configuration
 - **startMailServer** – Starts the smtp-tester SMTP server
 - **getMails** – Get received mails from smtp-tester
 - **clearEmails** – Clear all smtp-tester received mails

tests/System/entrypoint.sh

@@ -39,4 +39,4 @@ if [ -z "$( ls -A '/root/.cache/Cypress' )" ]; then
   npx cypress verify
 fi
 
-npx cypress run --browser=firefox --e2e --env cmsPath=/tests/www/$TEST_GROUP,db_type=$DB_ENGINE,db_host=$DB_HOST,db_password=joomla_ut,db_prefix="${TEST_GROUP}_" --config baseUrl=https://localhost/$TEST_GROUP,screenshotsFolder=$JOOMLA_BASE/tests/System/output/screenshots
+npx cypress run --browser=firefox --e2e --env cmsPath=/tests/www/$TEST_GROUP,db_type=$DB_ENGINE,db_host=$DB_HOST,db_password=joomla_ut,db_prefix="${TEST_GROUP}_",logFile=/var/log/apache2/error.log --config baseUrl=https://localhost/$TEST_GROUP,screenshotsFolder=$JOOMLA_BASE/tests/System/output/screenshots

tests/System/plugins/index.mjs

@@ -1,6 +1,7 @@
 import { getMails, clearEmails, startMailServer } from './mail.mjs';
 import { writeRelativeFile, deleteRelativePath, copyRelativeFile } from './fs.mjs';
 import { queryTestDB, deleteInsertedItems } from './db.mjs';
+import { checkForLogs, clearLogs } from './logs.mjs';
 
 /**
  * Does the setup of the plugins.
@@ -17,6 +18,8 @@ export default function setupPlugins(on, config) {
     writeRelativeFile: ({ path, content, mode }) => writeRelativeFile(path, content, config, mode),
     deleteRelativePath: (path) => deleteRelativePath(path, config),
     copyRelativeFile: ({ source, destination }) => copyRelativeFile(source, destination, config),
+    checkForLogs: () => checkForLogs(config),
+    clearLogs: () => clearLogs(config),
     getMails: () => getMails(),
     clearEmails: () => clearEmails(),
     startMailServer: () => startMailServer(config),

tests/System/plugins/logs.mjs

@@ -0,0 +1,42 @@
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+
+/**
+ * Checks if there are entries written to the logs file.
+ *
+ * @param {object} config - The Cypress configuration object
+ *
+ * @returns null
+ */
+function checkForLogs(config) {
+  const { logFile } = config.env;
+  if (!existsSync(logFile)) {
+    return null;
+  }
+
+  const log = readFileSync(logFile, 'utf8');
+  if (!log) {
+    return null;
+  }
+
+  throw new Error(log);
+}
+
+/**
+ * Clears the log file.
+ *
+ * @param {object} config - The Cypress configuration object
+ *
+ * @returns null
+ */
+function clearLogs(config) {
+  const { logFile } = config.env;
+  if (!existsSync(logFile)) {
+    return null;
+  }
+
+  writeFileSync(logFile, '');
+
+  return null;
+}
+
+export { checkForLogs, clearLogs };

tests/System/support/index.js

@@ -3,9 +3,11 @@ import('joomla-cypress');
 
 before(() => {
   cy.task('startMailServer');
+  cy.task('clearLogs');
 });
 
 afterEach(() => {
   cy.checkForPhpNoticesOrWarnings();
+  cy.task('checkForLogs');
   cy.task('cleanupDB');
 });