Support exec command

[valaparthvi]

What type of PR is this:

What does this PR do / why we need it:

Which issue(s) this PR fixes:

Fixes #5701

PR acceptance criteria:

• Unit test

• Integration test

• Documentation

How to test changes / Special notes to the reviewer:

1. git clone https://github.com/kadel/demo-odo-springboot.git
2. git checkout d5956f5
3. Copy the following content in the devfile.yaml

devfile.yaml

schemaVersion: 2.2.0
metadata:
  name: demo
variables:
  APP_IMAGE: quay.io/tkral/devbox-demo-app
  DEV_IMAGE: quay.io/tkral/devbox-demo-devbox

components:
  - container:
      endpoints:
        - name: 8080-tcp
          targetPort: 8080
      env:
        - name: DEBUG_PORT
          value: "5858"
      image: "{{DEV_IMAGE}}"
      mountSources: true
    name: tools
  - container:
      image: golang
    name: pi
  - name: dev-image
    image:
      imageName: "{{DEV_IMAGE}}"
      dockerfile:
        uri: ./devcontainer/Dockerfile
        buildContext: ${PROJECT_SOURCE}

  - name: app-image
    image:
      imageName: "{{APP_IMAGE}}"
      dockerfile:
        uri: ./src/main/docker/Dockerfile
        buildContext: ${PROJECT_SOURCE}

  - name: resource-app
    kubernetes:
      uri: config/default/app.yaml

  - name: resource-pvc
    kubernetes:
      uri: config/default/pvc.yaml

  - name: resource-service
    kubernetes:
      uri: config/default/service.yaml

  - name: resource-route
    kubernetes:
      uri: config/local/route.yaml

