aboutsummaryrefslogtreecommitdiffstats
path: root/src/booking/quick_deployer.py
blob: 743cdcf0eed973d891fd72821ead5e8e8eeca8aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
##############################################################################
# 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
##############################################################################


import json
import uuid
import re
from django.db.models import Q
from datetime import timedelta
from django.utils import timezone
from account.models import Lab

from resource_inventory.models import (
    Installer,
    Image,
    GenericResourceBundle,
    ConfigBundle,
    Host,
    HostProfile,
    HostConfiguration,
    GenericResource,
    GenericHost,
    GenericInterface,
    OPNFVRole,
    OPNFVConfig,
    Network,
    NetworkConnection,
    NetworkRole,
    HostOPNFVConfig,
)
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 (
    InvalidHostnameException,
    ResourceAvailabilityException,
    ModelValidationException,
    BookingLengthException
)
from api.models import JobFactory


# model validity exceptions
class IncompatibleInstallerForOS(Exception):
    pass


class IncompatibleScenarioForInstaller(Exception):
    pass


class IncompatibleImageForHost(Exception):
    pass


class ImageOwnershipInvalid(Exception):
    pass


class ImageNotAvailableAtLab(Exception):
    pass


class LabDNE(Exception):
    pass


class HostProfileDNE(Exception):
    pass


class HostNotAvailable(Exception):
    pass


class NoLabSelectedError(Exception):
    pass


class OPNFVRoleDNE(Exception):
    pass


class NoRemainingPublicNetwork(Exception):
    pass


class BookingPermissionException(Exception):
    pass


def parse_host_field(host_json):
    """
    Parse the json from the frontend.

    returns a reference to the selected Lab and HostProfile objects
    """
    lab, profile = (None, None)
    lab_dict = host_json['lab']
    for lab_info in lab_dict.values():
        if lab_info['selected']:
            lab = Lab.objects.get(lab_user__id=lab_info['id'])

    host_dict = host_json['host']
    for host_info in host_dict.values():
        if host_info['selected']:
            profile = HostProfile.objects.get(pk=host_info['id'])

    if lab is None:
        raise NoLabSelectedError("No lab was selected")
    if profile is None:
        raise HostProfileDNE("No Host was selected")

    return lab, profile


def check_available_matching_host(lab, hostprofile):
    """
    Check the resources are available.

    Returns true if the requested host type is availble,
    Or throws an exception
    """
    available_host_types = ResourceManager.getInstance().getAvailableHostTypes(lab)
    if hostprofile not in available_host_types:
        # TODO: handle deleting generic resource in this instance along with grb
        raise HostNotAvailable('Requested host type is not available. Please try again later. Host availability can be viewed in the "Hosts" tab to the left.')

    hostset = Host.objects.filter(lab=lab, profile=hostprofile).filter(booked=False).filter(working=True)
    if not hostset.exists():
        raise HostNotAvailable("Couldn't find any matching unbooked hosts")

    return True


# Functions to create models

def generate_grb(owner, lab, common_id):
    """Create a Generic Resource Bundle."""
    grbundle = GenericResourceBundle(owner=owner)
    grbundle.lab = lab
    grbundle.name = "grbundle for quick booking with uid " + common_id
    grbundle.description = "grbundle created for quick-deploy booking"
    grbundle.save()

    return grbundle


def generate_gresource(bundle, hostname):
    """Create a Generic Resource."""
    if not re.match(r"(?=^.{1,253}$)(^([A-Za-z0-9-_]{1,62}\.)*[A-Za-z0-9-_]{1,63})$", hostname):
        raise InvalidHostnameException("Hostname must comply to RFC 952 and all extensions to it until this point")
    gresource = GenericResource(bundle=bundle, name=hostname)
    gresource.save()

    return gresource


def generate_ghost(generic_resource, host_profile):
    """Create a Generic Host."""
    ghost = GenericHost()
    ghost.resource = generic_resource
    ghost.profile = host_profile
    ghost.save()

    return ghost


def generate_config_bundle(owner, common_id, grbundle):
    """Create a Configuration Bundle."""
    cbundle = ConfigBundle()
    cbundle.owner = owner
    cbundle.name = "configbundle for quick booking with uid " + common_id
    cbundle.description = "configbundle created for quick-deploy booking"
    cbundle.bundle = grbundle
    cbundle.save()

    return cbundle


def generate_opnfvconfig(scenario, installer, config_bundle):
    """Create an OPNFV Configuration."""
    opnfvconfig = OPNFVConfig()
    opnfvconfig.scenario = scenario
    opnfvconfig.installer = installer
    opnfvconfig.bundle = config_bundle
    opnfvconfig.save()

    return opnfvconfig


def generate_hostconfig(generic_host, image, config_bundle):
    """Create a Host Configuration."""
    hconf = HostConfiguration()
    hconf.host = generic_host
    hconf.image = image
    hconf.bundle = config_bundle
    hconf.is_head_node = True
    hconf.save()

    return hconf


def generate_hostopnfv(hostconfig, opnfvconfig):
    """Relate the Host and OPNFV Configs."""
    config = HostOPNFVConfig()
    role = None
    try:
        role = OPNFVRole.objects.get(name="Jumphost")
    except Exception:
        role = OPNFVRole.objects.create(
            name="Jumphost",
            description="Single server jumphost role"
        )
    config.role = role
    config.host_config = hostconfig
    config.opnfv_config = opnfvconfig
    config.save()
    return config


def generate_resource_bundle(generic_resource_bundle, config_bundle):  # warning: requires cleanup
    """Create a Resource Bundle."""
    try:
        resource_manager = ResourceManager.getInstance()
        resource_bundle = resource_manager.convertResourceBundle(generic_resource_bundle, config=config_bundle)
        return resource_bundle
    except ResourceAvailabilityException:
        raise ResourceAvailabilityException("Requested resources not available")
    except ModelValidationException:
        raise ModelValidationException("Encountered error while saving grbundle")


