tests: convert tests from python-nose to pytest

- As python-nose is deprecated, move all tests to pytest.
- Add tox to run the tests.
- Add flake8 as linter
- Run tox during CI.
- Let the HTTP server return Content-Length for tests.
  As otherwise tests are broken since newer OpenSSL version [1]

[1]: curl/curl#13389

Signed-off-by: Jean-Louis Dupond <jean-louis@dupond.be>

Author: dupondje

.github/workflows/build.yaml

@@ -55,7 +55,7 @@ jobs:
             libxml2-devel \
             libxslt-devel \
             python3-devel \
-            python3-nose \
+            python3-nose2 \
             python3-pip \
             python3-pycurl \
             python3-pygments \

.github/workflows/tests.yaml

@@ -0,0 +1,64 @@
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - name: centos-stream-9
+            shortcut: c9s
+            container-name: el9stream
+            packages:
+              - gcc
+              - libxml2-devel
+              - python3
+              - python3-pip
+              - python3-devel
+              - python3-setuptools
+              - python3.11
+              - python3.11-pip
+              - python3.11-devel
+              - python3.11-setuptools
+              - python3.12
+              - python3.12-pip
+              - python3.12-devel
+              - python3.12-setuptools
+          - name: centos-stream-10
+            shortcut: c10s
+            container-name: el10stream
+            packages:
+              - gcc
+              - libxml2-devel
+              - python3
+              - python3-pip
+              - python3-devel
+              - python3-setuptools
+
+    name: ${{ matrix.name }}
+
+    container:
+      image: quay.io/ovirt/buildcontainer:${{ matrix.container-name }}
+
+    steps:
+      - name: Checkout sources
+        uses: ovirt/checkout-action@main
+
+      - name: Install dependencies
+        run: |
+          dnf install -y ${{ join(matrix.packages, ' ') }}
+          python -m venv /venv
+          source /venv/bin/activate
+          python3 -m pip install tox
+      
+      - name: Run tests
+        run: |
+          source /venv/bin/activate
+          tox

.gitignore

@@ -2,4 +2,10 @@
 PKG-INFO
 setup.py
 version.py
-lib/ovirtsdk4/__pycache__/
+__pycache__
+.tox
+/build
+/dist
+*.so
+.vscode
+*.egg-info

lib/ovirtsdk4/__init__.py

@@ -689,7 +689,7 @@ def _get_sso_response(self, url, params=''):
 
         # Prepare headers:
         header_lines = [
-            'User-Agent: PythonSDK/%s' % version.VERSION,
+            'User-Agent: PythonSDK/%s' % get_version(),
             'Accept: application/json'
         ]
         curl.setopt(pycurl.HTTPHEADER, header_lines)

setup.cfg

@@ -1,2 +1,2 @@
-[nosetests]
-where=tests
+[unittest]
+start-dir = tests

tests/server.py

@@ -24,10 +24,10 @@
 import ssl
 
 try:
-  from http.server import HTTPServer, BaseHTTPRequestHandler
+  from http.server import HTTPServer
   from http.server import SimpleHTTPRequestHandler
 except ImportError:
-  from BaseHTTPServer import HTTPServer, BaseHTTPRequestHandler
+  from BaseHTTPServer import HTTPServer
   from SimpleHTTPServer import SimpleHTTPRequestHandler
 
 from threading import Thread
@@ -100,15 +100,21 @@ def _handle_request(handler):
 
             authorization = handler.headers.get('Authorization')
             if authorization != "Bearer %s" % self.TOKEN:
+                data = '401  - Unauthorized'.encode('utf-8')
+
                 handler.send_response(401)
-                handler.wfile.write('')
+                handler.send_header('Content-Length', len(data))
+                handler.end_headers()
+                handler.wfile.write()
             else:
+                data = body.encode('utf-8')
+
                 sleep(delay)
                 handler.send_response(code)
                 handler.send_header('Content-Type', 'application/xml')
