-
Notifications
You must be signed in to change notification settings - Fork 6
/
views.py
603 lines (540 loc) · 20.2 KB
/
views.py
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
from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.parsers import JSONParser
from rest_framework import generics
from .models import (
AssuranceCase,
TopLevelNormativeGoal,
Context,
SystemDescription,
PropertyClaim,
Argument,
EvidentialClaim,
Evidence,
)
from .serializers import (
AssuranceCaseSerializer,
TopLevelNormativeGoalSerializer,
ContextSerializer,
SystemDescriptionSerializer,
PropertyClaimSerializer,
ArgumentSerializer,
EvidentialClaimSerializer,
EvidenceSerializer,
)
TYPE_DICT = {
"assurance_case": {
"serializer": AssuranceCaseSerializer,
"model": AssuranceCase,
"children": ["goals"],
"fields": ("name", "description"),
},
"goals": {
"serializer": TopLevelNormativeGoalSerializer,
"model": TopLevelNormativeGoal,
"children": ["context", "system_description", "property_claims"],
"fields": ("name", "short_description", "long_description", "keywords"),
"parent_types": [("assurance_case", False)],
},
"context": {
"serializer": ContextSerializer,
"model": Context,
"children": [],
"fields": ("name", "short_description", "long_description"),
"parent_types": [("goal", False)],
},
"system_description": {
"serializer": SystemDescriptionSerializer,
"model": SystemDescription,
"children": [],
"fields": ("name", "short_description", "long_description"),
"parent_types": [("goal", False)],
},
"property_claims": {
"serializer": PropertyClaimSerializer,
"model": PropertyClaim,
"children": ["arguments", "property_claims"],
"fields": ("name", "short_description", "long_description"),
"parent_types": [("goal", False), ("property_claim", False)],
},
"arguments": {
"serializer": ArgumentSerializer,
"model": Argument,
"children": ["evidential_claims"],
"fields": ("name", "short_description", "long_description"),
"parent_types": [("property_claim", True)],
},
"evidential_claims": {
"serializer": EvidentialClaimSerializer,
"model": EvidentialClaim,
"children": ["evidence"],
"fields": ("name", "short_description", "long_description"),
"parent_types": [("argument", False)],
},
"evidence": {
"serializer": EvidenceSerializer,
"model": Evidence,
"children": [],
"fields": ("name", "short_description", "long_description", "URL"),
"parent_types": [("evidential_claim", True)],
},
}
class AssuranceView(generics.ListCreateAPIView):
queryset = AssuranceCase.objects.all()
serializer_class = AssuranceCaseSerializer
class GoalsView(generics.ListCreateAPIView):
queryset = TopLevelNormativeGoal.objects.all()
serializer_class = TopLevelNormativeGoalSerializer
class DetailAssuranceView(generics.RetrieveUpdateDestroyAPIView):
queryset = AssuranceCase.objects.all()
serializer_class = AssuranceCaseSerializer
def make_summary(serialized_data):
"""
Take in a full serialized object, and return dict containing just
the id and the name
parameter: serialized_data, dict, or list of dicts
returns: dict, or list of dicts, containing just "name" and "id" key/values.
"""
def summarize_one(data):
if not (
isinstance(data, dict) and "id" in data.keys() and "name" in data.keys()
):
raise RuntimeError("Expected dictionary containing name and id")
return {"name": data["name"], "id": data["id"]}
if isinstance(serialized_data, list):
return [summarize_one(sd) for sd in serialized_data]
else:
return summarize_one(serialized_data)
def get_json_tree(id_list, obj_type):
"""
Recursive function for populating the full JSON data for goals, used
in the case_detail view (i.e. one API call returns the full case data).
Params
======
id_list: list of object_ids from the parent serializer
obj_type: key of the json object (also a key of 'TYPE_DICT')
Returns
=======
objs: list of json objects
"""
objs = []
for obj_id in id_list:
obj = TYPE_DICT[obj_type]["model"].objects.get(pk=obj_id)
obj_serializer = TYPE_DICT[obj_type]["serializer"](obj)
obj_data = obj_serializer.data
for child_type in TYPE_DICT[obj_type]["children"]:
child_list = obj_data[child_type]
obj_data[child_type] = get_json_tree(child_list, child_type)
objs.append(obj_data)
return objs
def save_json_tree(data, obj_type, parent_id=None, parent_type=None):
"""Recursively write items in an assurance case tree.
Create a new assurance case like the one described by data, including all
its items.
Params
======
data: JSON for the assurance case and all its items. At the top level
includes the whole item tree, subtrees when recursing.
obj_type: Key of the json object (also a key of 'TYPE_DICT'). At the top
level this should be "assurance_case".
parent_id: None at the top level, id of the caller when recursing.
Returns
=======
objs: JsonResponse describing failure/success.
"""
# Create the top object in data. Only include some of the fields from data,
# so that e.g. the new object gets a unique ID even if `data` specifies an
# ID.
this_data = {k: data[k] for k in TYPE_DICT[obj_type]["fields"]}
if parent_id is not None and parent_type is not None:
for parent_type_tmp, plural in TYPE_DICT[obj_type]["parent_types"]:
# TODO This is silly. It's all because some parent_type names are written
# with a plural s in the end while others are not.
if parent_type not in parent_type_tmp:
continue
if plural:
parent_id = [parent_id]
this_data[parent_type_tmp + "_id"] = parent_id
serializer_class = TYPE_DICT[obj_type]["serializer"]
serializer = serializer_class(data=this_data)
if serializer.is_valid():
serializer.save()
else:
return JsonResponse(serializer.errors, status=400)
# Recurse into child types.
name = serializer.data["name"]
id = serializer.data["id"]
success_http_code = 201
child_types = TYPE_DICT[obj_type]["children"]
for child_type in child_types:
if child_type not in data:
continue
for child_data in data[child_type]:
retval = save_json_tree(
child_data, child_type, parent_id=id, parent_type=obj_type
)
# If one of the subcalls returns an error, return.
if retval.status_code != success_http_code:
return retval
summary = {"name": name, "id": id}
return JsonResponse(summary, status=success_http_code)
@csrf_exempt
def case_list(request):
"""
List all cases, or make a new case
"""
if request.method == "GET":
cases = AssuranceCase.objects.all()
serializer = AssuranceCaseSerializer(cases, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
return save_json_tree(data, "assurance_case")
@csrf_exempt
def case_detail(request, pk):
"""
Retrieve, update, or delete an AssuranceCase, by primary key
"""
try:
case = AssuranceCase.objects.get(pk=pk)
except AssuranceCase.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = AssuranceCaseSerializer(case)
case_data = serializer.data
goals = get_json_tree(case_data["goals"], "goals")
case_data["goals"] = goals
return JsonResponse(case_data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = AssuranceCaseSerializer(case, data=data, partial=True)
if serializer.is_valid():
serializer.save()
return JsonResponse(serializer.data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
case.delete()
return HttpResponse(status=204)
@csrf_exempt
def goal_list(request):
"""
List all goals, or make a new goal
"""
if request.method == "GET":
goals = TopLevelNormativeGoal.objects.all()
serializer = TopLevelNormativeGoalSerializer(goals, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
assurance_case_id = AssuranceCase.objects.get(id=data["assurance_case_id"])
data["assurance_case"] = assurance_case_id
serializer = TopLevelNormativeGoalSerializer(data=data)
if serializer.is_valid():
serializer.save()
summary = make_summary(serializer.data)
return JsonResponse(summary, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def goal_detail(request, pk):
"""
Retrieve, update, or delete a TopLevelNormativeGoal, by primary key
"""
try:
goal = TopLevelNormativeGoal.objects.get(pk=pk)
shape = goal.shape.name
except TopLevelNormativeGoal.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = TopLevelNormativeGoalSerializer(goal)
data = serializer.data
# replace IDs for children with full JSON objects
for key in ["context", "system_description", "property_claims"]:
data[key] = get_json_tree(data[key], key)
data["shape"] = shape
return JsonResponse(data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = TopLevelNormativeGoalSerializer(goal, data=data, partial=True)
if serializer.is_valid():
serializer.save()
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
goal.delete()
return HttpResponse(status=204)
@csrf_exempt
def context_list(request):
"""
List all contexts, or make a new context
"""
if request.method == "GET":
contexts = Context.objects.all()
serializer = ContextSerializer(contexts, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
serializer = ContextSerializer(data=data)
if serializer.is_valid():
serializer.save()
summary = make_summary(serializer.data)
return JsonResponse(summary, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def context_detail(request, pk):
"""
Retrieve, update, or delete a Context, by primary key
"""
try:
context = Context.objects.get(pk=pk)
shape = context.shape.name
except Context.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = ContextSerializer(context)
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = ContextSerializer(context, data=data, partial=True)
if serializer.is_valid():
serializer.save()
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
context.delete()
return HttpResponse(status=204)
@csrf_exempt
def description_list(request):
"""
List all descriptions, or make a new description
"""
if request.method == "GET":
descriptions = SystemDescription.objects.all()
serializer = SystemDescriptionSerializer(descriptions, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
serializer = SystemDescriptionSerializer(data=data)
if serializer.is_valid():
serializer.save()
summary = make_summary(serializer.data)
return JsonResponse(summary, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def description_detail(request, pk):
"""
Retrieve, update, or delete a SystemDescription, by primary key
"""
try:
description = SystemDescription.objects.get(pk=pk)
shape = description.shape.name
except SystemDescription.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = SystemDescriptionSerializer(description)
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = SystemDescriptionSerializer(description, data=data, partial=True)
if serializer.is_valid():
serializer.save()
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
description.delete()
return HttpResponse(status=204)
@csrf_exempt
def property_claim_list(request):
"""
List all claims, or make a new claim
"""
if request.method == "GET":
claims = PropertyClaim.objects.all()
serializer = PropertyClaimSerializer(claims, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
serializer = PropertyClaimSerializer(data=data)
if serializer.is_valid():
serializer.save()
summary = make_summary(serializer.data)
return JsonResponse(summary, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def property_claim_detail(request, pk):
"""
Retrieve, update, or delete a PropertyClaim, by primary key
"""
try:
claim = PropertyClaim.objects.get(pk=pk)
shape = claim.shape.name
except PropertyClaim.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = PropertyClaimSerializer(claim)
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = PropertyClaimSerializer(claim, data=data, partial=True)
if serializer.is_valid():
serializer.save()
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
claim.delete()
return HttpResponse(status=204)
@csrf_exempt
def argument_list(request):
"""
List all arguments, or make a new argument
"""
if request.method == "GET":
arguments = Argument.objects.all()
serializer = ArgumentSerializer(arguments, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
serializer = ArgumentSerializer(data=data)
if serializer.is_valid():
serializer.save()
summary = make_summary(serializer.data)
return JsonResponse(summary, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def argument_detail(request, pk):
"""
Retrieve, update, or delete a Argument, by primary key
"""
try:
argument = Argument.objects.get(pk=pk)
shape = argument.shape.name
except Argument.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = ArgumentSerializer(argument)
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = ArgumentSerializer(argument, data=data, partial=True)
if serializer.is_valid():
serializer.save()
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
argument.delete()
return HttpResponse(status=204)
@csrf_exempt
def evidential_claim_list(request):
"""
List all evidential_claims, or make a new evidential_claim
"""
if request.method == "GET":
evidential_claims = EvidentialClaim.objects.all()
serializer = EvidentialClaimSerializer(evidential_claims, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
serializer = EvidentialClaimSerializer(data=data)
if serializer.is_valid():
serializer.save()
summary = make_summary(serializer.data)
return JsonResponse(summary, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def evidential_claim_detail(request, pk):
"""
Retrieve, update, or delete a EvidentialClaim, by primary key
"""
try:
evidential_claim = EvidentialClaim.objects.get(pk=pk)
shape = evidential_claim.shape.name
except EvidentialClaim.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = EvidentialClaimSerializer(evidential_claim)
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = EvidentialClaimSerializer(
evidential_claim, data=data, partial=True
)
if serializer.is_valid():
serializer.save()
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
evidential_claim.delete()
return HttpResponse(status=204)
@csrf_exempt
def evidence_list(request):
"""
List all evidences, or make a new evidence
"""
if request.method == "GET":
evidences = Evidence.objects.all()
serializer = EvidenceSerializer(evidences, many=True)
summaries = make_summary(serializer.data)
return JsonResponse(summaries, safe=False)
elif request.method == "POST":
data = JSONParser().parse(request)
serializer = EvidenceSerializer(data=data)
if serializer.is_valid():
serializer.save()
summary = make_summary(serializer.data)
return JsonResponse(summary, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def evidence_detail(request, pk):
"""
Retrieve, update, or delete Evidence, by primary key
"""
try:
evidence = Evidence.objects.get(pk=pk)
shape = evidence.shape.name
except Evidence.DoesNotExist:
return HttpResponse(status=404)
if request.method == "GET":
serializer = EvidenceSerializer(evidence)
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
elif request.method == "PUT":
data = JSONParser().parse(request)
serializer = EvidenceSerializer(evidence, data=data, partial=True)
if serializer.is_valid():
serializer.save()
data = serializer.data
data["shape"] = shape
return JsonResponse(data)
return JsonResponse(serializer.errors, status=400)
elif request.method == "DELETE":
evidence.delete()
return HttpResponse(status=204)