allure-report-publisher 5.0.0-alpha.0

package/dist/utils/spinner.js

@@ -0,0 +1,28 @@
+import chalk from 'chalk';
+import ora from 'ora';
+import { config } from './config.js';
+import { logger } from './logger.js';
+function flushDebug() {
+    if (config.debug)
+        logger.flushDebug();
+}
+export async function spin(action, message, options = {}) {
+    const spinner = ora(message).start();
+    try {
+        const result = await action;
+        spinner.succeed(`${message} ... ${chalk.green('done')}`);
+        flushDebug();
+        return result;
+    }
+    catch (error) {
+        if (options.ignoreError) {
+            spinner.warn(`${message} ... ${chalk.yellow('failed')}`);
+            logger.warn(error.message);
+            flushDebug();
+            return undefined;
+        }
+        spinner.fail(`${message} ... ${chalk.red('failed')}`);
+        flushDebug();
+        throw error;
+    }
+}

package/dist/utils/uploader.d.ts

@@ -0,0 +1,11 @@
+import { BaseUploader } from '../lib/uploader/base.js';
+export declare function getUploader(type: string, opts: {
+    bucket: string;
+    copyLatest: boolean;
+    parallel: number;
+    historyPath: string;
+    output: string;
+    plugins: string[];
+    baseUrl?: string;
+    prefix?: string;
+}): BaseUploader;

package/dist/utils/uploader.js

@@ -0,0 +1,19 @@
+import { S3Uploader } from '../lib/uploader/s3.js';
+export function getUploader(type, opts) {
+    switch (type) {
+        case 's3': {
+            return new S3Uploader(opts);
+        }
+        // case 'gcs': {
+        //   const {GCSUploader} = require('./gcs.js')
+        //   return new GCSUploader(opts)
+        // }
+        // case 'gitlab-artifacts': {
+        //   const {GitLabArtifactsUploader} = require('./gitlab-artifacts.js')
+        //   return new GitLabArtifactsUploader(opts)
+        // }
+        default: {
+            throw new Error(`Unsupported uploader type: ${type}`);
+        }
+    }
+}

package/oclif.manifest.json

