Refactor tests

* Use pytest-aiohttp
* Use the async def / await syntax.
* Fix tests to run with Python 3.8

tests/compute/virtualbox/test_virtualbox_manager.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2015 GNS3 Technologies Inc.
+# Copyright (C) 2020 GNS3 Technologies Inc.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -20,8 +20,6 @@ import pytest
 import tempfile
 import os
 import stat
-import asyncio
-
 
 from unittest.mock import patch
 
@@ -31,19 +29,22 @@ from tests.utils import asyncio_patch
 
 
 @pytest.fixture
-def manager(port_manager):
+async def manager(loop, port_manager):
+
     m = VirtualBox.instance()
     m.port_manager = port_manager
     return m
 
 
 def test_vm_invalid_vboxmanage_path(manager):
+
     with patch("gns3server.config.Config.get_section_config", return_value={"vboxmanage_path": "/bin/test_fake"}):
         with pytest.raises(VirtualBoxError):
             manager.find_vboxmanage()
 
 
 def test_vm_non_executable_vboxmanage_path(manager):
+
     tmpfile = tempfile.NamedTemporaryFile()
     with patch("gns3server.config.Config.get_section_config", return_value={"vboxmanage_path": tmpfile.name}):
         with pytest.raises(VirtualBoxError):
@@ -51,27 +52,28 @@ def test_vm_non_executable_vboxmanage_path(manager):
 
 
 def test_vm_invalid_executable_name_vboxmanage_path(manager, tmpdir):
+
     path = str(tmpdir / "vpcs")
     with open(path, "w+") as f:
         f.write(path)
     os.chmod(path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
-    tmpfile = tempfile.NamedTemporaryFile()
     with patch("gns3server.config.Config.get_section_config", return_value={"vboxmanage_path": path}):
         with pytest.raises(VirtualBoxError):
             manager.find_vboxmanage()
 
 
 def test_vboxmanage_path(manager, tmpdir):
+
     path = str(tmpdir / "VBoxManage")
     with open(path, "w+") as f:
         f.write(path)
     os.chmod(path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
-    tmpfile = tempfile.NamedTemporaryFile()
     with patch("gns3server.config.Config.get_section_config", return_value={"vboxmanage_path": path}):
         assert manager.find_vboxmanage() == path
 
 
-def test_list_vms(manager, loop):
+async def test_list_vms(manager):
+
     vm_list = ['"Windows 8.1" {27b4d095-ff5f-4ac4-bb9d-5f2c7861c1f1}',
                '"Carriage',
                'Return" {27b4d095-ff5f-4ac4-bb9d-5f2c7861c3f3}',
@@ -83,7 +85,6 @@ def test_list_vms(manager, loop):
         if cmd == "list":
             return vm_list
         else:
-            print(args)
             if args[0] == "27b4d095-ff5f-4ac4-bb9d-5f2c7861c1f1":
                 return ["memory=512"]
             elif args[0] == "ccd8c50b-c172-457d-99fa-dd69371ede0e":
@@ -92,7 +93,7 @@ def test_list_vms(manager, loop):
 
     with asyncio_patch("gns3server.compute.virtualbox.VirtualBox.execute") as mock:
         mock.side_effect = execute_mock
-        vms = loop.run_until_complete(asyncio.ensure_future(manager.list_vms()))
+        vms = await manager.list_vms()
     assert vms == [
         {"vmname": "Windows 8.1", "ram": 512},
         {"vmname": "Linux Microcore 4.7.1", "ram": 256}

tests/compute/virtualbox/test_virtualbox_vm.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2015 GNS3 Technologies Inc.
+# Copyright (C) 2020 GNS3 Technologies Inc.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -26,30 +26,34 @@ from gns3server.compute.virtualbox import VirtualBox
 
 
 @pytest.fixture
-def manager(port_manager):
+def manager(loop, port_manager):
+
     m = VirtualBox.instance()
     m.port_manager = port_manager
     return m
 
 
 @pytest.fixture(scope="function")
-def vm(project, manager):
-    return VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager, "test", False)
+def vm(compute_project, manager):
+
+    return VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", compute_project, manager, "test", False)
 
 
-def test_vm(project, manager):
-    vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager, "test", False)
+def test_vm(compute_project, manager):
+
+    vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", compute_project, manager, "test", False)
     assert vm.name == "test"
     assert vm.id == "00010203-0405-0607-0809-0a0b0c0d0e0f"
     assert vm.vmname == "test"
 
 
-def test_rename_vmname(project, manager, async_run):
+async def test_rename_vmname(compute_project, manager):
     """
     Rename a VM is not allowed when using a running linked clone
     or if the vm already exists in Vbox
     """
-    vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager, "test", False)
+
+    vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", compute_project, manager, "test", False)
     vm.manager.list_vms = AsyncioMagicMock(return_value=[{"vmname": "Debian"}])
     vm._linked_clone = True
     vm._modify_vm = AsyncioMagicMock()
@@ -57,42 +61,46 @@ def test_rename_vmname(project, manager, async_run):
     # Vm is running
     vm._node_status = "started"
     with pytest.raises(VirtualBoxError):
-        async_run(vm.set_vmname("Arch"))
+        await vm.set_vmname("Arch")
     assert not vm._modify_vm.called
 
     vm._node_status = "stopped"
 
     # Name already use
     with pytest.raises(VirtualBoxError):
-        async_run(vm.set_vmname("Debian"))
+        await vm.set_vmname("Debian")
     assert not vm._modify_vm.called
 
     # Work
-    async_run(vm.set_vmname("Arch"))
+    await vm.set_vmname("Arch")
     assert vm._modify_vm.called
 
 
-def test_vm_valid_virtualbox_api_version(loop, project, manager):
+async def test_vm_valid_virtualbox_api_version(compute_project, manager):
+
     with asyncio_patch("gns3server.compute.virtualbox.VirtualBox.execute", return_value=["API version:  4_3"]):
-        vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager, "test", False)
+        vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", compute_project, manager, "test", False)
         vm._uuid = "00010203-0405-0607-0809-0a0b0c0d0e0f"