def check_invariants(request, **kwargs):
    """
    Verify all the contraints on the requested booking.

    verifies software compatibility, booking length, etc
    """
    installer = kwargs['installer']
    image = kwargs['image']
    scenario = kwargs['scenario']
    lab = kwargs['lab']
    host_profile = kwargs['host_profile']
    length = kwargs['length']
    # check that image os is compatible with installer
    if installer in image.os.sup_installers.all():
        # if installer not here, we can omit that and not check for scenario
        if not scenario:
            raise IncompatibleScenarioForInstaller("An OPNFV Installer needs a scenario to be chosen to work properly")
        if scenario not in installer.sup_scenarios.all():
            raise IncompatibleScenarioForInstaller("The chosen installer does not support the chosen scenario")
    if image.from_lab != lab:
        raise ImageNotAvailableAtLab("The chosen image is not available at the chosen hosting lab")
    if image.host_type != host_profile:
        raise IncompatibleImageForHost("The chosen image is not available for the chosen host type")
    if not image.public and image.owner != request.user:
        raise ImageOwnershipInvalid("You are not the owner of the chosen private image")
    if length < 1 or length > 21:
        raise BookingLengthException("Booking must be between 1 and 21 days long")


def configure_networking(grb, config):
    # create network
    net = Network.objects.create(name="public", bundle=grb, is_public=True)
    # connect network to generic host
    grb.getResources()[0].generic_interfaces.first().connections.add(
        NetworkConnection.objects.create(network=net, vlan_is_tagged=False)
    )
    # asign network role
    role = NetworkRole.objects.create(name="public", network=net)
    opnfv_config = config.opnfv_config.first()
    if opnfv_config:
        opnfv_config.networks.add(role)


def create_from_form(form, request):
    """
    Create a Booking from the user's form.

    Large, nasty method to create a booking or return a useful error
    based on the form from the frontend
    """
    quick_booking_id = str(uuid.uuid4())

    host_field = form.cleaned_data['filter_field']
    purpose_field = form.cleaned_data['purpose']
    project_field = form.cleaned_data['project']
    users_field = form.cleaned_data['users']
    hostname = form.cleaned_data['hostname']
    length = form.cleaned_data['length']

    image = form.cleaned_data['image']
    scenario = form.cleaned_data['scenario']
    installer = form.cleaned_data['installer']

    lab, host_profile = parse_host_field(host_field)
    data = form.cleaned_data
    data['lab'] = lab
    data['host_profile'] = host_profile
    check_invariants(request, **data)

    # check booking privileges
    if Booking.objects.filter(owner=request.user, end__gt=timezone.now()).count() >= 3 and not request.user.userprofile.booking_privledge:
        raise BookingPermissionException("You do not have permission to have more than 3 bookings at a time.")

    check_available_matching_host(lab, host_profile)  # requires cleanup if failure after this point

    grbundle = generate_grb(request.user, lab, quick_booking_id)
    gresource = generate_gresource(grbundle, hostname)
    ghost = generate_ghost(gresource, host_profile)
    cbundle = generate_config_bundle(request.user, quick_booking_id, grbundle)
    hconf = generate_hostconfig(ghost, image, cbundle)

    # if no installer provided, just create blank host
    opnfv_config = None
    if installer:
        opnfv_config = generate_opnfvconfig(scenario, installer, cbundle)
        generate_hostopnfv(hconf, opnfv_config)

    # construct generic interfaces
    for interface_profile in host_profile.interfaceprofile.all():
        generic_interface = GenericInterface.objects.create(profile=interface_profile, host=ghost)
        generic_interface.save()

    configure_networking(grbundle, cbundle)

    # generate resource bundle
    resource_bundle = generate_resource_bundle(grbundle, cbundle)

    # generate booking
    booking = Booking.objects.create(
        purpose=purpose_field,
        project=project_field,
        lab=lab,
        owner=request.user,
        start=timezone.now(),
        end=timezone.now() + timedelta(days=int(length)),
        resource=resource_bundle,
        config_bundle=cbundle,
        opnfv_config=opnfv_config
    )
    booking.pdf = PDFTemplater.makePDF(booking)

    for collaborator in users_field:  # list of UserProfiles
        booking.collaborators.add(collaborator.user)

    booking.save()

    # generate job
    JobFactory.makeCompleteJob(booking)
    NotificationHandler.notify_new_booking(booking)

    return booking


def drop_filter(user):
    """
    Return a dictionary that contains filters.

    Only certain installlers are supported on certain images, etc
    so the image filter indexed at [imageid][installerid] is truthy if
    that installer is supported on that image
    """
    installer_filter = {}
    for image in Image.objects.all():
        installer_filter[image.id] = {}
        for installer in image.os.sup_installers.all():
            installer_filter[image.id][installer.id] = 1

    scenario_filter = {}
    for installer in Installer.objects.all():
        scenario_filter[installer.id] = {}
        for scenario in installer.sup_scenarios.all():
            scenario_filter[installer.id][scenario.id] = 1

    images = Image.objects.filter(Q(public=True) | Q(owner=user))
    image_filter = {}
    for image in images:
        image_filter[image.id] = {}
        image_filter[image.id]['lab'] = 'lab_' + str(image.from_lab.lab_user.id)
        image_filter[image.id]['host_profile'] = 'host_' + str(image.host_type.id)
        image_filter[image.id]['name'] = image.name

    return {'installer_filter': json.dumps(installer_filter),
            'scenario_filter': json.dumps(scenario_filter),
            'image_filter': json.dumps(image_filter)}