Save PROJECT_SOURCE for containers mounting source

[maysunfaisal]

Signed-off-by: Maysun J Faisal maysunaneek@gmail.com

/kind feature

What does does this PR do / why we need it:

• Introduces an env, PROJECT_SOURCE to all component containers that mount sources
• devfile can now use PROJECT_SOURCE which holds the project path in a container
• PROJECT_SOURCE value depends upon container's sourceMapping & project's clonePath
• Updated GetSyncFolder() logic for devfile containing more than one project ie; the first project is now selected
• New and updated tests
• Updated public docs about env
• PROJECTS_ROOT & PROJECT_SOURCE are reserved, check Should PROJECTS_ROOT and PROJECT_SOURCE be reserved environment variables? devfile/api#132

Which issue(s) this PR fixes:

Fixes #3781

PR acceptance criteria:

• Unit test

• Integration test

• Documentation

• I have read the test guidelines

How to test changes / Special notes to the reviewer:

• push odo component by varying number of projects, project's clonePath and container's sourceMapping
• PROJECT_SOURCE cannot be explicitly mentioned in the devfile

schemaVersion: 2.0.0
metadata:
  name: java-springboot
  version: 1.1.0
# projects:
#   - name: myproj1
#     # clonePath: myapp1/
#     git:
#       remotes:
#         origin: https://github.com/odo-devfiles/springboot-ex
#   - name: myproj2
#     clonePath: myapp2/
#     git:
#       remotes:
#         origin: https://github.com/odo-devfiles/springboot-ex
starterProjects:
- name: springbootproject
  git:
    remotes:
      origin: https://github.com/odo-devfiles/springboot-ex.git
components:
- name: tools
  container:
    endpoints:
    - name: 8080-tcp
      targetPort: 8080
    - exposure: public
      path: /
      name: myjava
      targetPort: 8080
      protocol: http
    image: quay.io/eclipse/che-java11-maven:nightly
    memoryLimit: 768Mi
    mountSources: true
    volumeMounts:
    - name: m2
      path: /home/user/.m2
    # env:
    # - name: PROJECTS_ROOT
    #   value: /mycustom/path/
- name: dummy
  container:
    image: quay.io/eclipse/che-java11-maven:nightly
    memoryLimit: 768Mi
    mountSources: true
    sourceMapping: /test
    command: ['tail']
    args: [ '-f', '/dev/null']
    # env:
    # - name: PROJECT_SOURCE
    #   value: /mycustom/path/
- name: m2
  volume:
    size: 3Gi
commands:
- exec:
    commandLine: mvn clean -Dmaven.repo.local=/home/user/.m2/repository package -Dmaven.test.skip=true
    workingDir: ${PROJECT_SOURCE}
    component: tools
    group:
      isDefault: true
      kind: build
  id: build
- exec:
    commandLine: mvn -Dmaven.repo.local=/home/user/.m2/repository spring-boot:run
    workingDir: ${PROJECT_SOURCE}
    component: tools
    group:
      isDefault: true
      kind: run
  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
  id: debug

[openshift-ci-robot]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[codecov]

Codecov Report

Merging #3979 into master will increase coverage by 0.11%.
The diff coverage is 88.46%.

@@            Coverage Diff             @@
##           master    #3979      +/-   ##
==========================================
+ Coverage   43.17%   43.29%   +0.11%     
==========================================
  Files         146      147       +1     
  Lines       12338    12411      +73     
==========================================
+ Hits         5327     5373      +46     
- Misses       6445     6470      +25     
- Partials      566      568       +2     

Impacted Files	Coverage Δ
pkg/devfile/adapters/common/utils.go	94.23% <ø> (ø)
pkg/testingutil/devfile.go	0.00% <0.00%> (ø)
pkg/devfile/adapters/kubernetes/utils/utils.go	80.66% <86.66%> (+21.34%)	⬆️
pkg/devfile/validate/components.go	93.10% <100.00%> (+1.10%)	⬆️
pkg/devfile/validate/errors.go	43.75% <100.00%> (+3.75%)	⬆️
pkg/sync/adapter.go	76.64% <100.00%> (ø)
pkg/component/component.go	21.48% <0.00%> (-1.22%)	⬇️
pkg/envinfo/envinfo.go	41.54% <0.00%> (-0.30%)	⬇️
pkg/component/pushed_component.go	47.36% <0.00%> (ø)
pkg/devfile/parser/representation.go
... and 3 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b3c126d...a35bc65. Read the comment docs.

[maysunfaisal]

@adisky @johnmcollier Could you pls help review the PR? thx!

[johnmcollier]

Do we need this if we also have https://github.com/openshift/odo/pull/3979/files#diff-ab356982336b3424cbe588733e4259ffR39?

[maysunfaisal]

Yeah I thought about this. But I was wondering if for some reason, devfile parse validation changes in the future and it removed the env check; then we'd somehow allow this when creating a container. So put it as double fail safe. I know its redundant but i can remove it, if you feel strongly

[johnmcollier]

IMO, we just need the one check for now to avoid having duplicate code (and code that won't get triggered currently), and if anyone overhauls the validation code in the future, it's their responsibility to make sure the check for PROJECT_SOURCE still occurs

But I'm totally flexible either way, TBH. I can see where you're coming from.

[maysunfaisal]

With devfile parser being extracted out soon, would we want to validate this at the parser level or push level? 🤔

[johnmcollier]

At the parser level in my opinion, so the validation should be kept there as well.

Modifying PROJECT_SOURCE isn't valid at the devfile spec level, so it makes sense to have the check there

[johnmcollier]

Opened devfile/api#132 for discussion too, FYI.

Your point about moving out the devfile parser reminded me that we don't really have anything in the spec right now that says PROJECT_SOURCE can't be overridden.

[maysunfaisal]

/retest

[adisky]

@maysunfaisal Tried it out working well, code wise also looks good.
/lgtm

[girishramnani]

/approve

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: girishramnani

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [girishramnani]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment