test(test-tooling): filter whitespaces from container logs #1247

Adds a utility function in the Containers class to stream logs and automatically exclude newline-only log messages. Resolves #1247 Signed-off-by: jgusta <jgustafx@gmail.com>
hyperledger-cacti · Oct 28, 2021 · 67ddebe · 67ddebe
1 parent 4a4e38f
commit 67ddebe
Show file tree

Hide file tree

Showing 11 changed files with 80 additions and 48 deletions.
diff --git a/packages/cactus-test-tooling/src/main/typescript/besu/besu-mp-test-ledger.ts b/packages/cactus-test-tooling/src/main/typescript/besu/besu-mp-test-ledger.ts
@@ -149,11 +149,11 @@ export class BesuMpTestLedger {
         this._containerId = Optional.ofNonNull(id);
 
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.imageFqn}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.imageFqn}]`;
+          await Containers.streamLogs({
+            container: this.container.get(),
+            tag: fnTag,
+            log: this.log,
           });
         }
 

diff --git a/packages/cactus-test-tooling/src/main/typescript/besu/besu-test-ledger.ts b/packages/cactus-test-tooling/src/main/typescript/besu/besu-test-ledger.ts
@@ -266,11 +266,11 @@ export class BesuTestLedger implements ITestLedger {
         this.containerId = container.id;
 
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.getContainerImageName()}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.getContainerImageName()}]`;
+          await Containers.streamLogs({
+            container: this.getContainer(),
+            tag: fnTag,
+            log: this.log,
           });
         }
 

diff --git a/packages/cactus-test-tooling/src/main/typescript/common/containers.ts b/packages/cactus-test-tooling/src/main/typescript/common/containers.ts
@@ -16,6 +16,7 @@ import {
   LoggerProvider,
   Strings,
   ILoggerOptions,
+  Logger,
 } from "@hyperledger/cactus-common";
 import { IDockerPullProgress } from "./i-docker-pull-progress";
 
@@ -630,4 +631,23 @@ export class Containers {
     }
     return response;
   }
+
+  public static async streamLogs(req: IStreamLogsRequest): Promise<void> {
+    const logOptions = { follow: true, stderr: true, stdout: true };
+    const logStream = await req.container.logs(logOptions);
+    const newLineOnlyLogMessages = [`\r\n`, `+\r\n`, `.\r\n`];
+
+    logStream.on("data", (data: Buffer) => {
+      const msg = data.toString("utf-8");
+      if (!newLineOnlyLogMessages.includes(msg)) {
+        req.log.debug(`${req.tag} %o`, msg);
+      }
+    });
+  }
+}
+
+export interface IStreamLogsRequest {
+  readonly container: Container;
+  readonly log: Logger;
+  readonly tag: string;
 }
diff --git a/...ages/cactus-test-tooling/src/main/typescript/corda-connector/corda-connector-container.ts b/...ages/cactus-test-tooling/src/main/typescript/corda-connector/corda-connector-container.ts
@@ -134,14 +134,16 @@ export class CordaConnectorContainer {
       eventEmitter.once("start", async (container: Container) => {
         this.container = container;
         this.containerId = container.id;
+
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.getContainerImageName()}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.getContainerImageName()}]`;
+          await Containers.streamLogs({
+            container: this.getContainer(),
+            tag: fnTag,
+            log: this.log,
           });
         }
+
         try {
           await Containers.waitForHealthCheck(this.containerId);
           resolve(container);

diff --git a/packages/cactus-test-tooling/src/main/typescript/corda/corda-test-ledger.ts b/packages/cactus-test-tooling/src/main/typescript/corda/corda-test-ledger.ts
@@ -175,14 +175,16 @@ export class CordaTestLedger implements ITestLedger {
       eventEmitter.once("start", async (container: Container) => {
         this.container = container;
         this.containerId = container.id;
+
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.getContainerImageName()}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.getContainerImageName()}]`;
+          await Containers.streamLogs({
+            container: this.getContainer(),
+            tag: fnTag,
+            log: this.log,
           });
         }
