feat: add vscode devcontainer definition

[reubenmiller]

Signed-off-by: Reuben Miller reuben.miller@softwareag.com

Proposed changes

Add a (VSCode) dev container definition which makes it easier for developers to develop by providing all of the project dependencies.

The dev container is an optional feature which enables VSCode users to start developing quickly as the dev containers includes all of the dependencies required to build/debug/run the project. It is currently only applicable for VSCode users, however the dev container definition contains a plain Dockerfile and docker-compose.yml that lists the dependencies making it easier for other IDE users to read and replicate in their applicable environments.

To use a dev container locally on your machine, the following dependencies are required:

• VSCode
• VSCode Dev Containers extension. Alternatively the Remote Development extension pack can be installed
• docker (e.g. Windows can install docker-ce under WSL2 and MacOS can utilize colima)
• docker-compose

Alternatively, GitHub has a feature called Codespaces which also reads the dev container definition to launch a browser based IDE directly from GitHub.

The following is included in the dev container definition:

• Rust dependencies
• Configures docker from docker (to support calling the host docker from inside the dev container)
• Install test dependencies (notably nodejs)
• Systemd enabled environment
• VSCode extensions which are useful for the project (e.g. Rust and python (for tests) extensions)
• VSCode settings

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
• Documentation Update (if none of the other choices apply)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

Checklist

• I have read the CONTRIBUTING doc
• I have signed the CLA (in all commits with git commit -s)
• I ran cargo fmt as mentioned in CODING_GUIDELINES
• I used cargo clippy as mentioned in CODING_GUIDELINES
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

[reubenmiller]

I added some docs to explain how to use the dev container (and install docker)

[albinsuresh]

You could just reference the other INSTALLING_DOCKER.md doc here.

[reubenmiller]

Yeah you're right...I thought I updated this (I hope I didn't force push over the changes, as I swear I did link to the INSTALLAING_DOCKER.md before...I will prepare another PR.

[albinsuresh]

Now that it's merged, this line can be removed.

[albinsuresh]

Suggested change

	This guide is to assist with the installation of docker and some of the docker. It is not meant to replace other online articles but more of a cheat sheet to getting your setup up and running as fast as possible. If you encounter issues with the setup, please search online for a fix.
	This guide is to assist with the installation of docker and some of the docker cli tools. It is not meant to replace other online articles but more of a cheat sheet to getting your setup up and running as fast as possible. If you encounter issues with the setup, please search online for a fix.