Make Labcontroller compatible with Python 2 and Python 3

.github/workflows/review-checks.yml

@@ -45,6 +45,7 @@ jobs:
 
   integration-tests:
     runs-on: ubuntu-latest
+    timeout-minutes: 30
     env:
       MYSQL_USER: beaker
       MYSQL_PASSWORD: beaker
@@ -125,3 +126,68 @@ jobs:
           # Disable Selenium tests until we have plan for selenium driver + firefox
           rm -rf src/bkr/inttest/server/selenium
           ./run-tests.sh -v ${{ matrix.test-target }}
+
+  unit-tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    container:
+      image: ${{ matrix.os-target.name }}
+      options: --init
+    strategy:
+      fail-fast: false
+      matrix:
+        test-target:
+          - Common
+          - Client
+          - LabController
+        os-target:
+          - name: centos:7
+          - name: quay.io/centos/centos:stream8
+            additional_repo: "powertools"
+          - name: quay.io/centos/centos:stream9
+            additional_repo: "crb"
+            # After fixing the names of unit test functions, migrate to the latest
+          - name: fedora:38
+    steps:
+      - name: Set BKR_PY3 environment variable
+        run: echo "BKR_PY3=1" >> $GITHUB_ENV
+        if: matrix.os-target.name != 'centos:7'
+
+      - name: Install DNF and plugins
+        run: yum install -y dnf 'dnf-command(builddep)' 'dnf-command(config-manager)'
+
+      - name: Enable additional repositories
+        run: |
+          IFS=', ' read -r -a repos <<< "${{ matrix.os-target.additional_repo }}"
+          for repo in "${repos[@]}"; do
+            dnf config-manager --set-enabled $repo
+          done
+
+      # Do not upgrade to @v4 as node 20 is incompatible with CentOS 7
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Add Beaker Server YUM repository
+        if: matrix.os-target.name == 'centos:7'
+        run: |
+          curl -o /etc/yum.repos.d/beaker-server.repo https://beaker-project.org/yum/beaker-server-RedHatEnterpriseLinux.repo
+
+      - name: Use EPEL
+        if: matrix.os-target.name != 'centos:7' && !startsWith(matrix.os-target.name, 'fedora:')
+        run: |
+          dnf install -y epel-release
+
+      # Build dependencies must be sufficient, the same is done during RPM build
+      - name: Install Beaker dependency from specfile
+        run: |
+          dnf builddep -y *.spec
+
+      - name: Show Python Environment
+        if: matrix.os-target.name != 'centos:7'
+        run: |
+          python3 -m pip freeze
+
+      - name: Run unit tests
+        run: |
+          pushd ${{ matrix.test-target }}
+          ./run-tests.sh

Common/bkr/common/helpers.py

@@ -12,6 +12,8 @@
 import os
 import fcntl
 import errno
+
+import six
 from six.moves import queue
 
 log = getLogger(__name__)
@@ -100,12 +102,20 @@ def run(self):
             self.finished.clear()
 
 
-class SensitiveUnicode(unicode):
+class SensitiveUnicode(six.text_type):
+    """The intent of this class is to standardize the behavior of Unicode strings across Python 2 and 3,
+    while treating the contents of the string as sensitive.
+
+    In Python 2, it encodes the unicode string to bytes (str), wrapped in SensitiveStr.
+    In Python 3, it preserves the unicode representation (str) by overriding the default 'encode' behavior.
+    """
     def __repr__(self):
         return '<repr blocked>'
 
     def encode(self, *args, **kwargs):
-        return SensitiveStr(super(SensitiveUnicode, self).encode(*args, **kwargs))
+        if six.PY2:
+            return SensitiveStr(super(SensitiveUnicode, self).encode(*args, **kwargs))
+        return self
 
 
 class SensitiveStr(str):
@@ -235,6 +245,10 @@ def siphon(src, dest):
         chunk = src.read(4096)
         if not chunk:
             break
+
+        if six.PY3 and isinstance(chunk, bytes):
+            chunk = chunk.decode('utf-8')
+
         dest.write(chunk)
 
 

LabController/Makefile

@@ -4,17 +4,25 @@
 # the Free Software Foundation; either version 2 of the License, or
 # (at your option) any later version.
 
+BKR_PY3 ?= 0
+COMMAND := python2
+
+ifeq ($(BKR_PY3),1)
+	COMMAND := python3
+endif
+
+
 .PHONY: build
 build:
-	python2 setup.py build
+	$(COMMAND) setup.py build
 
 .PHONY: install
 install: build
-	python2 setup.py install -O1 --skip-build --root $(DESTDIR)
+	$(COMMAND) setup.py install -O1 --skip-build --root $(DESTDIR)
 
 .PHONY: clean
 clean:
-	python2 setup.py clean
+	$(COMMAND) setup.py clean
 	rm -rf build
 
 .PHONY: check