Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update devcontainer to bookworm container using rust-nightly #170

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

update devcontainer to bookworm container using rust-nightly #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7dafe2c
update devcontainer setting format
Vollbrecht Nov 4, 2023
a6bfb71
upgrade to bookworm rust nightly image
Vollbrecht Nov 4, 2023
5fa3067
only source file if espup installed
Vollbrecht Nov 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 25 additions & 29 deletions cargo/.devcontainer/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
ARG VARIANT=bullseye
FROM debian:${VARIANT}
FROM ghcr.io/rust-lang/rust:nightly-bookworm
ENV DEBIAN_FRONTEND=noninteractive
ENV LC_ALL=C.UTF-8
ENV LANG=C.UTF-8
Expand All @@ -10,47 +9,42 @@ ARG CONTAINER_GROUP=esp
ARG ESP_BOARD=all
ARG GITHUB_TOKEN

# Install dependencies
ARG RUST_INSTALL_DIR=/usr/local/cargo

# Install dependencies needed for esp-idf + clang for riscv rust
RUN apt-get update \
&& apt-get install -y git curl gcc clang ninja-build libudev-dev unzip xz-utils\
python3 python3-pip python3-venv libusb-1.0-0 libssl-dev pkg-config libpython2.7 \
&& apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts
&& apt-get install -y flex bison gperf python3-pip python3-venv cmake ninja-build ccache dfu-util clang \
&& apt-get clean -y \
&& rm -rf /var/lib/apt/lists/* /tmp/library-scripts

# Set users
RUN adduser --disabled-password --gecos "" ${CONTAINER_USER}
USER ${CONTAINER_USER}
WORKDIR /home/${CONTAINER_USER}

# Install rustup
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- \
--default-toolchain none -y --profile minimal

# Update envs
ENV PATH=${PATH}:/home/${CONTAINER_USER}/.cargo/bin

# Install extra crates
RUN ARCH=$($HOME/.cargo/bin/rustup show | grep "Default host" | sed -e 's/.* //') && \
curl -L "https://github.com/esp-rs/espup/releases/latest/download/espup-${ARCH}" -o "${HOME}/.cargo/bin/espup" && \
chmod u+x "${HOME}/.cargo/bin/espup" && \
curl -L "https://github.com/esp-rs/espflash/releases/latest/download/cargo-espflash-${ARCH}.zip" -o "${HOME}/.cargo/bin/cargo-espflash.zip" && \
unzip "${HOME}/.cargo/bin/cargo-espflash.zip" -d "${HOME}/.cargo/bin/" && \
rm "${HOME}/.cargo/bin/cargo-espflash.zip" && \
chmod u+x "${HOME}/.cargo/bin/cargo-espflash" && \
curl -L "https://github.com/esp-rs/embuild/releases/latest/download/ldproxy-${ARCH}.zip" -o "${HOME}/.cargo/bin/ldproxy.zip" && \
unzip "${HOME}/.cargo/bin/ldproxy.zip" -d "${HOME}/.cargo/bin/" && \
rm "${HOME}/.cargo/bin/ldproxy.zip" && \
chmod u+x "${HOME}/.cargo/bin/ldproxy" && \
Comment on lines -35 to -41
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see some value on having espflash or cargo-espflash installed, they offer subcomands like save-image that can be really helpful even in a container, and also the user would like to forward the usb-connection and flash from the container as you mentioned.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i am on board with it, i just stripped them in here with the mind of a potential container that is often build. If we follow that what i wrote on esp-rs/rust-lang issue i think it should be all included in both the all and the target specific images

curl -L "https://github.com/bjoernQ/esp-web-flash-server/releases/latest/download/web-flash-${ARCH}.zip" -o "${HOME}/.cargo/bin/web-flash.zip" && \
unzip "${HOME}/.cargo/bin/web-flash.zip" -d "${HOME}/.cargo/bin/" && \
rm "${HOME}/.cargo/bin/web-flash.zip" && \
chmod u+x "${HOME}/.cargo/bin/web-flash"
RUN ARCH=$(${RUST_INSTALL_DIR}/bin/rustup show | grep "Default host" | sed -e 's/.* //') && \
{% if arch != "riscv" -%}
curl -L "https://github.com/esp-rs/espup/releases/latest/download/espup-${ARCH}" -o "${RUST_INSTALL_DIR}/bin/espup" && \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{% if arch != "riscv" -%}
{% if arch == "xtensa" -%}

chmod u+x "${RUST_INSTALL_DIR}/bin/espup" && \
{% endif -%}
curl -L "https://github.com/esp-rs/embuild/releases/latest/download/ldproxy-${ARCH}.zip" -o "${RUST_INSTALL_DIR}/bin/ldproxy.zip" && \
unzip "${RUST_INSTALL_DIR}/bin/ldproxy.zip" -d "${RUST_INSTALL_DIR}/bin/" && \
rm "${RUST_INSTALL_DIR}/bin/ldproxy.zip" && \
chmod u+x "${RUST_INSTALL_DIR}/bin/ldproxy" && \
curl -L "https://github.com/bjoernQ/esp-web-flash-server/releases/latest/download/web-flash-${ARCH}.zip" -o "${RUST_INSTALL_DIR}/bin/web-flash.zip" && \
unzip "${RUST_INSTALL_DIR}/bin/web-flash.zip" -d "${RUST_INSTALL_DIR}/bin/" && \
rm "${RUST_INSTALL_DIR}/bin/web-flash.zip" && \
chmod u+x "${RUST_INSTALL_DIR}/bin/web-flash"

# Install Xtensa Rust
{% if arch != "riscv" -%}
RUN if [ -n "${GITHUB_TOKEN}" ]; then export GITHUB_TOKEN=${GITHUB_TOKEN}; fi \
&& ${HOME}/.cargo/bin/espup install\
&& ${RUST_INSTALL_DIR}/bin/espup install\
--targets "${ESP_BOARD}" \
--log-level debug \
--export-file /home/${CONTAINER_USER}/export-esp.sh
{% endif %}

# Set default toolchain
{% if arch == "riscv" -%}
Expand All @@ -59,7 +53,9 @@ RUN rustup default nightly
RUN rustup default esp
{% endif %}

{% if arch != "riscv" -%}
# Activate ESP environment
RUN echo "source /home/${CONTAINER_USER}/export-esp.sh" >> ~/.bashrc
{% endif %}

CMD [ "/bin/bash" ]
58 changes: 33 additions & 25 deletions cargo/.devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "{{ crate_name }}",
// Select between image and build propieties to pull or build the image.
// Select between image and build properties to pull or build the image.
// "image": "docker.io/espressif/idf-rust:{{ mcu }}_latest",
"build": {
"dockerfile": "Dockerfile",
Expand All @@ -10,35 +10,43 @@
"ESP_BOARD": "{{ mcu }}"
}
},
"settings": {
"editor.formatOnPaste": true,
"editor.formatOnSave": true,
"editor.formatOnSaveMode": "file",
"editor.formatOnType": true,
"lldb.executable": "/usr/bin/lldb",
"files.watcherExclude": {
"**/target/**": true
},
"rust-analyzer.checkOnSave.command": "clippy",
"rust-analyzer.checkOnSave.allTargets": false,
"[rust]": {
"editor.defaultFormatter": "rust-lang.rust-analyzer"
"runArgs": [
"--userns=keep-id" // needed for podman compatibility
],
"containerUser": "esp",
"customizations": {
"vscode": {
"settings": {
"editor.formatOnPaste": true,
"editor.formatOnSave": true,
"editor.formatOnSaveMode": "file",
"editor.formatOnType": true,
"lldb.executable": "/usr/bin/lldb",
"files.watcherExclude": {
"**/target/**": true
},
"rust-analyzer.checkOnSave.command": "clippy",
"rust-analyzer.checkOnSave.allTargets": false,
"[rust]": {
"editor.defaultFormatter": "rust-lang.rust-analyzer"
}
},
"extensions": [
"rust-lang.rust-analyzer",
"tamasfe.even-better-toml",
"serayuzgur.crates",
"mutantdino.resourcemonitor",
"yzhang.markdown-all-in-one",
"ms-vscode.cpptools",
"actboy168.tasks",
"Wokwi.wokwi-vscode"
]
}
},
"extensions": [
"rust-lang.rust-analyzer",
"tamasfe.even-better-toml",
"serayuzgur.crates",
"mutantdino.resourcemonitor",
"yzhang.markdown-all-in-one",
"ms-vscode.cpptools",
"actboy168.tasks",
"Wokwi.wokwi-vscode"
],
"forwardPorts": [
3333,
8000
],
"workspaceMount": "source=${localWorkspaceFolder},target=/home/esp/{{ crate_name }},type=bind,consistency=cached",
"workspaceFolder": "/home/esp/{{ crate_name }}"
}
}
Loading