Skip to content

Add support for devfile postStart event in Workspaces

MRs:

Description

As a Workspaces user, I want the postStart hook in the devfile standard to be supported.

See devfile docs for postStart object and events.

See the "Current Planned Solution" section in the epic (Startup scripts for Remote Development workspac... (&15602)) for full context and details.

NOTE: Preliminary refactor MRs were performed as part of Refactorings to workspace container/script logic (#511503 - closed)

Acceptance Criteria

  • postStart entries in devfile are executed when the container to which they are bound is successfully started.
  • Either support all valid devfile schema postStart options, e.g. workingDir as per https://devfile.io/docs/2.3.0/adding-event-bindings, or else document they are not supported, and add validation to prevent their usage. See related comment.
  • User-defined postStart commands should have a validation steps added to the steps of the ".../workspace_operations/create" ROP chain. This should attempt to validate, as much as possible, that all user-defined postStart commands are valid bash commands
  • Middle-of-testing-pyramid integration tests are added/updated at ee/spec/lib/remote_development/workspace_operations/reconcile/main_integration_spec.rb
  • Update the fixture devfile that contains all of the possible devfile entries

Technical Requirements

See details in "Current Planned Solution" section in the epic (Startup scripts for Remote Development workspac... (&15602))

We should also either support all valid devfile schema postStart options, e.g. workingDir as per https://devfile.io/docs/2.3.0/adding-event-bindings, or else document they are not supported, and add validation to prevent their usage. See related comment.

Design Requirements

N/A - no UI changes, the only UX change is the addition of support for the postStart event in Workspace devfiles.

Impact Assessment

See the epic (Startup scripts for Remote Development workspac... (&15602)

Edited by 🤖 GitLab Bot 🤖