qase-javascript-commons 2.4.5 → 2.4.6

package/README.md

@@ -26,8 +26,9 @@ npm install qase-javascript-commons
 
 Qase JS Reporters can be configured in multiple ways:
 
-- using a config file `qase.config.json`
-- using environment variables
+* using a config file `qase.config.json`
+* using environment variables
+
 
 All configuration options are listed in the table below:
 
@@ -41,6 +42,9 @@ All configuration options are listed in the table below:
 | Enable debug logs                                                                                                     | `debug`                    | `QASE_DEBUG`                    | `False`                                 | No       | `True`, `False`            |
 | Enable capture logs from `stdout` and `stderr`                                                                        | `testops.defect`           | `QASE_CAPTURE_LOGS`             | `False`                                 | No       | `True`, `False`            |
 | Map test result statuses to different values (format: `fromStatus=toStatus`)                                          | `statusMapping`                     | `QASE_STATUS_MAPPING`                    | undefined                               | No       | Object mapping statuses (e.g., `{"invalid": "failed", "skipped": "passed"}`) |
+| **Logging configuration**                                                                                             |                            |                                 |                                         |          |                            |
+| Enable/disable console output for reporter logs                                                                       | `logging.console`          | `QASE_LOGGING_CONSOLE`          | `True`                                  | No       | `True`, `False`            |
+| Enable/disable file output for reporter logs                                                                          | `logging.file`             | `QASE_LOGGING_FILE`             | Same as `debug` setting                 | No       | `True`, `False`            |
 | **Qase Report configuration**                                                                                         |                            |                                 |                                         |          |                            |
 | Driver used for report mode                                                                                           | `report.driver`            | `QASE_REPORT_DRIVER`            | `local`                                 | No       | `local`                    |
 | Path to save the report                                                                                               | `report.connection.path`   | `QASE_REPORT_CONNECTION_PATH`   | `./build/qase-report`                   |          |                            |
@@ -64,7 +68,7 @@ All configuration options are listed in the table below:
 | Configuration values to create/find in groups (format: `group1=value1,group2=value2`)                                | `testops.configurations.values`     | `QASE_TESTOPS_CONFIGURATIONS_VALUES`     | undefined                               | No       | Comma-separated key=value pairs |
 | Create configuration groups if they don't exist                                                                       | `testops.configurations.createIfNotExists` | `QASE_TESTOPS_CONFIGURATIONS_CREATE_IF_NOT_EXISTS` | `false`                          | No       | `True`, `False`            |
 
-### Example `qase.config.json` config:
+### Example `qase.config.json` config
 
 ```json
 {
@@ -77,6 +81,10 @@ All configuration options are listed in the table below:
     "invalid": "failed",
     "skipped": "passed"
   },
+  "logging": {
+    "console": true,
+    "file": true
+  },
   "report": {
     "driver": "local",
     "connection": {
@@ -125,7 +133,7 @@ All configuration options are listed in the table below:
 }
 ```
 
-### Environment Variables Example:
+### Environment Variables Example
 
 ```bash
 # Set external link for Jira Cloud
@@ -139,4 +147,8 @@ export QASE_TESTOPS_STATUS_FILTER="passed,failed"
 
 # Map test result statuses
 export QASE_STATUS_MAPPING="invalid=failed,skipped=passed"
+
+# Logging configuration
+export QASE_LOGGING_CONSOLE=false  # Disable console output
+export QASE_LOGGING_FILE=true      # Enable file output
 ```

package/changelog.md

@@ -1,3 +1,9 @@
+# qase-javascript-commons@2.4.6
+
+## What's new
+
+Added ability to control logging to console and file using the `logging` configuration option.
+
 # qase-javascript-commons@2.4.5
 
 ## What's new

package/dist/client/dateUtils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStartTime = exports.formatUTCDate = void 0;
+exports.formatUTCDate = formatUTCDate;
+exports.getStartTime = getStartTime;
 // Utils
 const pad = (num) => num.toString().padStart(2, '0');
 function formatUTCDate(date) {
@@ -12,9 +13,7 @@ function formatUTCDate(date) {
     const seconds = pad(date.getUTCSeconds());
     return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
 }
-exports.formatUTCDate = formatUTCDate;
 function getStartTime() {
     const date = new Date();
     return formatUTCDate(new Date(date.getTime() - 10000));
 }
-exports.getStartTime = getStartTime;

package/dist/config/config-validation-schema.d.ts

@@ -40,6 +40,20 @@ export declare const configValidationSchema: {
                 type: string;
             };
         };
