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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
|
##############################################################################
# Copyright (c) 2018 Sawyer Bergeron, Parker Berberian, 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.contrib.auth.models import User
from django.db import models
from django.core.exceptions import PermissionDenied, ValidationError
from django.shortcuts import get_object_or_404
from django.http import HttpResponseNotFound
from django.urls import reverse
from django.utils import timezone
import json
import uuid
from booking.models import Booking
from resource_inventory.models import (
Lab,
ResourceProfile,
Image,
Interface,
ResourceOPNFVConfig,
RemoteInfo,
OPNFVConfig,
ConfigState,
ResourceQuery
)
from resource_inventory.idf_templater import IDFTemplater
from resource_inventory.pdf_templater import PDFTemplater
from account.models import Downtime, UserProfile
from dashboard.utils import AbstractModelQuery
class JobStatus(object):
"""
A poor man's enum for a job's status.
A job is NEW if it has not been started or recognized by the Lab
A job is CURRENT if it has been started by the lab but it is not yet completed
a job is DONE if all the tasks are complete and the booking is ready to use
"""
NEW = 0
CURRENT = 100
DONE = 200
ERROR = 300
class LabManagerTracker(object):
@classmethod
def get(cls, lab_name, token):
"""
Get a LabManager.
Takes in a lab name (from a url path)
returns a lab manager instance for that lab, if it exists
Also checks that the given API token is correct
"""
try:
lab = Lab.objects.get(name=lab_name)
except Exception:
raise PermissionDenied("Lab not found")
if lab.api_token == token:
return LabManager(lab)
raise PermissionDenied("Lab not authorized")
class LabManager(object):
"""
Handles all lab REST calls.
handles jobs, inventory, status, etc
may need to create helper classes
"""
def __init__(self, lab):
self.lab = lab
def get_downtime(self):
return Downtime.objects.filter(start__lt=timezone.now(), end__gt=timezone.now(), lab=self.lab)
def get_downtime_json(self):
downtime = self.get_downtime().first() # should only be one item in queryset
if downtime:
return {
"is_down": True,
"start": downtime.start,
"end": downtime.end,
"description": downtime.description
}
return {"is_down": False}
def create_downtime(self, form):
"""
Create a downtime event.
Takes in a dictionary that describes the model.
{
"start": utc timestamp
"end": utc timestamp
"description": human text (optional)
}
For timestamp structure, https://docs.djangoproject.com/en/2.2/ref/forms/fields/#datetimefield
"""
Downtime.objects.create(
start=form.cleaned_data['start'],
end=form.cleaned_data['end'],
description=form.cleaned_data['description'],
lab=self.lab
)
return self.get_downtime_json()
def update_host_remote_info(self, data, res_id):
resource = ResourceQuery.filter(labid=res_id, lab=self.lab)
if len(resource) != 1:
return HttpResponseNotFound("Could not find single host with id " + str(res_id))
resource = resource[0]
info = {}
try:
info['address'] = data['address']
info['mac_address'] = data['mac_address']
info['password'] = data['password']
info['user'] = data['user']
info['type'] = data['type']
info['versions'] = json.dumps(data['versions'])
except Exception as e:
return {"error": "invalid arguement: " + str(e)}
remote_info = resource.remote_management
if "default" in remote_info.mac_address:
remote_info = RemoteInfo()
remote_info.address = info['address']
remote_info.mac_address = info['mac_address']
remote_info.password = info['password']
remote_info.user = info['user']
remote_info.type = info['type']
remote_info.versions = info['versions']
remote_info.save()
resource.remote_management = remote_info
resource.save()
booking = Booking.objects.get(resource=resource.bundle)
self.update_xdf(booking)
return {"status": "success"}
def update_xdf(self, booking):
booking.pdf = PDFTemplater.makePDF(booking)
booking.idf = IDFTemplater().makeIDF(booking)
booking.save()
def get_pdf(self, booking_id):
booking = get_object_or_404(Booking, pk=booking_id, lab=self.lab)
return booking.pdf
def get_idf(self, booking_id):
booking = get_object_or_404(Booking, pk=booking_id, lab=self.lab)
return booking.idf
def get_profile(self):
prof = {}
prof['name'] = self.lab.name
prof['contact'] = {
"phone": self.lab.contact_phone,
"email": self.lab.contact_email
}
prof['host_count'] = [{
"type": profile.name,
"count": len(profile.get_resources(lab=self.lab))}
for profile in ResourceProfile.objects.filter(labs=self.lab)]
return prof
def format_user(self, userprofile):
return {
"id": userprofile.user.id,
"username": userprofile.user.username,
"email": userprofile.email_addr,
"first_name": userprofile.user.first_name,
"last_name": userprofile.user.last_name,
"company": userprofile.company
}
def get_users(self):
userlist = [self.format_user(profile) for profile in UserProfile.objects.select_related("user").all()]
return json.dumps({"users": userlist})
def get_user(self, user_id):
user = User.objects.get(pk=user_id)
profile = get_object_or_404(UserProfile, user=user)
return json.dumps(self.format_user(profile))
def get_inventory(self):
inventory = {}
resources = ResourceQuery.filter(lab=self.lab)
images = Image.objects.filter(from_lab=self.lab)
profiles = ResourceProfile.objects.filter(labs=self.lab)
inventory['resources'] = self.serialize_resources(resources)
inventory['images'] = self.serialize_images(images)
inventory['host_types'] = self.serialize_host_profiles(profiles)
return inventory
def get_host(self, hostname):
resource = ResourceQuery.filter(labid=hostname, lab=self.lab)
if len(resource) != 1:
return HttpResponseNotFound("Could not find single host with id " + str(hostname))
resource = resource[0]
return {
"booked": resource.booked,
"working": resource.working,
"type": resource.profile.name
}
def update_host(self, hostname, data):
resource = ResourceQuery.filter(labid=hostname, lab=self.lab)
if len(resource) != 1:
return HttpResponseNotFound("Could not find single host with id " + str(hostname))
resource = resource[0]
if "working" in data:
working = data['working'] == "true"
resource.working = working
resource.save()
return self.get_host(hostname)
def get_status(self):
return {"status": self.lab.status}
def set_status(self, payload):
{}
def get_current_jobs(self):
jobs = Job.objects.filter(booking__lab=self.lab)
return self.serialize_jobs(jobs, status=JobStatus.CURRENT)
def get_new_jobs(self):
jobs = Job.objects.filter(booking__lab=self.lab)
return self.serialize_jobs(jobs, status=JobStatus.NEW)
def get_done_jobs(self):
jobs = Job.objects.filter(booking__lab=self.lab)
return self.serialize_jobs(jobs, status=JobStatus.DONE)
def get_job(self, jobid):
return Job.objects.get(pk=jobid).to_dict()
def update_job(self, jobid, data):
{}
def serialize_jobs(self, jobs, status=JobStatus.NEW):
job_ser = []
for job in jobs:
jsonized_job = job.get_delta(status)
if len(jsonized_job['payload']) < 1:
continue
job_ser.append(jsonized_job)
return job_ser
def serialize_resources(self, resources):
# TODO: rewrite for Resource model
host_ser = []
for res in resources:
r = {
'interfaces': [],
'hostname': res.name,
'host_type': res.profile.name
}
for iface in res.get_interfaces():
r['interfaces'].append({
'mac': iface.mac_address,
'busaddr': iface.bus_address,
'name': iface.name,
'switchport': {"switch_name": iface.switch_name, "port_name": iface.port_name}
})
return host_ser
def serialize_images(self, images):
images_ser = []
for image in images:
images_ser.append(
{
"name": image.name,
"lab_id": image.lab_id,
"dashboard_id": image.id
}
)
return images_ser
def serialize_resource_profiles(self, profiles):
profile_ser = []
for profile in profiles:
p = {}
p['cpu'] = {
"cores": profile.cpuprofile.first().cores,
"arch": profile.cpuprofile.first().architecture,
"cpus": profile.cpuprofile.first().cpus,
}
p['disks'] = []
for disk in profile.storageprofile.all():
d = {
"size": disk.size,
"type": disk.media_type,
"name": disk.name
}
p['disks'].append(d)
p['description'] = profile.description
p['interfaces'] = []
for iface in profile.interfaceprofile.all():
p['interfaces'].append(
{
"speed": iface.speed,
"name": iface.name
}
)
p['ram'] = {"amount": profile.ramprofile.first().amount}
p['name'] = profile.name
profile_ser.append(p)
return profile_ser
class Job(models.Model):
"""
A Job to be performed by the Lab.
The API uses Jobs and Tasks to communicate actions that need to be taken to the Lab
that is hosting a booking. A booking from a user has an associated Job which tells
the lab how to configure the hardware, networking, etc to fulfill the booking
for the user.
This is the class that is serialized and put into the api
"""
booking = models.OneToOneField(Booking, on_delete=models.CASCADE, null=True)
status = models.IntegerField(default=JobStatus.NEW)
complete = models.BooleanField(default=False)
def to_dict(self):
d = {}
for relation in self.get_tasklist():
if relation.job_key not in d:
d[relation.job_key] = {}
d[relation.job_key][relation.task_id] = relation.config.to_dict()
return {"id": self.id, "payload": d}
def get_tasklist(self, status="all"):
if status != "all":
return JobTaskQuery.filter(job=self, status=status)
return JobTaskQuery.filter(job=self)
def is_fulfilled(self):
"""
If a job has been completed by the lab.
This method should return true if all of the job's tasks are done,
and false otherwise
"""
my_tasks = self.get_tasklist()
for task in my_tasks:
if task.status != JobStatus.DONE:
return False
return True
def get_delta(self, status):
d = {}
for relation in self.get_tasklist(status=status):
if relation.job_key not in d:
d[relation.job_key] = {}
d[relation.job_key][relation.task_id] = relation.config.get_delta()
return {"id": self.id, "payload": d}
def to_json(self):
return json.dumps(self.to_dict())
class TaskConfig(models.Model):
state = models.IntegerField(default=ConfigState.NEW)
keys = set() # TODO: This needs to be an instance variable, not a class variable
delta_keys_list = models.CharField(max_length=200, default="[]")
@property
def delta_keys(self):
return list(set(json.loads(self.delta_keys_list)))
@delta_keys.setter
def delta_keys(self, keylist):
self.delta_keys_list = json.dumps(keylist)
def to_dict(self):
raise NotImplementedError
def get_delta(self):
raise NotImplementedError
def format_delta(self, config, token):
delta = {k: config[k] for k in self.delta_keys}
delta['lab_token'] = token
return delta
def to_json(self):
return json.dumps(self.to_dict())
def clear_delta(self):
self.delta_keys = []
def set(self, *args):
dkeys = self.delta_keys
for arg in args:
if arg in self.keys:
dkeys.append(arg)
self.delta_keys = dkeys
class BridgeConfig(models.Model):
"""Displays mapping between jumphost interfaces and bridges."""
interfaces = models.ManyToManyField(Interface)
opnfv_config = models.ForeignKey(OPNFVConfig, on_delete=models.CASCADE)
def to_dict(self):
d = {}
hid = ResourceQuery.get(interface__pk=self.interfaces.first().pk).labid
d[hid] = {}
for interface in self.interfaces.all():
d[hid][interface.mac_address] = []
for vlan in interface.config.all():
network_role = self.opnfv_model.networks().filter(network=vlan.network)
bridge = IDFTemplater.bridge_names[network_role.name]
br_config = {
"vlan_id": vlan.vlan_id,
"tagged": vlan.tagged,
"bridge": bridge
}
d[hid][interface.mac_address].append(br_config)
return d
def to_json(self):
return json.dumps(self.to_dict())
class OpnfvApiConfig(models.Model):
installer = models.CharField(max_length=200)
scenario = models.CharField(max_length=300)
roles = models.ManyToManyField(ResourceOPNFVConfig)
# pdf and idf are url endpoints, not the actual file
pdf = models.CharField(max_length=100)
idf = models.CharField(max_length=100)
bridge_config = models.OneToOneField(BridgeConfig, on_delete=models.CASCADE, null=True)
delta = models.TextField()
opnfv_config = models.ForeignKey(OPNFVConfig, null=True, on_delete=models.SET_NULL)
def to_dict(self):
d = {}
if not self.opnfv_config:
return d
if self.installer:
d['installer'] = self.installer
if self.scenario:
d['scenario'] = self.scenario
if self.pdf:
d['pdf'] = self.pdf
if self.idf:
d['idf'] = self.idf
if self.bridge_config:
d['bridged_interfaces'] = self.bridge_config.to_dict()
hosts = self.roles.all()
if hosts.exists():
d['roles'] = []
for host in hosts:
d['roles'].append({
host.labid: self.opnfv_config.host_opnfv_config.get(
host_config__pk=host.config.pk
).role.name
})
return d
def to_json(self):
return json.dumps(self.to_dict())
def set_installer(self, installer):
self.installer = installer
d = json.loads(self.delta)
d['installer'] = installer
self.delta = json.dumps(d)
def set_scenario(self, scenario):
self.scenario = scenario
d = json.loads(self.delta)
d['scenario'] = scenario
self.delta = json.dumps(d)
def set_xdf(self, booking, update_delta=True):
kwargs = {'lab_name': booking.lab.name, 'booking_id': booking.id}
self.pdf = reverse('get-pdf', kwargs=kwargs)
self.idf = reverse('get-idf', kwargs=kwargs)
if update_delta:
d = json.loads(self.delta)
d['pdf'] = self.pdf
d['idf'] = self.idf
self.delta = json.dumps(d)
def add_role(self, host):
self.roles.add(host)
d = json.loads(self.delta)
if 'role' not in d:
d['role'] = []
d['roles'].append({host.labid: host.config.opnfvRole.name})
self.delta = json.dumps(d)
def clear_delta(self):
self.delta = '{}'
def get_delta(self):
return json.loads(self.to_json())
class AccessConfig(TaskConfig):
access_type = models.CharField(max_length=50)
user = models.ForeignKey(User, on_delete=models.CASCADE)
revoke = models.BooleanField(default=False)
context = models.TextField(default="")
delta = models.TextField(default="{}")
def to_dict(self):
d = {}
d['access_type'] = self.access_type
d['user'] = self.user.id
d['revoke'] = self.revoke
try:
d['context'] = json.loads(self.context)
except Exception:
pass
return d
def get_delta(self):
d = json.loads(self.to_json())
d["lab_token"] = self.accessrelation.lab_token
return d
def to_json(self):
return json.dumps(self.to_dict())
def clear_delta(self):
d = {}
d["lab_token"] = self.accessrelation.lab_token
self.delta = json.dumps(d)
def set_access_type(self, access_type):
self.access_type = access_type
d = json.loads(self.delta)
d['access_type'] = access_type
self.delta = json.dumps(d)
def set_user(self, user):
self.user = user
d = json.loads(self.delta)
d['user'] = self.user.id
self.delta = json.dumps(d)
def set_revoke(self, revoke):
self.revoke = revoke
d = json.loads(self.delta)
d['revoke'] = revoke
self.delta = json.dumps(d)
def set_context(self, context):
self.context = json.dumps(context)
d = json.loads(self.delta)
d['context'] = context
self.delta = json.dumps(d)
class SoftwareConfig(TaskConfig):
"""Handles software installations, such as OPNFV or ONAP."""
opnfv = models.ForeignKey(OpnfvApiConfig, on_delete=models.CASCADE)
def to_dict(self):
d = {}
if self.opnfv:
d['opnfv'] = self.opnfv.to_dict()
d["lab_token"] = self.softwarerelation.lab_token
self.delta = json.dumps(d)
return d
def get_delta(self):
d = {}
d['opnfv'] = self.opnfv.get_delta()
d['lab_token'] = self.softwarerelation.lab_token
return d
def clear_delta(self):
self.opnfv.clear_delta()
def to_json(self):
return json.dumps(self.to_dict())
class HardwareConfig(TaskConfig):
"""Describes the desired configuration of the hardware."""
image = models.CharField(max_length=100, default="defimage")
power = models.CharField(max_length=100, default="off")
hostname = models.CharField(max_length=100, default="hostname")
ipmi_create = models.BooleanField(default=False)
delta = models.TextField()
keys = set(["id", "image", "power", "hostname", "ipmi_create"])
def get_delta(self):
return self.format_delta(
self.hosthardwarerelation.get_resource().get_configuration(self.state),
self.hosthardwarerelation.lab_token)
class NetworkConfig(TaskConfig):
"""Handles network configuration."""
interfaces = models.ManyToManyField(Interface)
delta = models.TextField()
def to_dict(self):
d = {}
hid = self.hostnetworkrelation.resource_id
d[hid] = {}
for interface in self.interfaces.all():
d[hid][interface.mac_address] = []
if self.state != ConfigState.CLEAN:
for vlan in interface.config.all():
# TODO: should this come from the interface?
# e.g. will different interfaces for different resources need different configs?
d[hid][interface.mac_address].append({"vlan_id": vlan.vlan_id, "tagged": vlan.tagged})
return d
def to_json(self):
return json.dumps(self.to_dict())
def get_delta(self):
d = json.loads(self.to_json())
d['lab_token'] = self.hostnetworkrelation.lab_token
return d
def clear_delta(self):
self.delta = json.dumps(self.to_dict())
self.save()
def add_interface(self, interface):
self.interfaces.add(interface)
d = json.loads(self.delta)
hid = self.hostnetworkrelation.resource_id
if hid not in d:
d[hid] = {}
d[hid][interface.mac_address] = []
for vlan in interface.config.all():
d[hid][interface.mac_address].append({"vlan_id": vlan.vlan_id, "tagged": vlan.tagged})
self.delta = json.dumps(d)
class SnapshotConfig(TaskConfig):
resource_id = models.CharField(max_length=200, default="default_id")
image = models.IntegerField(null=True)
dashboard_id = models.IntegerField()
delta = models.TextField(default="{}")
def to_dict(self):
d = {}
if self.host:
d['host'] = self.host.labid
if self.image:
d['image'] = self.image
d['dashboard_id'] = self.dashboard_id
return d
def to_json(self):
return json.dumps(self.to_dict())
def get_delta(self):
d = json.loads(self.to_json())
return d
def clear_delta(self):
self.delta = json.dumps(self.to_dict())
self.save()
def set_host(self, host):
self.host = host
d = json.loads(self.delta)
d['host'] = host.labid
self.delta = json.dumps(d)
def set_image(self, image):
self.image = image
d = json.loads(self.delta)
d['image'] = self.image
self.delta = json.dumps(d)
def clear_image(self):
self.image = None
d = json.loads(self.delta)
d.pop("image", None)
self.delta = json.dumps(d)
def set_dashboard_id(self, dash):
self.dashboard_id = dash
d = json.loads(self.delta)
d['dashboard_id'] = self.dashboard_id
self.delta = json.dumps(d)
def save(self, *args, **kwargs):
if len(ResourceQuery.filter(labid=self.resource_id)) != 1:
raise ValidationError("resource_id " + str(self.resource_id) + " does not refer to a single resource")
super().save(*args, **kwargs)
def get_task(task_id):
for taskclass in [AccessRelation, SoftwareRelation, HostHardwareRelation, HostNetworkRelation, SnapshotRelation]:
try:
ret = taskclass.objects.get(task_id=task_id)
return ret
except taskclass.DoesNotExist:
pass
from django.core.exceptions import ObjectDoesNotExist
raise ObjectDoesNotExist("Could not find matching TaskRelation instance")
def get_task_uuid():
return str(uuid.uuid4())
class TaskRelation(models.Model):
"""
Relates a Job to a TaskConfig.
superclass that relates a Job to tasks anc maintains information
like status and messages from the lab
"""
status = models.IntegerField(default=JobStatus.NEW)
job = models.ForeignKey(Job, on_delete=models.CASCADE)
config = models.OneToOneField(TaskConfig, on_delete=models.CASCADE)
task_id = models.CharField(default=get_task_uuid, max_length=37)
lab_token = models.CharField(default="null", max_length=50)
message = models.TextField(default="")
job_key = None
def delete(self, *args, **kwargs):
self.config.delete()
return super(self.__class__, self).delete(*args, **kwargs)
def type_str(self):
return "Generic Task"
class Meta:
abstract = True
class AccessRelation(TaskRelation):
config = models.OneToOneField(AccessConfig, on_delete=models.CASCADE)
job_key = "access"
def type_str(self):
return "Access Task"
def delete(self, *args, **kwargs):
self.config.delete()
return super(self.__class__, self).delete(*args, **kwargs)
class SoftwareRelation(TaskRelation):
config = models.OneToOneField(SoftwareConfig, on_delete=models.CASCADE)
job_key = "software"
def type_str(self):
return "Software Configuration Task"
def delete(self, *args, **kwargs):
self.config.delete()
return super(self.__class__, self).delete(*args, **kwargs)
class HostHardwareRelation(TaskRelation):
resource_id = models.CharField(max_length=200, default="default_id")
config = models.OneToOneField(HardwareConfig, on_delete=models.CASCADE)
job_key = "hardware"
def type_str(self):
return "Hardware Configuration Task"
def get_delta(self):
return self.config.to_dict()
def delete(self, *args, **kwargs):
self.config.delete()
return super(self.__class__, self).delete(*args, **kwargs)
def save(self, *args, **kwargs):
if len(ResourceQuery.filter(labid=self.resource_id)) != 1:
raise ValidationError("resource_id " + str(self.resource_id) + " does not refer to a single resource")
super().save(*args, **kwargs)
def get_resource(self):
return ResourceQuery.get(labid=self.resource_id)
class HostNetworkRelation(TaskRelation):
resource_id = models.CharField(max_length=200, default="default_id")
config = models.OneToOneField(NetworkConfig, on_delete=models.CASCADE)
job_key = "network"
def type_str(self):
return "Network Configuration Task"
def delete(self, *args, **kwargs):
self.config.delete()
return super(self.__class__, self).delete(*args, **kwargs)
def save(self, *args, **kwargs):
if len(ResourceQuery.filter(labid=self.resource_id)) != 1:
raise ValidationError("resource_id " + str(self.resource_id) + " does not refer to a single resource")
super().save(*args, **kwargs)
def get_resource(self):
return ResourceQuery.get(labid=self.resource_id)
class SnapshotRelation(TaskRelation):
snapshot = models.ForeignKey(Image, on_delete=models.CASCADE)
config = models.OneToOneField(SnapshotConfig, on_delete=models.CASCADE)
job_key = "snapshot"
def type_str(self):
return "Snapshot Task"
def get_delta(self):
return self.config.to_dict()
def delete(self, *args, **kwargs):
self.config.delete()
return super(self.__class__, self).delete(*args, **kwargs)
class JobFactory(object):
"""This class creates all the API models (jobs, tasks, etc) needed to fulfill a booking."""
@classmethod
def reimageHost(cls, new_image, booking, host):
"""Modify an existing job to reimage the given host."""
job = Job.objects.get(booking=booking)
# make hardware task new
hardware_relation = HostHardwareRelation.objects.get(host=host, job=job)
hardware_relation.config.set_image(new_image.lab_id)
hardware_relation.config.save()
hardware_relation.status = JobStatus.NEW
# re-apply networking after host is reset
net_relation = HostNetworkRelation.objects.get(host=host, job=job)
net_relation.status = JobStatus.NEW
# re-apply ssh access after host is reset
for relation in AccessRelation.objects.filter(job=job, config__access_type="ssh"):
relation.status = JobStatus.NEW
relation.save()
hardware_relation.save()
net_relation.save()
@classmethod
def makeSnapshotTask(cls, image, booking, host):
relation = SnapshotRelation()
job = Job.objects.get(booking=booking)
config = SnapshotConfig.objects.create(dashboard_id=image.id)
relation.job = job
relation.config = config
relation.config.save()
relation.config = relation.config
relation.snapshot = image
relation.save()
config.clear_delta()
config.set_host(host)
config.save()
@classmethod
def makeCompleteJob(cls, booking):
"""Create everything that is needed to fulfill the given booking."""
resources = booking.resource.get_resources()
job = None
try:
job = Job.objects.get(booking=booking)
except Exception:
job = Job.objects.create(status=JobStatus.NEW, booking=booking)
cls.makeHardwareConfigs(
resources=resources,
job=job
)
cls.makeNetworkConfigs(
resources=resources,
job=job
)
cls.makeSoftware(
booking=booking,
job=job
)
all_users = list(booking.collaborators.all())
all_users.append(booking.owner)
cls.makeAccessConfig(
users=all_users,
access_type="vpn",
revoke=False,
job=job
)
for user in all_users:
try:
cls.makeAccessConfig(
users=[user],
access_type="ssh",
revoke=False,
job=job,
context={
"key": user.userprofile.ssh_public_key.open().read().decode(encoding="UTF-8"),
"hosts": [r.labid for r in resources]
}
)
except Exception:
continue
@classmethod
def makeHardwareConfigs(cls, resources=[], job=Job()):
"""
Create and save HardwareConfig.
Helper function to create the tasks related to
configuring the hardware
"""
for res in resources:
hardware_config = None
try:
hardware_config = HardwareConfig.objects.get(relation__resource_id=res.labid)
except Exception:
hardware_config = HardwareConfig()
relation = HostHardwareRelation()
relation.resource_id = res.labid
relation.job = job
relation.config = hardware_config
relation.config.save()
relation.config = relation.config
relation.save()
hardware_config.set("id", "image", "hostname", "power", "ipmi_create")
hardware_config.save()
@classmethod
def makeAccessConfig(cls, users, access_type, revoke=False, job=Job(), context=False):
"""
Create and save AccessConfig.
Helper function to create the tasks related to
configuring the VPN, SSH, etc access for users
"""
for user in users:
relation = AccessRelation()
relation.job = job
config = AccessConfig()
config.access_type = access_type
config.user = user
config.save()
relation.config = config
relation.save()
config.clear_delta()
if context:
config.set_context(context)
config.set_access_type(access_type)
config.set_revoke(revoke)
config.set_user(user)
config.save()
@classmethod
def makeNetworkConfigs(cls, resources=[], job=Job()):
"""
Create and save NetworkConfig.
Helper function to create the tasks related to
configuring the networking
"""
for res in resources:
network_config = None
try:
network_config = NetworkConfig.objects.get(relation__host=res)
except Exception:
network_config = NetworkConfig.objects.create()
relation = HostNetworkRelation()
relation.resource_id = res.labid
relation.job = job
network_config.save()
relation.config = network_config
relation.save()
network_config.clear_delta()
# TODO: use get_interfaces() on resource
for interface in res.interfaces.all():
network_config.add_interface(interface)
network_config.save()
@classmethod
def make_bridge_config(cls, booking):
if len(booking.resource.get_resources()) < 2:
return None
try:
jumphost_config = ResourceOPNFVConfig.objects.filter(
role__name__iexact="jumphost"
)
jumphost = ResourceQuery.filter(
bundle=booking.resource,
config=jumphost_config.resource_config
)[0]
except Exception:
return None
br_config = BridgeConfig.objects.create(opnfv_config=booking.opnfv_config)
for iface in jumphost.interfaces.all():
br_config.interfaces.add(iface)
return br_config
@classmethod
def makeSoftware(cls, booking=None, job=Job()):
"""
Create and save SoftwareConfig.
Helper function to create the tasks related to
configuring the desired software, e.g. an OPNFV deployment
"""
if not booking.opnfv_config:
return None
opnfv_api_config = OpnfvApiConfig.objects.create(
opnfv_config=booking.opnfv_config,
installer=booking.opnfv_config.installer.name,
scenario=booking.opnfv_config.scenario.name,
bridge_config=cls.make_bridge_config(booking)
)
opnfv_api_config.set_xdf(booking, False)
opnfv_api_config.save()
for host in booking.resource.get_resources():
opnfv_api_config.roles.add(host)
software_config = SoftwareConfig.objects.create(opnfv=opnfv_api_config)
software_relation = SoftwareRelation.objects.create(job=job, config=software_config)
return software_relation
JOB_TASK_CLASSLIST = [
HostHardwareRelation,
AccessRelation,
HostNetworkRelation,
SoftwareRelation,
SnapshotRelation
]
class JobTaskQuery(AbstractModelQuery):
model_list = JOB_TASK_CLASSLIST
|