Add an `odo run` command to manually execute command during `odo dev` by feloy · Pull Request #6857 · redhat-developer/odo

feloy · 2023-06-01T09:06:52Z

What type of PR is this:

/kind feature

What does this PR do / why we need it:

Which issue(s) this PR fixes:

Fixes partially #6568

The points covered by this PR are:

there should be a command (odo run for example) that takes one argument that is the command name and executes the command defined in devfile
odo run assumes that odo dev is running in a separate terminal, if odo dev is not running (resources not present on the cluster) odo run errors out and tells the user to run odo dev first.
if the command is exec command and the container where the program needs to be started is not running, the command should be executed as a Job; for podman this can be running inside a pod/container (this case is not possible currently: odo dev includes all the containers defined in the Devfile).
if the command is exec and the container is already running, it should be just executed inside the running container
if command is apply it just applies what it needs to :-) kubernetes/openshift components get created, container component gets turned into Deployment is dedicatedPod: true
if command is composite that it performs all action based on the above rules

This PR does not completely covers #6568. Points not implemented/tested yet are:

odo run streams logs into the terminal and waits for the command to finish.
user can interrupt the command by pressing control-c; cleanup the resources.
the exit code of odo run command reflect the exit code of the last devfile command executed. If the last command was apply and it was successful it returns 0, if failed returns 1
Because odo dev is running, if Kubernetes/OpenShift resources are created with Apply commands, they should be deployed in "Dev" mode (to be cleanup when odo dev terminates) - make it clear it will be cleaned up.

PR acceptance criteria:

Unit test
Integration test
Documentation

How to test changes / Special notes to the reviewer:

netlify · 2023-06-01T09:06:57Z

✅ Deploy Preview for odo-docusaurus-preview canceled.

Name	Link
🔨 Latest commit	`2ada482`
🔍 Latest deploy log	https://app.netlify.com/sites/odo-docusaurus-preview/deploys/6479cf88b66bb200072d72ef

odo-robot · 2023-06-01T09:13:32Z

OpenShift Unauthenticated Tests on commit 77841ae finished successfully.
View logs: TXT HTML

odo-robot · 2023-06-01T09:13:59Z

NoCluster Tests on commit 77841ae finished successfully.
View logs: TXT HTML

odo-robot · 2023-06-01T09:16:06Z

Unit Tests on commit 77841ae finished successfully.
View logs: TXT HTML

odo-robot · 2023-06-01T09:20:58Z

Validate Tests on commit 77841ae finished successfully.
View logs: TXT HTML

odo-robot · 2023-06-01T09:37:27Z

Kubernetes Tests on commit 77841ae finished successfully.
View logs: TXT HTML

odo-robot · 2023-06-01T09:38:43Z

Windows Tests (OCP) on commit 77841ae finished with errors.
View logs: TXT HTML

odo-robot · 2023-06-01T09:46:25Z

OpenShift Tests on commit 77841ae finished successfully.
View logs: TXT HTML

odo-robot · 2023-06-01T09:47:59Z

Kubernetes Docs Tests on commit b6c9c88 finished successfully.
View logs: TXT HTML

rm3l

Added a few comments..

pkg/odo/cli/run/run.go

pkg/dev/podmandev/run.go

pkg/libdevfile/libdevfile.go

pkg/podman/pods.go

pkg/dev/common/run.go

tests/examples/source/devfiles/nodejs/devfile-for-run.yaml

sonarqubecloud · 2023-06-02T12:40:45Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
6.1% Duplication

rm3l

Thanks for the changes - it works great so far!

feloy · 2023-06-02T13:27:15Z

/override windows-integration-test/Windows-test

 [FAILED] [206.381 seconds]
E2E Test starting with non-empty Directory add Binding [It] should verify developer workflow of using binding as env in innerloop
C:/Users/Administrator.ANSIBLE-TEST-VS/4064/tests/e2escenarios/e2e_test.go:462
[...]
[FAILED] Expected
      <*url.Error | 0xc0001090e0>: {
          Op: "Post",
          URL: "http://127.0.0.1:62941/api/newuser",
          Err: <*errors.errorString | 0xc00008a130>{s: "EOF"},
      }
  to be nil

openshift-ci · 2023-06-02T13:27:24Z

@feloy: Overrode contexts on behalf of feloy: windows-integration-test/Windows-test

Details

In response to this:

/override windows-integration-test/Windows-test

[FAILED] [206.381 seconds]
E2E Test starting with non-empty Directory add Binding [It] should verify developer workflow of using binding as env in innerloop
C:/Users/Administrator.ANSIBLE-TEST-VS/4064/tests/e2escenarios/e2e_test.go:462
[...]
[FAILED] Expected
     <*url.Error | 0xc0001090e0>: {
         Op: "Post",
         URL: "http://127.0.0.1:62941/api/newuser",
         Err: <*errors.errorString | 0xc00008a130>{s: "EOF"},
     }
 to be nil

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

