fix: auto-mount path collisions

[akurinnoy]

What does this PR do?

This PR makes DWO handle auto-mount path collisions and fails the workspace with the error message.

What issues does this PR fix or reference?

fixes #1194

Is it tested? How?

PR Checklist

• E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)
  • v8-devworkspace-operator-e2e: DevWorkspace e2e test
  • v8-che-happy-path: Happy path for verification integration with Che

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: akurinnoy
Once this PR has been reviewed and has the lgtm label, please assign dkwon17 for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

• OWNERS

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

[dkwon17]

Thank you for the PR @akurinnoy ,

Could we do the collision check here?

devworkspace-operator/pkg/provision/automount/projected.go

Line 42 in 5864a64

mountPathToVolumeMounts[volumeMount.MountPath] = append(mountPathToVolumeMounts[volumeMount.MountPath], volumeMount)

Right now, if there is a collision, it fails silently because it overwrites the existing value of the map

[dkwon17]

This is the case I tested this PR with:

kind: ConfigMap
apiVersion: v1
metadata:
  name: my-configmap-mount-1
  namespace: devworkspace-controller
  labels:
    controller.devfile.io/mount-to-devworkspace: 'true'
    controller.devfile.io/watch-configmap: 'true'
  annotations:
    controller.devfile.io/mount-path: /home/user/hello-world
data:
  myfile: this is my file

and:

kind: ConfigMap
apiVersion: v1
metadata:
  name: my-configmap-mount-2
  namespace: devworkspace-controller
  labels:
    controller.devfile.io/mount-to-devworkspace: 'true'
    controller.devfile.io/watch-configmap: 'true'
  annotations:
    controller.devfile.io/mount-path: /home/user/hello-world
data:
  myfile: this is my file 2

And I was able to start the workspace successfully.

However, I was able to get it working if I add this annotation:

controller.devfile.io/mount-as: subpath

[akurinnoy]

/test v8-devworkspace-operator-e2e, v8-che-happy-path

[openshift-ci]

@akurinnoy: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test v14-che-happy-path

/test v14-devworkspace-operator-e2e

/test v14-images

Use /test all to run the following jobs that were automatically triggered:

pull-ci-devfile-devworkspace-operator-main-v14-devworkspace-operator-e2e

pull-ci-devfile-devworkspace-operator-main-v14-images

In response to this:

/test v8-devworkspace-operator-e2e, v8-che-happy-path

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-sigs/prow repository.

[akurinnoy]

/test v14-che-happy-path

[openshift-ci]

@akurinnoy: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/v14-che-happy-path	e6cca33	link	true	/test v14-che-happy-path

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.