👷 Migrate to GitHub Actions

AndreMiras · AndreMiras · commit f957aa75ccc7 · 2025-02-25T13:41:37.000+01:00
Also bump a few versions to get the CI to pass.
In future iterations we could bump more dependencies.

TODO:
- explain why we removed dependencies from the Makefile
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,57 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - tag: zbarcam-linux
+            dockerfile: dockerfiles/Dockerfile-linux
+            # TODO: debugging
+            command: "make test"
+            # command: "xeyes"
+          # TODO: debugging
+          # - tag: zbarcam-android
+          #   dockerfile: dockerfiles/Dockerfile-android
+          #   command: "buildozer android debug"
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Build Docker image
+        run: docker build --tag=${{ matrix.tag }} --file=${{ matrix.dockerfile }} --build-arg CI .
+
+      # - name: Run headless test
+      #   uses: coactions/setup-xvfb@v1
+      #   with:
+      #     run: docker run --env-file dockerfiles/env.list -v /tmp/.X11-unix:/tmp/.X11-unix ${{ matrix.tag }} ${{ matrix.command }}
+
+      # TODO
+      - name: Run Docker container
+        # TODO: try with :0 too
+        env:
+          DISPLAY: :1
+        run: |
+          # TODO
+          ls -la /tmp/
+          sudo apt update
+          sudo apt install xvfb x11-xserver-utils
+          sudo apt install mutter dbus-x11
+          dbus-launch --auto-syntax > dbus-env;
+          source dbus-env;
+          # try with x11/wayland
+          mutter --headless --virtual-monitor 1920x1080 &
+          # xhost +local:root
+          # docker run --env-file dockerfiles/env.list -v /tmp/.X11-unix:/tmp/.X11-unix ${{ matrix.tag }} ${{ matrix.command }}
+          xvfb-run --auto-servernum docker run --env-file dockerfiles/env.list -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=unix$DISPLAY ${{ matrix.tag }} ${{ matrix.command }}
+          # docker run --env-file dockerfiles/env.list -v /tmp/.X11-unix:/tmp/.X11-unix ${{ matrix.tag }} ${{ matrix.command }}
+          # docker run --env-file dockerfiles/env.list -v /tmp/.X11-unix:/tmp/.X11-unix ${{ matrix.tag }} ${{ matrix.command }}
+        # TODO: needed?
+        # timeout-minutes: 30
diff --git a/.travis.yml b/.travis.yml
diff --git a/Makefile b/Makefile
@@ -10,6 +10,7 @@ SOURCES=src/ tests/ setup.py setup_meta.py
 # using full path so it can be used outside the root dir
 SPHINXBUILD=$(shell realpath venv/bin/sphinx-build)
 DOCS_DIR=doc
+# TODO: remove
 SYSTEM_DEPENDENCIES= \
 	build-essential \
 	ccache \
@@ -20,7 +21,6 @@ SYSTEM_DEPENDENCIES= \
 	libsdl2-image-dev \
 	libsdl2-mixer-dev \
 	libsdl2-ttf-dev \
-	libpython3.7-dev \
 	libpython$(PYTHON_VERSION)-dev \
 	libzbar-dev \
 	pkg-config \
@@ -31,7 +31,7 @@ SYSTEM_DEPENDENCIES= \
 	virtualenv
 OS=$(shell lsb_release -si 2>/dev/null || uname)
 PYTHON_MAJOR_VERSION=3
-PYTHON_MINOR_VERSION=7
+PYTHON_MINOR_VERSION=10
 PYTHON_VERSION=$(PYTHON_MAJOR_VERSION).$(PYTHON_MINOR_VERSION)
 PYTHON_MAJOR_MINOR=$(PYTHON_MAJOR_VERSION)$(PYTHON_MINOR_VERSION)
 PYTHON_WITH_VERSION=python$(PYTHON_VERSION)
@@ -46,7 +46,8 @@ endif
 
 $(VIRTUAL_ENV):
 	$(PYTHON_WITH_VERSION) -m venv $(VIRTUAL_ENV)
-	$(PIP) install Cython==0.28.6
+	$(PIP) install --upgrade pip
+	$(PIP) install Cython==0.29.34
 	$(PIP) install -r requirements.txt
 
 virtualenv: $(VIRTUAL_ENV)
@@ -111,3 +112,4 @@ docker/run/app:
 
 docker/run/shell:
 	docker run --env-file dockerfiles/env.list -v /tmp/.X11-unix:/tmp/.X11-unix --device=/dev/video0:/dev/video0 -it --rm zbarcam-linux
+	docker run --env-file dockerfiles/env.list -v /tmp/.X11-unix:/tmp/.X11-unix --device=/dev/video0:/dev/video0 -it --rm --gpus all -e DISPLAY=unix$$DISPLAY zbarcam-linux
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # zbarcam
 
