Merge User Booking API Rev 1 (Try 3)

Signed-off-by: Sawyer Bergeron <sbergeron@iol.unh.edu>
Change-Id: Ie1eee0a59929f8da39f16bb6bc17ae3de4f1cba9
Signed-off-by: Sawyer Bergeron <sbergeron@iol.unh.edu>

2 files changed, 26 insertions, 13 deletions

diff --git a/src/resource_inventory/resource_manager.py b/src/resource_inventory/resource_manager.py
index 9406977..37bf33c 100644
--- a/src/resource_inventory/resource_manager.py
+++ b/src/resource_inventory/resource_manager.py
@@ -6,20 +6,28 @@
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
+from __future__ import annotations
+
 import re
+from typing import Optional
 from django.db.models import Q
 
 from dashboard.exceptions import ResourceAvailabilityException
 
 from resource_inventory.models import (
+    Resource,
     ResourceBundle,
     ResourceTemplate,
+    ResourceConfiguration,
     Network,
     Vlan,
     PhysicalNetwork,
     InterfaceConfiguration,
 )
 
+from account.models import Lab
+from django.contrib.auth.models import User
+
 
 class ResourceManager:
 
@@ -29,19 +37,19 @@ class ResourceManager:
         pass
 
     @staticmethod
-    def getInstance():
+    def getInstance() -> ResourceManager:
         if ResourceManager.instance is None:
             ResourceManager.instance = ResourceManager()
         return ResourceManager.instance
 
-    def getAvailableResourceTemplates(self, lab, user=None):
+    def getAvailableResourceTemplates(self, lab: Lab, user: Optional[User] = None) -> list[ResourceTemplate]:
         filter = Q(public=True)
         if user:
             filter = filter | Q(owner=user)
         filter = filter & Q(temporary=False) & Q(lab=lab)
         return ResourceTemplate.objects.filter(filter)
 
-    def templateIsReservable(self, resource_template):
+    def templateIsReservable(self, resource_template: ResourceTemplate):
         """
         Check if the required resources to reserve this template is available.
 
@@ -63,13 +71,16 @@ class ResourceManager:
         return True
 
     # public interface
-    def deleteResourceBundle(self, resourceBundle):
+    def deleteResourceBundle(self, resourceBundle: ResourceBundle):
         raise NotImplementedError("Resource Bundle Deletion Not Implemented")
 
-    def releaseResourceBundle(self, resourceBundle):
+    def releaseResourceBundle(self, resourceBundle: ResourceBundle):
         resourceBundle.release()
 
-    def get_vlans(self, resourceTemplate):
+    def get_vlans(self, resourceTemplate: ResourceTemplate) -> dict[str, int]:
+        """
+        returns: dict from network name to the associated vlan number (backend vlan id)
+        """
         networks = {}
         vlan_manager = resourceTemplate.lab.vlan_manager
         for network in resourceTemplate.networks.all():
@@ -84,7 +95,7 @@ class ResourceManager:
                 networks[network.name] = vlans[0]
         return networks
 
-    def instantiateTemplate(self, resource_template):
+    def instantiateTemplate(self, resource_template: ResourceTemplate):
         """
         Convert a ResourceTemplate into a ResourceBundle.
 
@@ -113,16 +124,18 @@ class ResourceManager:
 
         return resource_bundle
 
-    def configureNetworking(self, resource_bundle, resource, vlan_map):
+    def configureNetworking(self, resource_bundle: ResourceBundle, resource: Resource, vlan_map: dict[str, int]):
+        """
+        @vlan_map: dict from network name to the associated vlan number (backend vlan id)
+        """
         for physical_interface in resource.interfaces.all():
-            # assign interface configs
 
-            iface_configs = InterfaceConfiguration.objects.filter(
+            # assign interface configs
+            iface_config = InterfaceConfiguration.objects.get(
                 profile=physical_interface.profile,
                 resource_config=resource.config
             )
 
-            iface_config = iface_configs.first()
             physical_interface.acts_as = iface_config
             physical_interface.acts_as.save()
 
@@ -143,7 +156,7 @@ class ResourceManager:
                 )
 
     # private interface
-    def acquireHost(self, resource_config):
+    def acquireHost(self, resource_config: ResourceConfiguration) -> Resource:
         resources = resource_config.profile.get_resources(
             lab=resource_config.template.lab,
             unreserved=True
diff --git a/src/resource_inventory/urls.py b/src/resource_inventory/urls.py
index a008176..a9a4d43 100644
--- a/src/resource_inventory/urls.py
+++ b/src/resource_inventory/urls.py
@@ -29,7 +29,7 @@ from django.conf.urls import url
 from resource_inventory.views import HostView, hostprofile_detail_view
 
 
-app_name = "resource"
+app_name = 'resource'
 urlpatterns = [
     url(r'^hosts$', HostView.as_view(), name='hosts'),
     url(r'^profiles/(?P<hostprofile_id>.+)/$', hostprofile_detail_view, name='host_detail'),