commands:
  - exec:
      commandLine: mvn package -Dmaven.test.skip=true
      component: tools
      group:
        isDefault: true
        kind: build
      workingDir: ${PROJECT_SOURCE}
    id: build

  - exec:
      commandLine: mvn spring-boot:run -Dspring-boot.run.profiles=postgres
      component: tools
      hotReloadCapable: true
      group:
        isDefault: true
        kind: run
      workingDir: ${PROJECT_SOURCE}
    id: run

  - exec:
      commandLine:
        java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=${DEBUG_PORT},suspend=n
        -jar target/*.jar
      component: tools
      group:
        isDefault: true
        kind: debug
      workingDir: ${PROJECT_SOURCE}
    id: debug

  - exec:
      commandLine: helm repo add bitnami https://charts.bitnami.com/bitnami && helm install my-db bitnami/postgresql
      component: tools
    id: deploy-db
  - exec:
      commandLine: go version
      component: pi
    id: deploy-pi-db
  - apply:
      component: resource-app
    id: deploy-app

  - apply:
      component: resource-pvc
    id: deploy-pvc

  - apply:
      component: resource-service
    id: deploy-service

  - apply:
      component: resource-route
    id: deploy-route

  - apply:
      component: app-image
    id: app-image

  - composite:
      commands:
        # - app-image
        # - deploy-pvc
        # - deploy-service
        # - deploy-route
        # - deploy-app
        - deploy-pi-db
        - deploy-db
      group:
        isDefault: true
        kind: deploy
    id: deploy

4. odo deploy

The first task(deploy-pi-db) should execute successfully, the second(deploy-db) should fail because of incorrect ServiceAccount setup. In both cases a log should be printed and the job should be deleted in 60s after its completion.
There is a third case where if the job continues to run after 60s minute, log/error will be printed after every 60s which will continue until the user interrupts. This can be tested by changing the image for container comp pi to geolandg or some non-existent image.

[netlify]

✅ Deploy Preview for odo-docusaurus-preview ready!

Name	Link
🔨 Latest commit	c54a522
🔍 Latest deploy log	https://app.netlify.com/sites/odo-docusaurus-preview/deploys/640094118b0f8a00083db4cd
😎 Deploy Preview	https://deploy-preview-6579--odo-docusaurus-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[odo-robot]

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

[odo-robot]

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

[odo-robot]

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

[odo-robot]

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

[odo-robot]

Kubernetes Tests on commit fe15d56 finished with errors.
View logs: TXT HTML

[odo-robot]

Windows Tests (OCP) on commit fe15d56 finished successfully.
View logs: TXT HTML

[odo-robot]

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

[odo-robot]

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

[rm3l]

A few comments after testing it.

[valaparthvi]

• after 1 minute, we advise the user to look at odo logs --deploy --follow
• display the last 100 lines of the output if the execution fails to be consistent with odo deploy.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

No Coverage information
0.3% Duplication

[feloy]

When I execute a long-running command, and try to get the logs, as documented in the output of odo deploy, I don't get anything:

$ odo logs --deploy
no containers running in the specified mode for the component "my-nodejs-2"

I'm not sure if it is a problem on odo logs side, or if some labels are not set on the Job or on the Pod Template of the Job?

[valaparthvi]

When I execute a long-running command, and try to get the logs, as documented in the output of odo deploy, I don't get anything:

$ odo logs --deploy
no containers running in the specified mode for the component "my-nodejs-2"

I'm not sure if it is a problem on odo logs side, or if some labels are not set on the Job or on the Pod Template of the Job?

Are you running odo logs after odo deploy finishes or while it is running? If you run it before or after odo deploy is run, odo logs is bound to throw the no containers error. If that is not the case, can you share the devfile you're running?

[feloy]

When I execute a long-running command, and try to get the logs, as documented in the output of odo deploy, I don't get anything:

$ odo logs --deploy
no containers running in the specified mode for the component "my-nodejs-2"

I'm not sure if it is a problem on odo logs side, or if some labels are not set on the Job or on the Pod Template of the Job?

Are you running odo logs after odo deploy finishes or while it is running? If you run it before or after odo deploy is run, odo logs is bound to throw the no containers error. If that is not the case, can you share the devfile you're running?

I'm running odo logs while the job is running. I've used the devfile used for the integration test (devfile-deploy-exec.yaml), adding sleep 60 after the echo Hello world command:

commands:
  - exec:
      commandLine: npm install
      component: runtime
      group:
        isDefault: true
        kind: build
      workingDir: /project
    id: install
  - exec:
      commandLine: npm start
      component: runtime
      group:
        isDefault: true
        kind: run
      workingDir: /project
    id: run
  - exec:
      commandLine: npm run debug
      component: runtime
      group:
        isDefault: true
        kind: debug
      workingDir: /project
    id: debug
  - exec:
      commandLine: npm test
      component: runtime
      group:
        isDefault: true
        kind: test
      workingDir: /project
    id: test
  - exec:
      commandLine: echo Hello world; sleep 65; echo Bye
      component: runtime
    id: deploy-exec
  - id: deploy
    composite:
      commands:
        - deploy-exec
      group:
        kind: deploy
        isDefault: true
components:
  - container:
      endpoints:
        - name: http-3000
          targetPort: 3000
      image: registry.access.redhat.com/ubi8/nodejs-14:latest
      memoryLimit: 1024Mi
      mountSources: true
      sourceMapping: /project
    name: runtime
metadata:
  description: Stack with Node.js 14
  displayName: Node.js Runtime
  icon: https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg
  language: javascript
  name: nodejs-prj1-api-abhz
  projectType: nodejs
  tags:
    - NodeJS
    - Express
    - ubi8
  version: 1.0.1
schemaVersion: 2.2.0
starterProjects:
  - git:
      remotes:
        origin: https://github.com/odo-devfiles/nodejs-ex.git
    name: nodejs-starter
variables:
  CONTAINER_IMAGE: quay.io/unknown-account/myimage

[valaparthvi]

I cannot seem to reproduce this.

[feloy]

I cannot seem to reproduce this.

My bad, I cannot reproduce it either today.

[feloy]

Thanks @valaparthvi for this work

[feloy]

[FAILED] [33.509 seconds]
odo dev command tests
/go/odo_1/tests/integration/cmd_dev_test.go:34
  when a component is bootstrapped and pushed
  /go/odo_1/tests/integration/cmd_dev_test.go:64
    when a delay is necessary for the component to start and running odo dev
    /go/odo_1/tests/integration/cmd_dev_test.go:494
      [It] should first fail then succeed querying endpoint
      /go/odo_1/tests/integration/cmd_dev_test.go:512

Unrelated failing test
/override Kubernetes-Integration-Tests/Kubernetes-Integration-Tests

[openshift-ci]

@feloy: Overrode contexts on behalf of feloy: Kubernetes-Integration-Tests/Kubernetes-Integration-Tests

In response to this:

[FAILED] [33.509 seconds]
odo dev command tests
/go/odo_1/tests/integration/cmd_dev_test.go:34
 when a component is bootstrapped and pushed
 /go/odo_1/tests/integration/cmd_dev_test.go:64
   when a delay is necessary for the component to start and running odo dev
   /go/odo_1/tests/integration/cmd_dev_test.go:494
     [It] should first fail then succeed querying endpoint
     /go/odo_1/tests/integration/cmd_dev_test.go:512

Unrelated failing test
/override Kubernetes-Integration-Tests/Kubernetes-Integration-Tests

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.