-[![Build Status](https://travis-ci.org/kivy-garden/zbarcam.svg?branch=develop)](https://travis-ci.org/kivy-garden/zbarcam)
+[![Tests](https://github.com/kivy-garden/zbarcam/actions/workflows/tests.yml/badge.svg)](https://github.com/kivy-garden/zbarcam/actions/workflows/tests.yml)
 [![Coverage Status](https://coveralls.io/repos/github/kivy-garden/zbarcam/badge.svg?branch=develop)](https://coveralls.io/github/kivy-garden/zbarcam?branch=develop)
 [![PyPI version](https://badge.fury.io/py/zbarcam.svg)](https://badge.fury.io/py/zbarcam)
 [![Documentation Status](https://readthedocs.org/projects/zbarcam/badge/?version=latest)](https://zbarcam.readthedocs.io/en/latest/?badge=latest)
diff --git a/dockerfiles/Dockerfile-linux b/dockerfiles/Dockerfile-linux
@@ -10,11 +10,12 @@
 #   docker run -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix zbarcam-linux 'make uitest'
 # Or for interactive shell:
 #   docker run -it --rm zbarcam-linux
-FROM ubuntu:18.04
+FROM ubuntu:22.04
 
 ENV USER="user"
 ENV HOME_DIR="/home/${USER}"
 ENV WORK_DIR="${HOME_DIR}"
+ENV PYTHON_VERSION="3.10"
 
 # configure locale
 RUN apt update -qq > /dev/null && apt install --yes --no-install-recommends \
@@ -24,11 +25,32 @@ ENV LANG="en_US.UTF-8" \
     LANGUAGE="en_US.UTF-8" \
     LC_ALL="en_US.UTF-8"
 
+# TODO: x11-apps for debugging
 # install system dependencies
 RUN apt install --yes --no-install-recommends \
+    build-essential \
+    ccache \
+    cmake \
+    curl \
+    git \
+    libpython${PYTHON_VERSION}-dev \
+    libsdl2-dev \
+    libsdl2-image-dev \
+    libsdl2-mixer-dev \
+    libsdl2-ttf-dev \
+    libzbar-dev \
     lsb-release \
     make \
-    sudo
+    pkg-config \
+    python${PYTHON_VERSION} \
+    python${PYTHON_VERSION}-dev \
+    python${PYTHON_VERSION}-venv \
+    sudo \
+    tox \
+    virtualenv
+
+RUN apt install --yes --no-install-recommends \
+    x11-apps
 
 # prepare non root env
 RUN useradd --create-home --shell /bin/bash ${USER}
@@ -42,5 +64,7 @@ USER ${USER}
 WORKDIR ${WORK_DIR}
 COPY . ${WORK_DIR}
 
-RUN sudo make system_dependencies && make virtualenv
-ENTRYPOINT ["./dockerfiles/start.sh"]
+# TODO
+# RUN sudo make system_dependencies && make virtualenv
+# RUN make virtualenv
+# ENTRYPOINT ["./dockerfiles/start.sh"]
diff --git a/requirements/requirements-base.txt b/requirements/requirements-base.txt
@@ -1,7 +1,7 @@
-Kivy==2.0.0rc2
+Kivy==2.1.0
 Kivy-Garden==0.1.4
-numpy==1.18.4
-opencv-python==4.2.0.34
+numpy==1.21.2
+opencv-python==4.7.0.72
 Pillow==8.2.0
 pyzbar==0.1.8
 xcamera==2019.928
diff --git a/setup.py b/setup.py
@@ -1,19 +1,23 @@
 import os
+import re
 
 from setuptools import find_namespace_packages, setup
 
-from src.kivy_garden.zbarcam import version
-
 
 def read(fname):
     with open(os.path.join(os.path.dirname(__file__), fname)) as f:
         return f.read()
 
 
+def get_version():
+    version_pattern = re.compile(r"__version__\s*=\s*['\"](.*?)['\"]")
+    return version_pattern.search("src/kivy_garden/zbarcam/version.py")
+
+
 # exposing the params so it can be imported
 setup_params = {
     'name': 'kivy_garden.zbarcam',
-    'version': version.__version__,
+    'version': get_version(),
     'description': 'Real time Barcode and QR Code scanner Edit',
     'long_description': read('README.md'),
     'long_description_content_type': 'text/markdown',
diff --git a/src/kivy_garden/zbarcam/__init__.py b/src/kivy_garden/zbarcam/__init__.py
@@ -1,15 +1,4 @@
 """
 Exposes `ZBarCam` directly in `zbarcam` rather than `zbarcam.zbarcam`.
-Also note this may break `pip` since all imports within `zbarcam.py` would be
-required at setup time. This is because `version.py` (same directory) is used
-by the `setup.py` file.
-Hence we're not exposing `ZBarCam` if `pip` is detected.
 """
-import os
-
-project_dir = os.path.abspath(
-    os.path.join(__file__, os.pardir, os.pardir, os.pardir, os.pardir))
-using_pip = os.path.basename(project_dir).startswith('pip-')
-# only exposes `ZBarCam` if not within `pip` ongoing install
-if not using_pip:
-    from .zbarcam import ZBarCam  # noqa
+from .zbarcam import ZBarCam  # noqa
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = pep8,isort-check,py36,py37
+envlist = pep8,isort-check,py310
 # no setup.py to be ran
 skipsdist = True
 