+        logging: {
+            type: string;
+            nullable: boolean;
+            properties: {
+                console: {
+                    type: string;
+                    nullable: boolean;
+                };
+                file: {
+                    type: string;
+                    nullable: boolean;
+                };
+            };
+        };
         testops: {
             type: string;
             nullable: boolean;

package/dist/config/config-validation-schema.js

@@ -43,6 +43,20 @@ exports.configValidationSchema = {
                 type: 'string',
             },
         },
+        logging: {
+            type: 'object',
+            nullable: true,
+            properties: {
+                console: {
+                    type: 'boolean',
+                    nullable: true,
+                },
+                file: {
+                    type: 'boolean',
+                    nullable: true,
+                },
+            },
+        },
         testops: {
             type: 'object',
             nullable: true,

package/dist/env/env-enum.d.ts

@@ -63,3 +63,10 @@ export declare enum EnvLocalEnum {
     path = "QASE_REPORT_CONNECTION_PATH",
     format = "QASE_REPORT_CONNECTION_FORMAT"
 }
+/**
+ * @enum {string}
+ */
+export declare enum EnvLoggingEnum {
+    console = "QASE_LOGGING_CONSOLE",
+    file = "QASE_LOGGING_FILE"
+}

package/dist/env/env-enum.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnvLocalEnum = exports.EnvConfigurationsEnum = exports.EnvBatchEnum = exports.EnvPlanEnum = exports.EnvRunEnum = exports.EnvApiEnum = exports.EnvTestOpsEnum = exports.EnvEnum = void 0;
+exports.EnvLoggingEnum = exports.EnvLocalEnum = exports.EnvConfigurationsEnum = exports.EnvBatchEnum = exports.EnvPlanEnum = exports.EnvRunEnum = exports.EnvApiEnum = exports.EnvTestOpsEnum = exports.EnvEnum = void 0;
 /**
  * @enum {string}
  */
@@ -74,3 +74,11 @@ var EnvLocalEnum;
     EnvLocalEnum["path"] = "QASE_REPORT_CONNECTION_PATH";
     EnvLocalEnum["format"] = "QASE_REPORT_CONNECTION_FORMAT";
 })(EnvLocalEnum || (exports.EnvLocalEnum = EnvLocalEnum = {}));
+/**
+ * @enum {string}
+ */
+var EnvLoggingEnum;
+(function (EnvLoggingEnum) {
+    EnvLoggingEnum["console"] = "QASE_LOGGING_CONSOLE";
+    EnvLoggingEnum["file"] = "QASE_LOGGING_FILE";
+})(EnvLoggingEnum || (exports.EnvLoggingEnum = EnvLoggingEnum = {}));

package/dist/env/env-to-config.js

@@ -75,5 +75,9 @@ const envToConfig = (env) => ({
             },
         },
     },
+    logging: (env[env_enum_1.EnvLoggingEnum.console] !== undefined || env[env_enum_1.EnvLoggingEnum.file] !== undefined) ? {
+        console: env[env_enum_1.EnvLoggingEnum.console],
+        file: env[env_enum_1.EnvLoggingEnum.file],
+    } : undefined,
 });
 exports.envToConfig = envToConfig;

package/dist/env/env-type.d.ts

@@ -1,4 +1,4 @@
-import { EnvEnum, EnvTestOpsEnum, EnvApiEnum, EnvRunEnum, EnvLocalEnum, EnvPlanEnum, EnvBatchEnum, EnvConfigurationsEnum } from './env-enum';
+import { EnvEnum, EnvTestOpsEnum, EnvApiEnum, EnvRunEnum, EnvLocalEnum, EnvPlanEnum, EnvBatchEnum, EnvConfigurationsEnum, EnvLoggingEnum } from './env-enum';
 import { ModeEnum } from '../options';
 import { FormatEnum } from '../writer';
 export interface EnvType {
@@ -27,4 +27,6 @@ export interface EnvType {
     [EnvConfigurationsEnum.createIfNotExists]?: boolean;
     [EnvLocalEnum.path]?: string;
     [EnvLocalEnum.format]?: `${FormatEnum}`;
+    [EnvLoggingEnum.console]?: boolean;
+    [EnvLoggingEnum.file]?: boolean;
 }

package/dist/env/env-validation-schema.js

@@ -113,5 +113,13 @@ exports.envValidationSchema = {
             enum: [writer_1.FormatEnum.json, writer_1.FormatEnum.jsonp],
             nullable: true,
         },
+        [env_enum_1.EnvLoggingEnum.console]: {
+            type: 'boolean',
+            nullable: true,
+        },
+        [env_enum_1.EnvLoggingEnum.file]: {
+            type: 'boolean',
+            nullable: true,
+        },
     },
 };

