Merge pull request #140 from kstekovi/main

Improve developer experience: auto-detect Podman, structured logging, and dependency updates

Author: OndrejKotek

.github/workflows/manual-test-matrix-workflow.yaml

@@ -1,5 +1,10 @@
 on:
   workflow_dispatch:
+    inputs:
+      verbose:
+        type: boolean
+        description: "Enable verbose Berg logging"
+        default: false
 name: "Manual matrix test execution"
 concurrency:
   group: ${{ github.ref }}
@@ -30,6 +35,8 @@ jobs:
             "mail",
             "microprofile",
             "metrics",
+            "micrometer",
+            "opentelemetry",
             "runtime",
             "security-manager",
             "system-property",
@@ -71,6 +78,9 @@ jobs:
       - name: "Run compile"
         run: "npm run compile"
       - name: "Run test(s)"
+        env:
+          BERG_VERBOSE: ${{ inputs.verbose }}
+          DEBUG: ${{ inputs.verbose && 'testcontainers*' || '' }}
         run: "npm run test:compiled -- --browser=firefox --specs=packages/testsuite/cypress/e2e/${{ matrix.specs }}"
       - name: "Archive test report(s) and video(s)"
         if: ${{ !cancelled() }}

.github/workflows/manual-test-worfklow.yaml

@@ -4,9 +4,14 @@ on:
       spec:
         type: string
         description: "Spec to run"
+      verbose:
+        type: boolean
+        description: "Enable verbose Berg logging"
+        default: false
 name: "Manual job execution"
 jobs:
   call-reusable-workflow:
     uses: "./.github/workflows/reusable-build-project-workflow.yaml"
     with:
       spec: ${{ inputs.spec }}
+      verbose: ${{ inputs.verbose }}

.github/workflows/on-pull-request-workflow.yaml

@@ -35,6 +35,8 @@ jobs:
             packages/testsuite/cypress/e2e/**/*.cy.ts
       - name: "Run tests of modified files"
         if: steps.changed-files-specific.outputs.any_changed == 'true'
+        env:
+          TESTCONTAINERS_RYUK_DISABLED: true
         run: |
           SPECS="${{ steps.changed-files-specific.outputs.all_changed_files }}"
           KEYCLOAK_IMAGE=quay.io/keycloak/keycloak:24.0 npm run test -- --browser=chrome --specs=$SPECS

.github/workflows/reusable-build-project-workflow.yaml

@@ -6,6 +6,11 @@ on:
         type: string
         required: false
         description: "Comma delimited test spec file(s) to run."
+      verbose:
+        type: boolean
+        required: false
+        default: false
+        description: "Enable verbose Berg logging"
 jobs:
   build_project_job:
     name: "Build Project"
@@ -36,7 +41,15 @@ jobs:
         run: "npm run compile"
       - name: "Run all tests"
         if: "${{ github.event.inputs.spec == '' }}"
+        env:
+          TESTCONTAINERS_RYUK_DISABLED: true
+          BERG_VERBOSE: ${{ inputs.verbose }}
+          DEBUG: ${{ inputs.verbose && 'testcontainers*' || '' }}
         run: "npm run test:compiled"
       - name: "Run specific test"
         if: "${{ github.event.inputs.spec != '' }}"
+        env:
+          TESTCONTAINERS_RYUK_DISABLED: true
+          BERG_VERBOSE: ${{ inputs.verbose }}
+          DEBUG: ${{ inputs.verbose && 'testcontainers*' || '' }}
         run: "npm run test:compiled -- --specs=${{ inputs.spec }}"

.github/workflows/scheduled-run-all-tests-workflow.yaml

@@ -30,6 +30,8 @@ jobs:
             "jsf",
             "mail",
             "metrics",
+            "micrometer",
+            "opentelemetry",
             "runtime",
             "security-manager",
             "system-property",

README.md

