Dev Container

The Visual Studio Dev Containers extension lets you use a Docker container as a full-featured development environment.

With this setup it is easy to reproduce a similar state to what Jenkins is doing in our continuous integration.

Available Containers

We added three images that are used by the continuous integration used to compile or test the pull requests on github.com/OpenModelica/OpenMOdelica.

• build-deps-v1.16.4: Default build image to compile OpenModelica.
• cache-bionic-cmake-3.17.2: Build image used to compile OpenModelica with CMake.
• fmuchecker: Image with FMU checker to test generated FMUs.

Usage in Visual Studio Code

Make sure you have Dev Containers extension ms-vscode-remote.remote-containers and Docker installed and running.

Open command pallet (Strg+Shift+P) and run >Dev Containers: Open Folder in Container..., select the OpenModelica directory. Then select a devcontainer.json file to start.

New Dev Container

Check directory ../.CI/ for more Dockerfiles used by Jenkins and construct your own dev container in a similar way.

For more details check https://containers.dev/implementors/json_reference/.

Adding VSCode Extensions

Use customizations in devcontainer.json to add more extensions to your dev container.

Caveats

• The images need an additional Dockerfile to add an non-root user with your user name and UID.
• Running Docker images with a different architecture than the host system can have poor performance or don't work at all. E.g. running an arm image on x86_64.
• Because on Windows and Unix the environment variable containing the user name are different and only one should be set both are added to devcontainer.json: If your user name isn't correct replace

  -"${localEnv:USER}${localEnv:USERNAME}"
  +"username"