qase-javascript-commons 2.0.0-beta.4 → 2.0.0-beta.5

package/changelog.md

@@ -1,3 +1,10 @@
+# qase-javascript-commons@2.0.0-beta.5
+
+## What's new
+
+* Update the config of reporters. Added `framework.captureLogs` field. If it is set to `true`, the reporter will capture logs from the test framework.
+* Added `getMimeType` function to the commons package. It returns the MIME type of the file by its extension.
+
 # qase-javascript-commons@2.0.0-beta.4
 
 ## What's new

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

@@ -27,6 +27,10 @@ exports.configValidationSchema = {
             type: ['string', 'number'],
             nullable: true,
         },
+        captureLogs: {
+            type: 'boolean',
+            nullable: true,
+        },
         testops: {
             type: 'object',
             nullable: true,

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

@@ -5,7 +5,8 @@ export declare enum EnvEnum {
     mode = "QASE_MODE",
     fallback = "QASE_FALLBACK",
     debug = "QASE_DEBUG",
-    environment = "QASE_ENVIRONMENT"
+    environment = "QASE_ENVIRONMENT",
+    captureLogs = "QASE_CAPTURE_LOGS"
 }
 /**
  * @enum {string}

package/dist/env/env-enum.js

@@ -10,6 +10,7 @@ var EnvEnum;
     EnvEnum["fallback"] = "QASE_FALLBACK";
     EnvEnum["debug"] = "QASE_DEBUG";
     EnvEnum["environment"] = "QASE_ENVIRONMENT";
+    EnvEnum["captureLogs"] = "QASE_CAPTURE_LOGS";
 })(EnvEnum || (exports.EnvEnum = EnvEnum = {}));
 /**
  * @enum {string}

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

@@ -11,6 +11,7 @@ const envToConfig = (env) => ({
     mode: env[env_enum_1.EnvEnum.mode],
     debug: env[env_enum_1.EnvEnum.debug],
     environment: env[env_enum_1.EnvEnum.environment],
+    captureLogs: env[env_enum_1.EnvEnum.captureLogs],
     testops: {
         project: env[env_enum_1.EnvTestOpsEnum.project],
         uploadAttachments: env[env_enum_1.EnvTestOpsEnum.uploadAttachments],

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

@@ -6,6 +6,7 @@ export type EnvType = {
     [EnvEnum.fallback]?: `${ModeEnum}`;
     [EnvEnum.debug]?: boolean;
     [EnvEnum.environment]?: string | number;
+    [EnvEnum.captureLogs]?: boolean;
     [EnvTestOpsEnum.project]?: string;
     [EnvTestOpsEnum.uploadAttachments]?: boolean;
     [EnvTestOpsEnum.chunk]?: number;

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

@@ -28,6 +28,10 @@ exports.envValidationSchema = {
             type: ['string', 'number'],
             nullable: true,
         },
+        [env_enum_1.EnvEnum.captureLogs]: {
+            type: 'boolean',
+            nullable: true,
+        },
         [env_enum_1.EnvTestOpsEnum.project]: {
             type: 'string',
             nullable: true,

package/dist/index.d.ts

@@ -7,3 +7,4 @@ export * from './options';
 export * from './reporters';
 export * from './writer';
 export * from './utils/get-package-version';
+export * from './utils/mimeTypes';

package/dist/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./options"), exports);
 __exportStar(require("./reporters"), exports);
 __exportStar(require("./writer"), exports);
 __exportStar(require("./utils/get-package-version"), exports);
+__exportStar(require("./utils/mimeTypes"), exports);

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

@@ -21,6 +21,7 @@ export type OptionsType = {
     reporterName: string;
     mode?: `${ModeEnum}` | undefined;
     fallback?: `${ModeEnum}` | undefined;
+    captureLogs?: boolean | undefined;
     debug?: boolean | undefined;
     environment?: string | number | undefined;
     testops?: (RecursivePartial<TestOpsOptionsType> & AdditionalTestOpsOptionsType) | undefined;

package/dist/qase.js

@@ -71,7 +71,7 @@ class QaseReporter extends reporters_1.AbstractReporter {
     constructor(options, logger) {
         const env = (0, env_1.envToConfig)((0, env_schema_1.default)({ schema: env_1.envValidationSchema }));
         const composedOptions = (0, options_1.composeOptions)(options, env);
-        super({ debug: composedOptions.debug }, logger);
+        super({ debug: composedOptions.debug, captureLogs: composedOptions.captureLogs }, logger);
         /**
          * @type {boolean}
          * @private
@@ -233,13 +233,17 @@ class QaseReporter extends reporters_1.AbstractReporter {
                     },
                     plan,
                     chunk,
-                    ...commonOptions,
+                    debug: commonOptions.debug,
+                    captureLogs: commonOptions.captureLogs,
                 }, apiClient, logger, typeof environment === 'number' ? environment : undefined);
             }
             case options_1.ModeEnum.report: {
                 const localOptions = report.connections?.[writer_1.DriverEnum.local];
                 const writer = new writer_1.FsWriter(localOptions);
-                return new reporters_1.ReportReporter(commonOptions, writer, logger, typeof environment === 'number' ? environment.toString() : environment, testops.run?.id);
+                return new reporters_1.ReportReporter({
+                    debug: commonOptions.debug,
+                    captureLogs: commonOptions.captureLogs,
+                }, writer, logger, typeof environment === 'number' ? environment.toString() : environment, testops.run?.id);
             }
             case options_1.ModeEnum.off:
                 throw new disabled_exception_1.DisabledException();

package/dist/reporters/abstract-reporter.d.ts

@@ -6,12 +6,14 @@ export interface LoggerInterface {
 }
 export interface ReporterOptionsType {
     debug?: boolean | undefined;
+    captureLogs?: boolean | undefined;
 }
 export interface ReporterInterface {
     addTestResult(result: TestResultType): void;
     publish(): Promise<void>;
     getTestResults(): TestResultType[];
     setTestResults(results: TestResultType[]): void;
+    isCaptureLogs(): boolean;
 }
 /**
  * @abstract
@@ -25,6 +27,15 @@ export declare abstract class AbstractReporter implements ReporterInterface {
      * @private
      */
     private readonly debug;
+    /**
+     * @type {boolean | undefined}
+     * @private
+     */
+    private readonly captureLogs;
+    /**
+     * @type {TestResultType[]}
+     * @protected
+     */
     protected results: TestResultType[];
     /**
      * @returns {Promise<void>}
@@ -40,6 +51,10 @@ export declare abstract class AbstractReporter implements ReporterInterface {
      * @returns {TestResultType[]}
      */
     getTestResults(): TestResultType[];
+    /**
+     * @returns {boolean}
+     */
+    isCaptureLogs(): boolean;
     /**
      * @param {TestResultType} result
      */

package/dist/reporters/abstract-reporter.js

@@ -21,9 +21,14 @@ class AbstractReporter {
      */
     constructor(options, logger = console) {
         this.logger = logger;
+        /**
+         * @type {TestResultType[]}
+         * @protected
+         */
         this.results = [];
-        const { debug } = options ?? {};
+        const { debug, captureLogs } = options ?? {};
         this.debug = debug;
+        this.captureLogs = captureLogs;
     }
     /**
      * @returns {TestResultType[]}
@@ -31,6 +36,12 @@ class AbstractReporter {
     getTestResults() {
         return this.results;
     }
+    /**
+     * @returns {boolean}
+     */
+    isCaptureLogs() {
+        return this.captureLogs ?? false;
+    }
     /**
      * @param {TestResultType} result
      */

package/dist/utils/mimeTypes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get mime type of the file
+ * @param {string} filePath
+ */
+export declare function getMimeTypes(filePath: string): string;

package/dist/utils/mimeTypes.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMimeTypes = void 0;
+const path = __importStar(require("path"));
+const mime = __importStar(require("mime-types"));
+/**
+ * Get mime type of the file
+ * @param {string} filePath
+ */
+function getMimeTypes(filePath) {
+    const fileName = path.basename(filePath);
+    const mimeType = mime.contentType(fileName);
+    if (!mimeType && typeof mimeType !== 'string') {
+        return 'application/octet-stream';
+    }
+    return mimeType;
+}
+exports.getMimeTypes = getMimeTypes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.5",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -26,15 +26,16 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "chalk": "^4.1.2",
+    "child-process-ext": "^3.0.2",
     "env-schema": "^5.2.0",
     "form-data": "^4.0.0",
     "lodash.get": "^4.4.2",
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
+    "mime-types": "^2.1.33",
     "qaseio": "^2.1.0-beta.1",
     "strip-ansi": "^6.0.1",
-    "uuid": "^9.0.0",
-    "child-process-ext": "^3.0.2"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",
@@ -42,6 +43,8 @@
     "@types/lodash.get": "^4.4.7",
     "@types/lodash.merge": "^4.6.7",
     "@types/lodash.mergewith": "^4.6.7",
+    "@types/mime-types": "^2.1.4",
+    "@types/node": "^20.12.5",
     "@types/uuid": "^9.0.1",
     "axios": "^0.21.4",
     "jest": "^29.5.0",