@@ -28,11 +28,9 @@ Following tools are required to run the test suite
   - recommended version is 22.
   - [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm) is recommended optional tool to install & manage multiple Node environments
 - [npx](https://github.com/npm/npx) CLI tool used to exeute binaries from project's `node_modules` directly (instead of providing absolute/relative path to the commannds). It is used in multiple build steps.
-- [Podman](https://podman.io) | [Docker](https://www.docker.com) as a container runtime used by TestContainers. Note that when using Podman as container runtime you may need to export following environment variables and start podman socket:
+- [Podman](https://podman.io) | [Docker](https://www.docker.com) as a container runtime used by TestContainers. Podman is auto-detected: `DOCKER_HOST`, `TESTCONTAINERS_RYUK_DISABLED`, and `podman.socket` are configured automatically. To override, set the environment variables manually before running the test suite:
   - `export TESTCONTAINERS_RYUK_DISABLED=true`
   - `export DOCKER_HOST=unix:///run/user/$UID/podman/podman.sock`
-    - the path can be found by command `podman info --debug` and look for `path` in `remoteSocket` section.
-  - `systemctl --user start podman.socket`
 - Java. Yes we'll need Java to write deployments/applications that will be deployed onto the running WildFly container.
 - [Maven](https://maven.apache.org). Yes, we'll need Maven to ease up the development of the deployed applications & downloading needed JDBC drivers for datasource & drivers UI tests. Maven is mostly used embedded by [node-maven](https://github.com/headcr4sh/node-maven) JS wrapper to execute Maven & Java related tasks into the build automation.
 
@@ -96,6 +94,21 @@ Following is a table of supported environment properties that can be used when r
 | `MYSQL_IMAGE`    | `docker.io/library/mysql:latest`                | MySQL image to be used for datasource tests                                                   |
 | `MARIADB_IMAGE`  | `docker.io/library/mariadb:latest`              | MariaDB image to be used for datasource tests                                                 |
 | `MSSQL_IMAGE`    | `mcr.microsoft.com/mssql/server:2022-latest`    | Microsoft SQL Server image to be used for datasource tests                                    |
+| `BERG_VERBOSE`   | `false`                                         | Enable verbose Berg logging (debug messages for container setup, CLI commands, etc.)          |
+
+## JDBC drivers
+
+JDBC driver jars are used in datasource tests. They are downloaded automatically by Maven during `npm install` (via `npm run resources`) and placed into `packages/testsuite/cypress/fixtures/jdbc-drivers/`. These jars are `.gitignore`d and built fresh each time.
+
+### Where versions are defined
+
+Driver versions are managed in [`packages/resources/pom.xml`](packages/resources/pom.xml) under `<dependencyManagement>`. The download is configured in [`packages/resources/modules/jdbc-drivers/pom.xml`](packages/resources/modules/jdbc-drivers/pom.xml).
+
+### How to update
+
+1. Update the version in `packages/resources/pom.xml` under `<dependencyManagement>`
+2. Run `npm install` or `npm run resources` to download the new jars
+3. No test spec changes needed -- driver paths are resolved automatically at runtime by the `resolve:jdbc:driver` Cypress task using the artifact prefix (e.g., `postgresql`, `mysql-connector-j`)
 
 ## Custom method documentation
 

config/containers/database.ts

@@ -1,6 +1,6 @@
 import { PullPolicy, GenericContainer, StartedTestContainer, Wait } from "testcontainers";
 import { DatabaseConfig } from "../interfaces";
-import { handleContainerError } from "../helpers";
+import { handleContainerError, logger } from "../helpers";
 
 export function startDatabaseContainer(
   config: DatabaseConfig,
@@ -18,7 +18,7 @@ export function startDatabaseContainer(
   return containerBuilder
     .start()
     .then((container) => {
-      console.log(config.successMessage);
+      logger.debug(config.successMessage);
       startedContainersMap.set(config.containerMapKey, container);
       return container;
     })

config/containers/wildfly.ts

@@ -11,7 +11,7 @@ import {
   MANAGEMENT_INTERFACE_ADDRESS,
 } from "../../cypress.config";
 import { WildflyManagementResponse } from "../interfaces";
-import { buildLocalhostUrl } from "../helpers";
+import { buildLocalhostUrl, logger } from "../helpers";
 
 export function pollWildflyState(managementApi: string, container: StartedTestContainer): Promise<string> {
   const startTime = new Date().getTime();
@@ -34,7 +34,7 @@ export function pollWildflyState(managementApi: string, container: StartedTestCo
           }
         })
         .catch(() => {
-          console.log("WildFly server is not ready yet");
+          logger.debug("WildFly server is not ready yet");
         });
     }, WILDFLY_POLL_INTERVAL_MS);
   });
@@ -61,7 +61,7 @@ export function configureWildflyNetworkMode(
   networkName?: string,
 ): Promise<{ portOffset: number }> {
   if (useHostMode) {
-    console.log("host mode");
+    logger.debug("host mode");
     return findAPortNotInUse(WILDFLY_PORT_RANGE.min, WILDFLY_PORT_RANGE.max).then((freePort) => {
       const portOffset = freePort - WILDFLY_PORT_RANGE.min;
       wildfly
@@ -75,7 +75,7 @@ export function configureWildflyNetworkMode(
       return { portOffset };
     });
   } else {
-    console.log(`default network mode, network name: ${networkName}`);
+    logger.debug(`default network mode, network name: ${networkName}`);
     wildfly
       .withNetworkMode(networkName!)
       .withNetworkAliases("wildfly")

config/helpers/error-handler.ts

@@ -1,4 +1,6 @@
+import { logger } from "./logger";
+
 export function handleContainerError(err: unknown): Error {
-  console.log(err);
+  logger.error(err);
   return err instanceof Error ? err : new Error(JSON.stringify(err));
 }

config/helpers/index.ts

@@ -1,3 +1,4 @@
 export * from "./error-handler";
 export * from "./url-builder";
 export * from "./container-helpers";
+export * from "./logger";