REST APIs that allows saving/edit/delete/search/share devfiles #17843

skabashnyuk · 2020-09-11T15:04:53Z

What does this PR do?

This is a set of REST APIs that allows saving/edit/delete/search/share devfiles.
The code is marked as 'Preview Beta'. We expect some changes in future releases.
Code can be reviewed commit by commit

Model

Main model object.

{
  "name": "devfile-94c37pcwf49pcsy7",
  "namespace": "opentlc-mgr",
  "id": "id-8th8js34s6doo3q7",
  "devfile": {
    "metadata": {
      "name": "wksp-custom"
    },
    "apiVersion": "1.0.0"
  },
  "links": [
    {
      "href": "https://che-che.apps.cluster-f3d8.f3d8.example.opentlc.com/api/devfile/id-8th8js34s6doo3q7",
      "method": "GET",
      "rel": "self",
      "produces": "application/json"
    }
  ]
}

you can see such parts

Field	Description
id	Uniquely identifying persistent devfile
name	Short human readable name of persistent devfile
description	A long explanation about how this concrete persistent devfile is used.
namespace	Che namespace to which this persistent devfile belongs to
devfile	Content of devfile that is matched Devfile schema 1.0
link	Weblinks related to this persistent devfile

Such rest methods was implemented:

As you can see there are two POST methods. One devfile/devfile/ is used to create persistent devfile from yaml. The name would be generated randomly.
For compatibility reasons method GET /devfile left untouched. It returns devfile 1.0 schema. Method GET /devfile/list is used to enumerate and search for devfiles.

TODO for Phase 2

update CascadeRemovalTest, add userdevfiles cascade removal Complete remaining after merging 17843 PR #17911
REST API to get by namespace @Path("/namespace/{namespace:.*}") Complete remaining after merging 17843 PR #17911
Replace get by ID with get by composite key @Path("/{key:.*}"). Composite key can be just devfile I D or in the namespace:devfile_name form, where namespace is optional (e.g :devfile_name is valid key too. namespace/devfile_name form, where namespace can contain '/' character. Complete remaining after merging 17843 PR #17911

Screenshot/screencast of this PR

What issues does this PR fix or reference?

#16981

How to test this PR?

deploy che server image quay.io/skabashn/che-server:che16981
run script https://gist.github.com/skabashnyuk/97200e6b2e1df316e854d3d5fd1e326b

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

che-bot · 2020-09-30T09:04:59Z

❌ E2E Happy path tests failed ❗

See Details

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

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

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

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

che-bot · 2020-09-30T09:28:37Z

❌ E2E Happy path tests failed ❗

See Details

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

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

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

sparkoo · 2020-09-30T12:01:35Z

...er/che-core-api-devfile/src/main/java/org/eclipse/che/api/devfile/server/DevfileService.java

+  }
+
+  @POST
+  @Consumes({APPLICATION_JSON})


why not accept yaml here?

I see no use-case for that. Do you?

I don't know. Hard to imagine all use-cases. I guess we can add it in the future, if need raises

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

skabashnyuk · 2020-10-01T08:57:59Z

@sparkoo @mshaposhnik @metlos @sleshchenko I think I've addressed your comments. Noticeable commits:

Applying reviewers suggestions d790930
Applying reviewers suggestions 50e9f09
Added explanation of what UserDevfile.namespace is f8cb092
Cover the possibility of using invalid search and order filed names a7f9eb3

che-bot · 2020-10-01T09:09:32Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

che-bot · 2020-10-05T13:53:06Z

❌ E2E Happy path tests failed ❗

See Details

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

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

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

skabashnyuk · 2020-10-05T13:55:54Z

[crw-ci-test]

che-bot · 2020-10-05T14:14:08Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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

sleshchenko

Sorry for the delay, I did not manage to redo the review in detail but I believe this PR should be good to merge once other reviewers approve it. So, feel free to merge without my approval )

...g/eclipse/che/multiuser/permission/devfile/server/UserDevfileCreatorPermissionsProvider.java

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

skabashnyuk · 2020-10-05T20:10:35Z

[ci-build]

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

che-bot · 2020-10-05T20:53:31Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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

skabashnyuk · 2020-10-06T06:08:09Z

[ci-build]

skabashnyuk · 2020-10-06T06:08:25Z

ci-build

skabashnyuk · 2020-10-06T07:15:01Z

ci-build

skabashnyuk · 2020-10-06T07:15:10Z

[ci-build]

skabashnyuk · 2020-10-06T08:37:00Z

[ci-build]

skabashnyuk · 2020-10-06T09:32:33Z