@@ -0,0 +1,237 @@
+{
+  "commands": {
+    "upload": {
+      "aliases": [],
+      "args": {
+        "type": {
+          "description": "Cloud storage provider type",
+          "name": "type",
+          "options": [
+            "s3",
+            "gcs",
+            "gitlab-artifacts"
+          ],
+          "required": true
+        }
+      },
+      "description": "Generate and upload allure report to cloud storage",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> s3 --results-glob=\"path/to/allure-results\" --bucket=my-bucket",
+        "<%= config.bin %> <%= command.id %> gcs --results-glob=\"paths/to/**/allure-results\" --bucket=my-bucket --prefix=my-project/prs",
+        "<%= config.bin %> <%= command.id %> gitlab-artifacts --results-glob=\"paths/to/**/allure-results\"",
+        "<%= config.bin %> <%= command.id %> s3 --results-glob=\"path/to/allure-results\" --bucket=my-bucket --update-pr=comment --summary=behaviors"
+      ],
+      "flags": {
+        "baseUrl": {
+          "aliases": [
+            "base-url"
+          ],
+          "description": "Custom base URL for report links",
+          "env": "ALLURE_BASE_URL",
+          "name": "baseUrl",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "resultsGlob": {
+          "aliases": [
+            "results-glob"
+          ],
+          "char": "r",
+          "description": "Glob pattern for allure results directories",
+          "env": "ALLURE_RESULTS_GLOB",
+          "name": "resultsGlob",
+          "default": "./**/allure-results",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "bucket": {
+          "char": "b",
+          "description": "Cloud storage bucket name (required for s3/gcs)",
+          "env": "ALLURE_BUCKET",
+          "name": "bucket",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "prefix": {
+          "char": "p",
+          "description": "Prefix for report path in cloud storage (ignored for gitlab-artifacts)",
+          "env": "ALLURE_PREFIX",
+          "name": "prefix",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "config": {
+          "char": "c",
+          "description": "The path to allure config file (only .json or .yaml are supported)",
+          "env": "ALLURE_CONFIG_PATH",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "reportName": {
+          "aliases": [
+            "report-name"
+          ],
+          "description": "Custom report name in Allure report (ignored with config-path)",
+          "env": "ALLURE_REPORT_NAME",
+          "name": "reportName",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ciReportTitle": {
+          "aliases": [
+            "ci-report-title"
+          ],
+          "description": "Title for PR comment/description section",
+          "env": "ALLURE_CI_REPORT_TITLE",
+          "name": "ciReportTitle",
+          "default": "Allure Report",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "summary": {
+          "description": "Add test summary table to PR",
+          "env": "ALLURE_SUMMARY",
+          "name": "summary",
+          "default": "total",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "behaviors",
+            "suites",
+            "packages",
+            "total"
+          ],
+          "type": "option"
+        },
+        "summaryTableType": {
+          "aliases": [
+            "summary-table-type"
+          ],
+          "description": "Summary table format",
+          "env": "ALLURE_SUMMARY_TABLE_TYPE",
+          "name": "summaryTableType",
+          "default": "ascii",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "ascii",
+            "markdown"
+          ],
+          "type": "option"
+        },
+        "updatePr": {
+          "aliases": [
+            "update-pr"
+          ],
+          "description": "Update PR with report URL (comment/description/actions)",
+          "env": "ALLURE_UPDATE_PR",
+          "name": "updatePr",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "comment",
+            "description",
+            "actions"
+          ],
+          "type": "option"
+        },
+        "collapseSummary": {
+          "aliases": [
+            "collapse-summary"
+          ],
+          "description": "Create collapsible summary section in PR",
+          "env": "ALLURE_COLLAPSE_SUMMARY",
+          "name": "collapseSummary",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "color": {
+          "description": "Force color output",
+          "env": "ALLURE_COLOR",
+          "name": "color",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "copyLatest": {
+          "aliases": [
+            "copy-latest"
+          ],
+          "description": "Keep copy of latest run report at base prefix (ignored for gitlab-artifacts)",
+          "env": "ALLURE_COPY_LATEST",
+          "name": "copyLatest",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "debug": {
+          "description": "Print debug log output",
+          "env": "ALLURE_DEBUG",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flakyWarningStatus": {
+          "aliases": [
+            "flaky-warning-status"
+          ],
+          "description": "Mark run with ! status if flaky tests found",
+          "env": "ALLURE_FLAKY_WARNING_STATUS",
+          "name": "flakyWarningStatus",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "ignoreMissingResults": {
+          "aliases": [
+            "ignore-missing-results"
+          ],
+          "description": "Ignore missing allure results",
+          "env": "ALLURE_IGNORE_MISSING_RESULTS",
+          "name": "ignoreMissingResults",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "output": {
+          "char": "o",
+          "description": "Output directory for generated report (default: temp dir for cloud, \"allure-report\" for gitlab-artifacts)",
+          "env": "ALLURE_OUTPUT",
+          "name": "output",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "parallel": {
+          "description": "Number of parallel threads for upload",
+          "env": "ALLURE_PARALLEL",
+          "name": "parallel",
+          "default": 8,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "upload",
+      "pluginAlias": "allure-report-publisher",
+      "pluginName": "allure-report-publisher",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "upload",
+        "index.js"
+      ]
+    }
+  },
+  "version": "5.0.0-alpha.0"
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "allure-report-publisher",
+  "description": "Publish allure 3 reports to cloud storage providers",
+  "version": "5.0.0-alpha.0",
+  "author": "Andrejs Cunskis",
+  "bin": {
+    "allure-report-publisher": "bin/run.js"
+  },
+  "bugs": "https://github.com/andrcuns/allure-report-publisher/issues",
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.0.0",
+    "@gitbeaker/rest": "^43.8.0",
+    "@oclif/core": "^4",
+    "allure": "^3.0.0",
+    "chalk": "^5.0.0",
+    "cli-table3": "^0.6.0",
+    "glob": "^13.0.0",
+    "mime-types": "^3.0.0",
+    "nano-spawn": "^2.0.0",
+    "ora": "^9.0.0",
+    "p-all": "^5.0.1",
+    "yaml": "^2.0.0"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^2.0.0",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4.1.15",
+    "@types/chai": "^5.2.3",
+    "@types/mime-types": "^3.0.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.3",
+    "allure-mocha": "^3.4.3",
+    "chai": "^6.2.2",
+    "eslint": "^9.39.2",
+    "eslint-config-oclif": "^6.0.128",
+    "eslint-config-prettier": "^10.1.8",
+    "mocha": "^11.7.5",
+    "oclif": "^4.22.61",
+    "shx": "^0.4.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/andrcuns/allure-report-publisher",
+  "keywords": [
+    "oclif",
+    "allure",
+    "test-report"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "allure-report-publisher",
+    "dirname": "allure-report-publisher",
+    "commands": "./dist/commands",
+    "plugins": [],
+    "topicSeparator": " ",
+    "topics": {}
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/andrcuns/allure-report-publisher.git"
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "cleanBuild": "shx rm -rf dist && shx rm -f tsconfig.tsbuildinfo && tsc -b",
+    "lint": "eslint",
+    "prepack": "oclif manifest && oclif readme",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts"
+}