monocart-reporter 2.2.2 → 2.2.4

package/README.md

@@ -171,15 +171,33 @@ Separated metadata file (Already included in the above HTML and compressed, it c
 ```
 
 ## View Trace Online 
-> The [Trace Viewer](https://trace.playwright.dev/) requires that the trace file must be loaded over the http:// or https:// protocols without [CORS](https://developer.mozilla.org/en-US/docs/Glossary/CORS) issue, try following start a local web server:
+> The [Trace Viewer](https://trace.playwright.dev/) requires that the trace file must be loaded over the http:// or https:// protocols without [CORS](https://developer.mozilla.org/en-US/docs/Glossary/CORS) issue.
+- Start a local web server with following CLI:
 ```sh
 # serve and open report
-npx monocart show-report <your-outputFile-path>
+npx monocart show-report <path-to-report>
 
 # serve report
-npx monocart serve-report <your-outputFile-path>
+npx monocart serve-report <path-to-report>
+```
+The server add the http header `Access-Control-Allow-Origin: *` to [allow requesting from any origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin), it works with `http://localhost:port/` or `http://127.0.0.1:port/`
+- To successfully work with other `IP` or `domain`, you can start web server with `https`:
+```sh
+npx monocart show-report <path-to-report> --ssl <path-to-key,path-to-cert>
+```
+For example: `npx monocart show-report test-results/index.html --ssl ssl/key.pem,ssl/cert.pem`
+
+You can create and install local CA with [mkcert](https://mkcert.dev)
+- Using your own trace viewer url with option `traceViewerUrl`:
+```js
+// reporter options
+{
+    name: "My Test Report",
+    outputFile: './test-results/report.html',
+    // defaults to 'https://trace.playwright.dev/?trace={traceUrl}'
+    traceViewerUrl: 'https://your-own-trace-viewer-url/?trace={traceUrl}'
+}
 ```
-Or customize your own trace viewer url with option `traceViewerUrl` defaults to  `https://trace.playwright.dev/?trace={traceUrl}`
 
 ## Custom Fields Report
 You can add custom fields to the report. for example: Owner, JIRA Key etc.

package/lib/cli.js

@@ -3,12 +3,37 @@
 const fs = require('fs');
 const path = require('path');
 const http = require('http');
+const https = require('https');
 const net = require('net');
+const os = require('os');
 const EC = require('eight-colors');
 const KSR = require('koa-static-resolver');
 const Koa = require('koa');
+const CG = require('console-grid');
 
+const { program } = require('./packages/monocart-vendor.js');
 const defaultOptions = require('./default/options.js');
+const version = require('../package.json').version;
+
+const getInternalIps = () => {
+    const n = os.networkInterfaces();
+    // console.log(n);
+    const list = [];
+    for (const k in n) {
+        const inter = n[k];
+        for (const j in inter) {
+            const item = inter[j];
+            if (item.family === 'IPv4' && !item.internal) {
+                const a = item.address;
+                if (a.startsWith('192.') || a.startsWith('10.')) {
+                    list.push(a);
+                }
+            }
+        }
+    }
+    return list;
+};
+
 
 const generatePort = (startPort) => {
     return new Promise((resolve) => {
@@ -29,36 +54,71 @@ const generatePort = (startPort) => {
     });
 };
 
+const showIpInfo = (protocol, port) => {
+    const ips = getInternalIps();
+    CG({
+        options: {
+            headerVisible: false
+        },
+        columns: [{
+            id: 'type'
+        }, {
+            id: 'url',
+            formatter: (v) => {
+                return EC.green(v);
+            }
+        }],
+        rows: [{
+            url: `${protocol}://localhost:${port}`,
+            type: 'Local'
+        }, ... ips.map((ip) => {
+            return {
+                url: `${protocol}://${ip}:${port}`,
+                type: 'Internal'
+            };
+        })]
+    });
+};
+
 const openUrl = async (p) => {
     const open = await import('open');
     await open.default(p);
 };
 
+const createServer = (app, options) => {
+
+    if (options.ssl) {
+        const [keyPath, certPath] = options.ssl.split(',');
+        const serverOptions = {
+            key: fs.readFileSync(path.resolve(keyPath)),
+            cert: fs.readFileSync(path.resolve(certPath))
+        };
+        return https.createServer(serverOptions, app.callback());
+    }
+
+    return http.createServer(app.callback());
+
+};
+
+const serveReport = async (p, options) => {
 
-const serveReport = async (list, openReport) => {
-    if (!list.length) {
-        list.push(defaultOptions.outputFile);
+    if (!p) {
+        p = defaultOptions.outputFile;
     }
 
+    const dirs = [];
     let filename = '';
-    const dirs = list.filter((item) => {
-        if (fs.existsSync(item)) {
-            return true;
-        }
-        EC.logRed(`the path does not exists: ${item}`);
-        return false;
-    }).map((item) => {
-        const stat = fs.statSync(item);
+    if (fs.existsSync(p)) {
+        const stat = fs.statSync(p);
         if (stat.isDirectory()) {
-            return item;
+            dirs.push(p);
+        } else if (stat.isFile()) {
+            filename = path.basename(p);
+            dirs.push(path.dirname(p));
         }
-
-        if (!filename) {
-            filename = path.basename(item);
-        }
-
-        return path.dirname(item);
-    });
+    } else {
+        EC.logRed(`The path does not exists: ${p}`);
+    }
 
     dirs.push('./');
 
@@ -75,36 +135,53 @@ const serveReport = async (list, openReport) => {
         maxAge: 1
     }));
 
-    const server = http.createServer(app.callback());
+    const server = createServer(app, options);
 
     const port = await generatePort(8090);
+    const protocol = options.ssl ? 'https' : 'http';
 
-    const url = `http://localhost:${port}/${filename}`;
+    const url = `${protocol}://localhost:${port}/${filename}`;
 
     server.listen(port, function() {
         EC.logCyan(`${new Date().toLocaleString()} server listening on ${url}`);
-        if (openReport) {
+        if (protocol === 'https') {
+            showIpInfo(protocol, port);
+        }
+        if (options.open) {
             openUrl(url);
         }
     });
 
 };
 
-const start = function() {
-    const args = process.argv.slice(2);
-    const command = args.shift();
-    // console.log(command, args);
-    if (command === 'show' || command === 'show-report') {
-        serveReport(args, true);
-        return;
-    }
+program
+    .name('monocart')
+    .description('CLI to serve monocart reporter')
+    .version(version);
+
+program.command('show-report')
+    .alias('show')
+    .description('Show report')
+    .argument('<path-to-report>', 'Report dir or html path')
+    .option('-s, --ssl <path-to-key,path-to-cert>', 'Start https server')
+    .action((str, options) => {
+        options.open = true;
+        serveReport(str, options);
+    });
 
-    if (command === 'serve' || command === 'serve-report') {
-        serveReport(args, false);
-        return;
-    }
+program.command('serve-report')
+    .alias('serve')
+    .description('Serve report')
+    .argument('<path-to-report>', 'Report dir or html path')
+    .option('-s, --ssl <path-to-key,path-to-cert>', 'Start https server')
+    .action((str, options) => {
+        serveReport(str, options);
+    });
 
-    EC.logRed(`Not found command: ${command}`);
-};
+program.addHelpText('after', `
+Starts ${EC.cyan('https')} with option --ssl:
+    npx monocart show-report <path-to-report> ${EC.cyan('--ssl <path-to-key,path-to-cert>')}
+    # Create and install local CA with 'mkcert', see: https://mkcert.dev
+`);
 
-start();
+program.parse();