update model and api (via allure-framework#25)

Author: sseliverstov

.eslintrc.yml

@@ -35,7 +35,7 @@ rules:
   arrow-spacing: error
   no-confusing-arrow: error
   no-var: error
-  object-shorthand: [error, consistent-as-needed]
+  object-shorthand: [warn, consistent-as-needed]
   prefer-const: error
   prefer-destructuring: warn
   prefer-rest-params: warn

package.json

@@ -17,14 +17,15 @@
     "pack": "lerna exec -- npm pack"
   },
   "devDependencies": {
-    "@types/node": "^10.12.18",
+    "@types/node": "^11.13.6",
     "allure-commandline": "^2.9.0",
-    "lerna": "^3.10.6",
+    "lerna": "^3.13.3",
     "npm-run-all": "^4.1.5",
     "rimraf": "^2.6.3",
-    "typescript": "^3.4.5",
-    "eslint": "^5.12.1",
-    "@typescript-eslint/eslint-plugin": "^1.0.0",
-    "@typescript-eslint/parser": "^1.0.0"
+    "typescript": "^3.4.4",
+    "eslint": "^5.16.0",
+    "@typescript-eslint/eslint-plugin": "^1.7.0",
+    "@typescript-eslint/parser": "^1.7.0",
+    "nyc": "^14.0.0"
   }
 }

packages/allure-cucumberjs/features/support/chai-partial.ts

@@ -32,7 +32,6 @@ export function ChaiPartial(_chai: any, utils: any) {
       if (object.length < expected.length) {
         return false;
       }
-
       return expected.every((exp: any) => object.some((obj: any) => partial(obj, exp)));
     }
 

packages/allure-cucumberjs/index.ts