[ci-build]

che-bot added kind/task Internal things, technical debt, and to-do tasks to be performed. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. labels Sep 11, 2020

skabashnyuk mentioned this pull request Sep 11, 2020

[Devfile] CRUD Rest API #16981

Closed

skabashnyuk force-pushed the che16981_model2 branch from af98beb to 65bf783 Compare September 16, 2020 08:00

This was referenced Sep 16, 2020

[Preview do not merge] UserDevfile API #17009

Closed

UserDevfile API permissions skabashnyuk/che#12

Closed

skabashnyuk force-pushed the che16981_model2 branch from 5ff1704 to 106fefa Compare September 17, 2020 12:27

eclipse-che deleted a comment from che-bot Sep 17, 2020

skabashnyuk added 5 commits September 17, 2020 17:10

REST APIs that allows saving/edit/delete/search/share devfiles

e872904

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

Devfile integration tests

2278504

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

Devfile permission implementation

e89ff75

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

Devfile permission integration testing

079e192

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

Devfile service assembly

0d1fbe6

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

skabashnyuk force-pushed the che16981_model2 branch from d8044c5 to 0d1fbe6 Compare September 17, 2020 14:14

skabashnyuk marked this pull request as ready for review September 17, 2020 14:15

skabashnyuk requested review from l0rd, metlos, mshaposhnik, nickboldt, sleshchenko and vparfonov as code owners September 17, 2020 14:15

Added explanation of what UserDevfile.namespace is

f8cb092

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

sparkoo reviewed Sep 30, 2020

View reviewed changes

skabashnyuk added 2 commits October 1, 2020 11:53

Cover posibility of using invalid search and order filed names

a7f9eb3

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

Merge remote-tracking branch 'upstream/master' into che16981_model2

8546948

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

sparkoo approved these changes Oct 2, 2020

View reviewed changes

Merge remote-tracking branch 'upstream/master' into che16981_model2

bf7faa7

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

sleshchenko reviewed Oct 5, 2020

View reviewed changes

mshaposhnik reviewed Oct 5, 2020

View reviewed changes

...g/eclipse/che/multiuser/permission/devfile/server/UserDevfileCreatorPermissionsProvider.java Outdated Show resolved Hide resolved

Fixup

b2580d0

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

Merge remote-tracking branch 'upstream/master' into che16981_model2

9fca600

Signed-off-by: Sergii Kabashniuk <skabashniuk@redhat.com>

mshaposhnik approved these changes Oct 6, 2020

View reviewed changes

skabashnyuk merged commit f703f6f into eclipse-che:master Oct 6, 2020

skabashnyuk deleted the che16981_model2 branch October 6, 2020 10:01

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 Oct 6, 2020

che-bot added this to the 7.20 milestone Oct 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

REST APIs that allows saving/edit/delete/search/share devfiles #17843

REST APIs that allows saving/edit/delete/search/share devfiles #17843

skabashnyuk commented Sep 11, 2020 •

edited

Loading

che-bot commented Sep 30, 2020

che-bot commented Sep 30, 2020

sparkoo Sep 30, 2020

skabashnyuk Oct 1, 2020

sparkoo Oct 2, 2020

skabashnyuk commented Oct 1, 2020

che-bot commented Oct 1, 2020

che-bot commented Oct 5, 2020

skabashnyuk commented Oct 5, 2020

che-bot commented Oct 5, 2020

sleshchenko left a comment

skabashnyuk commented Oct 5, 2020

che-bot commented Oct 5, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

REST APIs that allows saving/edit/delete/search/share devfiles #17843

REST APIs that allows saving/edit/delete/search/share devfiles #17843

Conversation

skabashnyuk commented Sep 11, 2020 • edited Loading

What does this PR do?

Model

TODO for Phase 2

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

che-bot commented Sep 30, 2020

che-bot commented Sep 30, 2020

sparkoo Sep 30, 2020

Choose a reason for hiding this comment

skabashnyuk Oct 1, 2020

Choose a reason for hiding this comment

sparkoo Oct 2, 2020

Choose a reason for hiding this comment

skabashnyuk commented Oct 1, 2020

che-bot commented Oct 1, 2020

che-bot commented Oct 5, 2020

skabashnyuk commented Oct 5, 2020

che-bot commented Oct 5, 2020

sleshchenko left a comment

Choose a reason for hiding this comment

skabashnyuk commented Oct 5, 2020

che-bot commented Oct 5, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Oct 6, 2020

skabashnyuk commented Sep 11, 2020 •

edited

Loading