UNPKG

4.31 kBTypeScriptView Raw
1/// <reference types="node" />
2export declare const ALLURE_METADATA_CONTENT_TYPE = "application/vnd.allure.metadata+json";
3export declare const ALLURE_IMAGEDIFF_CONTENT_TYPE = "application/vnd.allure.image.diff";
4export declare const ALLURE_SKIPPED_BY_TEST_PLAN_LABEL = "allure-skipped-by-test-plan";
5export interface AttachmentMetadata {
6 name: string;
7 type: string;
8 content: string;
9 encoding: BufferEncoding;
10}
11export interface StepMetadata extends Omit<ExecutableItem, "attachments" | "steps"> {
12 steps: StepMetadata[];
13 attachments: AttachmentMetadata[];
14}
15export interface MetadataMessage {
16 attachments?: AttachmentMetadata[];
17 displayName?: string;
18 testCaseId?: string;
19 historyId?: string;
20 labels?: Label[];
21 links?: Link[];
22 parameter?: Parameter[];
23 description?: string;
24 descriptionHtml?: string;
25 steps?: StepMetadata[];
26}
27export interface Attachment {
28 name: string;
29 type: string;
30 source: string;
31}
32export interface AttachmentOptions {
33 contentType: ContentType | string;
34 fileExtension?: string;
35}
36export interface Label {
37 name: LabelName | string;
38 value: string;
39}
40export interface Link {
41 name?: string;
42 url: string;
43 type?: LinkType | string;
44}
45export interface Parameter {
46 name: string;
47 value: string;
48 excluded?: boolean;
49 mode?: "hidden" | "masked" | "default";
50}
51export type ParameterOptions = Pick<Parameter, "mode" | "excluded">;
52export interface StatusDetails {
53 message?: string;
54 trace?: string;
55}
56export interface ExecutableItem {
57 name?: string;
58 status?: Status;
59 statusDetails: StatusDetails;
60 stage: Stage;
61 description?: string;
62 descriptionHtml?: string;
63 steps: StepResult[];
64 attachments: Attachment[];
65 parameters: Parameter[];
66 start?: number;
67 stop?: number;
68}
69export type FixtureResult = ExecutableItem;
70export type StepResult = ExecutableItem;
71export interface TestResult extends ExecutableItem {
72 uuid: string;
73 historyId: string;
74 fullName?: string;
75 testCaseId?: string;
76 labels: Label[];
77 links: Link[];
78}
79export interface TestResultContainer {
80 uuid: string;
81 name?: string;
82 children: string[];
83 befores: FixtureResult[];
84 afters: FixtureResult[];
85}
86export interface Category {
87 name?: string;
88 description?: string;
89 descriptionHtml?: string;
90 messageRegex?: string | RegExp;
91 traceRegex?: string | RegExp;
92 matchedStatuses?: Status[];
93 flaky?: boolean;
94}
95export interface ExecutorInfo {
96 name?: string;
97 type?: string;
98 url?: string;
99 buildOrder?: number;
100 buildName?: string;
101 buildUrl?: string;
102 reportUrl?: string;
103 reportName?: string;
104}
105export declare enum Status {
106 FAILED = "failed",
107 BROKEN = "broken",
108 PASSED = "passed",
109 SKIPPED = "skipped"
110}
111export declare enum Stage {
112 SCHEDULED = "scheduled",
113 RUNNING = "running",
114 FINISHED = "finished",
115 PENDING = "pending",
116 INTERRUPTED = "interrupted"
117}
118export declare enum LabelName {
119 ALLURE_ID = "ALLURE_ID",
120 AS_ID = "ALLURE_ID",
121 SUITE = "suite",
122 PARENT_SUITE = "parentSuite",
123 SUB_SUITE = "subSuite",
124 EPIC = "epic",
125 FEATURE = "feature",
126 STORY = "story",
127 SEVERITY = "severity",
128 TAG = "tag",
129 OWNER = "owner",
130 LEAD = "lead",
131 HOST = "host",
132 THREAD = "thread",
133 TEST_METHOD = "testMethod",
134 TEST_CLASS = "testClass",
135 PACKAGE = "package",
136 FRAMEWORK = "framework",
137 LANGUAGE = "language",
138 LAYER = "layer"
139}
140export declare enum Severity {
141 BLOCKER = "blocker",
142 CRITICAL = "critical",
143 NORMAL = "normal",
144 MINOR = "minor",
145 TRIVIAL = "trivial"
146}
147export declare enum ContentType {
148 TEXT = "text/plain",
149 XML = "application/xml",
150 HTML = "text/html",
151 CSV = "text/csv",
152 TSV = "text/tab-separated-values",
153 CSS = "text/css",
154 URI = "text/uri-list",
155 SVG = "image/svg+xml",
156 PNG = "image/png",
157 JSON = "application/json",
158 ZIP = "application/zip",
159 WEBM = "video/webm",
160 JPEG = "image/jpeg",
161 MP4 = "video/mp4"
162}
163export declare enum LinkType {
164 ISSUE = "issue",
165 TMS = "tms"
166}
167export interface ImageDiffAttachment {
168 expected: string | undefined;
169 actual: string | undefined;
170 diff: string | undefined;
171 name: string;
172}