Skip to content

Commit

Permalink
VSCode : Enable Development inside Docker Container
Browse files Browse the repository at this point in the history
This will enable seamless Development of optee_os Project with VSCode
inside Docker container.

The VSCode Container provides:

* Automatic Mapping of the host user UID/GID inside the container
* GCC Cross-Compilers (aarch64/armhf/riscv64)
* GDB Multiarch for Debugging
* Remote SSH on the Target with seamless ssh mapping of the Host
  inside the container (Linux/Windows WSL)
* Git and Git Extensions to work and send Patches

Note: This require Docker installation for Linux/or Windows :
      [1] https://docs.docker.com/engine/install

      VSCode Extensions (extensions.json) will be recommended
      for the installation

For more Information :
[2] https://code.visualstudio.com/docs/devcontainers/containers
[3] https://www.youtube.com/watch?v=C_5tDWsWSj0
[4] https://www.youtube.com/watch?v=b1RavPr_878

Signed-off-by: Ayoub Zaki <[email protected]>
Acked-by: Jerome Forissier <[email protected]>
  • Loading branch information
embetrix authored and jforissier committed Nov 29, 2024
1 parent 461cf00 commit 9f34db3
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .devcontainer/Dockerfile.vscode
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
FROM ubuntu:22.04

ENV DEBIAN_FRONTEND=noninteractive
RUN apt update && apt upgrade -y && apt-get install -y \
build-essential \
autoconf \
bc \
bison \
ccache \
clang \
lld \
cmake \
codespell \
device-tree-compiler \
expect \
flex \
gcc-aarch64-linux-gnu \
gcc-arm-linux-gnueabihf \
gcc-riscv64-linux-gnu \
gdb-multiarch \
gdisk \
gettext \
libncurses5 \
libssl-dev \
lsb-release \
python3 \
python3-pip \
python3-cryptography \
python3-pycodestyle \
python3-pycryptodome \
python3-pyelftools \
sudo \
uuid-dev \
wget \
curl \
git-core \
git-man \
git-email \
sudo \
nano \
vim \
openssh-client \
bash-completion

# Add non root user
RUN useradd -ms /bin/bash optee
RUN echo "optee ALL=(ALL) NOPASSWD: ALL" | tee -a /etc/sudoers
USER optee
29 changes: 29 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "optee-os-docker",
"build": {
"dockerfile": "Dockerfile.vscode"
},

"customizations": {
"vscode": {
"settings": {
"terminal.integrated.profiles.linux": {
"bash": {
"path": "/bin/bash",
"args": ["-l"]
}
},
"terminal.integrated.defaultProfile.linux": "bash"
},
"extensions": [
"ms-vscode.cpptools",
"eamodio.gitlens"
]
}
},

// Map the host .ssh folder into the container for a seamless ssh experience
"mounts": [
"source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/optee/.ssh,type=bind,consistency=cached"
]
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@
!.gitattributes
!.gitignore
!.github
!.devcontainer
!.vscode
10 changes: 10 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"recommendations": [
"ms-vscode-remote.remote-containers",
"ms-vscode-remote.remote-wsl",
"ms-vscode-remote.vscode-remote-extensionpack",
"ms-vscode.cpptools-extension-pack",
"ms-vscode.cpptools",
"eamodio.gitlens",
]
}

0 comments on commit 9f34db3

Please sign in to comment.