qase-report 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,282 @@
+# Qase Report
+
+Open-source CLI tool for visualizing test reports in [Qase Report Format](https://github.com/qase-tms/specs/tree/master/report). Interactive HTML report with dashboard, test list, step timeline, attachments viewer, and history analytics.
+
+![Qase Report](images/main.png)
+
+## Features
+
+- **Dashboard** — Pass/fail statistics, completion rate ring, run metadata
+- **Test List** — Filterable test cases with suite hierarchy and expandable rows
+- **Step Timeline** — Nested steps with duration visualization
+- **Attachments** — Screenshots, logs, and files with lightbox viewer
+- **History Analytics** — Trends, flakiness detection, regression alerts, stability scoring
+- **Command Palette** — Quick search with ⌘K / Ctrl+K
+- **Dark Theme** — Dark mode by default with light theme option
+- **Static Export** — Generate standalone HTML file that works offline
+
+## Installation (Development)
+
+### Requirements
+
+- Node.js >= 18.0.0
+- npm
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/qase-tms/qase-report.git
+cd qase-report
+
+# Install dependencies
+npm install
+
+# Build the CLI
+npm run build
+```
+
+After building, you can run the CLI directly:
+
+```bash
+node dist/cli/index.js --help
+```
+
+Or link it globally for easier access:
+
+```bash
+npm link
+qase-report --help
+```
+
+## Usage
+
+### Open Report in Browser
+
+Start a local server and open the report in your browser:
+
+```bash
+qase-report open ./path/to/results
+```
+
+Options:
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-p, --port <number>` | Port number | `3000` |
+| `--no-open` | Don't open browser automatically | — |
+| `-H, --history <path>` | History file path | `./qase-report-history.json` in results folder |
+
+Examples:
+
+```bash
+# Open report on custom port
+qase-report open ./results -p 8080
+
+# Open without launching browser
+qase-report open ./results --no-open
+
+# Specify custom history file
+qase-report open ./results -H ./my-history.json
+```
+
+The `open` command automatically saves run data to the history file, enabling trend analysis and flakiness detection across multiple runs.
+
+### Generate Static HTML
+
+Create a standalone HTML file that can be opened directly in a browser (works with `file://` protocol):
+
+```bash
+qase-report generate ./path/to/results
+```
+
+Options:
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-o, --output <file>` | Output file path | `report.html` |
+| `-H, --history <path>` | History file to embed | — |
+
+Examples:
+
+```bash
+# Generate report with custom name
+qase-report generate ./results -o my-report.html
+
+# Generate with embedded history
+qase-report generate ./results -H ./history.json -o report-with-history.html
+```
+
+## Data Format
+
+Qase Report expects data in the [Qase Report Format](https://github.com/qase-tms/qase-report-format) structure:
+
+```
+results/
+├── run.json              # Run metadata and statistics
+├── results/
+│   ├── {uuid}.json       # Individual test results
+│   └── ...
+├── attachments/          # Screenshots, logs, files
+│   └── ...
+└── qase-report-history.json  # Optional: history for analytics
+```
+
+### run.json
+
+Contains run metadata, execution timing, and test summary:
+
+```json
+{
+  "title": "Test Run",
+  "environment": "production",
+  "execution": {
+    "start_time": 1707700000000,
+    "end_time": 1707700060000,
+    "duration": 60000,
+    "cumulative_duration": 45000
+  },
+  "stats": {
+    "total": 100,
+    "passed": 95,
+    "failed": 3,
+    "skipped": 2
+  },
+  "results": [
+    { "id": "uuid-1", "title": "Test 1", "status": "passed", "duration": 150, "thread": "worker-1" }
+  ],
+  "threads": ["worker-1", "worker-2"],
+  "suites": ["Auth", "API"],
+  "host_data": {
+    "node": "v20.0.0",
+    "system": "Darwin",
+    "release": "23.0.0",
+    "version": "Darwin Kernel Version 23.0.0",
+    "machine": "arm64"
+  }
+}
+```
+
+### results/{uuid}.json
+
+Individual test result with steps, attachments, and metadata:
+
+```json
+{
+  "id": "uuid-1",
+  "title": "User can login with valid credentials",
+  "signature": "auth.login.valid_credentials",
+  "muted": false,
+  "execution": {
+    "status": "passed",
+    "start_time": 1707700000000,
+    "end_time": 1707700000150,
+    "duration": 150,
+    "stacktrace": null,
+    "thread": "worker-1"
+  },
+  "message": null,
+  "relations": {
+    "suite": {
+      "data": [
+        { "title": "Auth", "public_id": null },
+        { "title": "Login", "public_id": null }
+      ]
+    }
+  },
+  "steps": [
+    {
+      "name": "Navigate to login page",
+      "status": "passed",
+      "duration": 50,
+      "steps": []
+    }
+  ],
+  "attachments": [
+    {
+      "name": "screenshot.png",
+      "mime_type": "image/png",
+      "file_path": "attachments/screenshot.png"
+    }
+  ],
+  "params": {},
+  "param_groups": [],
+  "fields": {},
+  "testops_ids": [123]
+}
+```
+
+### Test Status Values
+
+| Status | Description |
+|--------|-------------|
+| `passed` | Test completed successfully |
+| `failed` | Test failed with assertion errors |
+| `skipped` | Test was skipped |
+| `broken` | Test encountered unexpected errors preventing execution |
+| `blocked` | Test was blocked by external dependency |
+| `invalid` | Test configuration or data is invalid |
+| `muted` | Test failures are muted/ignored |
+
+### qase-report-history.json
+
+History file for tracking test results across multiple runs. Enables trend analysis, flakiness detection, and stability scoring.
+
+```json
+{
+  "schema_version": "1.0.0",
+  "runs": [
+    {
+      "run_id": "1707700000000",
+      "title": "Test Run",
+      "environment": "production",
+      "start_time": 1707700000000,
+      "end_time": 1707700060000,
+      "duration": 60000,
+      "stats": {
+        "total": 100,
+        "passed": 95,
+        "failed": 3,
+        "skipped": 2
+      }
+    }
+  ],
+  "tests": [
+    {
+      "signature": "auth.login.valid_credentials",
+      "title": "User can login with valid credentials",
+      "runs": [
+        {
+          "run_id": "1707700000000",
+          "status": "passed",
+          "duration": 150,
+          "start_time": 1707700000000,
+          "error_message": null
+        }
+      ]
+    }
+  ]
+}
+```
+
+**Key fields:**
+
+- `schema_version` — Format version for future migrations
+- `runs` — Array of run summaries with stats
+- `tests` — Array of per-test history grouped by `signature`
+- `signature` — Stable test identifier (not UUID) for tracking across runs
+- `error_message` — First line of error, used for flakiness detection
+
+## Tech Stack
+
+- React 18 + TypeScript 5.9
+- Vite 5
+- shadcn/ui + Tailwind CSS v4
+- MobX for state management
+- TanStack Table + Virtual for performant tables
+- Recharts for visualizations
+- Zod v4 for schema validation
+
+## License
+
+MIT

package/dist/cli/commands/generate.js

@@ -0,0 +1,69 @@
+import { existsSync, accessSync, constants, mkdirSync, writeFileSync, statSync } from 'fs';
+import { join, resolve, dirname } from 'path';
+import { generateHtmlReport } from '../generators/html-generator.js';
+/**
+ * Formats file size in human-readable format (B, KB, MB)
+ */
+function formatFileSize(bytes) {
+    if (bytes < 1024)
+        return `${bytes} B`;
+    if (bytes < 1024 * 1024)
+        return `${(bytes / 1024).toFixed(2)} KB`;
+    return `${(bytes / (1024 * 1024)).toFixed(2)} MB`;
+}
+/**
+ * Registers the 'generate' command for creating standalone HTML reports.
+ *
+ * @param program - Commander program instance
+ */
+export function registerGenerateCommand(program) {
+    program
+        .command('generate <path>')
+        .description('Generate standalone HTML report')
+        .option('-o, --output <file>', 'Output file path', 'report.html')
+        .option('-H, --history <path>', 'History file path (default: ./qase-report-history.json in results folder)')
+        .action(async (path, options) => {
+        // 1. Resolve input path
+        const resolvedPath = resolve(path);
+        // 2. Validate path exists
+        if (!existsSync(resolvedPath)) {
+            console.error(`Error: Path does not exist: ${resolvedPath}`);
+            process.exit(1);
+        }
+        // 3. Validate run.json exists
+        const runJsonPath = join(resolvedPath, 'run.json');
+        try {
+            accessSync(runJsonPath, constants.R_OK);
+        }
+        catch {
+            console.error(`Error: run.json not found at ${runJsonPath}`);
+            process.exit(1);
+        }
+        // 4. Resolve output path (default: "report.html" in cwd)
+        const outputPath = resolve(options.output);
+        // 5. Create parent directories for output
+        const outputDir = dirname(outputPath);
+        mkdirSync(outputDir, { recursive: true });
+        // 6. Generate HTML report
+        try {
+            console.log(`Generating report from ${resolvedPath}`);
+            const historyPath = options.history ? resolve(options.history) : undefined;
+            const html = generateHtmlReport({
+                reportPath: resolvedPath,
+                historyPath,
+            });
+            // 7. Write result to output path
+            writeFileSync(outputPath, html, 'utf-8');
+            // 8. Log success message with file size
+            const stats = statSync(outputPath);
+            const fileSize = formatFileSize(stats.size);
+            console.log(`\nReport generated successfully!`);
+            console.log(`File: ${outputPath}`);
+            console.log(`Size: ${fileSize}`);
+        }
+        catch (error) {
+            console.error(`Error: Failed to write report: ${error instanceof Error ? error.message : error}`);
+            process.exit(1);
+        }
+    });
+}

package/dist/cli/commands/open.js

@@ -0,0 +1,95 @@
+import { existsSync, accessSync, constants, readFileSync, readdirSync } from 'fs';
+import { join, resolve } from 'path';
+import open from 'open';
+import { addRunToHistory } from '../history.js';
+// Strip UTF-8 BOM that some tools (e.g. .NET reporters) prepend to JSON files
+const stripBom = (s) => s.replace(/^\uFEFF/, '');
+/**
+ * Registers the 'open' command for serving reports in browser.
+ *
+ * @param program - Commander program instance
+ */
+export function registerOpenCommand(program) {
+    program
+        .command('open <path>')
+        .description('Serve report in browser')
+        .option('-p, --port <number>', 'Port number', '3000')
+        .option('--no-open', 'Disable automatic browser opening')
+        .option('-H, --history <path>', 'History file path (default: ./qase-report-history.json in results folder)')
+        .action(async (path, options) => {
+        const resolvedPath = resolve(path);
+        const runJsonPath = join(resolvedPath, 'run.json');
+        // Validate path exists
+        if (!existsSync(resolvedPath)) {
+            console.error(`Error: Path does not exist: ${resolvedPath}`);
+            process.exit(1);
+        }
+        // Validate run.json exists
+        try {
+            accessSync(runJsonPath, constants.R_OK);
+        }
+        catch {
+            console.error(`Error: run.json not found at ${runJsonPath}`);
+            console.error('Please provide a valid qase-report results directory.');
+            process.exit(1);
+        }
+        // Parse port
+        const port = parseInt(options.port, 10);
+        if (isNaN(port) || port < 1 || port > 65535) {
+            console.error(`Error: Invalid port number: ${options.port}`);
+            process.exit(1);
+        }
+        // Determine history path
+        const historyPath = options.history
+            ? resolve(options.history)
+            : join(resolvedPath, 'qase-report-history.json');
+        // Dynamic import to avoid bundling issues
+        const { createServer, startServer, setupGracefulShutdown } = await import('../server.js');
+        // Create and start server
+        const app = createServer({ reportPath: resolvedPath, port, historyPath });
+        console.log(`Serving report from ${resolvedPath}`);
+        try {
+            const { server, port: actualPort } = await startServer(app, port);
+            const url = `http://localhost:${actualPort}`;
+            console.log(`Open ${url} in your browser`);
+            // Setup graceful shutdown
+            setupGracefulShutdown(server);
+            // Save run to history
+            try {
+                // Read run.json
+                const runData = JSON.parse(stripBom(readFileSync(runJsonPath, 'utf-8')));
+                // Read all results from results/ directory
+                const resultsDir = join(resolvedPath, 'results');
+                const results = [];
+                if (existsSync(resultsDir)) {
+                    const resultFiles = readdirSync(resultsDir).filter((file) => file.endsWith('.json'));
+                    for (const file of resultFiles) {
+                        const resultPath = join(resultsDir, file);
+                        const resultData = JSON.parse(stripBom(readFileSync(resultPath, 'utf-8')));
+                        results.push(resultData);
+                    }
+                }
+                // Add to history
+                addRunToHistory({ historyPath, run: runData, results });
+                console.log(`History saved to ${historyPath}`);
+            }
+            catch (error) {
+                console.warn('Warning: Failed to save history:', error instanceof Error ? error.message : error);
+            }
+            // Open browser if --no-open was not specified
+            if (options.open) {
+                await open(url);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error &&
+                error.code === 'EADDRINUSE') {
+                console.error(`Error: Port ${port} is already in use`);
+            }
+            else {
+                console.error('Failed to start server:', error);
+            }
+            process.exit(1);
+        }
+    });
+}