@allurereport/plugin-api 3.0.0-beta.17 → 3.0.0-beta.19

package/dist/qualityGate.d.ts

@@ -1,44 +1,35 @@
-import type { AllureStore } from "./store.js";
-export type QualityGateRules = Record<string, any>;
-export type QualityGateRulesBaseMeta<T> = {
-    type: T;
-};
-export type QualityGateLabelsRulesMeta = QualityGateRulesBaseMeta<"label"> & {
-    name: string;
-    value: string;
-};
-export type QualityGateParametersRulesMeta = QualityGateRulesBaseMeta<"parameter"> & {
-    name: string;
-    value: string;
-};
-export type QualityGateLabelsEnforceConfig = {
-    type: "label";
-    name: string;
-    value: string;
-    rules: QualityGateRules;
+import type { KnownTestFailure, TestResult } from "@allurereport/core-api";
+export type QualityGateValidationResult = {
+    success: boolean;
+    expected: any;
+    actual: any;
+    rule: string;
+    message: string;
 };
-export type QualityGateParametersEnforceConfig = {
-    type: "parameter";
-    name: string;
-    value: string;
-    rules: QualityGateRules;
+export type QualityGateRules = Record<string, any> & {
+    id?: string;
+    fastFail?: boolean;
+    filter?: (tr: TestResult) => boolean;
 };
-export type QualityGateRulesMeta = Omit<QualityGateLabelsRulesMeta, "rules"> | Omit<QualityGateParametersRulesMeta, "rules">;
-export type QualityGateEnforceConfig = QualityGateLabelsEnforceConfig | QualityGateParametersEnforceConfig;
-export type QualityGateValidationResult = {
+export type QualityGateRuleResult = {
     success: boolean;
+    expected: any;
+    actual: any;
+};
+export type QualityGateRule<T = any> = {
     rule: string;
-    meta?: QualityGateRulesMeta;
-    expected?: number;
-    actual?: number;
-    message?: string;
+    message: (payload: {
+        expected: T;
+        actual: T;
+    }) => string;
+    validate: (payload: {
+        expected: T;
+        trs: TestResult[];
+        knownIssues: KnownTestFailure[];
+        state?: T;
+    }) => Promise<QualityGateRuleResult>;
 };
-export interface QualityGateValidator {
-    validate(store: AllureStore): Promise<QualityGateValidationResult>;
-}
-export type QualityGateValidatorConstructor = new (limit: number, meta?: QualityGateRulesMeta) => QualityGateValidator;
 export type QualityGateConfig = {
-    rules?: QualityGateRules;
-    enforce?: QualityGateEnforceConfig[];
-    validators?: Record<string, QualityGateValidatorConstructor>;
+    rules?: QualityGateRules[];
+    use?: QualityGateRule[];
 };

package/dist/store.d.ts

@@ -1,4 +1,6 @@
-import type { AttachmentLink, HistoryDataPoint, HistoryTestResult, KnownTestFailure, Statistic, TestCase, TestEnvGroup, TestFixtureResult, TestResult } from "@allurereport/core-api";
+import type { AttachmentLink, HistoryDataPoint, HistoryTestResult, KnownTestFailure, ReportVariables, Statistic, TestCase, TestEnvGroup, TestError, TestFixtureResult, TestResult } from "@allurereport/core-api";
+import type { ExitCode } from "./plugin.js";
+import type { QualityGateValidationResult } from "./qualityGate.js";
 import type { ResultFile } from "./resultFile.js";
 export type TestResultFilter = (testResult: TestResult) => boolean;
 export interface AllureStore {
@@ -12,6 +14,10 @@ export interface AllureStore {
     allHistoryDataPoints: () => Promise<HistoryDataPoint[]>;
     allKnownIssues: () => Promise<KnownTestFailure[]>;
     allNewTestResults: () => Promise<TestResult[]>;
+    qualityGateResults: () => Promise<QualityGateValidationResult[]>;
+    globalExitCode: () => Promise<ExitCode | undefined>;
+    allGlobalErrors: () => Promise<TestError[]>;
+    allGlobalAttachments: () => Promise<AttachmentLink[]>;
     testCaseById: (tcId: string) => Promise<TestCase | undefined>;
     testResultById: (trId: string) => Promise<TestResult | undefined>;
     attachmentById: (attachmentId: string) => Promise<AttachmentLink | undefined>;
@@ -35,3 +41,37 @@ export interface AllureStore {
     allVariables: () => Promise<Record<string, any>>;
     envVariables: (env: string) => Promise<Record<string, any>>;
 }
+export interface AllureStoreDump {
+    testResults: Record<string, TestResult>;
+    attachments: Record<string, AttachmentLink>;
+    globalAttachments: AttachmentLink[];
+    globalErrors: TestError[];
+    testCases: Record<string, TestCase>;
+    fixtures: Record<string, TestFixtureResult>;
+    environments: string[];
+    reportVariables: ReportVariables;
+    indexAttachmentByTestResult: Record<string, string[]>;
+    indexTestResultByHistoryId: Record<string, string[]>;
+    indexTestResultByTestCase: Record<string, string[]>;
+    indexLatestEnvTestResultByHistoryId: Record<string, string>;
+    indexAttachmentByFixture: Record<string, string[]>;
+    indexFixturesByTestResult: Record<string, string[]>;
+    indexKnownByHistoryId: Record<string, KnownTestFailure[]>;
+}
+export declare enum AllureStoreDumpFiles {
+    TestResults = "test-results.json",
+    TestCases = "test-cases.json",
+    Fixtures = "fixtures.json",
+    GlobalErrors = "global-errors.json",
+    GlobalAttachments = "global-attachments.json",
+    Attachments = "attachments.json",
+    Environments = "environments.json",
+    ReportVariables = "report-variables.json",
+    IndexAttachmentsByTestResults = "index-attachments-by-test-results.json",
+    IndexTestResultsByHistoryId = "index-test-results-by-history-id.json",
+    IndexTestResultsByTestCase = "index-test-results-by-test-case.json",
+    IndexLatestEnvTestResultsByHistoryId = "index-latest-env-test-results-by-history-id.json",
+    IndexAttachmentsByFixture = "index-attachments-by-fixture.json",
+    IndexFixturesByTestResult = "index-fixtures-by-test-result.json",
+    IndexKnownByHistoryId = "index-known-by-history-id.json"
+}

package/dist/store.js

@@ -1 +1,18 @@
-export {};
+export var AllureStoreDumpFiles;
+(function (AllureStoreDumpFiles) {
+    AllureStoreDumpFiles["TestResults"] = "test-results.json";
+    AllureStoreDumpFiles["TestCases"] = "test-cases.json";
+    AllureStoreDumpFiles["Fixtures"] = "fixtures.json";
+    AllureStoreDumpFiles["GlobalErrors"] = "global-errors.json";
+    AllureStoreDumpFiles["GlobalAttachments"] = "global-attachments.json";
+    AllureStoreDumpFiles["Attachments"] = "attachments.json";
+    AllureStoreDumpFiles["Environments"] = "environments.json";
+    AllureStoreDumpFiles["ReportVariables"] = "report-variables.json";
+    AllureStoreDumpFiles["IndexAttachmentsByTestResults"] = "index-attachments-by-test-results.json";
+    AllureStoreDumpFiles["IndexTestResultsByHistoryId"] = "index-test-results-by-history-id.json";
+    AllureStoreDumpFiles["IndexTestResultsByTestCase"] = "index-test-results-by-test-case.json";
+    AllureStoreDumpFiles["IndexLatestEnvTestResultsByHistoryId"] = "index-latest-env-test-results-by-history-id.json";
+    AllureStoreDumpFiles["IndexAttachmentsByFixture"] = "index-attachments-by-fixture.json";
+    AllureStoreDumpFiles["IndexFixturesByTestResult"] = "index-fixtures-by-test-result.json";
+    AllureStoreDumpFiles["IndexKnownByHistoryId"] = "index-known-by-history-id.json";
+})(AllureStoreDumpFiles || (AllureStoreDumpFiles = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-api",
-  "version": "3.0.0-beta.17",
+  "version": "3.0.0-beta.19",
   "description": "Allure Plugin API",
   "keywords": [
     "allure"
@@ -26,7 +26,7 @@
     "test": "rimraf ./out && vitest run"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.0.0-beta.17"
+    "@allurereport/core-api": "3.0.0-beta.19"
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "^2.6.1",
@@ -36,7 +36,7 @@
     "@typescript-eslint/parser": "^8.0.0",
     "@vitest/runner": "^2.1.9",
     "@vitest/snapshot": "^2.1.9",
-    "allure-vitest": "^3.3.0",
+    "allure-vitest": "^3.3.3",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",