Merge pull request #286 from xcp-ng/mypy

Fixes mypy support

Author: ydirson

.github/workflows/jobs-check.yml

@@ -19,3 +19,21 @@ jobs:
       run: cp data.py-dist data.py
     - name: jobs-check
       run: ./jobs.py check
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements/base.txt
+        pip install mypy
+    - name: Create a dummy data.py
+      run: cp data.py-dist data.py
+    - name: Check with mypy
+      run: mypy lib/ tests/

data.py-dist

@@ -1,3 +1,5 @@
+from typing import Any, Dict
+
 # Configuration file, to be adapted to one's needs
 
 # Default user and password to connect to a host through XAPI
@@ -15,7 +17,7 @@ HOST_DEFAULT_PASSWORD = ""
 # skip_xo_config allows to not touch XO's configuration regarding the host
 # Else the default behaviour is to add the host to XO servers at the beginning
 # of the testing session and remove it at the end.
-HOSTS = {
+HOSTS: Dict[str, Dict[str, Any]] = {
 #    "10.0.0.1": {"user": "root", "password": ""},
 #    "testhost1": {"user": "root", "password": "", 'skip_xo_config': True},
 }
@@ -106,44 +108,44 @@ DEFAULT_SR = 'default'
 CACHE_IMPORTED_VM = False
 
 # Default NFS device config:
-NFS_DEVICE_CONFIG = {
+NFS_DEVICE_CONFIG: Dict[str, Dict[str, str]] = {
 #    'server': '10.0.0.2', # URL/Hostname of NFS server
 #    'serverpath': '/path/to/shared/mount' # Path to shared mountpoint
 }
 
 # Default NFS4+ only device config:
-NFS4_DEVICE_CONFIG = {
+NFS4_DEVICE_CONFIG: Dict[str, Dict[str, str]] = {
 #    'server': '10.0.0.2', # URL/Hostname of NFS server
 #    'serverpath': '/path_to_shared_mount' # Path to shared mountpoint
 #    'nfsversion': '4.1'
 }
 
 # Default NFS ISO device config:
-NFS_ISO_DEVICE_CONFIG = {
+NFS_ISO_DEVICE_CONFIG: Dict[str, Dict[str, str]] = {
 #    'location': '10.0.0.2:/path/to/shared/mount' # URL/Hostname of NFS server and path to shared mountpoint
 }
 
 # Default CIFS ISO device config:
-CIFS_ISO_DEVICE_CONFIG = {
+CIFS_ISO_DEVICE_CONFIG: Dict[str, Dict[str, str]] = {
 #    'location': r'\\10.0.0.2\<shared folder name>',
 #    'username': '<user>',
 #    'cifspassword': '<password>',
 #    'type': 'cifs',
 #    'vers': '<1.0> or <3.0>'
 }
 
-CEPHFS_DEVICE_CONFIG = {
+CEPHFS_DEVICE_CONFIG: Dict[str, Dict[str, str]] = {
 #    'server': '10.0.0.2',
 #    'serverpath': '/vms'
 }
 
-MOOSEFS_DEVICE_CONFIG = {
+MOOSEFS_DEVICE_CONFIG: Dict[str, Dict[str, str]] = {
 #    'masterhost': 'mfsmaster',
 #    'masterport': '9421',
 #    'rootpath': '/vms'
 }
 
-LVMOISCSI_DEVICE_CONFIG = {
+LVMOISCSI_DEVICE_CONFIG: Dict[str, Dict[str, str]] = {
 #    'target': '192.168.1.1',
 #    'port': '3260',
 #    'targetIQN': 'target.example',

jobs.py

@@ -28,7 +28,7 @@
             "tests/snapshot",
             "tests/system",
             "tests/xapi",
-            "tests/xapi-plugins",
+            "tests/xapi_plugins",
         ],
         "markers": "(small_vm or no_vm) and not flaky and not reboot and not complex_prerequisites",
     },
@@ -333,7 +333,7 @@
         "params": {
             "--vm": "single/small_vm_unix_tools",
         },
-        "paths": ["tests/guest-tools/unix"],
+        "paths": ["tests/guest_tools/unix"],
         "markers": "",
     },
     "tools-unix-multi": {
@@ -347,7 +347,7 @@
         "params": {
             "--vm[]": "multi/tools_unix",
         },
-        "paths": ["tests/guest-tools/unix"],
+        "paths": ["tests/guest_tools/unix"],
         "markers": "multi_vms",
     },
     "tools-windows": {
@@ -360,7 +360,7 @@
         "params": {
             "--vm[]": "multi/tools_windows",
         },
-        "paths": ["tests/guest-tools/win"],
+        "paths": ["tests/guest_tools/win"],
         "markers": "multi_vms",
     },
     "xen": {
@@ -429,7 +429,7 @@
         # This test needs 2 hosts that can be from the same pool
         "nb_pools": 1,
         "params": {},
-        "paths": ["tests/fs-diff"],
+        "paths": ["tests/fs_diff"],
     },
 }
 

lib/efi.py

@@ -122,7 +122,7 @@ def get_secure_boot_guid(variable: str) -> GUID:
         'KEK': global_variable_guid,
         'db': image_security_database_guid,
         'dbx': image_security_database_guid,
-    }.get(variable)
+    }[variable]
 
 
 def cert_to_efi_sig_list(cert):
@@ -149,7 +149,7 @@ def cert_to_efi_sig_list(cert):
     )
 
 
-def certs_to_sig_db(certs):
+def certs_to_sig_db(certs) -> bytes:
     """Returns a signature database from a list cert file paths."""
     if isinstance(certs, str):
         certs = [certs]
@@ -380,7 +380,7 @@ def copy(cls, other, name=None):
 
         return obj
 
-    def _get_efi_signature_list(self) -> str:
+    def _get_efi_signature_list(self) -> bytes:
         if self.is_null:
             return b''
 

lib/vm.py

@@ -387,7 +387,7 @@ def sign_efi_bins(self, db: efi.EFIAuth):
                 signed = db.sign_image(local_bin)
                 self.scp(signed, remote_bin)
 
-    def set_efi_var(self, var: str, guid: str, attrs: bytes, data: bytes):
+    def set_efi_var(self, var: str, guid: efi.GUID, attrs: bytes, data: bytes):
         """Sets the data and attrs for an EFI variable and GUID."""
         assert len(attrs) == 4