[FEATURE] specVersion 2.1: Add support for "customConfiguration" #308

matz3 · 2020-04-16T13:01:42Z

Add "customConfiguration" object for arbitrary configuration
Also cover kind extension
Add tests for all types / kinds (maybe generic?)
Add generic tests to validate common configuration of 2.1 and 2.0 to avoid a lot of duplicated tests

CLAassistant · 2020-04-17T11:08:13Z

All committers have signed the CLA.

coveralls · 2020-04-17T14:33:12Z

Coverage increased (+0.007%) to 89.82% when pulling 71499c0 on specVersion-2.1 into d5d98c4 on master.

matz3 · 2020-04-20T13:45:48Z

test/lib/validation/schema/specVersion/2.0/kind/project/commonUtils.js

@@ -0,0 +1,494 @@
+const test = require("ava");
+
+test("commonUtils", async (t) => {


I think we should rather exclude this file in the ava config (see package.json).

good point! done

matz3 · 2020-04-20T13:48:55Z

test/lib/validation/schema/specVersion/2.0/kind/project/application.js

- }
- });
-});
+ test("framework configuration: Invalid (specVersion " + version + ")", async (t) => {


I think all framework tests should be common across application, library and theme-library.

matz3 · 2020-04-20T13:50:17Z

All types of kind extension should also have the customConfiguration

test/lib/validation/schema/__helper__/customConfiguration.js

test/lib/validation/schema/__helper__/projectUtils.js

test/lib/validation/schema/__helper__/customConfiguration.js

test/lib/validation/schema/__helper__/extensionUtils.js

matz3 · 2020-04-28T12:39:56Z

Looks ok from my side. Maybe @RandomByte also want to have a look

RandomByte · 2020-04-29T08:57:28Z

lib/validation/schema/specVersion/2.0/kind/extension/task.json

+ "metadata": {
+ "$ref": "../extension.json#/definitions/metadata"
+ },
+ "task": {


Maybe make this a reference as well

RandomByte · 2020-04-29T08:57:33Z

lib/validation/schema/specVersion/2.0/kind/extension/server-middleware.json

+ "metadata": {
+ "$ref": "../extension.json#/definitions/metadata"
+ },
+ "middleware": {


Maybe make this a reference as well

RandomByte · 2020-04-29T09:02:43Z

test/lib/validation/schema/__helper__/extension.js

+ test(`kind: extension / type: ${type} basic (${specVersion})`, async (t) => {
+ await assertValidation(t, Object.assign({
+ "specVersion": specVersion,
+ "kind": "extension",


Duplicate information. Already defined in additionalConfiguration, so should be removed here

Suggested change

"kind": "extension",

RandomByte · 2020-04-29T09:02:50Z

test/lib/validation/schema/__helper__/extension.js

+ test(`kind: extension / type: ${type} additionalProperties (${specVersion})`, async (t) => {
+ await assertValidation(t, Object.assign({
+ "specVersion": specVersion,
+ "kind": "extension",


Duplicate information. Already defined in additionalConfiguration, so should be removed here

Suggested change

"kind": "extension",

RandomByte · 2020-04-29T09:03:39Z

test/lib/validation/schema/__helper__/extension.js

+ }]);
+ });
+
+ test(`${type} Invalid configuration: Additional property (${specVersion})`, async (t) => {


Suggested change

test(`${type} Invalid configuration: Additional property (${specVersion})`, async (t) => {

test(`kind: extension / type: ${type} Invalid configuration: Additional property (${specVersion})`, async (t) => {

Align with other test names

Adds support for the "customConfiguration" configuration to provide custom data. Must be handled by custom tools. Can be consumed when using @ui5/project API.

RandomByte · 2020-05-11T08:48:47Z

We forgot to enhance this if with the new spec version:

ui5-project/lib/projectPreprocessor.js

Lines 279 to 280 in 71499c0

 if (project.specVersion !== "0.1" && project.specVersion !== "1.0" && 

 project.specVersion !== "1.1" && project.specVersion !== "2.0") {

Also tests were not adapted. Currently you can't use specVersion 2.1 in a project, it will raise an error

Unsupported specification version 2.1 defined for project openui5-sample-app. Your UI5 CLI installation might be outdated. For details see https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions

#308 only allowed the use of the new spec version for extensions.

tobiasso85 requested review from RandomByte and tobiasso85 April 20, 2020 09:46

matz3 commented Apr 20, 2020

View reviewed changes

tobiasso85 changed the title ~~[FEATURE] Add specification version 2.1~~ [FEATURE] Add specification version 2.1 which supports customConfiguration Apr 23, 2020

tobiasso85 mentioned this pull request Apr 23, 2020

[INTERNAL] Add "customConfiguration" configuration documentation SAP/ui5-tooling#230

Merged

matz3 commented Apr 24, 2020

View reviewed changes

RandomByte requested changes Apr 29, 2020

View reviewed changes

[FEATURE] specVersion 2.1: Add support for "customConfiguration"

71499c0

Adds support for the "customConfiguration" configuration to provide custom data. Must be handled by custom tools. Can be consumed when using @ui5/project API.

matz3 force-pushed the specVersion-2.1 branch from 7922f62 to 71499c0 Compare May 5, 2020 13:25

matz3 changed the title ~~[FEATURE] Add specification version 2.1 which supports customConfiguration~~ [FEATURE] specVersion 2.1: Add support for "customConfiguration" May 5, 2020

RandomByte approved these changes May 5, 2020

View reviewed changes

matz3 merged commit 201aaab into master May 5, 2020

matz3 deleted the specVersion-2.1 branch May 5, 2020 13:42

RandomByte added a commit that referenced this pull request May 11, 2020

[FIX] Allow the use of specVersion 2.1 for projects

b1e0766

#308 only allowed the use of the new spec version for extensions.

RandomByte mentioned this pull request May 11, 2020

[FIX] Allow the use of specVersion 2.1 for projects #323

Merged

RandomByte added a commit that referenced this pull request May 11, 2020

[FIX] Allow the use of specVersion 2.1 for projects

a42172f

#308 only allowed the use of the new spec version for extensions.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE] specVersion 2.1: Add support for "customConfiguration" #308

[FEATURE] specVersion 2.1: Add support for "customConfiguration" #308

matz3 commented Apr 16, 2020 •

edited

Loading

CLAassistant commented Apr 17, 2020 •

edited

Loading

coveralls commented Apr 17, 2020 •

edited

Loading

matz3 Apr 20, 2020

tobiasso85 Apr 21, 2020

matz3 Apr 20, 2020

tobiasso85 Apr 21, 2020 •

edited

Loading

matz3 commented Apr 20, 2020

matz3 commented Apr 28, 2020

RandomByte Apr 29, 2020

matz3 May 5, 2020

RandomByte Apr 29, 2020

matz3 May 5, 2020

RandomByte Apr 29, 2020

matz3 May 5, 2020

RandomByte Apr 29, 2020

matz3 May 5, 2020

RandomByte Apr 29, 2020

matz3 May 5, 2020

RandomByte commented May 11, 2020 •

edited

Loading

		@@ -0,0 +1,494 @@
		const test = require("ava");

		test("commonUtils", async (t) => {

	test(`${type} Invalid configuration: Additional property (${specVersion})`, async (t) => {
	test(`kind: extension / type: ${type} Invalid configuration: Additional property (${specVersion})`, async (t) => {

[FEATURE] specVersion 2.1: Add support for "customConfiguration" #308

[FEATURE] specVersion 2.1: Add support for "customConfiguration" #308

Conversation

matz3 commented Apr 16, 2020 • edited Loading

CLAassistant commented Apr 17, 2020 • edited Loading

coveralls commented Apr 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobiasso85 Apr 21, 2020 • edited Loading

Choose a reason for hiding this comment

matz3 commented Apr 20, 2020

matz3 commented Apr 28, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RandomByte commented May 11, 2020 • edited Loading

matz3 commented Apr 16, 2020 •

edited

Loading

CLAassistant commented Apr 17, 2020 •

edited

Loading

coveralls commented Apr 17, 2020 •

edited

Loading

tobiasso85 Apr 21, 2020 •

edited

Loading

RandomByte commented May 11, 2020 •

edited

Loading