@serenity-js/serenity-bdd 3.1.3 → 3.1.5

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.5](https://github.com/serenity-js/serenity-js/compare/v3.1.4...v3.1.5) (2023-04-18)
+
+**Note:** Version bump only for package @serenity-js/serenity-bdd
+
+
+
+
+
+## [3.1.4](https://github.com/serenity-js/serenity-js/compare/v3.1.3...v3.1.4) (2023-04-16)
+
+
+### Bug Fixes
+
+* **serenity-bdd:** escape HTML tags in scenaio name and title ([c5ca1bf](https://github.com/serenity-js/serenity-js/commit/c5ca1bfcfcc297d913208246addf84d400608245)), closes [#1630](https://github.com/serenity-js/serenity-js/issues/1630)
+
+
+
+
+
 ## [3.1.3](https://github.com/serenity-js/serenity-js/compare/v3.1.2...v3.1.3) (2023-04-14)
 
 **Note:** Version bump only for package @serenity-js/serenity-bdd

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/escapeHtml.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @package
+ * @param text
+ */
+export declare function escapeHtml(text: string): string;
+//# sourceMappingURL=escapeHtml.d.ts.map

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/escapeHtml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"escapeHtml.d.ts","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/mappers/escapeHtml.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAU/C"}

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/escapeHtml.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeHtml = void 0;
+/**
+ * @package
+ * @param text
+ */
+function escapeHtml(text) {
+    const replacements = {
+        '&': '&',
+        '"': '"',
+        '\'': ''',
+        '<': '&lt;',
+        '>': '&gt;'
+    };
+    return text.replace(/["&'<>]/g, character => replacements[character]);
+}
+exports.escapeHtml = escapeHtml;
+//# sourceMappingURL=escapeHtml.js.map

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/escapeHtml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"escapeHtml.js","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/mappers/escapeHtml.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,SAAgB,UAAU,CAAC,IAAY;IACnC,MAAM,YAAY,GAAG;QACjB,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,QAAQ;QACb,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,MAAM;QACX,GAAG,EAAE,MAAM;KACd,CAAC;IAEF,OAAO,IAAI,CAAC,OAAO,CAAE,UAAU,EAAE,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAE,CAAC;AAC5E,CAAC;AAVD,gCAUC"}

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/index.d.ts

@@ -1,4 +1,5 @@
 export * from './dashify';
 export * from './errorReportFrom';
+export * from './escapeHtml';
 export * from './outcomeReportFrom';
 //# sourceMappingURL=index.d.ts.map

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/mappers/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/mappers/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC"}

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/index.js

@@ -16,5 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./dashify"), exports);
 __exportStar(require("./errorReportFrom"), exports);
+__exportStar(require("./escapeHtml"), exports);
 __exportStar(require("./outcomeReportFrom"), exports);
 //# sourceMappingURL=index.js.map

package/lib/stage/crew/serenity-bdd-reporter/processors/mappers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/mappers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,oDAAkC;AAClC,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/mappers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,oDAAkC;AAClC,+CAA6B;AAC7B,sDAAoC"}

package/lib/stage/crew/serenity-bdd-reporter/processors/transformations/scenarioDetailsOf.js

@@ -10,13 +10,13 @@ function scenarioDetailsOf(details) {
     return (context) => {
         const name = (0, tiny_types_1.ensure)('scenario name', details.name.value, (0, tiny_types_1.isNotBlank)());
         const category = (0, tiny_types_1.ensure)('scenario category', details.category.value, (0, tiny_types_1.isNotBlank)());
-        context.report.name = name;
-        context.report.title = name;
+        context.report.name = (0, mappers_1.escapeHtml)(name);
+        context.report.title = (0, mappers_1.escapeHtml)(name);
         context.report.manual = false;
         context.report.testSteps = [];
         context.report.userStory = {
             id: (0, mappers_1.dashify)(category),
-            storyName: category,
+            storyName: (0, mappers_1.escapeHtml)(category),
             path: isFeatureFile(details.location.path)
                 ? details.location.path.value
                 : '',
@@ -29,7 +29,6 @@ exports.scenarioDetailsOf = scenarioDetailsOf;
 /**
  * @package
  * @param {Path} path
- * @returns {boolean}
  */
 function isFeatureFile(path) {
     return path && path.value.endsWith('.feature');

package/lib/stage/crew/serenity-bdd-reporter/processors/transformations/scenarioDetailsOf.js.map

@@ -1 +1 @@
-{"version":3,"file":"scenarioDetailsOf.js","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/transformations/scenarioDetailsOf.ts"],"names":[],"mappings":";;;AAEA,2CAAgD;AAEhD,wCAAqC;AAGrC;;GAEG;AACH,SAAgB,iBAAiB,CAA2C,OAAwB;IAChG,OAAO,CAAC,OAAgB,EAAW,EAAE;QACjC,MAAM,IAAI,GAAQ,IAAA,mBAAM,EAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAA,uBAAU,GAAE,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAI,IAAA,mBAAM,EAAC,mBAAmB,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAA,uBAAU,GAAE,CAAC,CAAC;QAEpF,OAAO,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;QAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG;YACvB,EAAE,EAAE,IAAA,iBAAO,EAAC,QAAQ,CAAC;YACrB,SAAS,EAAE,QAAQ;YACnB,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACtC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK;gBAC7B,CAAC,CAAC,EAAE;YACR,IAAI,EAAE,SAAS;SAClB,CAAC;QAEF,OAAO,OAAO,CAAC;IACnB,CAAC,CAAA;AACL,CAAC;AApBD,8CAoBC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,IAAU;IAC7B,OAAO,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC"}
+{"version":3,"file":"scenarioDetailsOf.js","sourceRoot":"","sources":["../../../../../../src/stage/crew/serenity-bdd-reporter/processors/transformations/scenarioDetailsOf.ts"],"names":[],"mappings":";;;AAEA,2CAAgD;AAEhD,wCAAiD;AAGjD;;GAEG;AACH,SAAgB,iBAAiB,CAA2C,OAAwB;IAChG,OAAO,CAAC,OAAgB,EAAW,EAAE;QACjC,MAAM,IAAI,GAAQ,IAAA,mBAAM,EAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAA,uBAAU,GAAE,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAI,IAAA,mBAAM,EAAC,mBAAmB,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAA,uBAAU,GAAE,CAAC,CAAC;QAEpF,OAAO,CAAC,MAAM,CAAC,IAAI,GAAG,IAAA,oBAAU,EAAC,IAAI,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,IAAA,oBAAU,EAAC,IAAI,CAAC,CAAC;QACxC,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG;YACvB,EAAE,EAAE,IAAA,iBAAO,EAAC,QAAQ,CAAC;YACrB,SAAS,EAAE,IAAA,oBAAU,EAAC,QAAQ,CAAC;YAC/B,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACtC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK;gBAC7B,CAAC,CAAC,EAAE;YACR,IAAI,EAAE,SAAS;SAClB,CAAC;QAEF,OAAO,OAAO,CAAC;IACnB,CAAC,CAAA;AACL,CAAC;AApBD,8CAoBC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,IAAU;IAC7B,OAAO,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/serenity-bdd",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "Serenity BDD reporter for Serenity/JS",
   "author": {
     "name": "Jan Molak",
@@ -45,9 +45,9 @@
     "npm": "^6 || ^7 || ^8 || ^9"
   },
   "dependencies": {
-    "@serenity-js/assertions": "3.1.3",
-    "@serenity-js/core": "3.1.3",
-    "@serenity-js/rest": "3.1.3",
+    "@serenity-js/assertions": "3.1.5",
+    "@serenity-js/core": "3.1.5",
+    "@serenity-js/rest": "3.1.5",
     "ansi-regex": "^5.0.1",
     "axios": "^1.3.5",
     "chalk": "^4.1.2",
@@ -71,5 +71,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.9.5"
   },
-  "gitHead": "6cabc4cb6e6f25411862c7375738b931012b6361"
+  "gitHead": "31f621a7c827e20ba07a86a2f7c77d941784bb0a"
 }

package/src/stage/crew/serenity-bdd-reporter/processors/mappers/escapeHtml.ts

@@ -0,0 +1,15 @@
+/**
+ * @package
+ * @param text
+ */
+export function escapeHtml(text: string): string {
+    const replacements = {
+        '&': '&',
+        '"': '"',
+        '\'': ''',
+        '<': '&lt;',
+        '>': '&gt;'
+    };
+
+    return text.replace( /["&'<>]/g, character => replacements[character] );
+}

package/src/stage/crew/serenity-bdd-reporter/processors/mappers/index.ts

@@ -1,3 +1,4 @@
 export * from './dashify';
 export * from './errorReportFrom';
+export * from './escapeHtml';
 export * from './outcomeReportFrom';

package/src/stage/crew/serenity-bdd-reporter/processors/transformations/scenarioDetailsOf.ts

@@ -2,7 +2,7 @@ import { Path } from '@serenity-js/core/lib/io';
 import { ScenarioDetails } from '@serenity-js/core/lib/model';
 import { ensure, isNotBlank } from 'tiny-types';
 
-import { dashify } from '../mappers';
+import { dashify, escapeHtml } from '../mappers';
 import { SerenityBDDReportContext } from '../SerenityBDDReportContext';
 
 /**
@@ -13,13 +13,13 @@ export function scenarioDetailsOf<Context extends SerenityBDDReportContext>(deta
         const name      = ensure('scenario name', details.name.value, isNotBlank());
         const category  = ensure('scenario category', details.category.value, isNotBlank());
 
-        context.report.name = name;
-        context.report.title = name;
+        context.report.name = escapeHtml(name);
+        context.report.title = escapeHtml(name);
         context.report.manual = false;
         context.report.testSteps = [];
         context.report.userStory = {
             id: dashify(category),
-            storyName: category,
+            storyName: escapeHtml(category),
             path: isFeatureFile(details.location.path)
                 ? details.location.path.value
                 : '',
@@ -33,7 +33,6 @@ export function scenarioDetailsOf<Context extends SerenityBDDReportContext>(deta
 /**
  * @package
  * @param {Path} path
- * @returns {boolean}
  */
 function isFeatureFile(path: Path): boolean {
     return path && path.value.endsWith('.feature');