+                handler.send_header('Content-Length', len(data))
                 handler.end_headers()
 
-                data = body.encode('utf-8')
                 handler.wfile.write(data)
 
         TestHandler.handlers[
@@ -117,21 +123,27 @@ def _handle_request(handler):
 
     def set_json_response(self, path, code, body):
         def _handle_request(handler):
+            data = json.dumps(body, ensure_ascii=False).encode('utf-8')
+
             handler.send_response(code)
             handler.send_header('Content-Type', 'application/json')
+            handler.send_header('Content-Length', len(data))
             handler.end_headers()
 
-            data = json.dumps(body, ensure_ascii=False).encode('utf-8')
             handler.wfile.write(data)
 
         TestHandler.handlers[path] = _handle_request
 
     def start_server(self, host='localhost'):
         self._httpd = HTTPServer((self.host(), self.port()), TestHandler)
-        self._httpd.socket = ssl.wrap_socket(
-            self._httpd.socket,
-            keyfile=self.__absolute_path('%s.key' % host),
+        context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
+        context.minimum_version = ssl.TLSVersion.TLSv1_2
+        context.load_cert_chain(
             certfile=self.__absolute_path('%s.crt' % host),
+            keyfile=self.__absolute_path('%s.key' % host)
+        )
+        self._httpd.socket = context.wrap_socket(
+            self._httpd.socket,
             server_side=True
         )
         # Path handler for username/password authentication service:
@@ -168,7 +180,7 @@ def port(self):
                 try:
                     server = HTTPServer(
                         (self.host(), port),
-                        BaseHTTPRequestHandler
+                        TestHandler
                     )
                     self.PORT = port
                     break

tests/test_affinity_group_reader.py

@@ -19,10 +19,6 @@
 import ovirtsdk4.types as types
 
 from io import BytesIO
-from nose.tools import (
-    assert_equals,
-    assert_true,
-)
 from ovirtsdk4.readers import AffinityGroupReader
 from ovirtsdk4.xml import XmlReader
 
@@ -48,13 +44,10 @@ def test_affinity_group_reader_with_assigned_vms():
     result = AffinityGroupReader.read_one(reader)
     reader.close()
 
-    assert_true(isinstance(result, types.AffinityGroup))
-    assert_true(len(result.vms) > 0)
-    assert_equals(
-        result.vms.href,
-        '/ovirt-engine/api/clusters/123/affinitygroups/456/vms'
-    )
-    assert_equals(result.vms[0].id, '123')
+    assert isinstance(result, types.AffinityGroup)
+    assert len(result.vms) > 0
+    assert result.vms.href == '/ovirt-engine/api/clusters/123/affinitygroups/456/vms'
+    assert result.vms[0].id == '123'
 
 
 def test_affinity_group_reader_with_assigned_vms_no_order():
@@ -72,10 +65,7 @@ def test_affinity_group_reader_with_assigned_vms_no_order():
     result = AffinityGroupReader.read_one(reader)
     reader.close()
 
-    assert_true(isinstance(result, types.AffinityGroup))
-    assert_true(len(result.vms) > 0)
-    assert_equals(
-        result.vms.href,
-        '/ovirt-engine/api/clusters/123/affinitygroups/456/vms'
-    )
-    assert_equals(result.vms[0].id, '123')
+    assert isinstance(result, types.AffinityGroup)
+    assert len(result.vms) > 0
+    assert result.vms.href == '/ovirt-engine/api/clusters/123/affinitygroups/456/vms'
+    assert result.vms[0].id == '123'

tests/test_check_types.py

@@ -19,12 +19,7 @@
 import ovirtsdk4.services as services
 import ovirtsdk4.types as types
 import unittest
-
-from nose.tools import (
-    assert_in,
-    assert_raises,
-)
-from .server import TestServer
+import pytest
 
 
 class CheckTypesTest(unittest.TestCase):
@@ -35,20 +30,20 @@ def test_service_type_error(self):
         generates an informative exception.
         """
         vm_service = services.VmService(None, None)
-        with assert_raises(TypeError) as context:
+        with pytest.raises(TypeError) as context:
             vm_service.start(
                 use_cloud_init='true',
                 vm=types.Disk(),
             )
-        message = str(context.exception)
-        assert_in(
+        message = str(context.value)
+        assert (
             "The 'use_cloud_init' parameter should be of type 'bool', "
-            "but it is of type 'str'",
+            "but it is of type 'str'" in
             message
         )
-        assert_in(
+        assert (
             "The 'vm' parameter should be of type 'Vm', but it is of "
-            "type 'Disk'",
+            "type 'Disk'" in
             message
         )
 
@@ -58,11 +53,11 @@ def test_locator_type_error(self):
         generates an informative exception.
         """
         vms_service = services.VmsService(None, None)
-        with assert_raises(TypeError) as context:
+        with pytest.raises(TypeError) as context:
             vms_service.vm_service(types.Vm())
-        message = str(context.exception)
-        assert_in(
+        message = str(context.value)
+        assert (
             "The 'id' parameter should be of type 'str', but it is of "
-            "type 'Vm'.",
+            "type 'Vm'." in
             message
         )

tests/test_cluster_reader.py

@@ -19,11 +19,6 @@
 import ovirtsdk4.types as types
 
 from io import BytesIO
-from nose.tools import (
-    assert_equals,
-    assert_is_none,
-    assert_true,
-)
 from ovirtsdk4.readers import ClusterReader
 from ovirtsdk4.xml import XmlReader
 
@@ -49,9 +44,9 @@ def test_cluster_with_no_rng_sources_and_switch_type():
     result = ClusterReader.read_one(reader)
     reader.close()
 
-    assert_true(isinstance(result, types.Cluster))
-    assert_equals(result.required_rng_sources, [])
-    assert_equals(result.switch_type, types.SwitchType.LEGACY)
+    assert isinstance(result, types.Cluster)
+    assert result.required_rng_sources == []
+    assert result.switch_type == types.SwitchType.LEGACY
 
 
 
@@ -67,5 +62,5 @@ def test_unsupported_switch_type_dont_raise_exception():
     result = ClusterReader.read_one(reader)
     reader.close()
 
-    assert_true(isinstance(result, types.Cluster))
-    assert_is_none(result.switch_type)
+    assert isinstance(result, types.Cluster)
+    assert result.switch_type is None

tests/test_cluster_service.py

@@ -18,10 +18,6 @@
 
 import unittest
 
-from nose.tools import (
-    assert_is_not_none,
-    assert_equal,
-)
 from .server import TestServer
 
 
@@ -44,25 +40,25 @@ def test_get_service(self):
         """
         Check that reference to clusters service is not none
         """
-        assert_is_not_none(self.clusters_service)
+        assert self.clusters_service is not None
 
     def test_get_list_of_clusters(self):
         """
         Test returning empty clusters list
         """
         self.server.set_xml_response("clusters", 200, "<clusters/>")
         clusters = self.clusters_service.list()
-        assert_is_not_none(clusters)
-        assert_equal(clusters, [])
+        assert clusters is not None
+        assert clusters == []
 
     def test_get_list_of_clusters_with_search(self):
         """
         Test returning empty clusters list
         """
         self.server.set_xml_response("clusters", 200, "<clusters/>")
         clusters = self.clusters_service.list(search="name=ugly")
-        assert_is_not_none(clusters)
-        assert_equal(clusters, [])
+        assert clusters is not None
+        assert clusters == []
 
     def test_get_cluster_by_id(self):
         """
@@ -75,5 +71,5 @@ def test_get_cluster_by_id(self):
             body="<cluster id=\"123\"><name>testcluster</name></cluster>"
         )
         cluster = self.clusters_service.cluster_service("123").get()
-        assert_equal(cluster.id, "123")
-        assert_equal(cluster.name, "testcluster")
+        assert cluster.id == "123"
+        assert cluster.name == "testcluster"