From 7722d4a2e3ace7db27991599d03a3d6ff95d133e Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Thu, 5 Sep 2019 14:09:35 +0200 Subject: [PATCH] [FEATURE] Add option to provide URL parameters for each testpage (#109) Resolves #105 --- README.md | 18 ++ lib/client/browser.js | 19 +- lib/errors.js | 32 +++ lib/framework.js | 31 +- package-lock.json | 272 +++++++++++------- package.json | 1 + test/framework.test.js | 95 ++++++ .../karma.conf.js | 22 ++ .../package.json | 7 + .../ui5.yaml | 5 + .../webapp/test/test.qunit.html | 15 + .../webapp/test/test.qunit.js | 15 + .../webapp/test/testsuite.qunit.html | 10 + .../webapp/test/testsuite.qunit.js | 13 + 14 files changed, 452 insertions(+), 103 deletions(-) create mode 100644 test/integration/application-ui5-tooling-url-parameters/karma.conf.js create mode 100644 test/integration/application-ui5-tooling-url-parameters/package.json create mode 100644 test/integration/application-ui5-tooling-url-parameters/ui5.yaml create mode 100644 test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.html create mode 100644 test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.js create mode 100644 test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.html create mode 100644 test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.js diff --git a/README.md b/README.md index f5feb7d3..07fdcd81 100644 --- a/README.md +++ b/README.md @@ -214,6 +214,7 @@ ui5: { Specific config options: - [testpage](#testpage) +- [urlParameters](#urlParameters) #### script @@ -249,6 +250,23 @@ ui5: { } ``` +### urlParameters +Type: `Array` +Specific to ["html" mode](#html) + +URL parameters to append to every testpage. + +Example: +```js +ui5: { + mode: "html", + urlParameters: [{ + key: "hidepassed", + value: true + }] +} +``` + ### config Type: `object` Specific to ["script" mode](#script) diff --git a/lib/client/browser.js b/lib/client/browser.js index 6823f030..39583341 100644 --- a/lib/client/browser.js +++ b/lib/client/browser.js @@ -1,3 +1,4 @@ +require("url-polyfill"); const istanbulLibCoverage = require("istanbul-lib-coverage"); require("./discovery.js"); @@ -115,6 +116,21 @@ require("./discovery.js"); }); } + function addUrlParameters(testpageUrl) { + if (!config.urlParameters) { + return testpageUrl; + } + + const url = new URL(testpageUrl, document.location.href); + config.urlParameters.forEach(function(urlParameter) { + url.searchParams.append(urlParameter.key, urlParameter.value); + }); + // Sort params for consistency between browsers (probably caused by polyfill) + url.searchParams.sort(); + + return url.toString(); + } + function runTests(testpages) { let totalNumberOfTest = 0; let coverageMap; @@ -130,7 +146,8 @@ require("./discovery.js"); } function runTestPage(i) { - const qunitHtmlFile = testpages[i]; + const qunitHtmlFile = addUrlParameters(testpages[i]); + windowUtil(qunitHtmlFile, function(testWindow) { let timer = null; let testResult = {}; diff --git a/lib/errors.js b/lib/errors.js index 57392380..5cb1d4ae 100644 --- a/lib/errors.js +++ b/lib/errors.js @@ -193,6 +193,38 @@ module.exports = function(config) { } }); };`, + urlParametersConfigInNonHtmlMode: (mode, urlParameters) => `error 14: +The urlParameters configuration can only be used in "html" mode + +module.exports = function(config) { + config.set({ + ui5: { + mode: "${mode}" + + // Cannot be used in combination with mode "${mode}": + urlParameters: ${JSON.stringify(urlParameters, null, "\t").split("\n").join("\n\t\t\t")} + } + }); +};`, + urlParametersNotAnArray: (urlParameters) => `error 15: +The urlParameters configuration must be an array but is of type "${typeof urlParameters}". + +module.exports = function(config) { + config.set({ + ui5: { + // Must be an array: + urlParameters: ${JSON.stringify(urlParameters, null, "\t").split("\n").join("\n\t\t\t")} + } + }); +};`, + urlParameterNotObject: (urlParameter) => `error 16: +The urlParameters configuration must be an array of objects. +But entry ${JSON.stringify(urlParameter)} is of type "${typeof urlParameter}".`, + + urlParameterMissingKeyOrValue: (urlParameter) => `error 17: +Every urlParameters configuration entry must have properties "key" and "value": +${JSON.stringify(urlParameter)} +`, failure: () => "ui5.framework failed. See error message above" } diff --git a/lib/framework.js b/lib/framework.js index 762407da..ae1ab45c 100644 --- a/lib/framework.js +++ b/lib/framework.js @@ -134,8 +134,8 @@ class Framework { throw new Error(ErrorMessage.failure()); } - if (config.frameworks && config.frameworks.length > 1 && this.config.ui5.mode === "html") { - this.logger.log("error", ErrorMessage.multipleFrameworks(config.frameworks) ); + if (this.config.frameworks && this.config.frameworks.length > 1 && this.config.ui5.mode === "html") { + this.logger.log("error", ErrorMessage.multipleFrameworks(this.config.frameworks) ); throw new Error(ErrorMessage.failure()); } @@ -149,6 +149,30 @@ class Framework { throw new Error(ErrorMessage.failure()); } + if (this.config.ui5.mode !== "html" && this.config.ui5.urlParameters) { + this.logger.log("error", ErrorMessage.urlParametersConfigInNonHtmlMode(this.config.ui5.mode, + this.config.ui5.urlParameters)); + throw new Error(ErrorMessage.failure()); + } + + if (this.config.ui5.urlParameters !== undefined && !Array.isArray(this.config.ui5.urlParameters)) { + this.logger.log("error", ErrorMessage.urlParametersNotAnArray(this.config.ui5.urlParameters)); + throw new Error(ErrorMessage.failure()); + } + + if (this.config.ui5.urlParameters) { + this.config.ui5.urlParameters.forEach((urlParameter) => { + if (typeof urlParameter !== "object") { + this.logger.log("error", ErrorMessage.urlParameterNotObject(urlParameter)); + throw new Error(ErrorMessage.failure()); + } + if (urlParameter.key === undefined || urlParameter.value === undefined) { + this.logger.log("error", ErrorMessage.urlParameterMissingKeyOrValue(urlParameter)); + throw new Error(ErrorMessage.failure()); + } + }); + } + this.config.ui5.paths = this.config.ui5.paths || { webapp: "webapp", src: "src", @@ -167,6 +191,9 @@ class Framework { // Make testpage url available to the client this.config.client.ui5.testpage = this.config.ui5.testpage; + // Pass configured urlParameters to client + this.config.client.ui5.urlParameters = this.config.ui5.urlParameters; + if (this.config.ui5.type === "application") { const webappFolder = this.config.ui5.paths.webapp; diff --git a/package-lock.json b/package-lock.json index cf354e62..4730b74e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -653,25 +653,25 @@ } }, "@nodelib/fs.scandir": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.2.tgz", - "integrity": "sha512-wrIBsjA5pl13f0RN4Zx4FNWmU71lv03meGKnqRUoCyan17s4V3WL92f3w3AIuWbNnpcrQyFBU5qMavJoB8d27w==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.1.tgz", + "integrity": "sha512-NT/skIZjgotDSiXs0WqYhgcuBKhUMgfekCmCGtkUAiLqZdOnrdjmZr9wRl3ll64J9NF79uZ4fk16Dx0yMc/Xbg==", "requires": { - "@nodelib/fs.stat": "2.0.2", + "@nodelib/fs.stat": "2.0.1", "run-parallel": "^1.1.9" } }, "@nodelib/fs.stat": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.2.tgz", - "integrity": "sha512-z8+wGWV2dgUhLqrtRYa03yDx4HWMvXKi1z8g3m2JyxAx8F7xk74asqPk5LAETjqDSGLFML/6CDl0+yFunSYicw==" + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.1.tgz", + "integrity": "sha512-+RqhBlLn6YRBGOIoVYthsG0J9dfpO79eJyN7BYBkZJtfqrBwf2KK+rD/M/yjZR6WBmIhAgOV7S60eCgaSWtbFw==" }, "@nodelib/fs.walk": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.3.tgz", - "integrity": "sha512-l6t8xEhfK9Sa4YO5mIRdau7XSOADfmh3jCr0evNHdY+HNkW6xuQhgMH7D73VV6WpZOagrW0UludvMTiifiwTfA==", + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.2.tgz", + "integrity": "sha512-J/DR3+W12uCzAJkw7niXDcqcKBg6+5G5Q/ZpThpGNzAUz70eOR6RV4XnnSN01qHZiVl0eavoxJsBypQoKsV2QQ==", "requires": { - "@nodelib/fs.scandir": "2.1.2", + "@nodelib/fs.scandir": "2.1.1", "fastq": "^1.6.0" } }, @@ -774,9 +774,9 @@ "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==" }, "@types/node": { - "version": "12.7.3", - "resolved": "https://registry.npmjs.org/@types/node/-/node-12.7.3.tgz", - "integrity": "sha512-3SiLAIBkDWDg6vFo0+5YJyHPWU9uwu40Qe+v+0MH8wRKYBimHvvAOyk3EzMrD/TrIlLYfXrqDqrg913PynrMJQ==" + "version": "12.7.2", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.7.2.tgz", + "integrity": "sha512-dyYO+f6ihZEtNPDcWNR1fkoTDf3zAK3lAABDze3mz6POyIercH0lEUawUFXlG8xaQZmm1yEBON/4TsYv/laDYg==" }, "@types/source-list-map": { "version": "0.1.2", @@ -846,30 +846,30 @@ } }, "@ui5/builder": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/@ui5/builder/-/builder-1.4.2.tgz", - "integrity": "sha512-QczJVw59yYT1w/9LtK1ZVzYjsteC/fhtQlhnTF2p5R8pO3oFsIxSS2yEEyVSA3OtwYuC6rGDaQSmXHsvRy+f2g==", + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/@ui5/builder/-/builder-1.4.1.tgz", + "integrity": "sha512-YiPYx76g7bNGK7dMmPI/W5Ctns9Alu0QD+j+DZE4nf6oAMShc2rDeJ7cRajzsUS0pimkFcr68sHiwQ7Fa+e9Dg==", "requires": { "@ui5/fs": "^1.1.2", "@ui5/logger": "^1.0.1", "cheerio": "^0.22.0", "escape-unicode": "^0.2.0", - "escodegen": "^1.12.0", + "escodegen": "^1.11.1", "escope": "^3.6.0", "esprima": "^4.0.1", "estraverse": "^4.3.0", "globby": "^10.0.1", - "graceful-fs": "^4.2.2", + "graceful-fs": "^4.2.1", "jsdoc": "3.5.5", "less-openui5": "^0.6.0", "make-dir": "^3.0.0", "pretty-data": "^0.40.0", "pretty-hrtime": "^1.0.3", "replacestream": "^4.0.3", - "rimraf": "^2.7.1", + "rimraf": "^2.6.3", "semver": "^6.3.0", "slash": "^3.0.0", - "terser": "^4.2.1", + "terser": "^4.1.4", "xml2js": "^0.4.17", "yazl": "^2.5.1" } @@ -1131,9 +1131,9 @@ "dev": true }, "abab": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.1.tgz", - "integrity": "sha512-1zSbbCuoIjafKZ3mblY5ikvAb0ODUbqBnFuUb7f6uLeQhhGJ0vEV4ntmtxKLT2WgXCO94E07BjunsIw1jOMPZw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.0.tgz", + "integrity": "sha512-sY5AXXVZv4Y1VACTtR11UJCPHHudgY5i26Qj5TypE6DKlIApbwb5uqhXcJ5UUGbvZNRh7EeIoW+LrJumBsKp7w==", "dev": true }, "abbrev": { @@ -3197,9 +3197,9 @@ } }, "es5-ext": { - "version": "0.10.51", - "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.51.tgz", - "integrity": "sha512-oRpWzM2WcLHVKpnrcyB7OW8j/s67Ba04JCm0WnNv3RiABSvs7mrQlutB8DBv793gKcp0XENR8Il8WxGTlZ73gQ==", + "version": "0.10.50", + "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.50.tgz", + "integrity": "sha512-KMzZTPBkeQV/JcSQhI5/z6d9VWJ3EnQ194USTUwIYZ2ZbpN8+SGXQKt1h68EX44+qt+Fzr8DO17vnxrw7c3agw==", "requires": { "es6-iterator": "~2.0.3", "es6-symbol": "~3.1.1", @@ -3425,9 +3425,9 @@ } }, "eslint-plugin-jsdoc": { - "version": "15.8.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-15.8.4.tgz", - "integrity": "sha512-KPYgMmZ6lrtCC93NIVp5O+yUE+bW3m3D8fztJylHw1d+VA2CQuq0BiNQZ7OXz+BK1SYF7TVAfsrHxWtIrE05GQ==", + "version": "15.9.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-15.9.1.tgz", + "integrity": "sha512-EwW580YgcyZkB83QqY8WuTioGUbIEBlPY+cRI/zSGYrg62GUpmue1HeCBiZRJ40A77BE/MGdGIbAGTdVX49URQ==", "dev": true, "requires": { "comment-parser": "^0.6.2", @@ -4129,11 +4129,11 @@ } }, "follow-redirects": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.8.1.tgz", - "integrity": "sha512-micCIbldHioIegeKs41DoH0KS3AXfFzgS30qVkM6z/XOE/GJgvmsoc839NUqa1B9udYe9dQxgv7KFwng6+p/dw==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.7.0.tgz", + "integrity": "sha512-m/pZQy4Gj287eNy94nivy5wchN3Kp+Q5WgUPNy5lJSZ3sgkVKSYV/ZChMAQVIgx1SqfZ2zBZtPA2YlXIWxxJOQ==", "requires": { - "debug": "^3.0.0" + "debug": "^3.2.6" }, "dependencies": { "debug": { @@ -4242,25 +4242,29 @@ "dependencies": { "abbrev": { "version": "1.1.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", "dev": true, "optional": true }, "ansi-regex": { "version": "2.1.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", "dev": true, "optional": true }, "aproba": { "version": "1.2.0", - "bundled": true, + "resolved": false, + "integrity": "sha512-Y9J6ZjXtoYh8RnXVCMOU/ttDmk1aBjunq9vO0ta5x85WDQiQfUF9sIPBITdbiiIVcBo03Hi3jMxigBtsddlXRw==", "dev": true, "optional": true }, "are-we-there-yet": { "version": "1.1.5", - "bundled": true, + "resolved": false, + "integrity": "sha512-5hYdAkZlcG8tOLujVDTgCT+uPX0VnpAH28gWsLfzpXYm7wP6mp5Q/gYyR7YQ0cKVJcXJnl3j2kpBan13PtQf6w==", "dev": true, "optional": true, "requires": { @@ -4270,13 +4274,15 @@ }, "balanced-match": { "version": "1.0.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", "dev": true, "optional": true }, "brace-expansion": { "version": "1.1.11", - "bundled": true, + "resolved": false, + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, "optional": true, "requires": { @@ -4286,37 +4292,43 @@ }, "chownr": { "version": "1.1.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-j38EvO5+LHX84jlo6h4UzmOwi0UgW61WRyPtJz4qaadK5eY3BTS5TY/S1Stc3Uk2lIM6TPevAlULiEJwie860g==", "dev": true, "optional": true }, "code-point-at": { "version": "1.1.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", "dev": true, "optional": true }, "concat-map": { "version": "0.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", "dev": true, "optional": true }, "console-control-strings": { "version": "1.1.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-PXz0Rk22RG6mRL9LOVB/mFEAjo4=", "dev": true, "optional": true }, "core-util-is": { "version": "1.0.2", - "bundled": true, + "resolved": false, + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", "dev": true, "optional": true }, "debug": { "version": "4.1.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", "dev": true, "optional": true, "requires": { @@ -4325,25 +4337,29 @@ }, "deep-extend": { "version": "0.6.0", - "bundled": true, + "resolved": false, + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", "dev": true, "optional": true }, "delegates": { "version": "1.0.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-hMbhWbgZBP3KWaDvRM2HDTElD5o=", "dev": true, "optional": true }, "detect-libc": { "version": "1.0.3", - "bundled": true, + "resolved": false, + "integrity": "sha1-+hN8S9aY7fVc1c0CrFWfkaTEups=", "dev": true, "optional": true }, "fs-minipass": { "version": "1.2.5", - "bundled": true, + "resolved": false, + "integrity": "sha512-JhBl0skXjUPCFH7x6x61gQxrKyXsxB5gcgePLZCwfyCGGsTISMoIeObbrvVeP6Xmyaudw4TT43qV2Gz+iyd2oQ==", "dev": true, "optional": true, "requires": { @@ -4352,13 +4368,15 @@ }, "fs.realpath": { "version": "1.0.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", "dev": true, "optional": true }, "gauge": { "version": "2.7.4", - "bundled": true, + "resolved": false, + "integrity": "sha1-LANAXHU4w51+s3sxcCLjJfsBi/c=", "dev": true, "optional": true, "requires": { @@ -4374,7 +4392,8 @@ }, "glob": { "version": "7.1.3", - "bundled": true, + "resolved": false, + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", "dev": true, "optional": true, "requires": { @@ -4388,13 +4407,15 @@ }, "has-unicode": { "version": "2.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-4Ob+aijPUROIVeCG0Wkedx3iqLk=", "dev": true, "optional": true }, "iconv-lite": { "version": "0.4.24", - "bundled": true, + "resolved": false, + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", "dev": true, "optional": true, "requires": { @@ -4403,7 +4424,8 @@ }, "ignore-walk": { "version": "3.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-DTVlMx3IYPe0/JJcYP7Gxg7ttZZu3IInhuEhbchuqneY9wWe5Ojy2mXLBaQFUQmo0AW2r3qG7m1mg86js+gnlQ==", "dev": true, "optional": true, "requires": { @@ -4412,7 +4434,8 @@ }, "inflight": { "version": "1.0.6", - "bundled": true, + "resolved": false, + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", "dev": true, "optional": true, "requires": { @@ -4422,19 +4445,22 @@ }, "inherits": { "version": "2.0.3", - "bundled": true, + "resolved": false, + "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", "dev": true, "optional": true }, "ini": { "version": "1.3.5", - "bundled": true, + "resolved": false, + "integrity": "sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==", "dev": true, "optional": true }, "is-fullwidth-code-point": { "version": "1.0.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", "dev": true, "optional": true, "requires": { @@ -4443,13 +4469,15 @@ }, "isarray": { "version": "1.0.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", "dev": true, "optional": true }, "minimatch": { "version": "3.0.4", - "bundled": true, + "resolved": false, + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", "dev": true, "optional": true, "requires": { @@ -4458,13 +4486,15 @@ }, "minimist": { "version": "0.0.8", - "bundled": true, + "resolved": false, + "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", "dev": true, "optional": true }, "minipass": { "version": "2.3.5", - "bundled": true, + "resolved": false, + "integrity": "sha512-Gi1W4k059gyRbyVUZQ4mEqLm0YIUiGYfvxhF6SIlk3ui1WVxMTGfGdQ2SInh3PDrRTVvPKgULkpJtT4RH10+VA==", "dev": true, "optional": true, "requires": { @@ -4474,7 +4504,8 @@ }, "minizlib": { "version": "1.2.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-7+4oTUOWKg7AuL3vloEWekXY2/D20cevzsrNT2kGWm+39J9hGTCBv8VI5Pm5lXZ/o3/mdR4f8rflAPhnQb8mPA==", "dev": true, "optional": true, "requires": { @@ -4483,7 +4514,8 @@ }, "mkdirp": { "version": "0.5.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", "dev": true, "optional": true, "requires": { @@ -4492,13 +4524,15 @@ }, "ms": { "version": "2.1.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", "dev": true, "optional": true }, "needle": { "version": "2.3.0", - "bundled": true, + "resolved": false, + "integrity": "sha512-QBZu7aAFR0522EyaXZM0FZ9GLpq6lvQ3uq8gteiDUp7wKdy0lSd2hPlgFwVuW1CBkfEs9PfDQsQzZghLs/psdg==", "dev": true, "optional": true, "requires": { @@ -4509,7 +4543,8 @@ }, "node-pre-gyp": { "version": "0.12.0", - "bundled": true, + "resolved": false, + "integrity": "sha512-4KghwV8vH5k+g2ylT+sLTjy5wmUOb9vPhnM8NHvRf9dHmnW/CndrFXy2aRPaPST6dugXSdHXfeaHQm77PIz/1A==", "dev": true, "optional": true, "requires": { @@ -4527,7 +4562,8 @@ }, "nopt": { "version": "4.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-0NRoWv1UFRk8jHUFYC0NF81kR00=", "dev": true, "optional": true, "requires": { @@ -4537,13 +4573,15 @@ }, "npm-bundled": { "version": "1.0.6", - "bundled": true, + "resolved": false, + "integrity": "sha512-8/JCaftHwbd//k6y2rEWp6k1wxVfpFzB6t1p825+cUb7Ym2XQfhwIC5KwhrvzZRJu+LtDE585zVaS32+CGtf0g==", "dev": true, "optional": true }, "npm-packlist": { "version": "1.4.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-+TcdO7HJJ8peiiYhvPxsEDhF3PJFGUGRcFsGve3vxvxdcpO2Z4Z7rkosRM0kWj6LfbK/P0gu3dzk5RU1ffvFcw==", "dev": true, "optional": true, "requires": { @@ -4553,7 +4591,8 @@ }, "npmlog": { "version": "4.1.2", - "bundled": true, + "resolved": false, + "integrity": "sha512-2uUqazuKlTaSI/dC8AzicUck7+IrEaOnN/e0jd3Xtt1KcGpwx30v50mL7oPyr/h9bL3E4aZccVwpwP+5W9Vjkg==", "dev": true, "optional": true, "requires": { @@ -4565,19 +4604,22 @@ }, "number-is-nan": { "version": "1.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", "dev": true, "optional": true }, "object-assign": { "version": "4.1.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", "dev": true, "optional": true }, "once": { "version": "1.4.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", "dev": true, "optional": true, "requires": { @@ -4586,19 +4628,22 @@ }, "os-homedir": { "version": "1.0.2", - "bundled": true, + "resolved": false, + "integrity": "sha1-/7xJiDNuDoM94MFox+8VISGqf7M=", "dev": true, "optional": true }, "os-tmpdir": { "version": "1.0.2", - "bundled": true, + "resolved": false, + "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=", "dev": true, "optional": true }, "osenv": { "version": "0.1.5", - "bundled": true, + "resolved": false, + "integrity": "sha512-0CWcCECdMVc2Rw3U5w9ZjqX6ga6ubk1xDVKxtBQPK7wis/0F2r9T6k4ydGYhecl7YUBxBVxhL5oisPsNxAPe2g==", "dev": true, "optional": true, "requires": { @@ -4608,19 +4653,22 @@ }, "path-is-absolute": { "version": "1.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", "dev": true, "optional": true }, "process-nextick-args": { "version": "2.0.0", - "bundled": true, + "resolved": false, + "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==", "dev": true, "optional": true }, "rc": { "version": "1.2.8", - "bundled": true, + "resolved": false, + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", "dev": true, "optional": true, "requires": { @@ -4632,7 +4680,8 @@ "dependencies": { "minimist": { "version": "1.2.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", "dev": true, "optional": true } @@ -4640,7 +4689,8 @@ }, "readable-stream": { "version": "2.3.6", - "bundled": true, + "resolved": false, + "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", "dev": true, "optional": true, "requires": { @@ -4655,7 +4705,8 @@ }, "rimraf": { "version": "2.6.3", - "bundled": true, + "resolved": false, + "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==", "dev": true, "optional": true, "requires": { @@ -4664,43 +4715,50 @@ }, "safe-buffer": { "version": "5.1.2", - "bundled": true, + "resolved": false, + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", "dev": true, "optional": true }, "safer-buffer": { "version": "2.1.2", - "bundled": true, + "resolved": false, + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "dev": true, "optional": true }, "sax": { "version": "1.2.4", - "bundled": true, + "resolved": false, + "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", "dev": true, "optional": true }, "semver": { "version": "5.7.0", - "bundled": true, + "resolved": false, + "integrity": "sha512-Ya52jSX2u7QKghxeoFGpLwCtGlt7j0oY9DYb5apt9nPlJ42ID+ulTXESnt/qAQcoSERyZ5sl3LDIOw0nAn/5DA==", "dev": true, "optional": true }, "set-blocking": { "version": "2.0.0", - "bundled": true, + "resolved": false, + "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", "dev": true, "optional": true }, "signal-exit": { "version": "3.0.2", - "bundled": true, + "resolved": false, + "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", "dev": true, "optional": true }, "string-width": { "version": "1.0.2", - "bundled": true, + "resolved": false, + "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", "dev": true, "optional": true, "requires": { @@ -4711,7 +4769,8 @@ }, "string_decoder": { "version": "1.1.1", - "bundled": true, + "resolved": false, + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", "dev": true, "optional": true, "requires": { @@ -4720,7 +4779,8 @@ }, "strip-ansi": { "version": "3.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", "dev": true, "optional": true, "requires": { @@ -4729,13 +4789,15 @@ }, "strip-json-comments": { "version": "2.0.1", - "bundled": true, + "resolved": false, + "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", "dev": true, "optional": true }, "tar": { "version": "4.4.8", - "bundled": true, + "resolved": false, + "integrity": "sha512-LzHF64s5chPQQS0IYBn9IN5h3i98c12bo4NCO7e0sGM2llXQ3p2FGC5sdENN4cTW48O915Sh+x+EXx7XW96xYQ==", "dev": true, "optional": true, "requires": { @@ -4750,13 +4812,15 @@ }, "util-deprecate": { "version": "1.0.2", - "bundled": true, + "resolved": false, + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", "dev": true, "optional": true }, "wide-align": { "version": "1.1.3", - "bundled": true, + "resolved": false, + "integrity": "sha512-QGkOQc8XL6Bt5PwnsExKBPuMKBxnGxWWW3fU55Xt4feHozMUhdUMaBCk290qpm/wG5u/RSKzwdAC4i51YigihA==", "dev": true, "optional": true, "requires": { @@ -4765,13 +4829,15 @@ }, "wrappy": { "version": "1.0.2", - "bundled": true, + "resolved": false, + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", "dev": true, "optional": true }, "yallist": { "version": "3.0.3", - "bundled": true, + "resolved": false, + "integrity": "sha512-S+Zk8DEWE6oKpV+vI3qWkaK+jSbIK86pCwe2IF/xwIpQ8jEuxpw9NyaGjmp9+BoJv5FV2piqCDcoCtStppiq2A==", "dev": true, "optional": true } @@ -10477,6 +10543,12 @@ } } }, + "url-polyfill": { + "version": "1.1.7", + "resolved": "https://registry.npmjs.org/url-polyfill/-/url-polyfill-1.1.7.tgz", + "integrity": "sha512-ZrAxYWCREjmMtL8gSbSiKKLZZticgihCvVBtrFbUVpyoETt8GQJeG2okMWA8XryDAaHMjJfhnc+rnhXRbI4DXA==", + "dev": true + }, "use": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/use/-/use-3.1.1.tgz", diff --git a/package.json b/package.json index cca820f0..225ec6ec 100644 --- a/package.json +++ b/package.json @@ -78,6 +78,7 @@ "lodash.assign": "^4.2.0", "puppeteer": "^1.19.0", "qunit": "^2.9.2", + "url-polyfill": "^1.1.7", "webpack": "^4.39.3", "webpack-cli": "^3.3.7" } diff --git a/test/framework.test.js b/test/framework.test.js index 65d2b220..061aaf02 100644 --- a/test/framework.test.js +++ b/test/framework.test.js @@ -448,6 +448,39 @@ describe("Testpage", () => { }); }); +describe("urlParameters", () => { + it("Configured URL parameters should be passed to client config", () => { + const config = { + ui5: { + urlParameters: [ + { + key: "test", + value: "🦆" + }, + { + key: 0, + value: "🐴" + } + ] + } + }; + const framework = new Framework(); + framework.exists = () => true; + framework.init({ + config: config, + logger: logger + }); + + expect(config.client.ui5.urlParameters).toStrictEqual([{ + key: "test", + value: "🦆" + }, { + key: 0, + value: "🐴" + }]); + }); +}); + describe("Without QUnit HTML Runner (with URL)", () => { it("Should include sap-ui-config.js and sap-ui-core.js", () => { const config = { @@ -601,6 +634,68 @@ describe("Error logging", () => { expect(framework.logger.message).toBe(ErrorMessage.invalidMode("foo")); }); + it("Should throw if urlParameters configuration is used in script mode", () => { + const config = { + ui5: { + mode: "script", + urlParameters: [ + { + key: "test", + value: "pony" + } + ] + } + }; + expect(() => framework.init({config, logger})).toThrow(); + expect(framework.logger.message).toBe(ErrorMessage.urlParametersConfigInNonHtmlMode("script", [{ + key: "test", + value: "pony" + }])); + }); + + it("Should throw if urlParameters configuration is not an array", () => { + const config = { + ui5: { + urlParameters: "🐬" + } + }; + expect(() => framework.init({config, logger})).toThrow(); + expect(framework.logger.message).toBe(ErrorMessage.urlParametersNotAnArray("🐬")); + }); + + it("Should throw if urlParameters configuration does not contain objects", () => { + const config = { + ui5: { + urlParameters: [{ + key: "hidepassed", + value: "true" + }, + "test=pony" + ] + } + }; + expect(() => framework.init({config, logger})).toThrow(); + expect(framework.logger.message).toBe(ErrorMessage.urlParameterNotObject("test=pony")); + }); + + it("Should throw if urlParameters configuration is missing \"value\" property", () => { + const config = { + ui5: { + urlParameters: [{ + key: "hidepassed", + value: "true" + }, + { + key: "🐧" + }] + } + }; + expect(() => framework.init({config, logger})).toThrow(); + expect(framework.logger.message).toBe(ErrorMessage.urlParameterMissingKeyOrValue({ + key: "🐧" + })); + }); + it("Should throw if multiple frameworks have been defined (qunit)", () => { const config = { frameworks: ["qunit", "ui5"] diff --git a/test/integration/application-ui5-tooling-url-parameters/karma.conf.js b/test/integration/application-ui5-tooling-url-parameters/karma.conf.js new file mode 100644 index 00000000..9f0d13af --- /dev/null +++ b/test/integration/application-ui5-tooling-url-parameters/karma.conf.js @@ -0,0 +1,22 @@ +module.exports = function(config) { + "use strict"; + + require("../karma-base.conf")(config); + config.set({ + + frameworks: ["ui5"], + ui5: { + urlParameters: [{ + key: "hidepassed", + value: true + }, { + key: 0, + value: "0️⃣" + }, { + key: "0", + value: "" + }] + } + + }); +}; diff --git a/test/integration/application-ui5-tooling-url-parameters/package.json b/test/integration/application-ui5-tooling-url-parameters/package.json new file mode 100644 index 00000000..1608f530 --- /dev/null +++ b/test/integration/application-ui5-tooling-url-parameters/package.json @@ -0,0 +1,7 @@ +{ + "name": "application-ui5-tooling-url-parameters", + "version": "1.0.0", + "dependencies": { + "@openui5/sap.ui.core": "*" + } +} diff --git a/test/integration/application-ui5-tooling-url-parameters/ui5.yaml b/test/integration/application-ui5-tooling-url-parameters/ui5.yaml new file mode 100644 index 00000000..4a0e0b4d --- /dev/null +++ b/test/integration/application-ui5-tooling-url-parameters/ui5.yaml @@ -0,0 +1,5 @@ +--- +specVersion: "1.0" +type: application +metadata: + name: test.app diff --git a/test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.html b/test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.html new file mode 100644 index 00000000..ae5a6c60 --- /dev/null +++ b/test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.html @@ -0,0 +1,15 @@ + + + + + QUnit Test + + + + + + + +
+ + diff --git a/test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.js b/test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.js new file mode 100644 index 00000000..aed52531 --- /dev/null +++ b/test/integration/application-ui5-tooling-url-parameters/webapp/test/test.qunit.js @@ -0,0 +1,15 @@ +/* global QUnit */ + +QUnit.config.autostart = false; + +sap.ui.getCore().attachInit(function() { + "use strict"; + + QUnit.test("URL Parameters", function(assert) { + assert.strictEqual(document.location.search, encodeURI("?0=0️⃣&0=&hidepassed=true"), + "Configured URL parameters got applied"); + assert.ok(QUnit.config.hidepassed, "URL parameter configured QUnit"); + }); + + QUnit.start(); +}); diff --git a/test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.html b/test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.html new file mode 100644 index 00000000..3153df14 --- /dev/null +++ b/test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.html @@ -0,0 +1,10 @@ + + + + Testsuite + + + + + + diff --git a/test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.js b/test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.js new file mode 100644 index 00000000..56c5fa8b --- /dev/null +++ b/test/integration/application-ui5-tooling-url-parameters/webapp/test/testsuite.qunit.js @@ -0,0 +1,13 @@ +/* global window, parent, location */ + +// eslint-disable-next-line sap-no-global-define +window.suite = function() { + "use strict"; + + // eslint-disable-next-line + var oSuite = new parent.jsUnitTestSuite(), + sContextPath = location.pathname.substring(0, location.pathname.lastIndexOf("/") + 1); + oSuite.addTestPage(sContextPath + "test.qunit.html"); + + return oSuite; +};