@allurereport/plugin-api 3.0.0-beta.18 → 3.0.0-beta.20

package/dist/charts.js

@@ -1,76 +1,12 @@
-import { ChartDataType, ChartMode, getPieChartValues } from "@allurereport/core-api";
-import { severityTrendDataAccessor } from "./severityTrendAccessor.js";
-import { statusTrendDataAccessor } from "./statusTrendAccessor.js";
-export const createEmptySeries = (items) => items.reduce((acc, item) => ({ ...acc, [item]: [] }), {});
-export const calculatePercentValues = (stats, executionId, itemType) => {
-    const points = {};
-    const series = createEmptySeries(itemType);
-    const values = Object.values(stats);
-    const total = values.reduce((sum, value) => sum + value, 0);
-    if (total === 0) {
-        return { points, series };
-    }
-    itemType.forEach((item) => {
-        const pointId = `${executionId}-${item}`;
-        const value = stats[item] ?? 0;
-        points[pointId] = {
-            x: executionId,
-            y: value / total,
-        };
-        series[item].push(pointId);
-    });
-    return { points, series };
-};
-const calculateRawValues = (stats, executionId, itemType) => {
-    const points = {};
-    const series = createEmptySeries(itemType);
-    itemType.forEach((item) => {
-        const pointId = `${executionId}-${item}`;
-        const value = stats[item] ?? 0;
-        points[pointId] = {
-            x: executionId,
-            y: value,
-        };
-        series[item].push(pointId);
-    });
-    return { points, series };
-};
-export const getTrendDataGeneric = (stats, reportName, executionOrder, itemType, chartOptions) => {
-    const { type, dataType, title, mode = ChartMode.Raw, metadata = {} } = chartOptions;
-    const { executionIdAccessor, executionNameAccessor } = metadata;
-    const executionId = executionIdAccessor ? executionIdAccessor(executionOrder) : `execution-${executionOrder}`;
-    const { points, series } = mode === ChartMode.Percent
-        ? calculatePercentValues(stats, executionId, itemType)
-        : calculateRawValues(stats, executionId, itemType);
-    const slices = {};
-    const pointsAsArray = Object.values(points);
-    const pointsCount = pointsAsArray.length;
-    const values = pointsAsArray.map((point) => point.y);
-    const min = pointsCount ? Math.min(...values) : 0;
-    const max = pointsCount ? Math.max(...values) : 0;
-    if (pointsCount > 0) {
-        const executionName = executionNameAccessor ? executionNameAccessor(executionOrder) : reportName;
-        slices[executionId] = {
-            min,
-            max,
-            metadata: {
-                executionId,
-                executionName,
-            },
-        };
+export const DEFAULT_CHART_HISTORY_LIMIT = 10;
+export const limitHistoryDataPoints = (historyDataPoints, limit) => {
+    if (limit <= 0 || historyDataPoints.length === 0) {
+        return [];
     }
-    return {
-        type,
-        dataType,
-        mode,
-        title,
-        points,
-        slices,
-        series,
-        min,
-        max,
-    };
+    const clampedLimit = Math.max(0, Math.floor(limit));
+    return historyDataPoints.slice(0, clampedLimit);
 };
+export const createEmptySeries = (items) => items.reduce((acc, item) => ({ ...acc, [item]: [] }), {});
 export const createEmptyStats = (items) => items.reduce((acc, item) => ({ ...acc, [item]: 0 }), {});
 export const normalizeStatistic = (statistic, itemType) => {
     return itemType.reduce((acc, item) => {
@@ -78,86 +14,70 @@ export const normalizeStatistic = (statistic, itemType) => {
         return acc;
     }, {});
 };
-export const mergeTrendDataGeneric = (trendData, trendDataPart, itemType) => {
-    return {
-        ...trendData,
-        points: {
-            ...trendData.points,
-            ...trendDataPart.points,
-        },
-        slices: {
-            ...trendData.slices,
-            ...trendDataPart.slices,
-        },
-        series: Object.entries(trendDataPart.series).reduce((series, [group, pointIds]) => {
-            if (Array.isArray(pointIds)) {
-                return {
-                    ...series,
-                    [group]: [...(trendData.series?.[group] || []), ...pointIds],
-                };
-            }
-            return series;
-        }, trendData.series || createEmptySeries(itemType)),
-        min: Math.min(trendData.min ?? Infinity, trendDataPart.min),
-        max: Math.max(trendData.max ?? -Infinity, trendDataPart.max),
-    };
-};
-export const DEFAULT_CHART_HISTORY_LIMIT = 10;
-export const getPieChartData = (stats, chartOptions) => ({
-    type: chartOptions.type,
-    title: chartOptions?.title,
-    ...getPieChartValues(stats),
-});
-export const generatePieChart = (options, stores) => {
-    const { statistic } = stores;
-    return getPieChartData(statistic, options);
-};
-export const generateComingSoonChart = (options) => {
-    return {
-        type: options.type,
-        title: options.title,
-    };
-};
-export const generateTrendChartGeneric = (options, stores, context, dataAccessor) => {
-    const { trs = [], statistic, history } = stores;
-    const { limit } = options;
-    const historyLimit = limit && limit > 0 ? Math.max(0, limit - 1) : undefined;
-    const currentData = dataAccessor.getCurrentData(trs, statistic);
-    const limitedHistoryPoints = historyLimit !== undefined ? history.slice(-historyLimit) : history;
-    const firstOriginalIndex = historyLimit !== undefined ? Math.max(0, history.length - historyLimit) : 0;
-    const convertedHistoryPoints = limitedHistoryPoints.map((point, index) => {
-        const originalIndex = firstOriginalIndex + index;
-        return {
-            name: point.name,
-            originalIndex,
-            statistic: dataAccessor.getHistoricalData(point),
-        };
-    });
-    const allValues = dataAccessor.getAllValues();
-    const currentTrendData = getTrendDataGeneric(normalizeStatistic(currentData, allValues), context.reportName, history.length + 1, allValues, options);
-    const historicalTrendData = convertedHistoryPoints.reduce((acc, historyPoint) => {
-        const trendDataPart = getTrendDataGeneric(normalizeStatistic(historyPoint.statistic, allValues), historyPoint.name, historyPoint.originalIndex + 1, allValues, options);
-        return mergeTrendDataGeneric(acc, trendDataPart, allValues);
-    }, {
-        type: options.type,
-        dataType: options.dataType,
-        mode: options.mode,
-        title: options.title,
-        points: {},
-        slices: {},
-        series: createEmptySeries(allValues),
-        min: Infinity,
-        max: -Infinity,
-    });
-    return mergeTrendDataGeneric(historicalTrendData, currentTrendData, allValues);
-};
-export const generateTrendChart = (options, stores, context) => {
-    const newOptions = { limit: DEFAULT_CHART_HISTORY_LIMIT, ...options };
-    const { dataType } = newOptions;
-    if (dataType === ChartDataType.Status) {
-        return generateTrendChartGeneric(newOptions, stores, context, statusTrendDataAccessor);
-    }
-    else if (dataType === ChartDataType.Severity) {
-        return generateTrendChartGeneric(newOptions, stores, context, severityTrendDataAccessor);
-    }
+export const hasLabels = (test, labelHierarchy) => test.labels?.some((label) => {
+    const { name } = label;
+    return name && labelHierarchy.includes(name);
+}) ?? false;
+export const isChildrenLeavesOnly = (node) => {
+    return node.children ? node.children.every((child) => child.children === undefined) : false;
 };
+export const defaultChartsConfig = [
+    {
+        type: "pie",
+        title: "Current status",
+    },
+    {
+        type: "trend",
+        dataType: "status",
+        title: "Status dynamics",
+    },
+    {
+        type: "bar",
+        dataType: "statusBySeverity",
+        title: "Test result severities",
+    },
+    {
+        type: "bar",
+        dataType: "statusTrend",
+        title: "Status change dynamics",
+    },
+    {
+        type: "bar",
+        dataType: "statusChangeTrend",
+        title: "Test base growth dynamics",
+    },
+    {
+        type: "treemap",
+        dataType: "coverageDiff",
+        title: "Coverage diff map",
+    },
+    {
+        type: "treemap",
+        dataType: "successRateDistribution",
+        title: "Success rate disctribution",
+    },
+    {
+        type: "heatmap",
+        title: "Problems distribution by environment",
+    },
+    {
+        type: "bar",
+        title: "Stability rate disctribution",
+    },
+    {
+        type: "bar",
+        title: "Duration by layer histogram",
+    },
+    {
+        type: "bar",
+        title: "Performance dynamics",
+    },
+    {
+        type: "bar",
+        title: "FBSU age pyramid",
+    },
+    {
+        type: "funnel",
+        title: "Testing pyramid",
+    },
+];

package/dist/config.d.ts

@@ -7,6 +7,8 @@ export interface Config {
     historyPath?: string;
     knownIssuesPath?: string;
     defaultLabels?: DefaultLabelsConfig;
+    stage?: string;
+    environment?: string;
     environments?: EnvironmentsConfig;
     variables?: ReportVariables;
     plugins?: Record<string, PluginDescriptor>;

package/dist/index.d.ts

@@ -1,11 +1,15 @@
 export * from "./config.js";
 export type * from "./plugin.js";
-export type * from "./store.js";
-export type * from "./resultFile.js";
 export type * from "./qualityGate.js";
+export * from "./store.js";
+export type * from "./resultFile.js";
 export * from "./utils/misc.js";
 export * from "./utils/tree.js";
 export * from "./utils/summary.js";
 export * from "./charts.js";
-export * from "./severityTrendAccessor.js";
-export * from "./statusTrendAccessor.js";
+export * from "./charts/treeMap.js";
+export * from "./charts/bar.js";
+export * from "./charts/line.js";
+export * from "./charts/pie.js";
+export * from "./charts/heatmap.js";
+export * from "./charts/comingSoon.js";

package/dist/index.js

@@ -1,7 +1,12 @@
 export * from "./config.js";
+export * from "./store.js";
 export * from "./utils/misc.js";
 export * from "./utils/tree.js";
 export * from "./utils/summary.js";
 export * from "./charts.js";
-export * from "./severityTrendAccessor.js";
-export * from "./statusTrendAccessor.js";
+export * from "./charts/treeMap.js";
+export * from "./charts/bar.js";
+export * from "./charts/line.js";
+export * from "./charts/pie.js";
+export * from "./charts/heatmap.js";
+export * from "./charts/comingSoon.js";

package/dist/store.d.ts

@@ -1,4 +1,4 @@
-import type { AttachmentLink, HistoryDataPoint, HistoryTestResult, KnownTestFailure, Statistic, TestCase, TestEnvGroup, TestError, 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";
@@ -41,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.18",
+  "version": "3.0.0-beta.20",
   "description": "Allure Plugin API",
   "keywords": [
     "allure"
@@ -26,7 +26,7 @@
     "test": "rimraf ./out && vitest run"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.0.0-beta.18"
+    "@allurereport/core-api": "3.0.0-beta.20"
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "^2.6.1",