Add Devfile plugin for provision Run Configurations

[vzhukovs]

Current changes proposal provides plugin for Devfile support. Especially for provision commands from Devfile as Run Configuration in IntelliJ-based IDEs.

Plugin listens to Project open event and look for environment variable DEVWORKSPACE_FLATTENED_DEVFILE. Then, when Project is opened it takes content by DEVWORKSPACE_FLATTENED_DEVFILE and parses exec commands:

Then user is able to run command provided by Devfile from the IDE UI:

To check how it works with already created Devfiles it is enough to create the workspace from the following factory link:

https://<your-che-host>/dashboard/#https://github.com/che-samples/bash/tree/devfilev2?che-editor=https://gist.githubusercontent.com/vzhukovs/2bf66c67025c7c1167c3e926bb23646b/raw/7371235eb471269ec1308e02b05bc88298af49e0/devfile.yaml

or create the workspace from the following repository: https://github.com/vzhukovs/che-21029

fixes eclipse-che/che#21029

Signed-off-by: Vladyslav Zhukovskyi vzhukovs@redhat.com

[benoitf]

Hello, could you make sure that omitting working directory will use PROJECT_SOURCE folder
A little bit of context:
eclipse-che/che#21079

( And of course it could be a following PR)

[vzhukovs]

Hello, could you make sure that omitting working directory will use PROJECT_SOURCE folder A little bit of context: eclipse/che#21079

( And of course it could be a following PR)

Hi! If property workingDir is missed in the Devfile command, then it won't be provided to Run Configuration: https://github.com/che-incubator/jetbrains-editor-images/pull/78/files#diff-25badcef04942bfb7814284151c2b07081c94abb751d132748accbe147d327b6R44

In this case default working directory will be /projector/ide/bin as it provided by default from IntelliJ logic.

As for replacing environment variables. Each variable that is provided in workingDir parameter is replaced by the corresponding value from current environment. So in a few words, if environment has PROJECT_ROOT it will be replaced by the value from this variable. It performed by this object: https://github.com/che-incubator/jetbrains-editor-images/pull/78/files#diff-5055c3b1852b91d19343f6c99b512430a88843e017b5072bee67da69a432a017R16-R35 and it is called here: https://github.com/che-incubator/jetbrains-editor-images/pull/78/files#diff-25badcef04942bfb7814284151c2b07081c94abb751d132748accbe147d327b6R44

So it depends how user configured the parameter workingDir and what exactly contains in current environment.

[benoitf]

no working directory in devfile, set workdir to PROJECT_SOURCE

[vzhukovs]

no working directory in devfile, set workdir to PROJECT_SOURCE

we can provide additional PR for this, after resolving eclipse-che/che#21079, because we haven't had this variable in environment yet

cc @azatsarynnyy

[benoitf]

it's there since devfile/devworkspace-operator#697

[azatsarynnyy]

... we haven't had this variable in environment yet

I have both:

PROJECTS_ROOT="/projects"
PROJECTS_SOURCE="/projects"

in my Che instance.

[azatsarynnyy]

we can provide additional PR for this ...

@vzhukovs create an issue for that. So, we won't forget fixing that in the next iteration.

[vzhukovs]

we can provide additional PR for this ...

@vzhukovs create an issue for that. So, we won't forget fixing that in the next iteration.

Created the issue: eclipse-che/che#21100

[azatsarynnyy]

I can't test it on the Che dogfooding instance, as I get

@vzhukovs what instance have you used for testing?

[azatsarynnyy]

I've also tried on RHPDS. The Dashboard logs:

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Detected unrecoverable event FailedMount: Unable to attach or mount volumes: unmounted volumes=[claim-devworkspace], unattached volumes=[claim-devworkspace workspace-metadata kube-api-access-k7tw9 che-gateway]: timed out waiting for the condition

[vzhukovs]

I've also tried on RHPDS. The Dashboard logs:

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Initializing DevWorkspace

Preparing networking

Networking ready

Waiting for DevWorkspace ServiceAccount

Waiting for workspace deployment

Detected unrecoverable event FailedMount: Unable to attach or mount volumes: unmounted volumes=[claim-devworkspace], unattached volumes=[claim-devworkspace workspace-metadata kube-api-access-k7tw9 che-gateway]: timed out waiting for the condition

Try to follow this steps:

$ minikube start --cpus=4 --memory=10000 --disk-size='35000mb'
$ chectl server:deploy --installer operator --platform minikube --batch --workspace-engine dev-workspace
$ eval $(minikube -p minikube docker-env)
$ docker pull quay.io/devfile/universal-developer-image:ubi8-eda6672
$ docker pull quay.io/vzhukovs/che-idea:che-21029

* start the workspace from the https://github.com/vzhukovs/che-21029 repository

[azatsarynnyy]

The good news is that pre-pulling the UDI image really helped to avoid terminating the workspace start by timeout. 👍 Thanks for the advice!
That's another issue. I'll rise it internally.

I was able to start a DevWorkspace from https://github.com/vzhukovs/che-21029.
But there're no Run Configurations for the Devfile Commands:

Also, I've tried the link provided the PR description - https://<your-che-host>/dashboard/#https://github.com/che-samples/bash/tree/devfilev2?che-editor=https://gist.githubusercontent.com/vzhukovs/a32cafcd8d84d9af7579fcf4c09d4e31/raw/d58d87233d9b7facd6e5c6ca691679f072492e6a/devfile.yaml

And I've got the same result.

[azatsarynnyy]

There's no plugin in the Plugins list:

[vzhukovs]

But there're no Run Configurations for the Devfile Commands

Prerequisites for appearing Run Configurations is finished project indexing. After that Run Configurations is become available. This is the limitation of IntelliJ IDEA.

The factory link from the description should be updated as it should contain the plugin before removing the preference page. So it not actual, will update the description. The correct repository for testing is:

https://github.com/vzhukovs/che-21029

This one was used to record the demo flow.

[vzhukovs]

There's no plugin in the Plugins list:

It should appear on Installed tab. The field, you've used is to look for plugins only in the marketplace.

[azatsarynnyy]

Prerequisites for appearing Run Configurations is finished project indexing. After that Run Configurations is become available. This is the limitation of IntelliJ IDEA.

After indexing the project, the Run Configurations were imported:

I was able to run/stop the commands.

[azatsarynnyy]

Great job!