deprecate prefixes for the commons package (via allure-framework#939)

RobertBattaglia · May 16, 2024 · 6ec0d00 · 6ec0d00
1 parent 0afa470
commit 6ec0d00
Show file tree

Hide file tree

Showing 234 changed files with 297 additions and 2,868 deletions.
diff --git a/packages/allure-codeceptjs/rollup.config.mjs b/packages/allure-codeceptjs/rollup.config.mjs
@@ -9,7 +9,11 @@ const dirname = fileURLToPath(new URL(".", import.meta.url));
 const createNodeEntry = (inputFile) => {
   const outputFileBase = inputFile.replace(/^src/, "dist");
   const external = [
-
+    "allure-js-commons",
+    "allure-js-commons/sdk/node",
+    "strip-ansi",
+    "codeceptjs",
+    "node:path",
   ];
 
   return [

diff --git a/packages/allure-codeceptjs/src/index.ts b/packages/allure-codeceptjs/src/index.ts
@@ -18,7 +18,7 @@ import {
   TestRuntime,
   extractMetadataFromString,
   setGlobalTestRuntime,
-} from "allure-js-commons/new/sdk/node";
+} from "allure-js-commons/sdk/node";
 import { extractMeta } from "./helpers";
 import { CodeceptError, CodeceptHook, CodeceptStep, CodeceptTest } from "./model";
 import { AllureCodeceptJSConfig } from "./model.js";

diff --git a/packages/allure-codeceptjs/src/model.ts b/packages/allure-codeceptjs/src/model.ts
@@ -1,4 +1,4 @@
-import type { Config } from "allure-js-commons/new/sdk/browser";
+import type { Config } from "allure-js-commons/sdk/browser";
 
 export interface CodeceptError {
   params: any;

diff --git a/packages/allure-codeceptjs/test/spec/attachments.test.ts b/packages/allure-codeceptjs/test/spec/attachments.test.ts
@@ -4,7 +4,7 @@ import { runCodeceptJSInlineTest } from "../utils";
 it("handles attachments in tests", async () => {
   const { tests, attachments } = await runCodeceptJSInlineTest({
     "login.test.js": `
-      const { attachment } = require("allure-js-commons/new");
+      const { attachment } = require("allure-js-commons");
 
       Feature("sample-feature");
       Scenario("sample-scenario", async () => {
@@ -30,7 +30,7 @@ it("handles attachments in tests", async () => {
 it("handles attachments in runtime steps", async () => {
   const { tests, attachments } = await runCodeceptJSInlineTest({
     "login.test.js": `
-      const { step, attachment } = require("allure-js-commons/new");
+      const { step, attachment } = require("allure-js-commons");
 
       Feature("sample-feature");
       Scenario("sample-scenario", async () => {

diff --git a/packages/allure-codeceptjs/test/spec/hooks.test.ts b/packages/allure-codeceptjs/test/spec/hooks.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { Stage, Status } from "allure-js-commons/new/sdk/node";
+import { Stage, Status } from "allure-js-commons/sdk/node";
 import { runCodeceptJSInlineTest } from "../utils";
 
 it("handles hooks", async () => {

diff --git a/packages/allure-codeceptjs/test/spec/labels.test.ts b/packages/allure-codeceptjs/test/spec/labels.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { LabelName } from "allure-js-commons/new/sdk/node";
+import { LabelName } from "allure-js-commons/sdk/node";
 import { runCodeceptJSInlineTest } from "../utils";
 
 it("adds labels", async () => {
@@ -19,7 +19,7 @@ it("adds labels", async () => {
         severity,
         story,
         tag,
-      } = require("allure-js-commons/new");
+      } = require("allure-js-commons");
 
       Feature("login-feature");
       Scenario("login-scenario1", async () => {

diff --git a/packages/allure-codeceptjs/test/spec/links.test.ts b/packages/allure-codeceptjs/test/spec/links.test.ts
@@ -1,11 +1,11 @@
 import { expect, it } from "vitest";
-import { LinkType } from "allure-js-commons/new/sdk/node";
+import { LinkType } from "allure-js-commons/sdk/node";
 import { runCodeceptJSInlineTest } from "../utils";
 
 it("sets runtime links", async () => {
   const results = await runCodeceptJSInlineTest({
     "sample.test.js": `
-      const { link, links, issue, tms } = require('allure-js-commons/new');
+      const { link, links, issue, tms } = require('allure-js-commons');
 
       Feature("login-feature");
       Scenario("login-scenario1", async () => {

diff --git a/packages/allure-codeceptjs/test/spec/parameters.test.ts b/packages/allure-codeceptjs/test/spec/parameters.test.ts
@@ -4,7 +4,7 @@ import { runCodeceptJSInlineTest } from "../utils";
 it("sets parameters", async () => {
   const { tests } = await runCodeceptJSInlineTest({
     "sample.test.js": `
-       const { parameter } = require("allure-js-commons/new");
+       const { parameter } = require("allure-js-commons");
 
       Feature("login-feature");
       Scenario("login-scenario1", async () => {

diff --git a/packages/allure-codeceptjs/test/spec/simple.test.ts b/packages/allure-codeceptjs/test/spec/simple.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { Stage, Status } from "allure-js-commons/new/sdk/node";
+import { Stage, Status } from "allure-js-commons/sdk/node";
 import { runCodeceptJSInlineTest } from "../utils";
 
 it("simple scenarios", async () => {

diff --git a/packages/allure-codeceptjs/test/spec/steps.test.ts b/packages/allure-codeceptjs/test/spec/steps.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { Stage, Status } from "allure-js-commons/new/sdk/node";
+import { Stage, Status } from "allure-js-commons/sdk/node";
 import { runCodeceptJSInlineTest } from "../utils";
 
 it("handles codeceptjs steps", async () => {
@@ -43,7 +43,7 @@ it("handles codeceptjs steps", async () => {
 it("handles lambda steps", async () => {
   const { tests } = await runCodeceptJSInlineTest({
     "sample.test.js": `
-      const { step } = require("allure-js-commons/new");
+      const { step } = require("allure-js-commons");
 
       Feature("sample-feature-1");
       Scenario("scenario1", async ({ I }) => {

diff --git a/packages/allure-codeceptjs/test/spec/tags.test.ts b/packages/allure-codeceptjs/test/spec/tags.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { LabelName } from "allure-js-commons/new/sdk/node";
+import { LabelName } from "allure-js-commons/sdk/node";
 import { runCodeceptJSInlineTest } from "../utils";
 
 it("supports codecept tags", async () => {

diff --git a/packages/allure-codeceptjs/test/spec/titleMetadata.test.ts b/packages/allure-codeceptjs/test/spec/titleMetadata.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { LabelName } from "allure-js-commons/new/sdk/node";
+import { LabelName } from "allure-js-commons/sdk/node";
 import { runCodeceptJSInlineTest } from "../utils";
 
 it("handles title metadata", async () => {

diff --git a/packages/allure-codeceptjs/test/utils.ts b/packages/allure-codeceptjs/test/utils.ts
@@ -3,7 +3,7 @@ import { randomUUID } from "node:crypto";
 import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 import { dirname, resolve as resolvePath } from "node:path";
-import type { AllureResults, TestResult, TestResultContainer } from "allure-js-commons/new/sdk/node";
+import type { AllureResults, TestResult, TestResultContainer } from "allure-js-commons/sdk/node";
 
 const parseJsonResult = <T>(data: string) => {
   return JSON.parse(Buffer.from(data, "base64").toString("utf8")) as T;

diff --git a/packages/allure-cucumberjs/rollup.config.mjs b/packages/allure-cucumberjs/rollup.config.mjs
@@ -15,8 +15,8 @@ const createNodeEntry = (inputFile) => {
     "node:os",
     "node:fs",
     "node:process",
-    "allure-js-commons/new/sdk/node",
-    "allure-js-commons/new/internal",
+    "allure-js-commons/sdk/node",
+    "allure-js-commons/internal",
   ];
 
   return [

diff --git a/packages/allure-cucumberjs/src/index.ts b/packages/allure-cucumberjs/src/index.ts
@@ -1,5 +1,5 @@
 import { Before, World } from "@cucumber/cucumber";
-import { ALLURE_RUNTIME_MESSAGE_CONTENT_TYPE } from "allure-js-commons/new/internal";
+import { ALLURE_RUNTIME_MESSAGE_CONTENT_TYPE } from "allure-js-commons/internal";
 import {
   ContentType,
   Label,
@@ -14,7 +14,7 @@ import {
   TestRuntime,
   getStatusFromError,
   setGlobalTestRuntime,
-} from "allure-js-commons/new/sdk/node";
+} from "allure-js-commons/sdk/node";
 
 export class AllureCucumberTestRuntime extends World implements TestRuntime {
   messagesHolder = new MessagesHolder();

diff --git a/packages/allure-cucumberjs/src/model.ts b/packages/allure-cucumberjs/src/model.ts
@@ -1,4 +1,4 @@
-import { Config, LabelName, LinkType } from "allure-js-commons/new/sdk/node";
+import { Config, LabelName, LinkType } from "allure-js-commons/sdk/node";
 
 export type LabelConfig = {
   pattern: RegExp[];

diff --git a/packages/allure-cucumberjs/src/reporter.ts b/packages/allure-cucumberjs/src/reporter.ts
@@ -3,7 +3,7 @@ import * as messages from "@cucumber/messages";
 import { PickleTag, Tag, TestStepResult, TestStepResultStatus } from "@cucumber/messages";
 import os from "node:os";
 import process from "node:process";
-import { ALLURE_RUNTIME_MESSAGE_CONTENT_TYPE } from "allure-js-commons/new/internal";
+import { ALLURE_RUNTIME_MESSAGE_CONTENT_TYPE } from "allure-js-commons/internal";
 import {
   AllureNodeReporterRuntime,
   Config,
@@ -18,7 +18,7 @@ import {
   TestResult,
   createStepResult,
   getWorstStepResultStatus,
-} from "allure-js-commons/new/sdk/node";
+} from "allure-js-commons/sdk/node";
 import { AllureCucumberReporterConfig, LabelConfig, LinkConfig } from "./model";
 
 const { ALLURE_THREAD_NAME } = process.env;

diff --git a/packages/allure-cucumberjs/test/fixtures/features/dataTableAndExamples.feature b/packages/allure-cucumberjs/test/fixtures/features/dataTableAndExamples.feature
@@ -7,6 +7,6 @@ Feature: dataTableAndExamples
     When I add <a> to <b>
     Then result is <result>
 
-    Examples: 
+    Examples:
       | b | result |
       | 3 |      4 |
diff --git a/packages/allure-cucumberjs/test/fixtures/features/examples.feature b/packages/allure-cucumberjs/test/fixtures/features/examples.feature
@@ -6,7 +6,7 @@ Feature: Test Scenarios with Examples
     When I add a to b
     Then result is <result>
 
-    Examples: 
+    Examples:
       | a | b | result |
       | 1 | 3 |      4 |
       | 2 | 4 |      6 |
diff --git a/packages/allure-cucumberjs/test/fixtures/support/attachments.cjs b/packages/allure-cucumberjs/test/fixtures/support/attachments.cjs
@@ -1,5 +1,5 @@
 const { Given } = require("@cucumber/cucumber");
-const { attachment } = require("allure-js-commons/new");
+const { attachment } = require("allure-js-commons");
 
 Given("add a text", async () => {
   await attachment("Text attachment", "some text", "text/plain");

diff --git a/packages/allure-cucumberjs/test/fixtures/support/description.cjs b/packages/allure-cucumberjs/test/fixtures/support/description.cjs
@@ -1,5 +1,5 @@
 const { Given } = require("@cucumber/cucumber");
-const { description, descriptionHtml } = require("allure-js-commons/new");
+const { description, descriptionHtml } = require("allure-js-commons");
 
 Given("a step", () => {});
 

diff --git a/packages/allure-cucumberjs/test/fixtures/support/labels.cjs b/packages/allure-cucumberjs/test/fixtures/support/labels.cjs
@@ -12,7 +12,7 @@ const {
   severity,
   story,
   tag,
-} = require("allure-js-commons/new");
+} = require("allure-js-commons");
 
 Given("a step", () => {});
 

diff --git a/packages/allure-cucumberjs/test/fixtures/support/links.cjs b/packages/allure-cucumberjs/test/fixtures/support/links.cjs
@@ -1,5 +1,5 @@
 const { Given } = require("@cucumber/cucumber");
-const { link, issue, tms } = require("allure-js-commons/new");
+const { link, issue, tms } = require("allure-js-commons");
 
 Given("a step", () => {});
 

diff --git a/packages/allure-cucumberjs/test/fixtures/support/steps.cjs b/packages/allure-cucumberjs/test/fixtures/support/steps.cjs
@@ -1,5 +1,5 @@
 const { Given } = require("@cucumber/cucumber");
-const { step, label, epic, attachment } = require("allure-js-commons/new");
+const { step, label, epic, attachment } = require("allure-js-commons");
 
 Given("allows to define runtime step", async () => {
   await step("first nested step", async function () {

diff --git a/packages/allure-cucumberjs/test/spec/dataTable.test.ts b/packages/allure-cucumberjs/test/spec/dataTable.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { ContentType } from "allure-js-commons/new/sdk";
+import { ContentType } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("handles data tables", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/dataTableAndExamples.test.ts b/packages/allure-cucumberjs/test/spec/dataTableAndExamples.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { ContentType } from "allure-js-commons/new/sdk";
+import { ContentType } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("handles both data table and examples for one feature", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/examples.test.ts b/packages/allure-cucumberjs/test/spec/examples.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { ContentType } from "allure-js-commons/new/sdk";
+import { ContentType } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("handles examples table", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/labels.test.ts b/packages/allure-cucumberjs/test/spec/labels.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { LabelName } from "allure-js-commons/new/sdk";
+import { LabelName } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("handles runtime labels", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/links.test.ts b/packages/allure-cucumberjs/test/spec/links.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { LinkType } from "allure-js-commons/new/sdk";
+import { LinkType } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("handles runtime links", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/simple.test.ts b/packages/allure-cucumberjs/test/spec/simple.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { Stage, Status } from "allure-js-commons/new/sdk";
+import { Stage, Status } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("handles basic cases", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/steps.test.ts b/packages/allure-cucumberjs/test/spec/steps.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { LabelName, Stage, Status } from "allure-js-commons/new/sdk/node";
+import { LabelName, Stage, Status } from "allure-js-commons/sdk/node";
 import { runCucumberInlineTest } from "../utils";
 
 it("handles runtime steps", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/tags.test.ts b/packages/allure-cucumberjs/test/spec/tags.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { LabelName } from "allure-js-commons/new/sdk";
+import { LabelName } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("assigns unmatched tags as tags labels", async () => {

diff --git a/packages/allure-cucumberjs/test/spec/undefinedStepDefs.test.ts b/packages/allure-cucumberjs/test/spec/undefinedStepDefs.test.ts
@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { Stage, Status } from "allure-js-commons/new/sdk";
+import { Stage, Status } from "allure-js-commons/sdk";
 import { runCucumberInlineTest } from "../utils";
 
 it("reports undefined tests and steps", async () => {

diff --git a/packages/allure-cucumberjs/test/utils.ts b/packages/allure-cucumberjs/test/utils.ts
@@ -2,7 +2,7 @@ import { fork } from "node:child_process";
 import { randomUUID } from "node:crypto";
 import { copyFile, mkdir, rm, writeFile } from "node:fs/promises";
 import { join, resolve as resolvePath } from "node:path";
-import { AllureResults, TestResult, TestResultContainer } from "allure-js-commons/new/sdk";
+import { AllureResults, TestResult, TestResultContainer } from "allure-js-commons/sdk";
 
 export const runCucumberInlineTest = async (features: string[], stepsDefs: string[]): Promise<AllureResults> => {
   const res: AllureResults = {

diff --git a/packages/allure-cypress/rollup.config.mjs b/packages/allure-cypress/rollup.config.mjs
@@ -10,7 +10,7 @@ const dirname = fileURLToPath(new URL(".", import.meta.url));
 
 const createNodeEntry = (inputFile) => {
   const outputFileBase = inputFile.replace(/^src/, "dist");
-  const external = ["node:fs", "allure-js-commons/new/sdk/node"];
+  const external = ["node:fs", "allure-js-commons/sdk/node"];
 
   return [
     defineConfig({

diff --git a/packages/allure-cypress/src/index.ts b/packages/allure-cypress/src/index.ts
@@ -14,7 +14,7 @@ import {
   getUnfinishedStepsMessages,
   hasStepMessage,
   setGlobalTestRuntime,
-} from "allure-js-commons/new/sdk/browser";
+} from "allure-js-commons/sdk/browser";
 import { CypressRuntimeMessage } from "./model.js";
 import { normalizeAttachmentContentEncoding, uint8ArrayToBase64 } from "./utils.js";
 

diff --git a/packages/allure-cypress/src/model.ts b/packages/allure-cypress/src/model.ts
@@ -1,4 +1,4 @@
-import { RuntimeMessage, Stage, Status, StatusDetails } from "allure-js-commons/new/sdk";
+import { RuntimeMessage, Stage, Status, StatusDetails } from "allure-js-commons/sdk";
 
 export type CypressTestStartRuntimeMessage = {
   type: "cypress_start";

diff --git a/packages/allure-cypress/src/reporter.ts b/packages/allure-cypress/src/reporter.ts
@@ -8,7 +8,7 @@ import {
   Stage,
   extractMetadataFromString,
   getSuitesLabels,
-} from "allure-js-commons/new/sdk/node";
+} from "allure-js-commons/sdk/node";
 import { CypressRuntimeMessage, CypressTestEndRuntimeMessage, CypressTestStartRuntimeMessage } from "./model.js";
 
 export type AllureCypressConfig = {

diff --git a/packages/allure-cypress/test/spec/screenshots.test.ts b/packages/allure-cypress/test/spec/screenshots.test.ts
@@ -18,7 +18,7 @@ it("attaches screenshots for failed specs", async () => {
 
   expect(attachment.name).toBe("Screenshot");
   expect(attachment.type).toBe(ContentType.PNG);
-  expect(attachments).toHaveProperty(attachment.source as string);
+  expect(attachments).toHaveProperty(attachment.source);
 });
 
 it("attaches runtime screenshots", async () => {
@@ -37,5 +37,5 @@ it("attaches runtime screenshots", async () => {
 
   expect(attachment.name).toBe("foo");
   expect(attachment.type).toBe(ContentType.PNG);
-  expect(attachments).toHaveProperty(attachment.source as string);
+  expect(attachments).toHaveProperty(attachment.source);
 });
diff --git a/packages/allure-cypress/test/spec/video.test.ts b/packages/allure-cypress/test/spec/video.test.ts
@@ -50,5 +50,5 @@ it("attaches same video to each spec in a test", async () => {
   expect(attachment.name).toBe("Video");
   expect(attachment.type).toBe(ContentType.MP4);
   expect(tests[1].attachments).toContainEqual(attachment);
-  expect(attachments).toHaveProperty(attachment.source as string);
+  expect(attachments).toHaveProperty(attachment.source);
 });