feloy · 2023-06-02T13:27:59Z

/override SonarCloud Code Analysis
Duplicate code on mocks due to Platform interface embedded into Podman interface

openshift-ci · 2023-06-02T13:28:02Z

@feloy: /override requires failed status contexts, check run or a prowjob name to operate on.
The following unknown contexts/checkruns were given:

Analysis
Code
SonarCloud

Only the following failed contexts/checkruns were expected:

Kubernetes-Integration-Tests/Kubernetes-Integration-Tests
OpenShift-Integration-tests/OpenShift-Integration-tests
OpenShift-Integration-tests/OpenShift-Unauth-Integration-tests
SonarCloud Code Analysis
Unit-Tests/Unit-Tests
ci/prow/odo-ocp4.13-lp-interop-images
ci/prow/odo-ocp4.14-lp-interop-images
ci/prow/v4.10-images
ci/prow/v4.11-images
ci/prow/v4.12-images
ci/prow/v4.13-images
netlify/odo-docusaurus-preview/deploy-preview
pull-ci-redhat-developer-odo-main-odo-ocp4.13-lp-interop-images
pull-ci-redhat-developer-odo-main-odo-ocp4.14-lp-interop-images
pull-ci-redhat-developer-odo-main-v4.10-images
pull-ci-redhat-developer-odo-main-v4.11-images
pull-ci-redhat-developer-odo-main-v4.12-images
pull-ci-redhat-developer-odo-main-v4.13-images
tide
validator/Validate
windows-integration-test/Windows-test

If you are trying to override a checkrun that has a space in it, you must put a double quote on the context.

Details

In response to this:

/override SonarCloud Code Analysis
Duplicate code on mocks due to Platform interface embedded into Podman interface

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

feloy · 2023-06-02T13:28:25Z

/override "SonarCloud Code Analysis"

openshift-ci · 2023-06-02T13:28:29Z

@feloy: Overrode contexts on behalf of feloy: SonarCloud Code Analysis

Details

In response to this:

/override "SonarCloud Code Analysis"

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

feloy added 8 commits May 31, 2023 15:13

Add a run command

18cf91d

Check command name passed as arg

8d09688

Check platform is available

30fb326

Add a Run method to the DevClient

cf9d506

Run command on cluster

8b8a95a

Add test with run command on cluster

a6eca7c

Implement and test run on podman

5dc290d

Enhance test to check that command has been executed in container

abf3033

feloy requested a review from rm3l June 1, 2023 09:06

openshift-ci bot added the kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation label Jun 1, 2023

openshift-ci bot requested review from anandrkskd and ritudes June 1, 2023 09:07

feloy added 3 commits June 1, 2023 13:34

Fix odo help test

cf33c09

Refactor common code for podman/cluster

a069261

Test Apply commands on Kubernetes/Images

1fdda50

feloy force-pushed the feature-6568/odo-run-command branch from 9a603f0 to 150f36d Compare June 1, 2023 15:55

Test a msg is displayed when executing odo run without odo dev

8c6f335

feloy force-pushed the feature-6568/odo-run-command branch from 150f36d to 8c6f335 Compare June 1, 2023 17:54

rm3l requested changes Jun 2, 2023

View reviewed changes

openshift-ci bot assigned rm3l Jun 2, 2023

feloy force-pushed the feature-6568/odo-run-command branch from e1a87d9 to dc42555 Compare June 2, 2023 09:54

feloy added 2 commits June 2, 2023 13:16

Review

852077f

makes GetRunningPodFromSelector return only Running pods on Podman

2ada482

feloy force-pushed the feature-6568/odo-run-command branch from dc42555 to 2ada482 Compare June 2, 2023 11:16

feloy requested review from rm3l and removed request for anandrkskd and ritudes June 2, 2023 11:32

feloy closed this Jun 2, 2023

feloy reopened this Jun 2, 2023

rm3l approved these changes Jun 2, 2023

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 2, 2023

openshift-merge-robot merged commit 330b724 into redhat-developer:main Jun 2, 2023

Conversation

feloy commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for odo-docusaurus-preview canceled.

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

odo-robot bot commented Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rm3l left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Jun 2, 2023

Uh oh!

rm3l left a comment

Choose a reason for hiding this comment

Uh oh!

feloy commented Jun 2, 2023

Uh oh!

openshift-ci bot commented Jun 2, 2023

Uh oh!

feloy commented Jun 2, 2023

Uh oh!

openshift-ci bot commented Jun 2, 2023

Uh oh!

feloy commented Jun 2, 2023

Uh oh!

openshift-ci bot commented Jun 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feloy commented Jun 1, 2023 •

edited

Loading

netlify bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading

odo-robot bot commented Jun 1, 2023 •

edited

Loading