package/dist/models/attachment.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface Attachment {
     file_name: string;
     mime_type: string;

package/dist/options/composeOptions.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="lodash" />
 type MergedType<T extends unknown[], A = NonNullable<unknown>> = T extends [infer F, ...(infer R)] ? MergedType<R, F & A> : A;
 declare module 'lodash' {
     interface LoDashStatic {

package/dist/options/options-type.d.ts

@@ -11,6 +11,10 @@ export type AdditionalReportOptionsType = {
     driver?: `${DriverEnum}`;
     connections?: ConnectionsType;
 };
+export type LoggingOptionsType = {
+    console?: boolean | undefined;
+    file?: boolean | undefined;
+};
 export type OptionsType = {
     frameworkPackage: string;
     frameworkName: string;
@@ -22,6 +26,7 @@ export type OptionsType = {
     environment?: string | undefined;
     rootSuite?: string | undefined;
     statusMapping?: Record<string, string> | undefined;
+    logging?: RecursivePartial<LoggingOptionsType> | undefined;
     testops?: RecursivePartial<TestOpsOptionsType> | undefined;
     report?: RecursivePartial<AdditionalReportOptionsType> | undefined;
 };

package/dist/qase.js

@@ -82,7 +82,17 @@ class QaseReporter {
         const env = (0, env_1.envToConfig)((0, env_schema_1.default)({ schema: env_1.envValidationSchema }));
         const composedOptions = (0, options_1.composeOptions)(options, env);
         this.options = composedOptions;
-        this.logger = new logger_1.Logger({ debug: composedOptions.debug });
+        // Process logging options with backward compatibility
+        const loggerOptions = {
+            debug: composedOptions.debug,
+        };
+        if (composedOptions.logging?.console !== undefined) {
+            loggerOptions.consoleLogging = composedOptions.logging.console;
+        }
+        if (composedOptions.logging?.file !== undefined) {
+            loggerOptions.fileLogging = composedOptions.logging.file;
+        }
+        this.logger = new logger_1.Logger(loggerOptions);
         this.logger.logDebug(`Config: ${JSON.stringify(this.sanitizeOptions(composedOptions))}`);
         const hostData = (0, hostData_1.getHostInfo)(options.frameworkPackage, options.reporterName);
         this.logger.logDebug(`Host data: ${JSON.stringify(hostData)}`);

package/dist/utils/hostData.js

@@ -15,15 +15,25 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHostInfo = void 0;
+exports.getHostInfo = getHostInfo;
 const os = __importStar(require("os"));
 const cp = __importStar(require("child_process"));
 const fs = __importStar(require("fs"));
@@ -188,4 +198,3 @@ function getHostInfo(framework, reporterName) {
         };
     }
 }
-exports.getHostInfo = getHostInfo;

package/dist/utils/is-axios-error.d.ts

@@ -3,4 +3,4 @@ import { AxiosError } from 'axios';
  * @param error
  * @returns {error is AxiosError}
  */
-export declare const isAxiosError: (error: unknown) => error is AxiosError<unknown, any>;
+export declare const isAxiosError: (error: unknown) => error is AxiosError;

package/dist/utils/logger.d.ts

@@ -6,9 +6,13 @@ export interface LoggerInterface {
 export declare class Logger implements LoggerInterface {
     private readonly debug;
     private readonly filePath;
+    private readonly consoleEnabled;
+    private readonly fileEnabled;
     constructor(options: {
         debug?: boolean | undefined;
         dir?: string;
+        consoleLogging?: boolean | undefined;
+        fileLogging?: boolean | undefined;
     });
     log(message: string): void;
     logError(message: string, error?: unknown): void;

package/dist/utils/logger.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
 const fs = __importStar(require("fs"));
@@ -31,33 +41,47 @@ const qase_error_1 = require("./qase-error");
 class Logger {
     debug;
     filePath;
+    consoleEnabled;
+    fileEnabled;
     constructor(options) {
         this.debug = options.debug;
+        // Determine console logging: if explicitly set, use that value; otherwise default to true
+        this.consoleEnabled = options.consoleLogging !== undefined ? options.consoleLogging : true;
+        // Determine file logging: if explicitly set, use that value; otherwise use debug setting
+        this.fileEnabled = options.fileLogging !== undefined ? options.fileLogging : (this.debug ?? false);
         const dir = options.dir ?? './logs';
-        if (!fs.existsSync(dir)) {
+        if (this.fileEnabled && !fs.existsSync(dir)) {
             fs.mkdirSync(dir);
         }
         this.filePath = path.join(dir, 'log.txt');
     }
     log(message) {
         const logMessage = `[INFO] qase: ${message}`;
-        console.log(logMessage);
-        if (this.debug) {
+        if (this.consoleEnabled) {
+            console.log(logMessage);
+        }
+        if (this.fileEnabled) {
             this.logToFile(logMessage);
         }
     }
     logError(message, error) {
         const logMessage = `[ERROR] qase: ${this.doLogError(message, error)}`;
-        console.error(logMessage);
-        if (this.debug) {
+        if (this.consoleEnabled) {
+            console.error(logMessage);
+        }
+        if (this.fileEnabled) {
             this.logToFile(logMessage);
         }
     }
     logDebug(message) {
         if (this.debug) {
             const logMessage = `[DEBUG] qase: ${message}`;
-            console.log(logMessage);
-            this.logToFile(logMessage);
+            if (this.consoleEnabled) {
+                console.log(logMessage);
+            }
+            if (this.fileEnabled) {
+                this.logToFile(logMessage);
+            }
         }
     }
     logToFile(message) {

package/dist/utils/mimeTypes.js

@@ -15,15 +15,25 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMimeTypes = void 0;
+exports.getMimeTypes = getMimeTypes;
 const path = __importStar(require("path"));
 const mime = __importStar(require("mime-types"));
 /**
@@ -38,4 +48,3 @@ function getMimeTypes(filePath) {
     }
     return mimeType;
 }
-exports.getMimeTypes = getMimeTypes;

package/dist/utils/status-mapping-utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateStatusMapping = exports.applyStatusMapping = void 0;
+exports.applyStatusMapping = applyStatusMapping;
+exports.validateStatusMapping = validateStatusMapping;
 const test_execution_1 = require("../models/test-execution");
 /**
  * Applies status mapping configuration to a test status
@@ -24,7 +25,6 @@ function applyStatusMapping(status, statusMapping) {
     }
     return mappedStatus;
 }
-exports.applyStatusMapping = applyStatusMapping;
 /**
  * Validates status mapping configuration
  * @param statusMapping - Status mapping configuration to validate
@@ -43,4 +43,3 @@ function validateStatusMapping(statusMapping) {
     }
     return errors;
 }
-exports.validateStatusMapping = validateStatusMapping;

package/dist/utils/test-status-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.determineTestStatus = void 0;
+exports.determineTestStatus = determineTestStatus;
 const test_execution_1 = require("../models/test-execution");
 /**
  * Determines test status based on error type
@@ -20,7 +20,6 @@ function determineTestStatus(error, originalStatus) {
     // For all other errors, return invalid
     return test_execution_1.TestStatusEnum.invalid;
 }
-exports.determineTestStatus = determineTestStatus;
 /**
  * Checks if error is an assertion error
  * @param error - Error object

package/dist/utils/validate-json.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateJson = exports.JsonValidationError = void 0;
+exports.JsonValidationError = void 0;
+exports.validateJson = validateJson;
 const ajv_1 = __importDefault(require("ajv"));
 /**
  * @type {Ajv}
@@ -38,4 +39,3 @@ function validateJson(schema, json) {
         throw new JsonValidationError(validator.errors ? [...validator.errors] : []);
     }
 }
-exports.validateJson = validateJson;

package/dist/writer/fs-writer.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FsWriter = void 0;
 const fs_1 = require("fs");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.4.5",
+  "version": "2.4.6",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",