-        loop.run_until_complete(asyncio.ensure_future(vm.create()))
+        await vm.create()
 
 
-def test_vm_invalid_virtualbox_api_version(loop, project, manager):
+async def test_vm_invalid_virtualbox_api_version(compute_project, manager):
+
     with asyncio_patch("gns3server.compute.virtualbox.VirtualBox.execute", return_value=["API version:  4_2"]):
         with pytest.raises(VirtualBoxError):
-            vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager, "test", False)
-            loop.run_until_complete(asyncio.ensure_future(vm.create()))
+            vm = VirtualBoxVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", compute_project, manager, "test", False)
+            await vm.create()
 
 
-def test_vm_adapter_add_nio_binding_adapter_not_exist(loop, vm, manager, free_console_port):
+async def test_vm_adapter_add_nio_binding_adapter_not_exist(vm, manager, free_console_port):
+
     nio = manager.create_nio({"type": "nio_udp", "lport": free_console_port, "rport": free_console_port, "rhost": "127.0.0.1"})
     with pytest.raises(VirtualBoxError):
-        loop.run_until_complete(asyncio.ensure_future(vm.adapter_add_nio_binding(15, nio)))
+        await vm.adapter_add_nio_binding(15, nio)
 
 
 def test_json(vm, tmpdir, project):
+
     assert vm.__json__()["node_directory"] is None
     project._path = str(tmpdir)
     vm._linked_clone = True
@@ -100,12 +108,14 @@ def test_json(vm, tmpdir, project):
 
 
 def test_patch_vm_uuid(vm):
+
     xml = """<?xml version="1.0"?>
     <VirtualBox xmlns="http://www.virtualbox.org/" version="1.16-macosx">
         <Machine uuid="{f8138a63-e361-49ee-a5a4-ba0559bc00e2}" name="Debian-1" OSType="Debian_64" currentSnapshot="{8bd00b14-4c14-4992-a165-cb09e80fe8e4    }" snapshotFolder="Snapshots" lastStateChange="2016-10-28T12:54:26Z">
         </Machine>
     </VirtualBox>
     """
+
     os.makedirs(os.path.join(vm.working_dir, vm._vmname), exist_ok=True)
     with open(vm._linked_vbox_file(), "w+") as f:
         f.write(xml)
@@ -117,6 +127,7 @@ def test_patch_vm_uuid(vm):
 
 
 def test_patch_vm_uuid_with_corrupted_file(vm):
+
     xml = """<?xml version="1.0"?>
     <VirtualBox>
     """