+
         try {
           let isHealthy = false;
           do {

diff --git a/packages/cactus-test-tooling/src/main/typescript/fabric/fabric-test-ledger-v1.ts b/packages/cactus-test-tooling/src/main/typescript/fabric/fabric-test-ledger-v1.ts
@@ -443,11 +443,11 @@ export class FabricTestLedgerV1 implements ITestLedger {
         this.containerId = container.id;
 
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.getContainerImageName()}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.getContainerImageName()}]`;
+          await Containers.streamLogs({
+            container: this.getContainer(),
+            tag: fnTag,
+            log: this.log,
           });
         }
 

diff --git a/packages/cactus-test-tooling/src/main/typescript/go-ipfs/go-ipfs-test-container.ts b/packages/cactus-test-tooling/src/main/typescript/go-ipfs/go-ipfs-test-container.ts
@@ -139,11 +139,11 @@ export class GoIpfsTestContainer {
         this._containerId = Optional.ofNonNull(id);
 
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.imageFqn}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.imageFqn}]`;
+          await Containers.streamLogs({
+            container: this.container.get(),
+            tag: fnTag,
+            log: this.log,
           });
         }
 

diff --git a/packages/cactus-test-tooling/src/main/typescript/iroha/iroha-test-ledger.ts b/packages/cactus-test-tooling/src/main/typescript/iroha/iroha-test-ledger.ts
@@ -310,13 +310,16 @@ export class IrohaTestLedger implements ITestLedger {
         this.log.debug(`Started container OK. Waiting for healthcheck...`);
         this.container = container;
         this.containerId = container.id;
+
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            this.log.debug(`[${this.imageFqn}] %o`, data.toString("utf-8"));
+          const fnTag = `[${this.imageFqn}]`;
+          await Containers.streamLogs({
+            container: this.container,
+            tag: fnTag,
+            log: this.log,
           });
         }
+
         try {
           await this.waitForHealthCheck();
           this.log.debug(`Healthcheck passing OK.`);

diff --git a/packages/cactus-test-tooling/src/main/typescript/openethereum/openethereum-test-ledger.ts b/packages/cactus-test-tooling/src/main/typescript/openethereum/openethereum-test-ledger.ts
@@ -154,13 +154,16 @@ export class OpenEthereumTestLedger {
       eventEmitter.once("start", async (container: Container) => {
         this._container = container;
         this._containerId = container.id;
+
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            this.log.debug(`[${this.imageFqn}] %o`, data.toString("utf-8"));
+          const fnTag = `[${this.imageFqn}]`;
+          await Containers.streamLogs({
+            container: this.container,
+            tag: fnTag,
+            log: this.log,
           });
         }
+
         try {
           await Containers.waitForHealthCheck(this._containerId);
           resolve(container);

diff --git a/packages/cactus-test-tooling/src/main/typescript/quorum/quorum-test-ledger.ts b/packages/cactus-test-tooling/src/main/typescript/quorum/quorum-test-ledger.ts
@@ -16,6 +16,7 @@ import { ITestLedger } from "../i-test-ledger";
 import { Streams } from "../common/streams";
 import { IKeyPair } from "../i-key-pair";
 import { IQuorumGenesisOptions } from "./i-quorum-genesis-options";
+import { Containers } from "../common/containers";
 
 export interface IQuorumTestLedgerConstructorOptions {
   containerImageVersion?: string;
@@ -241,11 +242,11 @@ export class QuorumTestLedger implements ITestLedger {
         this.log.debug("Quorum Test Ledger container started booting OK.");
 
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.getContainerImageName()}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.getContainerImageName()}]`;
+          await Containers.streamLogs({
+            container: this.container,
+            tag: fnTag,
+            log: this.log,
           });
         }
 

diff --git a/packages/cactus-test-tooling/src/main/typescript/rustc-container/rustc-container.ts b/packages/cactus-test-tooling/src/main/typescript/rustc-container/rustc-container.ts
@@ -180,13 +180,14 @@ export class RustcContainer {
         this._containerId = Optional.ofNonNull(id);
 
         if (this.emitContainerLogs) {
-          const logOptions = { follow: true, stderr: true, stdout: true };
-          const logStream = await container.logs(logOptions);
-          logStream.on("data", (data: Buffer) => {
-            const fnTag = `[${this.imageFqn}]`;
-            this.log.debug(`${fnTag} %o`, data.toString("utf-8"));
+          const fnTag = `[${this.imageFqn}]`;
+          await Containers.streamLogs({
+            container: this.container.get(),
+            tag: fnTag,
+            log: this.log,
           });
         }
+
         this.log.debug(`Registered container log stream callbacks OK`);
 
         try {