Make it possible to override values of the devfile by factory parameters #15220

mshaposhnik · 2019-11-18T13:53:19Z

What does this PR do?

This PR allows to override values of the devfile using factory parameters, in cases when direct editing of the devfile is inaccessible.

The value referencing rules are:

If the referenced value is a JSON object, the new value will be applied;
If the referenced value is not yet exists, the new value will be created;
If the currently referenced value is in a JSON array, the reference string MUST contain either name or alias of the referenced object;
If the currently referenced value is in a JSON array, but no object with referenced name or alias found, error will be thrown.

Few examples:

Override metadata.generateName:
http://<che.host>/f?url=https://..../devfile.yaml&metadata.generateName=foo-
Override project branch:
http://<che.host>/f?url=https://..../devfile.yaml&projects.p_name.source.branch=foo
Override component memory:
http://<che.host>/f?url=https://..../devfile.yaml&components.c_alias.memoryLimit=500Mi

What issues does this PR fix or reference?

#13617

Docs PR

sparkoo

It would be nice to simplify private JsonNode applyPropertiesOverride, but I'm not sure how. It seems like we can miss lot of corner cases there. Might be dangerous if devfile structure get more complicated.

...api-workspace/src/main/java/org/eclipse/che/api/workspace/server/devfile/DevfileManager.java

...workspace/src/test/java/org/eclipse/che/api/workspace/server/devfile/DevfileManagerTest.java

...api-workspace/src/main/java/org/eclipse/che/api/workspace/server/devfile/DevfileManager.java

che-bot · 2019-11-27T13:09:19Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:15220

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

⚠️ https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

ℹ️ Use comment "crw-ci-test" to rerun happy path E2E test.

che-bot · 2019-11-27T14:05:34Z

E2E tests of Eclipse Che Multiuser on OCP has failed:

Build details
Test report
docker image: eclipseche/che-server:15220
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "ci-test" to rerun the test.

dmytro-ndp · 2019-11-27T15:10:08Z

crw-ci-test

che-bot · 2019-11-27T15:34:58Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:15220

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

...test/java/org/eclipse/che/api/factory/server/github/GithubFactoryParametersResolverTest.java

che-bot · 2019-11-28T12:52:52Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:15220

che-bot · 2019-11-28T13:28:18Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:15220

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

metlos

Generally LGTM apart from some minor nitpicks.

...ce/src/main/java/org/eclipse/che/api/workspace/server/devfile/OverridePropertiesApplier.java

che-bot · 2019-11-28T15:25:42Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:15220

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

⚠️ https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

ℹ️ Use comment "crw-ci-test" to rerun happy path E2E test.

che-bot · 2019-11-28T15:44:14Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:15220

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

che-bot · 2019-11-28T16:10:45Z

E2E tests of Eclipse Che Multiuser on OCP has failed:

Build details
Test report
docker image: eclipseche/che-server:15220
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "ci-test" to rerun the test.

mshaposhnik · 2019-11-28T17:50:30Z

ci-test

che-bot · 2019-11-28T18:19:51Z

E2E tests of Eclipse Che Multiuser on OCP has failed:

Build details
Test report
docker image: eclipseche/che-server:15220
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "ci-test" to rerun the test.

mshaposhnik · 2019-11-28T18:43:25Z

ci-test

che-bot · 2019-11-28T19:31:26Z

E2E tests of Eclipse Che Multiuser on OCP has failed:

Build details
Test report
docker image: eclipseche/che-server:15220
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "ci-test" to rerun the test.

mshaposhnik · 2019-11-28T19:53:51Z

ci-test

che-bot · 2019-11-28T20:47:16Z

E2E tests of Eclipse Che Multiuser on OCP has failed:

Build details
Test report
docker image: eclipseche/che-server:15220
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "ci-test" to rerun the test.

mshaposhnik · 2019-11-29T07:18:26Z

ci-test

che-bot · 2019-11-29T08:15:17Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:15220

mshaposhnik added 3 commits November 15, 2019 18:54

Allow to override values in devfile using parameters of factory URL

8e34d01

Code fixups

e4a9150

fixup! Code fixups

77a2f9c

mshaposhnik requested review from l0rd, metlos, nickboldt, rhopp, skabashnyuk and sleshchenko as code owners November 18, 2019 13:53

mshaposhnik removed request for nickboldt, l0rd and rhopp November 18, 2019 13:53

che-bot added kind/enhancement A feature request - must adhere to the feature request template. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. labels Nov 18, 2019

mshaposhnik requested a review from sparkoo November 18, 2019 13:55

mshaposhnik added 5 commits November 18, 2019 15:56

Javadoc fixes

b55f52c

Code Fixup

692f194

Fixup fmt

f0427cf

fixup! Fixup fmt

af70ae4

Fixup github plugin

ad248d0

eclipse-che deleted a comment from che-bot Nov 19, 2019

sparkoo requested changes Nov 19, 2019

View reviewed changes

fixups

3256d08

skabashnyuk added this to the 7.6.0 milestone Nov 27, 2019

skabashnyuk reviewed Nov 28, 2019

View reviewed changes

mshaposhnik added 2 commits November 28, 2019 13:23

Merge branch 'master' into overrids

d0b64c8

Fixups

5806aed

skabashnyuk approved these changes Nov 28, 2019

View reviewed changes

metlos reviewed Nov 28, 2019

View reviewed changes

...ce/src/main/java/org/eclipse/che/api/workspace/server/devfile/OverridePropertiesApplier.java Outdated Show resolved Hide resolved

...ce/src/main/java/org/eclipse/che/api/workspace/server/devfile/OverridePropertiesApplier.java Outdated Show resolved Hide resolved

mshaposhnik added 2 commits November 28, 2019 17:13

Add separate exception for overrides

0800654

Add separate exception for overrides

7538876

mshaposhnik merged commit ceec1d8 into master Nov 29, 2019

mshaposhnik deleted the overrids branch November 29, 2019 09:07

che-bot removed the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label Nov 29, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make it possible to override values of the devfile by factory parameters #15220

Make it possible to override values of the devfile by factory parameters #15220

mshaposhnik commented Nov 18, 2019

sparkoo left a comment

che-bot commented Nov 27, 2019

che-bot commented Nov 27, 2019

dmytro-ndp commented Nov 27, 2019

che-bot commented Nov 27, 2019

che-bot commented Nov 28, 2019

che-bot commented Nov 28, 2019

metlos left a comment

che-bot commented Nov 28, 2019

che-bot commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 29, 2019

che-bot commented Nov 29, 2019

Make it possible to override values of the devfile by factory parameters #15220

Make it possible to override values of the devfile by factory parameters #15220

Conversation

mshaposhnik commented Nov 18, 2019

What does this PR do?

What issues does this PR fix or reference?

Docs PR

sparkoo left a comment

Choose a reason for hiding this comment

che-bot commented Nov 27, 2019

che-bot commented Nov 27, 2019

dmytro-ndp commented Nov 27, 2019

che-bot commented Nov 27, 2019

che-bot commented Nov 28, 2019

che-bot commented Nov 28, 2019

metlos left a comment

Choose a reason for hiding this comment

che-bot commented Nov 28, 2019

che-bot commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 28, 2019

che-bot commented Nov 28, 2019

mshaposhnik commented Nov 29, 2019

che-bot commented Nov 29, 2019