Add .dockerignore file

Adds a dockerignore file instructs docker to skip copying several
unnecessary files and directories into the docker image. Aside from
prevented unnecessary image bloat, it also improves image build caching
since the skipped files are the ones likely to change between builds.
The .git directory is excluded, which means that the labgrid version
must be passed as a build argument since it cannot be determined by
setup.py automatically.

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>

.dockerignore

@@ -0,0 +1,25 @@
+*.pyc
+*__pycache__
+*console_main
+.*.swp
+.cache
+/MANIFEST
+.tox
+/.#tox.ini
+/.eggs/README.txt
+*.egg
+*.egg-info
+/venv*
+/build
+/doc/.build
+/doc/modules
+/.coverage
+/dist
+/.pytest_cache/
+/htmlcov/
+/.idea
+*/__pycache__
+
+/dockerfiles/
+!/dockerfiles/exporter/entrypoint.sh
+.git/

.github/workflows/docker.yml

@@ -9,6 +9,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Install system dependencies
+      run: |
+        sudo apt install -yq python3-pip
+        python3 -m pip install --upgrade pip setuptools wheel
     - name: Login to DockerHub
       uses: docker/login-action@v1
       with:

.github/workflows/unit-tests.yml

@@ -63,6 +63,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Install system dependencies
+      run: |
+        sudo apt install -yq python3-pip
+        python3 -m pip install --upgrade pip setuptools wheel
     - name: Build docker images
       run: |
         ./dockerfiles/build.sh

dockerfiles/Dockerfile

@@ -18,12 +18,13 @@ RUN set -e ;\
 # Client
 #
 FROM labgrid-base AS labgrid-client
+ARG VERSION
 
 RUN set -e ;\
     cd /opt/labgrid ;\
     pip3 install yq ;\
     pip3 install --no-cache-dir -r requirements.txt ;\
-    python3 setup.py install ;\
+    SETUPTOOLS_SCM_PRETEND_VERSION="$VERSION" python3 setup.py install ;\
     apt update -q=2 ;\
     apt install -q=2 --yes --no-install-recommends microcom openssh-client sshpass rsync jq qemu-system; \
     apt clean ;\
@@ -35,13 +36,14 @@ CMD ["/bin/bash"]
 # Coordinator
 #
 FROM labgrid-base AS labgrid-coordinator
+ARG VERSION
 
 ENV CROSSBAR_DIR=/opt/crossbar
 
 RUN set -e ;\
     cd /opt/labgrid ;\
     pip3 install --no-cache-dir -r crossbar-requirements.txt ;\
-    python3 setup.py install
+    SETUPTOOLS_SCM_PRETEND_VERSION="$VERSION" python3 setup.py install
 
 VOLUME /opt/crossbar
 
@@ -101,13 +103,14 @@ RUN cd /src && \
 # Exporter
 #
 FROM labgrid-base AS labgrid-exporter
+ARG VERSION
 
 COPY dockerfiles/exporter/entrypoint.sh /entrypoint.sh
 
 RUN set -e ;\
     cd /opt/labgrid ;\
     pip3 install --no-cache-dir -r requirements.txt ;\
-    python3 setup.py install ;\
+    SETUPTOOLS_SCM_PRETEND_VERSION="$VERSION" python3 setup.py install ;\
     apt update -q=2 ;\
     apt install -q=2 --yes --no-install-recommends \
         libyaml-0-2 \

dockerfiles/build.sh

@@ -4,6 +4,9 @@ set -ex
 
 export DOCKER_BUILDKIT=1
 
+VERSION="$(./setup.py --version | tail -1)"
+
 for t in client exporter coordinator; do
-    docker build --target labgrid-${t} -t labgrid-${t} -f dockerfiles/Dockerfile .
+    docker build --build-arg VERSION="$VERSION" \
+        --target labgrid-${t} -t labgrid-${t} -f dockerfiles/Dockerfile .
 done