Merge "Enhance PDF/IDF Support"

6 files changed, 315 insertions, 181 deletions

diff --git a/src/booking/quick_deployer.py b/src/booking/quick_deployer.py
index dd78f15..8a81d18 100644
--- a/src/booking/quick_deployer.py
+++ b/src/booking/quick_deployer.py
@@ -33,6 +33,7 @@ from resource_inventory.models import (
     OPNFVConfig
 )
 from resource_inventory.resource_manager import ResourceManager
+from resource_inventory.pdf_templater import PDFTemplater
 from notifier.manager import NotificationHandler
 from booking.models import Booking
 from dashboard.exceptions import (
@@ -291,7 +292,7 @@ def create_from_form(form, request):
     booking.start = timezone.now()
     booking.end = timezone.now() + timedelta(days=int(length))
     booking.resource = resource_bundle
-    booking.pdf = ResourceManager().makePDF(booking.resource)
+    booking.pdf = PDFTemplater.makePDF(booking.resource)
     booking.config_bundle = cbundle
     booking.save()
     users_field = users_field[2:-2]
diff --git a/src/resource_inventory/pdf_templater.py b/src/resource_inventory/pdf_templater.py
new file mode 100644
index 0000000..9f7e7f1
--- /dev/null
+++ b/src/resource_inventory/pdf_templater.py
@@ -0,0 +1,173 @@
+##############################################################################
+# Copyright (c) 2018 Parker Berberian, Sawyer Bergeron, and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+
+from django.template.loader import render_to_string
+import booking
+from resource_inventory.models import Host, InterfaceProfile
+
+
+class PDFTemplater:
+    """
+    Utility class to create a full PDF yaml file
+    """
+
+    @classmethod
+    def makePDF(cls, resource):
+        """
+        fills the pod descriptor file template with info about the resource
+        """
+        template = "dashboard/pdf.yaml"
+        info = {}
+        info['details'] = cls.get_pdf_details(resource)
+        info['jumphost'] = cls.get_pdf_jumphost(resource)
+        info['nodes'] = cls.get_pdf_nodes(resource)
+
+        return render_to_string(template, context=info)
+
+    @classmethod
+    def get_pdf_details(cls, resource):
+        """
+        Info for the "details" section
+        """
+        details = {}
+        owner = "Anon"
+        email = "email@mail.com"
+        resource_lab = resource.template.lab
+        lab = resource_lab.name
+        location = resource_lab.location
+        pod_type = "development"
+        link = "https://wiki.opnfv.org/display/INF/Pharos+Laas"
+
+        try:
+            # try to get more specific info that may fail, we dont care if it does
+            booking_owner = booking.models.Booking.objects.get(resource=resource).owner
+            owner = booking_owner.username
+            email = booking_owner.userprofile.email_addr
+        except Exception:
+            pass
+
+        details['contact'] = email
+        details['lab'] = lab
+        details['link'] = link
+        details['owner'] = owner
+        details['location'] = location
+        details['type'] = pod_type
+
+        return details
+
+    @classmethod
+    def get_pdf_jumphost(cls, resource):
+        """
+        returns a dict of all the info for the "jumphost" section
+        """
+        jumphost = Host.objects.get(bundle=resource, config__opnfvRole__name__iexact="jumphost")
+        jumphost_info = cls.get_pdf_host(jumphost)
+        remote_params = jumphost_info['remote_management']  # jumphost has extra block not in normal hosts
+        remote_params.pop("address")
+        remote_params.pop("mac_address")
+        jumphost_info['remote_params'] = remote_params
+        jumphost_info['os'] = jumphost.config.image.os.name
+        return jumphost_info
+
+    @classmethod
+    def get_pdf_nodes(cls, resource):
+        """
+        returns a list of all the "nodes" (every host except jumphost)
+        """
+        pdf_nodes = []
+        nodes = Host.objects.filter(bundle=resource).exclude(config__opnfvRole__name__iexact="jumphost")
+        for node in nodes:
+            pdf_nodes.append(cls.get_pdf_host(node))
+
+        return pdf_nodes
+
+    @classmethod
+    def get_pdf_host(cls, host):
+        """
+        method to gather all needed info about a host
+        returns a dict
+        """
+        host_info = {}
+        host_info['name'] = host.template.resource.name
+        host_info['node'] = cls.get_pdf_host_node(host)
+        host_info['disks'] = []
+        for disk in host.profile.storageprofile.all():
+            host_info['disks'].append(cls.get_pdf_host_disk(disk))
+
+        host_info['interfaces'] = []
+        for interface in host.interfaces.all():
+            host_info['interfaces'].append(cls.get_pdf_host_iface(interface))
+
+        host_info['remote_management'] = cls.get_pdf_host_remote_management(host)
+
+        return host_info
+
+    @classmethod
+    def get_pdf_host_node(cls, host):
+        """
+        returns "node" info for a given host
+        """
+        d = {}
+        d['type'] = "baremetal"
+        d['vendor'] = host.vendor
+        d['model'] = host.model
+        d['memory'] = str(host.profile.ramprofile.first().amount) + "G"
+
+        cpu = host.profile.cpuprofile.first()
+        d['arch'] = cpu.architecture
+        d['cpus'] = cpu.cpus
+        d['cores'] = cpu.cores
+        cflags = cpu.cflags
+        if cflags and cflags.strip():
+            d['cpu_cflags'] = cflags
+        else:
+            d['cpu_cflags'] = "none"
+
+        return d
+
+    @classmethod
+    def get_pdf_host_disk(cls, disk):
+        """
+        returns a dict describing the given disk
+        """
+        disk_info = {}
+        disk_info['name'] = disk.name
+        disk_info['capacity'] = str(disk.size) + "G"
+        disk_info['type'] = disk.media_type
+        disk_info['interface'] = disk.interface
+        disk_info['rotation'] = disk.rotation
+        return disk_info
+
+    @classmethod
+    def get_pdf_host_iface(cls, interface):
+        """
+        returns a dict describing given interface
+        """
+        iface_info = {}
+        iface_info['features'] = "none"
+        iface_info['mac_address'] = interface.mac_address
+        iface_info['name'] = interface.name
+        profile = InterfaceProfile.objects.get(host=interface.host.profile, name=interface.name)
+        iface_info['speed'] = str(int(profile.speed / 1000)) + "gb"
+        return iface_info
+
+    @classmethod
+    def get_pdf_host_remote_management(cls, host):
+        """
+        gives the remote params of the host
+        """
+        mgmt = {}
+        mgmt['address'] = "I dunno"
+        mgmt['mac_address'] = "I dunno"
+        mgmt['pass'] = "I dunno"
+        mgmt['type'] = "I dunno"
+        mgmt['user'] = "I dunno"
+        mgmt['versions'] = ["I dunno"]
+        return mgmt
diff --git a/src/resource_inventory/resource_manager.py b/src/resource_inventory/resource_manager.py
index f43ae4d..52b0055 100644
--- a/src/resource_inventory/resource_manager.py
+++ b/src/resource_inventory/resource_manager.py
@@ -8,9 +8,6 @@
 ##############################################################################
 
 
-from django.template.loader import render_to_string
-
-import booking
 from dashboard.exceptions import (
     ResourceExistenceException,
     ResourceAvailabilityException,
@@ -142,90 +139,3 @@ class ResourceManager:
     def fail_acquire(self, hosts):
         for host in hosts:
             self.releaseHost(host)
-
-    def makePDF(self, resource):
-        """
-        fills the pod descriptor file template with info about the resource
-        """
-        template = "dashboard/pdf.yaml"
-        info = {}
-        info['details'] = self.get_pdf_details(resource)
-        info['jumphost'] = self.get_pdf_jumphost(resource)
-        info['nodes'] = self.get_pdf_nodes(resource)
-
-        return render_to_string(template, context=info)
-
-    def get_pdf_details(self, resource):
-        details = {}
-        owner = "Anon"
-        email = "email@mail.com"
-        resource_lab = resource.template.lab
-        lab = resource_lab.name
-        location = resource_lab.location
-        pod_type = "development"
-        link = "https://wiki.opnfv.org/display/INF/Pharos+Laas"
-
-        try:
-            # try to get more specific info that may fail, we dont care if it does
-            booking_owner = booking.models.Booking.objects.get(resource=resource).owner
-            owner = booking_owner.username
-            email = booking_owner.userprofile.email_addr
-        except Exception:
-            pass
-
-        details['owner'] = owner
-        details['email'] = email
-        details['lab'] = lab
-        details['location'] = location
-        details['type'] = pod_type
-        details['link'] = link
-
-        return details
-
-    def get_pdf_jumphost(self, resource):
-        jumphost = Host.objects.get(bundle=resource, config__opnfvRole__name__iexact="jumphost")
-        return self.get_pdf_host(jumphost)
-
-    def get_pdf_nodes(self, resource):
-        pdf_nodes = []
-        nodes = Host.objects.filter(bundle=resource).exclude(config__opnfvRole__name__iexact="jumphost")
-        for node in nodes:
-            pdf_nodes.append(self.get_pdf_host(node))
-
-        return pdf_nodes
-
-    def get_pdf_host(self, host):
-        host_info = {}
-        host_info['name'] = host.template.resource.name
-        host_info['node'] = {}
-        host_info['node']['type'] = "baremetal"
-        host_info['node']['vendor'] = host.vendor
-        host_info['node']['model'] = host.model
-        host_info['node']['arch'] = host.profile.cpuprofile.first().architecture
-        host_info['node']['cpus'] = host.profile.cpuprofile.first().cpus
-        host_info['node']['cores'] = host.profile.cpuprofile.first().cores
-        cflags = host.profile.cpuprofile.first().cflags
-        if cflags and cflags.strip():
-            host_info['node']['cpu_cflags'] = cflags
-        host_info['node']['memory'] = str(host.profile.ramprofile.first().amount) + "G"
-        host_info['disks'] = []
-        for disk in host.profile.storageprofile.all():
-            disk_info = {}
-            disk_info['name'] = disk.name
-            disk_info['capacity'] = str(disk.size) + "G"
-            disk_info['type'] = disk.media_type
-            disk_info['interface'] = disk.interface
-            disk_info['rotation'] = disk.rotation
-            host_info['disks'].append(disk_info)
-
-        host_info['interfaces'] = []
-        for interface in host.interfaces.all():
-            iface_info = {}
-            iface_info['name'] = interface.name
-            iface_info['address'] = "unknown"
-            iface_info['mac_address'] = interface.mac_address
-            vlans = "|".join([str(vlan.vlan_id) for vlan in interface.config.all()])
-            iface_info['vlans'] = vlans
-            host_info['interfaces'].append(iface_info)
-
-        return host_info
diff --git a/src/templates/dashboard/idf.yaml b/src/templates/dashboard/idf.yaml
new file mode 100644
index 0000000..5da20c4
--- /dev/null
+++ b/src/templates/dashboard/idf.yaml
@@ -0,0 +1,52 @@
+idf:
+  version: {{version|default:"0.1"}}
+  net_config:
+    oob:
+      ip-range: {{net_config.oob.ip-range}}
+      vlan: {{net_config.oob.vlan}}
+    admin:
+      interface: {{net_config.admin.interface}}
+      vlan: {{net_config.admin.vlan}}
+      network: {{net_config.admin.network}}
+      mask: {{net_config.admin.mask}}
+    mgmt:
+      interface: {{net_config.mgmt.interface}}
+      vlan: {{net_config.mgmt.vlan}}
+      network: {{net_config.mgmt.network}}
+      mask: {{net_config.mgmt.mask}}
+    private:
+      interface: {{net_config.private.interface}}
+      vlan: {{net_config.private.vlan}}
+      network: {{net_config.private.network}}
+      mask: {{net_config.private.mask}}
+    public:
+      interface: {{net_config.public.interface}}
+      vlan: {{net_config.public.vlan}}
+      network: {{net_config.public.network}}
+      mask: {{net_config.public.mask}}
+      ip-range: {{net_config.public.ip-range}}
+      mask: {{net_config.public.mask}}
+      gateway: {{net_config.public.gateway}}
+      dns:
+      {% for serv in net_config.public.dns %}
+      - {{serv}}
+      {% endfor %}
+  fuel:
+    jumphost:
+      bridges:
+        admin: {{fuel.jumphost.bridges.admin}}
+        mgmt: {{fuel.jumphost.bridges.mgmt}}
+        private: {{fuel.jumphost.bridges.private}}
+        public: {{fuel.jumphost.bridges.public}}
+    network:
+      {% for node in fuel.network.nodes %}
+      node:
+      - interfaces:
+        {% for iface in node.interfaces %}
+        - {{ iface }}
+        {% endfor %}
+      - busaddr:
+        {% for addr in node.bus_addrs %}
+        - {{addr}}
+        {% endfor %}
+      {% endfor %}
diff --git a/src/templates/dashboard/pdf.yaml b/src/templates/dashboard/pdf.yaml
index 297e04b..c893919 100644
--- a/src/templates/dashboard/pdf.yaml
+++ b/src/templates/dashboard/pdf.yaml
@@ -1,95 +1,92 @@
 ---
 version: {{version|default:"1.0"}}
 details:
-    pod_owner: {{details.owner}}
-    contact: {{details.contact}}
-    lab: {{details.lab}}
-    location: {{details.location}}
-    type: {{details.type}}
-    link: {{details.link}}
-
+  contact: {{details.contact}}
+  lab: {{details.lab}}
+  link: {{details.link}}
+  location: {{details.location}}
+  pod_owner: {{details.owner}}
+  type: {{details.type}}
 jumphost:
-    name: {{jumphost.name}}
-    node:
-        type: {{jumphost.node.type}}
-        vendor: {{jumphost.node.vendor}}
-        model: {{jumphost.node.model}}
-        arch: {{jumphost.node.arch}}
-        cpus: {{jumphost.node.cpus}}
-        cpu_cflags: {{jumphost.node.cpu_cflags}}
-        cores: {{jumphost.node.cores}}
-        memory: {{jumphost.node.memory}}
-    disks:
-        {% for disk in jumphost.disks %}
-          - name: {{disk.name}}
-            disk_capacity: {{disk.capacity}}
-            disk_type: {{disk.type}}
-            disk_interface: {{disk.interface}}
-            disk_rotation: {{disk.rotation}}
-
-        {% endfor %}
-    os: {{jumphost.os}}
-    remote_params:
-        type: {{jumphost.remote.type}}
-        versions:
-            {% for version in jumphost.remote.versions %}
-          - {{version}}
-            {% endfor %}
-        user: {{jumphost.remote.user}}
-        pass: {{jumphost.remote.pass}}
-    remote_management:
-        type: {{jumphost.remote.type}}
-        versions:
-            {% for version in jumphost.remote.versions %}
-          - {{version}}
-            {% endfor %}
-        user: {{jumphost.remote.user}}
-        pass: {{jumphost.remote.pass}}
-        address: {{jumphost.remote.address}}
-        mac_address: {{jumphost.remote.mac_address}}
-    interfaces:
-        {% for interface in jumphost.interfaces %}
-      - name: {{interface.name}}
-        address: {{interface.address}}
-        mac_address: {{interface.mac_address}}
-        vlan: {{interface.vlan}}
-        {% endfor %}
+  disks:
+  {% for disk in jumphost.disks %}
+  - disk_capacity: {{disk.capacity}}
+    disk_interface: {{disk.interface}}
+    disk_rotation: {{disk.rotation}}
+    disk_type: {{disk.type}}
+    name: {{disk.name}}
+  {% endfor %}
+  interfaces:
+    {% for interface in jumphost.interfaces %}
+  - features: {{interface.features}}
+    mac_address: {{interface.mac_address}}
+    name: {{interface.name}}
+    speed: {{interface.speed}}
+    {% endfor %}
+  name: {{jumphost.name}}
+  node:
+    arch: {{jumphost.node.arch}}
+    cores: {{jumphost.node.cores}}
+    cpu_cflags: {{jumphost.node.cpu_cflags}}
+    cpus: {{jumphost.node.cpus}}
+    memory: {{jumphost.node.memory}}
+    model: {{jumphost.node.model}}
+    type: {{jumphost.node.type}}
+    vendor: {{jumphost.node.vendor}}
+  os: {{jumphost.os}}
+  remote_management:
+    address: {{jumphost.remote.address}}
+    mac_address: {{jumphost.remote.mac_address}}
+    pass: {{jumphost.remote.pass}}
+    type: {{jumphost.remote.type}}
+    user: {{jumphost.remote.user}}
+    versions:
+      {% for version in jumphost.remote.versions %}
+    - {{version}}
+      {% endfor %}
+  remote_params:
+    pass: {{jumphost.remote.pass}}
+    type: {{jumphost.remote.type}}
+    user: {{jumphost.remote.user}}
+    versions:
+      {% for version in jumphost.remote.versions %}
+    - {{version}}
+      {% endfor %}
 nodes:
-    {% for node in nodes %}
-  - name: {{node.name}}
-    node:
-        type: {{node.node.type}}
-        vendor: {{node.node.vendor}}
-        model: {{node.node.model}}
-        arch: {{node.node.arch}}
-        cpus: {{node.node.cpus}}
-        cpu_cflags: {{node.node.cpu_cflags}}
-        cores: {{node.node.cores}}
-        memory: {{node.node.memory}}
-    disks:
-        {% for disk in node.disks %}
-      - name: {{disk.name}}
-        disk_capacity: {{disk.capacity}}
-        disk_type: {{disk.type}}
-        disk_interface: {{disk.interface}}
-        disk_rotation: {{disk.rotation}}
-
-        {% endfor %}
-    remote_management:
-        type: {{node.remote.type}}
-        versions:
-            {% for version in node.remote.versions %}
-          - {{version}}
-            {% endfor %}
-        user: {{node.remote.user}}
-        pass: {{node.remote.pass}}
-        address: {{node.remote.address}}
-        mac_address: {{node.remote.mac_address}}
-    interfaces:
-        {% for interface in node.interfaces %}
-      - name: {{interface.name}}
-        address: {{interface.address}}
-        mac_address: {{interface.mac_address}}
-        vlan: {{interface.vlan}}
-        {% endfor %}
+{% for node in nodes %}
+- disks:
+    {% for disk in node.disks %}
+  - disk_capacity: {{disk.capacity}}
+    disk_interface: {{disk.interface}}
+    disk_rotation: {{disk.rotation}}
+    disk_type: {{disk.type}}
+    name: {{disk.name}}
+    {% endfor %}
+  interfaces:
+    {% for interface in node.interfaces %}
+  - features: {{interface.features}}
+    mac_address: {{interface.mac_address}}
+    name: {{interface.name}}
+    speed: {{interface.speed}}
     {% endfor %}
+  name: {{node.name}}
+  node:
+    arch: {{node.node.arch}}
+    cores: {{node.node.cores}}
+    cpu_cflags: {{node.node.cpu_cflags}}
+    cpus: {{node.node.cpus}}
+    memory: {{node.node.memory}}
+    model: {{node.node.model}}
+    type: {{node.node.type}}
+    vendor: {{node.node.vendor}}
+  remote_management:
+    address: {{node.remote.address}}
+    mac_address: {{node.remote.mac_address}}
+    pass: {{node.remote.pass}}
+    type: {{node.remote.type}}
+    user: {{node.remote.user}}
+    versions:
+      {% for version in node.remote.versions %}
+    - {{version}}
+      {% endfor %}
+{% endfor %}
diff --git a/src/workflow/models.py b/src/workflow/models.py
index 7dae279..cdfddef 100644
--- a/src/workflow/models.py
+++ b/src/workflow/models.py
@@ -21,6 +21,7 @@ from api.models import JobFactory
 from dashboard.exceptions import ResourceAvailabilityException, ModelValidationException
 from resource_inventory.models import Image, GenericInterface
 from resource_inventory.resource_manager import ResourceManager
+from resource_inventory.pdf_templater import PDFTemplater
 from notifier.manager import NotificationHandler
 from booking.models import Booking
 
@@ -577,7 +578,7 @@ class Repository():
             booking.collaborators.add(collaborator)
 
         try:
-            booking.pdf = ResourceManager().makePDF(booking.resource)
+            booking.pdf = PDFTemplater.makePDF(booking.resource)
             booking.save()
         except Exception as e:
             return "BOOK, failed to create Pod Desriptor File: " + str(e)