@smartbear/one-report-publisher - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

dist/cjs/src/action/index.js

@@ -56,15 +56,18 @@ "use strict";
 var index_js_1 = require("../../src/index.js");
+var organizationId = core_1.default.getInput('organization-id');
+var username = core_1.default.getInput('username');
+var password = core_1.default.getInput('password');
+var globs = core_1.default.getMultilineInput('reports');
+var maxTime = core_1.default.getInput('max-time');
+var ignoreError = core_1.default.getBooleanInput('ignore-error');
+var baseUrl = core_1.default.getInput('url');
+var zip = core_1.default.getBooleanInput('zip');
 function main() {
     return __awaiter(this, void 0, void 0, function () {
-        var organizationId, username, password, globs, baseUrl, zip, responseBodies;
+        var requestTimeout, responseBodies;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    organizationId = core_1.default.getInput('organization-id');
-                    username = core_1.default.getInput('username');
-                    password = core_1.default.getInput('password');
-                    globs = core_1.default.getMultilineInput('reports');
-                    baseUrl = core_1.default.getInput('url');
-                    zip = core_1.default.getBooleanInput('zip');
-                    return [4 /*yield*/, (0, index_js_1.publish)(globs, zip, organizationId, baseUrl, process.env, (0, index_js_1.basicAuthAuthenticator)(username, password))];
+                    requestTimeout = maxTime ? +maxTime * 1000 : undefined;
+                    return [4 /*yield*/, (0, index_js_1.publish)(globs, zip, organizationId, baseUrl, process.env, (0, index_js_1.basicAuthAuthenticator)(username, password), requestTimeout)];
                 case 1:
@@ -101,3 +104,10 @@ responseBodies = _a.sent();
 })
-    .catch(function (error) { return core_1.default.setFailed(error.message); });
+    .catch(function (error) {
+    if (ignoreError) {
+        core_1.default.info(error.message);
+    }
+    else {
+        core_1.default.setFailed(error.message);
+    }
+});
 //# sourceMappingURL=index.js.map

dist/cjs/src/bin/one-report-publisher.js

@@ -59,15 +59,18 @@ #!/usr/bin/env node
 program.requiredOption('-r, --reports <glob...>', 'Glob to the files to publish');
+program.option('-m, --max-time <seconds>', 'Max time for each request');
+program.option('-i, --ignore-error', 'Exit with 0 even if a timeout or error occurred');
 program.option('--url <url>', 'OneReport URL', 'https://one-report.vercel.app');
 program.option('--no-zip', 'Do not zip non .zip files', false);
+program.parse(process.argv);
+var _a = program.opts(), organizationId = _a.organizationId, username = _a.username, password = _a.password, globs = _a.reports, maxTime = _a.maxTime, ignoreError = _a.ignoreError, baseUrl = _a.url, noZip = _a.noZip;
 function main() {
     return __awaiter(this, void 0, void 0, function () {
-        var _a, organizationId, username, password, globs, baseUrl, noZip, responseBodies;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var requestTimeout, responseBodies;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
                 case 0:
-                    program.parse(process.argv);
-                    _a = program.opts(), organizationId = _a.organizationId, username = _a.username, password = _a.password, globs = _a.reports, baseUrl = _a.url, noZip = _a.noZip;
-                    return [4 /*yield*/, (0, index_js_1.publish)(globs, !noZip, organizationId, baseUrl, process.env, (0, index_js_1.basicAuthAuthenticator)(username, password))];
+                    requestTimeout = maxTime ? +maxTime * 1000 : undefined;
+                    return [4 /*yield*/, (0, index_js_1.publish)(globs, !noZip, organizationId, baseUrl, process.env, (0, index_js_1.basicAuthAuthenticator)(username, password), requestTimeout)];
                 case 1:
-                    responseBodies = _b.sent();
+                    responseBodies = _a.sent();
                     return [2 /*return*/, responseBodies.map(function (body) {
@@ -100,4 +103,9 @@ return new url_1.URL("/organization/".concat(organizationId, "/executions/").concat(body.testSetExecutionId), baseUrl).toString();
     console.error(error.stack);
-    process.exit(1);
+    if (ignoreError) {
+        process.exit(0);
+    }
+    else {
+        process.exit(1);
+    }
 });
 //# sourceMappingURL=one-report-publisher.js.map

dist/cjs/src/publish.d.ts

@@ -12,5 +12,6 @@ import { Env } from '@cucumber/ci-environment';
  * @param authenticate a function that returns HTTP request headers for authentication (such as {Cookie: ...})
+ * @param requestTimeout timeout (in milliseconds) for each HTTP request
  * @return an array of ResponseBody constructed by parsing the response of each request as JSON
  */
-export declare function publish<ResponseBody>(globs: readonly string[], zip: boolean, organizationId: string, baseUrl: string, env: Env, authenticate: Authenticate): Promise<readonly ResponseBody[]>;
+export declare function publish<ResponseBody>(globs: readonly string[], zip: boolean, organizationId: string, baseUrl: string, env: Env, authenticate: Authenticate, requestTimeout: number | undefined): Promise<readonly ResponseBody[]>;
 //# sourceMappingURL=publish.d.ts.map

dist/cjs/src/publish.js

@@ -98,5 +98,6 @@ "use strict";
  * @param authenticate a function that returns HTTP request headers for authentication (such as {Cookie: ...})
+ * @param requestTimeout timeout (in milliseconds) for each HTTP request
  * @return an array of ResponseBody constructed by parsing the response of each request as JSON
  */
-function publish(globs, zip, organizationId, baseUrl, env, authenticate) {
+function publish(globs, zip, organizationId, baseUrl, env, authenticate, requestTimeout) {
     return __awaiter(this, void 0, void 0, function () {
@@ -136,3 +137,3 @@ var authHeaders, url, ciEnv, paths, publishPaths, _a;
                     publishPaths = _a;
-                    return [2 /*return*/, Promise.all(publishPaths.map(function (path) { return publishFile(path, url, ciEnv, authHeaders); }))];
+                    return [2 /*return*/, Promise.all(publishPaths.map(function (path) { return publishFile(path, url, ciEnv, authHeaders, requestTimeout); }))];
             }
@@ -143,3 +144,3 @@ });
 exports.publish = publish;
-function publishFile(path, url, ciEnv, authHeaders) {
+function publishFile(path, url, ciEnv, authHeaders, requestTimeout) {
     return __awaiter(this, void 0, void 0, function () {
@@ -192,3 +193,9 @@ return __generator(this, function (_a) {
                         });
+                        if (requestTimeout) {
+                            req.setTimeout(requestTimeout);
+                        }
                         req.on('error', reject);
+                        req.on('timeout', function () {
+                            return reject(new Error("request to ".concat(url.toString(), " timed out after ").concat(requestTimeout, "ms")));
+                        });
                         var file = fs_1.default.createReadStream(path);
@@ -195,0 +202,0 @@ (0, stream_1.pipeline)(file, req, function (err) {

dist/cjs/test/oneReportPublishTest.js

@@ -71,3 +71,3 @@ "use strict";
                     baseUrl = "https://one-report.vercel.app";
-                    return [4 /*yield*/, (0, index_js_1.publish)(['test/fixtures/*.{xml,json}'], true, process.env.ONE_REPORT_TEST_ORGANIZATION_ID, baseUrl, process.env, (0, index_js_1.basicAuthAuthenticator)('anyone', process.env.ONE_REPORT_PASSWORD))];
+                    return [4 /*yield*/, (0, index_js_1.publish)(['test/fixtures/*.{xml,json}'], true, process.env.ONE_REPORT_TEST_ORGANIZATION_ID, baseUrl, process.env, (0, index_js_1.basicAuthAuthenticator)('anyone', process.env.ONE_REPORT_PASSWORD), undefined)];
                 case 1:
@@ -74,0 +74,0 @@ responseBodies = _b.sent();

dist/cjs/test/publish.test.js

@@ -54,30 +54,33 @@ "use strict";
     var port;
+    var serverLatency;
     beforeEach(function () { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, new Promise(function (resolve) {
-                        server = http_1.default.createServer(function (req, res) {
-                            (0, readStream_js_1.readStream)(req)
-                                .then(function (body) {
-                                (0, assert_1.default)(req.url);
-                                serverRequests.push({
-                                    url: req.url,
-                                    headers: req.headers,
-                                    body: body,
+                case 0:
+                    serverLatency = 0;
+                    return [4 /*yield*/, new Promise(function (resolve) {
+                            server = http_1.default.createServer(function (req, res) {
+                                (0, readStream_js_1.readStream)(req)
+                                    .then(function (body) {
+                                    (0, assert_1.default)(req.url);
+                                    serverRequests.push({
+                                        url: req.url,
+                                        headers: req.headers,
+                                        body: body,
+                                    });
+                                    res.statusCode = 201;
+                                    var responseBody = {
+                                        hello: 'world',
+                                    };
+                                    setTimeout(function () { return res.end(JSON.stringify(responseBody)); }, serverLatency);
+                                })
+                                    .catch(function (err) {
+                                    res.statusCode = 500;
+                                    res.end(err.stack);
                                 });
-                                res.statusCode = 201;
-                                var responseBody = {
-                                    hello: 'world',
-                                };
-                                res.end(JSON.stringify(responseBody));
-                            })
-                                .catch(function (err) {
-                                res.statusCode = 500;
-                                res.end(err.stack);
                             });
-                        });
-                        server.listen(0, function () {
-                            resolve(server.address().port);
-                        });
-                    })];
+                            server.listen(0, function () {
+                                resolve(server.address().port);
+                            });
+                        })];
                 case 1:
@@ -98,2 +101,23 @@ port = _a.sent();
     }); });
+    it('times out after specified timeout', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var organizationId, fakeEnv;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    serverLatency = 10;
+                    organizationId = '32C46057-0AB6-44E8-8944-0246E0BEA96F';
+                    fakeEnv = {
+                        GITHUB_SERVER_URL: 'https://github.com',
+                        GITHUB_REPOSITORY: 'SmartBear/one-report-publisher',
+                        GITHUB_RUN_ID: '154666429',
+                        GITHUB_SHA: 'f7d967d6d4f7adc1d6657bda88f4e976c879d74c',
+                        GITHUB_REF: 'refs/heads/main',
+                    };
+                    return [4 /*yield*/, assert_1.default.rejects((0, index_js_1.publish)(['test/fixtures/*.xml'], false, organizationId, "http://localhost:".concat(port), fakeEnv, function () { return Promise.resolve({}); }, 1))];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
     it('publishes files from glob without zipping', function () { return __awaiter(void 0, void 0, void 0, function () {
@@ -113,3 +137,3 @@ var organizationId, fakeEnv, responseBodies, expectedServerRequests, _a, _b, _c, _d, _e, _f, _g, _h, _j, sortedServerRequests, sortedExpectedServerRequests, expectedResponseBodies;
                     };
-                    return [4 /*yield*/, (0, index_js_1.publish)(['test/fixtures/*.{xml,json,ndjson,zip}'], false, organizationId, "http://localhost:".concat(port), fakeEnv, function () { return Promise.resolve({}); })];
+                    return [4 /*yield*/, (0, index_js_1.publish)(['test/fixtures/*.{xml,json,ndjson,zip}'], false, organizationId, "http://localhost:".concat(port), fakeEnv, function () { return Promise.resolve({}); }, undefined)];
                 case 1:
@@ -238,3 +262,3 @@ responseBodies = _t.sent();
                     fakeEnv = {};
-                    return [4 /*yield*/, (0, index_js_1.publish)(['test/fixtures/*.{xml,json,ndjson,zip}'], true, organizationId, "http://localhost:".concat(port), fakeEnv, function () { return Promise.resolve({}); })];
+                    return [4 /*yield*/, (0, index_js_1.publish)(['test/fixtures/*.{xml,json,ndjson,zip}'], true, organizationId, "http://localhost:".concat(port), fakeEnv, function () { return Promise.resolve({}); }, undefined)];
                 case 1:
@@ -241,0 +265,0 @@ responseBodies = _a.sent();

dist/esm/src/action/index.js

@@ -13,11 +13,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
 import { basicAuthAuthenticator, publish } from '../../src/index.js';
+const organizationId = core.getInput('organization-id');
+const username = core.getInput('username');
+const password = core.getInput('password');
+const globs = core.getMultilineInput('reports');
+const maxTime = core.getInput('max-time');
+const ignoreError = core.getBooleanInput('ignore-error');
+const baseUrl = core.getInput('url');
+const zip = core.getBooleanInput('zip');
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
-        const organizationId = core.getInput('organization-id');
-        const username = core.getInput('username');
-        const password = core.getInput('password');
-        const globs = core.getMultilineInput('reports');
-        const baseUrl = core.getInput('url');
-        const zip = core.getBooleanInput('zip');
-        const responseBodies = yield publish(globs, zip, organizationId, baseUrl, process.env, basicAuthAuthenticator(username, password));
+        const requestTimeout = maxTime ? +maxTime * 1000 : undefined;
+        const responseBodies = yield publish(globs, zip, organizationId, baseUrl, process.env, basicAuthAuthenticator(username, password), requestTimeout);
         return responseBodies.map((body) => new URL(`/organization/${organizationId}/executions/${body.testSetExecutionId}`, baseUrl).toString());
@@ -37,3 +40,10 @@ });
 })
-    .catch((error) => core.setFailed(error.message));
+    .catch((error) => {
+    if (ignoreError) {
+        core.info(error.message);
+    }
+    else {
+        core.setFailed(error.message);
+    }
+});
 //# sourceMappingURL=index.js.map

dist/esm/src/bin/one-report-publisher.js

@@ -19,9 +19,12 @@ #!/usr/bin/env node
 program.requiredOption('-r, --reports <glob...>', 'Glob to the files to publish');
+program.option('-m, --max-time <seconds>', 'Max time for each request');
+program.option('-i, --ignore-error', 'Exit with 0 even if a timeout or error occurred');
 program.option('--url <url>', 'OneReport URL', 'https://one-report.vercel.app');
 program.option('--no-zip', 'Do not zip non .zip files', false);
+program.parse(process.argv);
+const { organizationId, username, password, reports: globs, maxTime, ignoreError, url: baseUrl, noZip, } = program.opts();
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
-        program.parse(process.argv);
-        const { organizationId, username, password, reports: globs, url: baseUrl, noZip } = program.opts();
-        const responseBodies = yield publish(globs, !noZip, organizationId, baseUrl, process.env, basicAuthAuthenticator(username, password));
+        const requestTimeout = maxTime ? +maxTime * 1000 : undefined;
+        const responseBodies = yield publish(globs, !noZip, organizationId, baseUrl, process.env, basicAuthAuthenticator(username, password), requestTimeout);
         return responseBodies.map((body) => new URL(`/organization/${organizationId}/executions/${body.testSetExecutionId}`, baseUrl).toString());
@@ -39,4 +42,9 @@ });
     console.error(error.stack);
-    process.exit(1);
+    if (ignoreError) {
+        process.exit(0);
+    }
+    else {
+        process.exit(1);
+    }
 });
 //# sourceMappingURL=one-report-publisher.js.map

dist/esm/src/publish.d.ts

@@ -12,5 +12,6 @@ import { Env } from '@cucumber/ci-environment';
  * @param authenticate a function that returns HTTP request headers for authentication (such as {Cookie: ...})
+ * @param requestTimeout timeout (in milliseconds) for each HTTP request
  * @return an array of ResponseBody constructed by parsing the response of each request as JSON
  */
-export declare function publish<ResponseBody>(globs: readonly string[], zip: boolean, organizationId: string, baseUrl: string, env: Env, authenticate: Authenticate): Promise<readonly ResponseBody[]>;
+export declare function publish<ResponseBody>(globs: readonly string[], zip: boolean, organizationId: string, baseUrl: string, env: Env, authenticate: Authenticate, requestTimeout: number | undefined): Promise<readonly ResponseBody[]>;
 //# sourceMappingURL=publish.d.ts.map

dist/esm/src/publish.js

@@ -38,5 +38,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
  * @param authenticate a function that returns HTTP request headers for authentication (such as {Cookie: ...})
+ * @param requestTimeout timeout (in milliseconds) for each HTTP request
  * @return an array of ResponseBody constructed by parsing the response of each request as JSON
  */
-export function publish(globs, zip, organizationId, baseUrl, env, authenticate) {
+export function publish(globs, zip, organizationId, baseUrl, env, authenticate, requestTimeout) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -59,6 +60,6 @@ if (!Array.isArray(globs)) {
         const publishPaths = zip ? yield zipPaths(paths) : paths;
-        return Promise.all(publishPaths.map((path) => publishFile(path, url, ciEnv, authHeaders)));
+        return Promise.all(publishPaths.map((path) => publishFile(path, url, ciEnv, authHeaders, requestTimeout)));
     });
 }
-function publishFile(path, url, ciEnv, authHeaders) {
+function publishFile(path, url, ciEnv, authHeaders, requestTimeout) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -109,3 +110,7 @@ return new Promise((resolve, reject) => {
                 });
+                if (requestTimeout) {
+                    req.setTimeout(requestTimeout);
+                }
                 req.on('error', reject);
+                req.on('timeout', () => reject(new Error(`request to ${url.toString()} timed out after ${requestTimeout}ms`)));
                 const file = fs.createReadStream(path);
@@ -112,0 +117,0 @@ pipeline(file, req, (err) => {

dist/esm/test/oneReportPublishTest.js

@@ -23,3 +23,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
         const baseUrl = `https://one-report.vercel.app`;
-        const responseBodies = yield publish(['test/fixtures/*.{xml,json}'], true, process.env.ONE_REPORT_TEST_ORGANIZATION_ID, baseUrl, process.env, basicAuthAuthenticator('anyone', process.env.ONE_REPORT_PASSWORD));
+        const responseBodies = yield publish(['test/fixtures/*.{xml,json}'], true, process.env.ONE_REPORT_TEST_ORGANIZATION_ID, baseUrl, process.env, basicAuthAuthenticator('anyone', process.env.ONE_REPORT_PASSWORD), undefined);
         assert.strictEqual(responseBodies.length, 2);
@@ -26,0 +26,0 @@ for (const responseBody of responseBodies) {

dist/esm/test/publish.test.js

@@ -22,3 +22,5 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     let port;
+    let serverLatency;
     beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        serverLatency = 0;
         port = yield new Promise((resolve) => {
@@ -38,3 +40,3 @@ server = http.createServer((req, res) => {
                     };
-                    res.end(JSON.stringify(responseBody));
+                    setTimeout(() => res.end(JSON.stringify(responseBody)), serverLatency);
                 })
@@ -58,2 +60,14 @@ .catch((err) => {
     }));
+    it('times out after specified timeout', () => __awaiter(void 0, void 0, void 0, function* () {
+        serverLatency = 10;
+        const organizationId = '32C46057-0AB6-44E8-8944-0246E0BEA96F';
+        const fakeEnv = {
+            GITHUB_SERVER_URL: 'https://github.com',
+            GITHUB_REPOSITORY: 'SmartBear/one-report-publisher',
+            GITHUB_RUN_ID: '154666429',
+            GITHUB_SHA: 'f7d967d6d4f7adc1d6657bda88f4e976c879d74c',
+            GITHUB_REF: 'refs/heads/main',
+        };
+        yield assert.rejects(publish(['test/fixtures/*.xml'], false, organizationId, `http://localhost:${port}`, fakeEnv, () => Promise.resolve({}), 1));
+    }));
     it('publishes files from glob without zipping', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -68,3 +82,3 @@ const organizationId = '32C46057-0AB6-44E8-8944-0246E0BEA96F';
         };
-        const responseBodies = yield publish(['test/fixtures/*.{xml,json,ndjson,zip}'], false, organizationId, `http://localhost:${port}`, fakeEnv, () => Promise.resolve({}));
+        const responseBodies = yield publish(['test/fixtures/*.{xml,json,ndjson,zip}'], false, organizationId, `http://localhost:${port}`, fakeEnv, () => Promise.resolve({}), undefined);
         const expectedServerRequests = [
@@ -146,3 +160,3 @@ {
         const fakeEnv = {};
-        const responseBodies = yield publish(['test/fixtures/*.{xml,json,ndjson,zip}'], true, organizationId, `http://localhost:${port}`, fakeEnv, () => Promise.resolve({}));
+        const responseBodies = yield publish(['test/fixtures/*.{xml,json,ndjson,zip}'], true, organizationId, `http://localhost:${port}`, fakeEnv, () => Promise.resolve({}), undefined);
         const expectedServerRequests = [
@@ -149,0 +163,0 @@ {

package.json

 {
   "name": "@smartbear/one-report-publisher",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Publish Test Results to SmartBear OneReport",
@@ -60,3 +60,3 @@ "type": "module",
     "@typescript-eslint/parser": "5.11.0",
-    "esbuild": "0.14.20",
+    "esbuild": "0.14.21",
     "eslint": "8.8.0",
@@ -71,3 +71,3 @@ "eslint-config-prettier": "8.3.0",
     "mocha-junit-reporter": "2.0.2",
-    "npm-check-updates": "12.2.1",
+    "npm-check-updates": "12.3.0",
     "prettier": "2.5.1",
@@ -74,0 +74,0 @@ "pretty-quick": "3.1.3",

README.md

@@ -78,4 +78,5 @@ [![Run Tests](https://github.com/SmartBear/one-report-publisher/actions/workflows/test.yaml/badge.svg)](https://github.com/SmartBear/one-report-publisher/actions/workflows/test.yaml)
   --organization-id F5222E06-BA05-4C82-949A-2FE537B6F59F \
+  --username anyone \
   --password ${ONE_REPORT_PASSWORD} \
   --reports ./reports/**/*.{xml,json,ndjson,zip}
 ```

No alert changes

Improved metrics

Total package byte prevSize

222880

3.36%

Lines of code

2285

4.01%

Number of lines in readme file

82

1.23%

No dependency changes