jest-allure - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "jest-allure",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Allure Reports for jest",
   "main": "dist/index",
   "repository": "[e-mail]:zaqqaz/jest-allure.git",
-  "author": "Denis Artyuhovich <[e-mail]>",
+  "author": "Denis Artyuhovich (zaqqaz) <[e-mail]>",
   "license": "MIT",
@@ -9,0 +9,0 @@ "scripts": {

readme.md

 # Jest-Allure reporting plugin
 
-Add more power to your test using Jest-Allure.
+#### Add more power to your tests using Jest-Allure. Easily generate nice reports at the end of the execution.
+[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/jest-community/awesome-jest)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
-Easily generate nice reports at the end of the execution.
+[![GitHub followers](https://img.shields.io/github/followers/zaqqaz.svg?style=social)](https://github.com/zaqqaz)
+[![GitHub stars](https://img.shields.io/github/stars/zaqqaz/jest-allure.svg?style=social)](https://github.com/zaqqaz/jest-allure/stargazers)
+[![GitHub watchers](https://img.shields.io/github/watchers/zaqqaz/jest-allure.svg?style=social)](https://github.com/zaqqaz/jest-allure/watchers)
+#### Examples
+- [Report example](https://103-170502579-gh.circle-artifacts.com/0/Report/Allure/index.html)
+- [Visual unit tests with allure report. Demo project](https://github.com/zaqqaz/visual-unit-tests)
+- [Simple integration test](https://github.com/zaqqaz/jest-allure/blob/master/examples/__tests__/test1.js)
 
-Allure Framework is a flexible lightweight multi-language test report tool that not only
+<hr>
+
+![Allure Report](https://user-images.githubusercontent.com/2823336/40350093-59cad576-5db1-11e8-8210-c4db3bf825a1.png)
+
+[Allure Framework](https://github.com/allure-framework/allure2) is a flexible lightweight multi-language test report tool that not only
 shows a very concise representation of what have been tested in a neat web report form,
@@ -12,6 +25,4 @@ but allows everyone participating in the development process to extract maximum of useful
 
-![Allure Report](https://user-images.githubusercontent.com/2823336/40350093-59cad576-5db1-11e8-8210-c4db3bf825a1.png)
+#### Installation
 
-# Installation
-
 ```
@@ -26,2 +37,11 @@ yarn add -D jest-allure
 
+### jest -v >24 ?
+Then add `jest-allure/dist/setup` to `setupFilesAfterEnv` section of your config.
+
+```
+setupFilesAfterEnv: ["jest-allure/dist/setup"]
+```
+
+### jest -v < 24 ?
+
 #### add reporter to jest.config.js
@@ -38,2 +58,4 @@ ```
 
+You need to install the [CLI](https://github.com/allure-framework/allure2#download) in order to obtain a report.
+
 To see a report in browser, run in console
@@ -51,23 +73,82 @@
 
+# Advanced features
+You can add description, screenshots, steps, severity and lots of other 
+fancy stuff to your reports.
+
+Global variable `reporter` available in your tests with such methods:
+
+```
+    description(description: string): this;
+    severity(severity: Severity): this;
+    epic(epic: string): this;
+    feature(feature: string): this;
+    story(story: string): this;
+    startStep(name: string): this;
+    endStep(status?: Status): this;
+    addArgument(name: string): this;
+    addEnvironment(name: string, value: string): this;
+    addAttachment(name: string, buffer: any, type: string): this;
+    addLabel(name: string, value: string): this;
+    addParameter(paramName: string, name: string, value: string): this;
+```
+**Example**
+
+```
+import { Severity } from "jest-allure/dist/Reporter";
+import { Feature } from "somwhere in your project";
+
+describe("Fancy test", () => {
+        ...
+        
+        it("Test your amazing feature", async () => {
+            reporter
+                .description("Feature should work cool")
+                .severity(Severity.Critical)
+                .feature(Feature.Betting)
+                .story("BOND-007");
+
+            reporter.startStep("Check it's fancy");
+            // expect that it's fancy
+            reporter.endStep();
+            
+            reporter.startStep("Check it's cool");
+            // expect that it's cool
+            reporter.endStep();
+
+            const screenshotBuffer = await page.screenshot();
+            reporter.addAttachment("Screenshot", screenshotBuffer, "image/png");
+        });
+        
+        ...
+    }
+);
+
+```
 #### What's next
 
 - [x] Generate report from Jest results
-- [ ] Add steps support
-- [ ] Add labels support
-- [ ] Add attachments support
+- [x] Add steps support
+- [x] Add labels support
+- [x] Add attachments support
+- [x] Add more examples
 
 ---
 
+#### Additional projects
+[visual-unit-tests](https://github.com/zaqqaz/visual-unit-tests)
+
+[jest-allure-image-snapshot](https://github.com/zaqqaz/jest-allure-image-snapshot)
+
 #### Warning
 ``jest-allure`` reporter dynamically configure "setupTestFrameworkScriptFile" option in Jest configuration.
-**If you have your own setupTestFrameworkScriptFile file**, you need to manually register allure reporter.
+**If you have your own setupTestFrameworkScriptFile file**, you need to manually register allure reporter, for it you need to import jest-allure/dist/setup.
 
 ```typescript
-import { registerAllureReporter } from "jest-allure/dist/setup";
-...
-registerAllureReporter();
+import "jest-allure/dist/setup";
 ```
 
+In case if you have jest version > 24 just add `jest-allure/dist/setup` to `setupFilesAfterEnv` section of your config.
+
 ## Contributors
 | [<img src="https://avatars3.githubusercontent.com/u/2823336?s=460&v=4" width="100px;"/><br/><sub><b>Denis Artyuhovich</b></sub>](https://denis.by) | [<img src="https://avatars1.githubusercontent.com/u/7804416?s=460&v=4" width="100px;"/><br/><sub><b>Dmitry Bogomya</b></sub>](https://github.com/bogomya) |
 | ---      | ---       |

src/Reporter.ts

@@ -51,2 +51,7 @@ import Allure from "allure-js-commons";
 
+    public testId(testId: string) {
+        this.addLabel('testId', testId);
+        return this;
+    }
+
     public startStep(name: string) {
@@ -53,0 +58,0 @@ this.allure.startStep(name);

src/setup.ts

 import Allure from "allure-js-commons";
 import stripAnsi from "strip-ansi";
 import { Reporter } from "./Reporter";
+import { relative } from "path";
 
@@ -33,6 +34,17 @@ declare namespace jasmine {
 
-    suiteStarted(suite: jasmine.CustomReporterResult) {
-        this.allure.startSuite(suite.fullName);
+    suiteStarted(suite?: jasmine.CustomReporterResult) {
+        if (suite) {
+            this.allure.startSuite(suite.fullName);
+        } else {
+            // case for tests without suite
+            this.allure.startSuite(relative(process.cwd(), (expect as any).getState().testPath));
+        }
     }
 
+    jasmineDone() {
+        if (this.allure.getCurrentSuite()) {
+            this.allure.endSuite();
+        }
+    };
+
     suiteDone() {
@@ -43,2 +55,5 @@ this.allure.endSuite();
     specStarted(spec: jasmine.CustomReporterResult) {
+        if (!this.allure.getCurrentSuite()) {
+            this.suiteStarted();
+        }
         this.allure.startCase(spec.description);
@@ -45,0 +60,0 @@ };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

151

increased by115.71%

Worsened metrics

Total package byte prevSize

16909

decreased by-67.33%

Number of package files

15

decreased by-16.67%

Lines of code

280

decreased by-21.79%

Number of low supply chain risk alerts

3

increased by200%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes