<div dir="ltr">Acked-by: Jeremy Spweock <<a href="mailto:jspweock@iol.unh.edu" target="_blank">jspweock@iol.unh.edu</a>> </div> <div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Feb 9, 2023 at 11:49 AM Patrick Robb <<a href="mailto:probb@iol.unh.edu">probb@iol.unh.edu</a>> wrote: </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div dir="ltr"> </div> <div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, Nov 4, 2022 at 5:16 AM Juraj Linkeš <juraj.linkes@pantheon.tech> wrote: </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Adding folks I forgot to add. > -----Original Message----- > From: Juraj Linkeš <juraj.linkes@pantheon.tech> > Sent: Thursday, November 3, 2022 2:47 PM > Cc: <a href="mailto:dev@dpdk.org" target="_blank">dev@dpdk.org</a>; Juraj Linkeš <juraj.linkes@pantheon.tech> > Subject: [PATCH v1] dts: add Dockerfile > > The Dockerfile defines development and CI runner images. > > Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech> > --- > dts/.devcontainer/devcontainer.json | 30 ++++++++++++++++ > dts/Dockerfile | 38 ++++++++++++++++++++ > dts/README.md | 55 +++++++++++++++++++++++++++++ > 3 files changed, 123 insertions(+) > create mode 100644 dts/.devcontainer/devcontainer.json > create mode 100644 dts/Dockerfile > create mode 100644 dts/README.md > > diff --git a/dts/.devcontainer/devcontainer.json > b/dts/.devcontainer/devcontainer.json > new file mode 100644 > index 0000000000..41ca28fc17 > --- /dev/null > +++ b/dts/.devcontainer/devcontainer.json > @@ -0,0 +1,30 @@ > +// For format details, see <a href="https://aka.ms/devcontainer.json" rel="noreferrer" target="_blank">https://aka.ms/devcontainer.json</a>. For config > options, see the README at: > +// > +<a href="https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/contai" rel="noreferrer" target="_blank">https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/contai</a> > +ners/docker-existing-dockerfile > +{ > + "name": "Existing Dockerfile", > + > + // Sets the run context to one level up instead of the .devcontainer > folder. > + "context": "..", > + > + // Update the 'dockerFile' property if you aren't using the standard > 'Dockerfile' filename. > + "dockerFile": "../Dockerfile", > + > + // Use 'forwardPorts' to make a list of ports inside the container > available locally. > + // "forwardPorts": [], > + > + // Uncomment the next line to run commands after the container is > created - for example installing curl. > + "postCreateCommand": "poetry install", > + > + "extensions": [ > + "ms-python.vscode-pylance", > + ] > + > + // Uncomment when using a ptrace-based debugger like C++, Go, > and Rust > + // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", > +"seccomp=unconfined" ], > + > + // Uncomment to use the Docker CLI from inside the container. See > <a href="https://aka.ms/vscode-remote/samples/docker-from-docker" rel="noreferrer" target="_blank">https://aka.ms/vscode-remote/samples/docker-from-docker</a>. > + // "mounts": [ > +"source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ], > + > + // Uncomment to connect as a non-root user if you've added one. > See <a href="https://aka.ms/vscode-remote/containers/non-root" rel="noreferrer" target="_blank">https://aka.ms/vscode-remote/containers/non-root</a>. > + // "remoteUser": "vscode" > +} > diff --git a/dts/Dockerfile b/dts/Dockerfile new file mode 100644 index > 0000000000..9a91949eeb > --- /dev/null > +++ b/dts/Dockerfile > @@ -0,0 +1,38 @@ > +# SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2022 University > +of New Hampshire > + > +# There are two Docker images defined in this Dockerfile. > +# One is to be used in CI for automated testing. > +# The other provides a DTS development environment, simplifying Python > dependency management. > + > +FROM ubuntu:22.04 AS base > + > +RUN apt-get -y update && apt-get -y upgrade && \ > + apt-get -y install --no-install-recommends \ > + python3 \ > + python3-pip \ > + python3-pexpect \ > + python3-poetry \ > + python3-cachecontrol \ > + openssh-client > +WORKDIR /dpdk/dts > + > + > +FROM base AS runner > + > +# This image is intended to be used as the base for automated systems. > +# It bakes DTS into the image during the build. > + > +COPY . /dpdk/dts > +RUN poetry install --no-dev > + > +CMD ["poetry", "run", "python", "main.py"] > + > +FROM base AS dev > + > +# This image is intended to be used as DTS development environment. It > +doesn't need C compilation # capabilities, only Python dependencies. > +Once a container mounting DTS using this image is running, # the > dependencies should be installed using Poetry. > + > +RUN apt-get -y install --no-install-recommends \ > + vim emacs git > diff --git a/dts/README.md b/dts/README.md new file mode 100644 index > 0000000000..fd9f32595c > --- /dev/null > +++ b/dts/README.md > @@ -0,0 +1,55 @@ > +# DTS Environment > +The execution and development environments for DTS are the same, a > +[Docker](<a href="https://docs.docker.com/" rel="noreferrer" target="_blank">https://docs.docker.com/</a>) container defined by our > [Dockerfile](./Dockerfile). > +Using a container for the development environment helps with a few > things. > + > +1. It helps enforce the boundary between the DTS environment and the > TG/SUT, something > + which caused issues in the past. > +2. It makes creating containers to run DTS inside automated tooling much > easier, since > + they can be based off of a known-working environment that will be > updated as DTS is. > +3. It abstracts DTS from the server it is running on. This means that the bare- > metal os > + can be whatever corporate policy or your personal preferences dictate, > and DTS does > + not have to try to support all distros that are supported by DPDK CI. > +4. It makes automated testing for DTS easier, since new dependencies > +can be sent in with > + the patches. > +5. It fixes the issue of undocumented dependencies, where some test > suites require > + python libraries that are not installed. > +6. Allows everyone to use the same python version easily, even if they are > using a > + distribution or Windows with out-of-date packages. > +7. Allows you to run the tester on Windows while developing via Docker for > Windows. > + > +## Tips for setting up a development environment > + > +### Getting a docker shell > +These commands will give you a bash shell inside the container with all > +the python dependencies installed. This will place you inside a python > +virtual environment. DTS is mounted via a volume, which is essentially a > symlink from the host to the container. > +This enables you to edit and run inside the container and then delete > +the container when you are done, keeping your work. > + > +```shell > +docker build --target dev -t dpdk-dts . > +docker run -v $(pwd)/..:/dpdk -it dpdk-dts bash $ poetry install $ > +poetry shell ``` > + > +### Vim/Emacs > +Any editor in the ubuntu repos should be easy to use, with vim and > +emacs already installed. You can add your normal config files as a > +volume, enabling you to use your preferred settings. > + > +```shell > +docker run -v ${HOME}/.vimrc:/root/.vimrc -v $(pwd)/..:/dpdk -it > +dpdk-dts bash ``` > + > +### Visual Studio Code > +VSCode has first-class support for developing with containers. You may > +need to run the non-docker setup commands in the integrated terminal. > +DTS contains a .devcontainer config, so if you open the folder in > +vscode it should prompt you to use the dev container assuming you have > +the plugin installed. Please refer to [VS Development Containers > +Docs](<a href="https://code.visualstudio.com/docs/remote/containers" rel="noreferrer" target="_blank">https://code.visualstudio.com/docs/remote/containers</a>) > +to set it all up. > + > +### Other > +Searching for '$IDE dev containers' will probably lead you in the right > direction. > -- > 2.30.2 </blockquote></div>Tested-by: Patrick Robb <<a href="mailto:probb@iol.unh.edu" target="_blank">probb@iol.unh.edu</a>> <div> </div>-- <div dir="ltr"><div dir="ltr">Patrick RobbTechnical Service ManagerUNH InterOperability Laboratory21 Madbury Rd, Suite 100, Durham, NH 03824<a href="http://www.iol.unh.edu/" style="color:rgb(17,85,204)" target="_blank">www.iol.unh.edu</a> <img src="https://lh4.googleusercontent.com/7sTY8VswXadak_YT0J13osh5ockNVRX2BuYaRsKoTTpkpilBokA0WlocYHLB4q7XUgXNHka6-ns47S8R_am0sOt7MYQQ1ILQ3S-P5aezsrjp3-IsJMmMrErHWmTARNgZhpAx06n2" width="150" height="37" style="border: none;"></div></div></div> </blockquote></div>