@@ -1,5 +1,5 @@
 export {
-  AllureInterface, World, CucumberJSAllureFormatter, CucumberJSAllureFormatterConfig
+  Allure, World, CucumberJSAllureFormatter, CucumberJSAllureFormatterConfig
 }
   from "./src/CucumberJSAllureReporter";
 export {

packages/allure-cucumberjs/src/CucumberAllureInterface.ts

@@ -1,85 +1,39 @@
 import {
-  AllureInterface,
+  Allure,
   AllureStep,
   AllureTest,
   ContentType,
   ExecutableItemWrapper,
   GlobalInfoWriter,
   isPromise,
   LabelName,
-  Severity
+  Severity, Status, StepInterface
 } from "allure-js-commons";
 import { CucumberJSAllureFormatter } from "./CucumberJSAllureReporter";
 
-export class CucumberAllureInterface extends AllureInterface {
+export class CucumberAllureInterface extends Allure {
   constructor(private readonly reporter: CucumberJSAllureFormatter) {
     super();
   }
 
-  private get currentExecutable(): ExecutableItemWrapper {
+  protected get currentExecutable(): ExecutableItemWrapper {
     const result = this.reporter.currentStep || this.reporter.currentTest;
     if (result === null) throw new Error("No executable!");
     return result;
   }
 
-  private get currentTest(): AllureTest {
+  protected get currentTest(): AllureTest {
     if (this.reporter.currentTest === null) throw new Error("No test running!");
     return this.reporter.currentTest;
   }
 
-  setDescription(text: string) {
-    this.currentExecutable.description = text;
-    this.currentExecutable.descriptionHtml = text;
-  }
-
-  setTestDescription(text: string) {
-    this.currentTest.description = text;
-    this.currentTest.descriptionHtml = text;
-  }
-
-  setFlaky() {
-    this.currentExecutable.detailsFlaky = true;
-  }
-
-  setKnown() {
-    this.currentExecutable.detailsKnown = true;
-  }
-
-  setMuted() {
-    this.currentExecutable.detailsMuted = true;
-  }
-
-  addOwner(owner: string) {
-    this.currentTest.addLabel(LabelName.OWNER, owner);
-  }
-
-  setSeverity(severity: Severity) {
-    this.currentTest.addLabel(LabelName.SEVERITY, severity);
-  }
-
-  addIssue(issue: string) {
-    this.currentTest.addLabel(LabelName.ISSUE, issue);
-  }
-
-  addTag(tag: string) {
-    this.currentTest.addLabel(LabelName.TAG, tag);
-  }
-
-  addTestType(type: string) {
-    this.currentTest.addLabel(LabelName.TEST_TYPE, type);
-  }
-
-  addLink(name: string, url: string, type?: string) {
-    this.currentTest.addLink(name, url, type);
-  }
-
   private startStep(name: string): WrappedStep {
     const allureStep: AllureStep = this.currentExecutable.startStep(name);
     this.reporter.pushStep(allureStep);
     return new WrappedStep(this.reporter, allureStep);
   }
 
-  step<T>(name: string, body: () => any): any {
+  step<T>(name: string, body: (step: StepInterface) => any): any {
     const wrappedStep = this.startStep(name);
     let result;
     try {
@@ -103,6 +57,10 @@ export class CucumberAllureInterface extends AllureInterface {
     }
   }
 
+  logStep(name: string, status?: Status): void {
+    this.step(name, () => {}); // todo status
+  }
+
   attachment(name: string, content: Buffer | string, type: ContentType) {
     const file = this.reporter.writeAttachment(content, type);
     this.currentExecutable.addAttachment(name, type, file);
@@ -142,7 +100,7 @@ export class WrappedStep {
     this.step.endStep();
   }
 
-  run<T>(body: () => T): T {
+  run<T>(body: (step: StepInterface) => T): T {
     return this.step.wrap(body)();
   }
 }

packages/allure-cucumberjs/src/CucumberJSAllureReporter.ts

@@ -1,7 +1,7 @@
 import { Formatter, World as CucumberWorld } from "cucumber";
 import {
   AllureGroup,
-  AllureInterface,
+  Allure,
   AllureRuntime,
   AllureStep,
   AllureTest,
@@ -26,10 +26,10 @@ import {
   stripIndent
 } from "./utilities";
 
-export { AllureInterface } from "allure-js-commons";
+export { Allure } from "allure-js-commons";
 
 export interface World extends CucumberWorld {
-  allure: AllureInterface;
+  allure: Allure;
 }
 
 export class CucumberJSAllureFormatterConfig {
@@ -54,7 +54,7 @@ export class CucumberJSAllureFormatter extends Formatter {
   currentBefore: ExecutableItemWrapper | null = null;
   currentAfter: ExecutableItemWrapper | null = null;
 
-  public readonly allureInterface: AllureInterface;
+  public readonly allureInterface: Allure;
 
   constructor(options: any, private readonly allureRuntime: AllureRuntime,
     config: CucumberJSAllureFormatterConfig) {
@@ -142,7 +142,7 @@ export class CucumberJSAllureFormatter extends Formatter {
       throw new Error("Unknown scenario");
     }
 
-    this.currentGroup = this.allureRuntime.startGroup("");
+    this.currentGroup = this.allureRuntime.startGroup();
     this.currentTest =
       this.currentGroup.startTest(applyExample(test.name || "Unnamed test", test.example));
 

packages/allure-jasmine/index.ts

@@ -5,7 +5,7 @@ export {
   AllureConfig,
   ContentType,
   Severity,
-  AllureInterface,
+  Allure,
   GlobalInfoWriter,
   ExecutorInfo,
   Category

packages/allure-jasmine/package.json

@@ -15,15 +15,35 @@
     "build": "npm run lint && npm run compile",
     "prepublishOnly": "npm run clean && npm run build",
     "generate-report": "allure generate ./out/allure-results -o ./out/allure-report --clean",
-    "runTest": "jasmine ./dist/test/*.js",
-    "runTestDebug": "node $NODE_DEBUG_OPTION ./node_modules/jasmine/bin/jasmine ./dist/test/*.js",
+    "runTest": "nyc jasmine ./dist/test/*.test.js",
+    "runTestDebug": "node $NODE_DEBUG_OPTION ./node_modules/.bin/jasmine ./dist/test/*.js",
     "test": "rimraf ./out ; npm run runTest ; npm run generate-report"
   },
   "devDependencies": {
-    "@types/jasmine": "^3.3.7",
-    "jasmine": "^3.3.1"
+    "@types/jasmine": "^3.3.12",
+    "jasmine": "^3.4.0"
   },
   "dependencies": {
     "allure-js-commons": "^2.0.0-beta.3"
+  },
+  "nyc": {
+    "check-coverage": false,
+    "lines": 85,
+    "statements": 85,
+    "functions": 85,
+    "branches": 75,
+    "extension": [
+      ".ts"
+    ],
+    "include": [
+      "**/src/**/*"
+    ],
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "all": true,
+    "report-dir": "./out/coverage",
+    "temp-dir": "./out/.nyc"
   }
 }

packages/allure-jasmine/src/JasmineAllureReporter.ts

@@ -1,7 +1,7 @@
 /* eslint-disable no-undef */
 import {
-  AllureGroup, AllureRuntime, AllureStep, AllureTest, ContentType, ExecutableItemWrapper,
-  isPromise, LabelName, Severity, Stage, Status, AllureInterface, GlobalInfoWriter
+  AllureGroup, IAllureRuntime, AllureStep, AllureTest, ContentType, ExecutableItemWrapper,
+  isPromise, LabelName, Severity, Stage, Status, GlobalInfoWriter, Allure, StepInterface
 } from "allure-js-commons";
 import FailedExpectation = jasmine.FailedExpectation;
 
@@ -22,7 +22,7 @@ export class JasmineAllureReporter implements jasmine.CustomReporter {
   private stepStack: AllureStep[] = [];
   private runningExecutable: ExecutableItemWrapper | null = null;
 
-  constructor(private readonly runtime: AllureRuntime) {
+  constructor(private readonly runtime: IAllureRuntime) {
     this.installHooks();
   }
 
@@ -37,7 +37,7 @@ export class JasmineAllureReporter implements jasmine.CustomReporter {
     return currentGroup;
   }
 
-  getInterface(): AllureInterface {
+  getInterface(): Allure {
     return new JasmineAllureInterface(this);
   }
 
@@ -238,62 +238,19 @@ export class JasmineAllureReporter implements jasmine.CustomReporter {
 }
 
 
-export class JasmineAllureInterface extends AllureInterface {
+export class JasmineAllureInterface extends Allure {
   constructor(private readonly reporter: JasmineAllureReporter) {
     super();
   }
 
-  private get currentExecutable(): ExecutableItemWrapper {
+  protected get currentExecutable(): ExecutableItemWrapper {
     return this.reporter.currentStep
       || this.reporter.currentExecutable
       || this.reporter.currentTest;
   }
 
-  setDescription(text: string) {
-    this.currentExecutable.description = text;
-    this.currentExecutable.descriptionHtml = text;
-  }
-
-  setFlaky() {
-    this.currentExecutable.detailsFlaky = true;
-  }
-
-  setKnown() {
-    this.currentExecutable.detailsKnown = true;
-  }
-
-  setMuted() {
-    this.currentExecutable.detailsMuted = true;
-  }
-
-  addOwner(owner: string) {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addLabel(LabelName.OWNER, owner);
-  }
-
-  setSeverity(severity: Severity) {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addLabel(LabelName.SEVERITY, severity);
-  }
-
-  addIssue(issue: string) {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addLabel(LabelName.ISSUE, issue);
-  }
-
-  addTag(tag: string) {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addLabel(LabelName.TAG, tag);
-  }
-
-  addTestType(type: string) {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addLabel(LabelName.TEST_TYPE, type);
-  }
-
-  addLink(name: string, url: string, type?: string) {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addLink(name, url, type);
+  protected get currentTest(): AllureTest {
+    return this.reporter.currentTest;
   }
 
   private startStep(name: string): WrappedStep {
@@ -302,7 +259,7 @@ export class JasmineAllureInterface extends AllureInterface {
     return new WrappedStep(this.reporter, allureStep);
   }
 
-  step<T>(name: string, body: () => any): any {
+  step<T>(name: string, body: (step: StepInterface) => any): any {
     const wrappedStep = this.startStep(name);
     let result;
     try {
@@ -326,21 +283,15 @@ export class JasmineAllureInterface extends AllureInterface {
     }
   }
 
+  logStep(name: string, status?: Status): void {
+    this.step(name, () => {}); // todo status
+  }
+
   attachment(name: string, content: Buffer | string, type: ContentType) {
     const file = this.reporter.writeAttachment(content, type);
     this.currentExecutable.addAttachment(name, type, file);
   }
 
-  addParameter(name: string, value: string): void {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addParameter(name, value);
-  }
-
-  addLabel(name: string, value: string): void {
-    if (this.reporter.currentTest === null) throw new Error("No test running!");
-    this.reporter.currentTest.addLabel(name, value);
-  }
-
   getGlobalInfoWriter(): GlobalInfoWriter {
     return this.reporter.getGlobalInfoWriter();
   }
@@ -362,7 +313,7 @@ class WrappedStep { // needed?
     this.step.endStep();
   }
 
-  run<T>(body: () => T): T {
+  run<T>(body: (step: StepInterface) => T): T {
     return this.step.wrap(body)();
   }
 }