[minor] added tmsWithId and issueWithId (#244)

Author: mmisty

docs/interface.md

@@ -307,6 +307,23 @@ Will be shown in Links field for test
 cy.allure().tms('1', 'tms-1');
 ```
 
+
+### tmsWithId
+**tmsWithId(url: string, name?: string)**
+
+Adds link to test of type 'tms' ('tms' will have specific icon )
+
+The same as `tms` but will add tms id into description
+
+When `tmsPrefix` environment variable added no need to input the whole URL
+
+Will be shown in Links field for test
+
+```javascript
+cy.allure().tmsWithId('ABC-1', 'desc'); // will have link 'ABC-1: desc' when tmsPrefix is set
+```
+
+
 ### issue
 **issue(url: string, name?: string)**
 
@@ -321,6 +338,21 @@ cy.allure().issue('1', 'issue-1');
 ```
 
 
+### issueWithId
+**issueWithId(url: string, name?: string)**
+
+Adds link to test of type 'issue' ('issue' will have specific icon - bug icon )
+
+The same as `issue` but will add issue id into description
+
+When `issuePrefix` environment variable added no need to input the whole URL
+
+Will be shown in Links field for test
+
+```javascript
+cy.allure().issueWithId('ABC-1', 'desc'); // will have link 'ABC-1: desc' when issuePrefix is set
+```
+
 ### parameter
 **parameter(name: string, value: string)**
 

src/commands/index.ts

@@ -31,7 +31,9 @@ export const registerCommands = () => {
     feature: (allure, value) => allure.feature(value),
     link: (allure, value, name, type) => allure.link(value, name, type),
     tms: (allure, value, name) => allure.tms(value, name),
+    tmsWithId: (allure, value, name) => allure.tmsWithId(value, name),
     issue: (allure, value, name) => allure.issue(value, name),
+    issueWithId: (allure, value, name) => allure.issueWithId(value, name),
     story: (allure, value) => allure.story(value),
     suite: (allure, name) => allure.suite(name),
     subSuite: (allure, name) => allure.subSuite(name),

src/common/index.ts

@@ -53,6 +53,29 @@ export const tmsIssueUrl = (env: Record<string, string>, value: string, type: 'i
   return `${prefixFixed}/${value}`;
 };
 
+export const tmsIssueId = (env: Record<string, string>, value: string, type: 'issue' | 'tms') => {
+  if (value.startsWith('http://') || value.startsWith('https://')) {
+    return undefined;
+  }
+
+  if (type === 'issue') {
+    return env['issuePrefix'] ? value : undefined;
+  }
+
+  if (type === 'tms') {
+    return env['tmsPrefix'] ? value : undefined;
+  }
+
+  return undefined;
+};
+
+export const descriptionId = (env: Record<string, string>, value: string, type: 'issue' | 'tms', desc?: string) => {
+  const id = tmsIssueId(env, value, type);
+  const idStr = id ? `${id}: ` : '';
+
+  return desc ? `${idStr}${desc}` : value;
+};
+
 // needed to work in browser
 export const extname = (path: string): string => {
   return path.match(/(\.[^.\\/]+)$/)?.[0] ?? '.unknown';

src/cypress/types.ts

@@ -305,6 +305,16 @@ declare namespace Cypress {
      */
     tms(urlOrId: string, name?: string): T;
 
+    /**
+     * Adds link to tms = has icon tms
+     * @param urlOrId = full url or ID of item
+     * @param name = display text for URL in report (will add urlOrId to diplay text when it is id)
+     * @example
+     *  cy.allure().tmsWithId('ABD-123');
+     *  cy.allure().tmsWithId('http://my.jira.com/ABD-123', 'ABD-123 description');
+     */
+    tmsWithId(urlOrId: string, name?: string): T;
+
     /**
      * Adds link to defect = has icon BUG
      * @param urlOrId = full url or ID of item
@@ -315,6 +325,17 @@ declare namespace Cypress {
      */
     issue(urlOrId: string, name?: string): T;
 
+    /**
+     * Adds link to defect = has icon BUG
+     * @param urlOrId = full url or ID of item
+     * @param name = display text for URL in report (will add urlOrId to diplay text when it is id)
+     * @example
+     *  cy.allure().issueWithId('ABD-123'); // will add link: "ABD-123"
+     *  cy.allure().issueWithId('http://my.jira.com/ABD-123', 'ABD-123 description'); // will add link: "ABD-123 description"
+     *  cy.allure().issueWithId('ABD-123', 'description'); // will add link: "ABD-123: description"
+     */
+    issueWithId(urlOrId: string, name?: string): T;
+
     feature(value: string): T;
     story(value: string): T;
     allureId(value: string): T;

src/setup/allure-mocha-reporter.ts

@@ -13,7 +13,7 @@ import {
 import { registerScreenshotHandler } from './screenshots';
 import StatusDetails = Cypress.StatusDetails;
 import { logClient } from './helper';
-import { packageLog, tmsIssueUrl } from '../common';
+import { descriptionId, packageLog, tmsIssueUrl } from '../common';
 import { EventEmitter } from 'events';
 import AllureEvents = Cypress.AllureEvents;
 
@@ -205,6 +205,14 @@ export const allureInterface = (
       return fn({ task: 'link', arg: { url: fullUrl, name: linkName, type } });
     },
 
+    tmsWithId: (url: string, name?: string) => {
+      const type: LinkType = 'tms';
+      const fullUrl = tmsIssueUrl(env, url, type);
+      const linkName = descriptionId(env, url, type, name);
+
+      return fn({ task: 'link', arg: { url: fullUrl, name: linkName, type } });
+    },
+
     issue: (url: string, name?: string) => {
       const type: LinkType = 'issue';
       const fullUrl = tmsIssueUrl(env, url, type);
@@ -213,6 +221,14 @@ export const allureInterface = (
       return fn({ task: 'link', arg: { url: fullUrl, name: linkName, type } });
     },
 
+    issueWithId: (url: string, name?: string) => {
+      const type: LinkType = 'issue';
+      const fullUrl = tmsIssueUrl(env, url, type);
+      const linkName = descriptionId(env, url, type, name);
+
+      return fn({ task: 'link', arg: { url: fullUrl, name: linkName, type } });
+    },
+
     label: (name: string, value: string) => fn({ task: 'label', arg: { name, value } }),
     suite: (name: string) => fn({ task: 'suite', arg: { name } }),
     parentSuite: (name: string) => fn({ task: 'parentSuite', arg: { name } }),