-
-
Notifications
You must be signed in to change notification settings - Fork 191
Expand file tree
/
Copy pathtest_views.py
More file actions
1744 lines (1483 loc) · 71.5 KB
/
test_views.py
File metadata and controls
1744 lines (1483 loc) · 71.5 KB
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
# SPDX-License-Identifier: Apache-2.0
#
# http://nexb.com and https://github.com/nexB/scancode.io
# The ScanCode.io software is licensed under the Apache License version 2.0.
# Data generated with ScanCode.io is provided as-is without warranties.
# ScanCode is a trademark of nexB Inc.
#
# You may not use this software except in compliance with the License.
# You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software distributed
# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
# CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.
#
# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES
# OR CONDITIONS OF ANY KIND, either express or implied. No content created from
# ScanCode.io should be considered or used as legal advice. Consult an Attorney
# for any legal advice.
#
# ScanCode.io is a free software code scanning tool from nexB Inc. and others.
# Visit https://github.com/nexB/scancode.io for support and download.
import io
import json
import shutil
import uuid
from pathlib import Path
from unittest import mock
from django.apps import apps
from django.http import FileResponse
from django.http.response import Http404
from django.test import TestCase
from django.test import override_settings
from django.urls import reverse
from django.urls.exceptions import NoReverseMatch
import openpyxl
import requests
from scanpipe.forms import BaseProjectActionForm
from scanpipe.models import CodebaseRelation
from scanpipe.models import CodebaseResource
from scanpipe.models import DiscoveredDependency
from scanpipe.models import DiscoveredPackage
from scanpipe.models import Project
from scanpipe.pipes import make_relation
from scanpipe.pipes import update_or_create_dependency
from scanpipe.pipes.input import copy_input
from scanpipe.pipes.input import copy_inputs
from scanpipe.tests import dependency_data1
from scanpipe.tests import dependency_data2
from scanpipe.tests import make_dependency
from scanpipe.tests import make_package
from scanpipe.tests import make_project
from scanpipe.tests import make_resource_directory
from scanpipe.tests import make_resource_file
from scanpipe.tests import package_data1
from scanpipe.tests import package_data2
from scanpipe.views import CodebaseResourceDetailsView
from scanpipe.views import ProjectActionView
from scanpipe.views import ProjectCodebasePanelView
from scanpipe.views import ProjectDetailView
scanpipe_app = apps.get_app_config("scanpipe")
@override_settings(SCANCODEIO_REQUIRE_AUTHENTICATION=False)
class ScanPipeViewsTest(TestCase):
data = Path(__file__).parent / "data"
def setUp(self):
self.project1 = Project.objects.create(name="Analysis")
def test_scanpipe_views_project_list_is_archived(self):
project2 = Project.objects.create(name="project2", is_archived=True)
url = reverse("project_list")
is_archive_filter = "?is_archived=true"
response = self.client.get(url)
self.assertContains(response, self.project1.name)
self.assertNotContains(response, project2.name)
self.assertContains(response, url)
self.assertContains(response, is_archive_filter)
response = self.client.get(url + is_archive_filter)
self.assertNotContains(response, self.project1.name)
self.assertContains(response, project2.name)
def test_scanpipe_views_project_list_filters(self):
url = reverse("project_list")
response = self.client.get(url)
is_archived_filters = """
<li>
<a href="?is_archived=" class=" is-active">
<i class="fa-solid fa-seedling"></i> 1 Active
</a>
</li>
<li>
<a href="?is_archived=true" class="">
<i class="fa-solid fa-dice-d6"></i> 0 Archived
</a>
</li>
"""
self.assertContains(response, is_archived_filters, html=True)
pipeline_filters = [
"?pipeline=analyze_docker_image",
"?pipeline=analyze_windows_docker_image",
"?pipeline=load_inventory",
"?pipeline=analyze_root_filesystem_or_vm_image",
"?pipeline=scan_codebase",
"?pipeline=scan_single_package",
]
for pipeline_filter in pipeline_filters:
self.assertContains(response, pipeline_filter)
status_filters = """
<li><a href="?status=" class="dropdown-item is-active">All</a></li>
<li><a href="?status=not_started" class="dropdown-item">Not started</a></li>
<li><a href="?status=queued" class="dropdown-item">Queued</a></li>
<li><a href="?status=running" class="dropdown-item">Running</a></li>
<li><a href="?status=succeed" class="dropdown-item">Success</a></li>
<li><a href="?status=failed" class="dropdown-item">Failure</a></li>
"""
self.assertContains(response, status_filters, html=True)
sort_filters = """
<li><a href="?sort=" class="dropdown-item is-active">Newest</a></li>
<li><a href="?sort=created_date" class="dropdown-item">Oldest</a></li>
<li><a href="?sort=name" class="dropdown-item">Name (A-z)</a></li>
<li><a href="?sort=-name" class="dropdown-item">Name (z-A)</a></li>
"""
self.assertContains(response, sort_filters, html=True)
def test_scanpipe_views_project_list_state_of_filters_in_search_form(self):
url = reverse("project_list")
data = {
"status": "failed",
"search": "query",
}
response = self.client.get(url, data=data)
expected = (
'<input class="input is-smaller" type="search" '
'placeholder="Search projects" name="search" value="query">'
)
self.assertContains(response, expected, html=True)
expected = '<input type="hidden" name="status" value="failed">'
self.assertContains(response, expected, html=True)
def test_scanpipe_views_project_list_filter_by_status_distinct_results(self):
url = reverse("project_list")
pipeline1 = self.project1.add_pipeline(pipeline_name="scan_codebase")
pipeline1.set_task_stopped()
pipeline2 = self.project1.add_pipeline(pipeline_name="scan_codebase")
pipeline2.set_task_stopped()
data = {"status": "failed"}
response = self.client.get(url, data=data)
self.assertEqual(1, len(response.context["object_list"]))
@mock.patch("scanpipe.views.ProjectListView.get_paginate_by")
def test_scanpipe_views_project_list_filters_exclude_page(self, mock_paginate_by):
url = reverse("project_list")
# Create another project to enable pagination
make_project()
mock_paginate_by.return_value = 1
data = {"page": "2"}
response = self.client.get(url, data=data)
expected = '<a href="?page=2&sort=name" class="is-black-link">Name</a>'
self.assertContains(response, expected, html=True)
expected = '<li><a href="?status=" class="dropdown-item is-active">All</a></li>'
self.assertContains(response, expected)
expected = '<a href="?pipeline=" class="dropdown-item is-active">All</a>'
self.assertContains(response, expected)
expected = '<a href="?sort=" class="dropdown-item is-active">Newest</a>'
self.assertContains(response, expected)
def test_scanpipe_views_project_list_modal_forms_include_url_query(self):
url = reverse("project_list")
response = self.client.get(url)
expected_html_names = [
"url_query",
"download-url_query",
"report-url_query",
"archive-url_query",
"reset-url_query",
]
for html_name in expected_html_names:
expected = f'<input type="hidden" name="{html_name}" value="">'
self.assertContains(response, expected, html=True)
url_query = "name=search_value"
response = self.client.get(url + "?" + url_query)
for html_name in expected_html_names:
expected = f'<input type="hidden" name="{html_name}" value="{url_query}">'
self.assertContains(response, expected, html=True)
@mock.patch("scanpipe.views.ProjectListView.get_paginate_by")
def test_scanpipe_views_project_list_modal_forms_include_show_on_all_checked(
self, mock_paginate_by
):
url = reverse("project_list")
# Create another project to enable pagination
make_project()
mock_paginate_by.return_value = 1
response = self.client.get(url)
expected = '<div class="show-on-all-checked">'
self.assertContains(response, expected)
mock_paginate_by.return_value = 2
response = self.client.get(url)
self.assertNotContains(response, expected)
def test_scanpipe_views_project_actions_view(self):
url = reverse("project_action")
response = self.client.get(url)
self.assertEqual(405, response.status_code)
response = self.client.post(url)
self.assertEqual(404, response.status_code)
data = {"action": "does_not_exists"}
response = self.client.post(url, data=data)
self.assertEqual(404, response.status_code)
data = {"action": "delete"}
response = self.client.post(url, data=data)
self.assertEqual(404, response.status_code)
random_uuid = uuid.uuid4()
data = {
"action": "delete",
"selected_ids": f"{self.project1.uuid},{random_uuid}",
}
response = self.client.post(url, data=data, follow=True)
self.assertRedirects(response, reverse("project_list"))
expected = '<div class="message-body">1 projects have been delete.</div>'
self.assertContains(response, expected, html=True)
def test_scanpipe_views_project_action_report_view(self):
url = reverse("project_action")
data = {
"action": "report",
"selected_ids": f"{self.project1.uuid}",
"report-model_name": "todo",
}
response = self.client.post(url, data=data, follow=True)
self.assertTrue(response.filename.startswith("scancodeio-report-"))
self.assertTrue(response.filename.endswith(".xlsx"))
output_file = io.BytesIO(b"".join(response.streaming_content))
workbook = openpyxl.load_workbook(output_file, read_only=True, data_only=True)
self.assertEqual(["TODOS"], workbook.sheetnames)
def test_scanpipe_views_project_action_reset_view(self):
url = reverse("project_action")
data = {
"action": "reset",
"selected_ids": f"{self.project1.uuid}",
"reset-restore_pipelines": "on",
}
self.project1.add_pipeline(pipeline_name="scan_codebase")
response = self.client.post(url, data=data, follow=True)
expected = "1 projects have been reset."
self.assertContains(response, expected)
self.assertTrue(Project.objects.filter(name=self.project1.name).exists())
self.assertEqual(1, self.project1.runs.count())
def test_scanpipe_views_project_action_view_get_project_queryset(self):
queryset = ProjectActionView.get_project_queryset(
selected_project_ids=[self.project1.uuid],
action_form=None,
)
self.assertQuerySetEqual(queryset, [self.project1])
# No project selection, no select_across
form_data = {"select_across": 0}
action_form = BaseProjectActionForm(data=form_data)
action_form.full_clean()
with self.assertRaises(Http404):
ProjectActionView.get_project_queryset(
selected_project_ids=None,
action_form=action_form,
)
# select_across, no active filters
form_data = {"select_across": 1}
action_form = BaseProjectActionForm(data=form_data)
action_form.full_clean()
self.assertQuerySetEqual(queryset, [self.project1])
# select_across, active filters
make_project()
self.assertEqual(2, Project.objects.count())
form_data = {"select_across": 1, "url_query": f"name={self.project1.name}"}
action_form = BaseProjectActionForm(data=form_data)
action_form.full_clean()
self.assertQuerySetEqual(queryset, [self.project1])
def test_scanpipe_views_project_details_is_archived(self):
url = self.project1.get_absolute_url()
expected1 = "WARNING: This project is archived and read-only."
response = self.client.get(url)
self.assertNotContains(response, expected1)
self.project1.archive()
response = self.client.get(url)
self.assertContains(response, expected1)
@mock.patch("requests.sessions.Session.head")
def test_scanpipe_views_project_details_add_inputs(self, mock_head):
url = self.project1.get_absolute_url()
data = {
"input_urls": "https://example.com/archive.zip",
"add-inputs-submit": "",
}
mock_head.side_effect = requests.exceptions.RequestException
response = self.client.post(url, data, follow=True)
self.assertContains(response, "Input file addition error.")
mock_head.side_effect = None
mock_head.return_value = mock.Mock(headers={}, status_code=200)
response = self.client.post(url, data, follow=True)
self.assertContains(response, "Input file(s) added.")
inputs_with_source = self.project1.get_inputs_with_source()
expected = [
{
"uuid": str(self.project1.inputsources.get().uuid),
"filename": "",
"download_url": "https://example.com/archive.zip",
"is_uploaded": False,
"tag": "",
"size": None,
"is_file": True,
"exists": False,
}
]
self.assertEqual(expected, inputs_with_source)
def test_scanpipe_views_project_details_download_input_view(self):
url = reverse("project_download_input", args=[self.project1.slug, "file.zip"])
response = self.client.get(url)
self.assertEqual(404, response.status_code)
file_location = self.data / "aboutcode" / "notice.NOTICE"
copy_input(file_location, self.project1.input_path)
filename = file_location.name
url = reverse("project_download_input", args=[self.project1.slug, filename])
response = self.client.get(url)
self.assertTrue(response.getvalue().startswith(b"# SPDX-License-Identifier"))
self.assertEqual("application/octet-stream", response.headers["Content-Type"])
self.assertEqual(
'attachment; filename="notice.NOTICE"',
response.headers["Content-Disposition"],
)
def test_scanpipe_views_project_details_download_output_view(self):
url = reverse("project_download_output", args=[self.project1.slug, "file.zip"])
response = self.client.get(url)
self.assertEqual(404, response.status_code)
file_location = self.data / "aboutcode" / "notice.NOTICE"
copy_input(file_location, self.project1.output_path)
filename = file_location.name
url = reverse("project_download_output", args=[self.project1.slug, filename])
response = self.client.get(url)
self.assertTrue(response.getvalue().startswith(b"# SPDX-License-Identifier"))
self.assertEqual("application/octet-stream", response.headers["Content-Type"])
self.assertEqual(
'attachment; filename="notice.NOTICE"',
response.headers["Content-Disposition"],
)
def test_scanpipe_views_project_details_delete_input_view(self):
random_uuid = str(uuid.uuid4())
url = reverse("project_delete_input", args=[self.project1.slug, random_uuid])
response = self.client.get(url)
self.assertEqual(405, response.status_code)
response = self.client.post(url, follow=True)
self.assertEqual(404, response.status_code)
file_location = self.data / "aboutcode" / "notice.NOTICE"
copy_input(file_location, self.project1.input_path)
filename = file_location.name
input1 = self.project1.add_input_source(filename=filename, is_uploaded=True)
self.project1.update(is_archived=True)
self.assertFalse(self.project1.can_change_inputs)
url = reverse("project_delete_input", args=[self.project1.slug, input1.uuid])
response = self.client.post(url)
self.assertEqual(404, response.status_code)
self.project1.update(is_archived=False)
self.project1 = Project.objects.get(pk=self.project1.pk)
self.assertTrue(self.project1.can_change_inputs)
response = self.client.post(url, follow=True)
self.assertRedirects(response, self.project1.get_absolute_url())
expected = f'<div class="message-body">Input {filename} deleted.</div>'
self.assertContains(response, expected, html=True)
self.assertEqual([], self.project1.input_sources)
self.assertEqual([], list(self.project1.inputs()))
def test_scanpipe_views_project_details_missing_inputs(self):
self.project1.add_input_source(filename="missing.zip", is_uploaded=True)
url = self.project1.get_absolute_url()
response = self.client.get(url)
expected = (
'<div class="message-body">'
" The following input files are not available on disk anymore:<br>"
" - missing.zip"
"</div>"
)
self.assertContains(response, expected, html=True)
def test_scanpipe_views_project_details_add_pipelines(self):
url = self.project1.get_absolute_url()
data = {
"pipeline": "analyze_docker_image",
}
response = self.client.post(url, data, follow=True)
self.assertEqual(404, response.status_code)
data["add-pipeline-submit"] = ""
response = self.client.post(url, data, follow=True)
self.assertContains(response, "Pipeline added.")
run = self.project1.runs.get()
self.assertEqual("analyze_docker_image", run.pipeline_name)
self.assertIsNone(run.task_start_date)
def test_scanpipe_views_project_details_get_pipeline_choices(self):
main_pipeline1 = "scan_codebase"
main_pipeline2 = "scan_single_package"
addon_pipeline = "find_vulnerabilities"
choices = ProjectDetailView.get_pipeline_choices(pipeline_runs=[])
pipeline_choices = [choice[0] for choice in choices]
self.assertIn(main_pipeline1, pipeline_choices)
self.assertIn(main_pipeline2, pipeline_choices)
self.assertNotIn(addon_pipeline, pipeline_choices)
self.project1.add_pipeline(pipeline_name=main_pipeline1)
choices = ProjectDetailView.get_pipeline_choices(
pipeline_runs=self.project1.runs.all()
)
pipeline_choices = [choice[0] for choice in choices]
self.assertIn(main_pipeline1, pipeline_choices)
self.assertNotIn(main_pipeline2, pipeline_choices)
self.assertIn(addon_pipeline, pipeline_choices)
def test_scanpipe_views_project_details_add_labels(self):
url = self.project1.get_absolute_url()
data = {
"labels": "label1, label2",
}
response = self.client.post(url, data, follow=True)
self.assertEqual(404, response.status_code)
data["add-labels-submit"] = ""
response = self.client.post(url, data, follow=True)
self.assertContains(response, "Label(s) added.")
self.assertEqual(["label1", "label2"], list(self.project1.labels.names()))
def test_scanpipe_views_project_delete_label(self):
self.project1.labels.add("label1")
url = reverse("project_delete_label", args=[self.project1.slug, "label1"])
response = self.client.get(url)
self.assertEqual(405, response.status_code)
response = self.client.post(url)
self.assertEqual(200, response.status_code)
self.assertEqual({}, response.json())
self.assertEqual([], list(self.project1.labels.names()))
def test_scanpipe_views_project_details_edit_input_source_tag(self):
url = self.project1.get_absolute_url()
input_source = self.project1.add_input_source(
filename="filename.zip",
is_uploaded=True,
tag="base value",
)
data = {
"input_source_uuid": input_source.uuid,
"tag": "new value",
"edit-input-tag-submit": "",
}
response = self.client.post(url, data, follow=True)
self.assertContains(response, "Tag updated.")
input_source.refresh_from_db()
self.assertEqual(data["tag"], input_source.tag)
def test_scanpipe_views_project_details_charts_view(self):
url = reverse("project_charts", args=[self.project1.slug])
with self.assertNumQueries(9):
response = self.client.get(url)
self.assertNotContains(response, 'id="package-charts"')
self.assertNotContains(response, 'id="dependency-charts"')
self.assertNotContains(response, 'id="resource-charts-charts"')
make_resource_file(self.project1, path="", programming_language="Python")
with self.assertNumQueries(12):
response = self.client.get(url)
self.assertContains(response, '{"Python": 1}')
def test_scanpipe_views_project_details_charts_compliance_alert(self):
url = reverse("project_charts", args=[self.project1.slug])
resource = make_resource_file(self.project1)
expected_resource_id = 'id="compliance_alert_chart"'
expected_package_id = 'id="package_compliance_alert_chart"'
response = self.client.get(url)
self.assertNotContains(response, expected_resource_id)
self.assertNotContains(response, expected_package_id)
# Do not trigger the save() logic.
CodebaseResource.objects.filter(id=resource.id).update(
compliance_alert=CodebaseResource.Compliance.ERROR
)
make_package(
self.project1,
package_url="pkg:generic/name@1.0",
compliance_alert=DiscoveredPackage.Compliance.WARNING,
)
response = self.client.get(url)
self.assertContains(response, expected_resource_id)
self.assertContains(response, expected_package_id)
self.assertContains(response, '{"error": 1}')
self.assertContains(response, '{"warning": 1}')
def test_scanpipe_views_project_details_charts_copyrights(self):
url = reverse("project_charts", args=[self.project1.slug])
make_resource_file(self.project1)
copyrights = [
{
"copyright": "Copyright (c) nexB Inc. and others",
"start_line": 2,
"end_line": 2,
}
]
make_resource_file(self.project1, copyrights=copyrights)
response = self.client.get(url)
expected = (
'<script id="file_copyrights" type="application/json">'
'{"Copyright (c) nexB Inc. and others": 1, "(No value detected)": 1}'
"</script>"
)
self.assertContains(response, expected)
def test_scanpipe_views_project_details_scan_summary_panels(self):
url = self.project1.get_absolute_url()
expected1 = 'id="license-clarity-panel"'
expected2 = 'id="scan-summary-panel"'
response = self.client.get(url)
self.assertNotContains(response, expected1)
self.assertNotContains(response, expected2)
summary_file = self.project1.get_output_file_path("summary", "json")
with summary_file.open("wb") as opened_file:
opened_file.write(b"\x21")
response = self.client.get(url)
self.assertNotContains(response, expected1)
self.assertNotContains(response, expected2)
scan_summary = self.data / "scancode" / "is-npm-1.0.0_scan_package_summary.json"
with summary_file.open("w") as opened_file:
opened_file.write(scan_summary.read_text())
response = self.client.get(url)
self.assertContains(response, expected1)
self.assertContains(response, expected2)
def test_scanpipe_views_project_details_get_license_clarity_data(self):
get_license_clarity_data = ProjectDetailView.get_license_clarity_data
scan_summary = self.data / "scancode" / "is-npm-1.0.0_scan_package_summary.json"
scan_summary_json = json.loads(scan_summary.read_text())
license_clarity_data = get_license_clarity_data(scan_summary_json)
self.assertEqual(7, len(license_clarity_data))
expected = ["label", "value", "help_text", "weight"]
self.assertEqual(expected, list(license_clarity_data[0].keys()))
score_entry = license_clarity_data[-1]
self.assertEqual("Score", score_entry.get("label"))
self.assertEqual(90, score_entry.get("value"))
self.assertIsNone(score_entry.get("weight"))
def test_scanpipe_views_project_details_get_scan_summary_data(self):
get_scan_summary_data = ProjectDetailView.get_scan_summary_data
scan_summary = self.data / "scancode" / "is-npm-1.0.0_scan_package_summary.json"
scan_summary_json = json.loads(scan_summary.read_text())
scan_summary_data = get_scan_summary_data(self.project1, scan_summary_json)
self.assertEqual(7, len(scan_summary_data))
expected = [
"declared_license_expression",
"declared_holder",
"primary_language",
"other_license_expressions",
"other_holders",
"other_languages",
"key_file_licenses",
]
self.assertEqual(expected, list(scan_summary_data.keys()))
def test_scanpipe_views_project_details_codebase_root(self):
(self.project1.codebase_path / "z.txt").touch()
(self.project1.codebase_path / "a.txt").touch()
(self.project1.codebase_path / "z").mkdir()
(self.project1.codebase_path / "a").mkdir()
(self.project1.codebase_path / "Zdir").mkdir()
(self.project1.codebase_path / "Dir").mkdir()
url = self.project1.get_absolute_url()
response = self.client.get(url)
codebase_root = response.context_data["codebase_root"]
expected = ["Dir", "Zdir", "a", "z", "a.txt", "z.txt"]
self.assertEqual(expected, [path.name for path in codebase_root])
@mock.patch.object(
Project, "license_policies_enabled", new_callable=mock.PropertyMock
)
def test_scanpipe_views_project_details_compliance_panel_availability(
self, mock_license_policies_enabled
):
url = self.project1.get_absolute_url()
make_package(
self.project1,
package_url="pkg:generic/name@1.0",
compliance_alert=DiscoveredPackage.Compliance.ERROR,
)
expected_url = reverse("project_compliance_panel", args=[self.project1.slug])
mock_license_policies_enabled.return_value = False
response = self.client.get(url)
self.assertNotContains(response, expected_url)
mock_license_policies_enabled.return_value = True
response = self.client.get(url)
self.assertContains(response, expected_url)
def test_scanpipe_views_project_create_view(self):
url = reverse("project_add")
response = self.client.get(url)
self.assertContains(response, "scan_codebase")
self.assertNotContains(response, "find_vulnerabilities")
def test_scanpipe_views_project_codebase_view(self):
url = reverse("project_codebase", args=[self.project1.slug])
(self.project1.codebase_path / "dir1").mkdir()
(self.project1.codebase_path / "dir1/dir2").mkdir()
(self.project1.codebase_path / "file+.txt").touch()
response = self.client.get(url)
resource_tree_url = reverse(
"project_resource_tree", args=[self.project1.slug, "dir1"]
)
self.assertContains(response, resource_tree_url)
resource_tree_url = reverse(
"project_resource_tree", args=[self.project1.slug, "file+.txt"]
)
self.assertContains(response, resource_tree_url)
def test_scanpipe_views_project_codebase_view_ordering(self):
url = reverse("project_codebase", args=[self.project1.slug])
(self.project1.codebase_path / "z.txt").touch()
(self.project1.codebase_path / "a.txt").touch()
(self.project1.codebase_path / "z").mkdir()
(self.project1.codebase_path / "a").mkdir()
(self.project1.codebase_path / "Zdir").mkdir()
(self.project1.codebase_path / "Dir").mkdir()
response = self.client.get(url)
codebase_tree = response.context_data["codebase_root_tree"]
expected = ["Dir", "Zdir", "a", "z", "a.txt", "z.txt"]
self.assertEqual(expected, [path.get("name") for path in codebase_tree])
def test_scanpipe_views_project_codebase_view_get_root_tree(self):
get_root_tree = ProjectCodebasePanelView.get_root_tree
(self.project1.codebase_path / "dir1").mkdir()
(self.project1.codebase_path / "dir1/dir2").mkdir()
(self.project1.codebase_path / "file.txt").touch()
with mock.patch.object(scanpipe_app, "workspace_path", ""):
self.assertEqual("", scanpipe_app.workspace_path)
with self.assertRaises(ValueError):
get_root_tree(self.project1)
codebase_tree = get_root_tree(self.project1)
expected = [
{"name": "dir1", "is_dir": True},
{"name": "file.txt", "is_dir": False},
]
self.assertEqual(expected, codebase_tree)
shutil.rmtree(self.project1.work_directory, ignore_errors=True)
self.assertFalse(self.project1.codebase_path.exists())
with self.assertRaises(Exception):
get_root_tree(self.project1)
def test_scanpipe_views_project_archive_view(self):
url = reverse("project_archive", args=[self.project1.slug])
run = self.project1.add_pipeline("analyze_docker_image")
run.set_task_started(run.pk)
response = self.client.post(url, follow=True)
expected = (
"Cannot execute this action until all associated pipeline runs "
"are completed."
)
self.assertContains(response, expected)
run.set_task_ended(exitcode=0)
response = self.client.post(url, follow=True)
expected = "has been archived."
self.assertContains(response, expected)
self.project1.refresh_from_db()
self.assertTrue(self.project1.is_archived)
def test_scanpipe_views_project_delete_view(self):
url = reverse("project_delete", args=[self.project1.slug])
run = self.project1.add_pipeline("analyze_docker_image")
run.set_task_started(run.pk)
response = self.client.post(url, follow=True)
expected = (
"Cannot execute this action until all associated pipeline runs "
"are completed."
)
self.assertContains(response, expected)
run.set_task_ended(exitcode=0)
response = self.client.post(url, follow=True)
expected = "all its related data have been removed."
self.assertContains(response, expected)
self.assertFalse(Project.objects.filter(name=self.project1.name).exists())
def test_scanpipe_views_project_reset_view(self):
url = reverse("project_reset", args=[self.project1.slug])
run = self.project1.add_pipeline("analyze_docker_image")
run.set_task_started(run.pk)
response = self.client.post(url, follow=True)
expected = (
"Cannot execute this action until all associated pipeline runs "
"are completed."
)
self.assertContains(response, expected)
run.set_task_ended(exitcode=0)
data = {"reset-restore_pipelines": "on"}
response = self.client.post(url, data=data, follow=True)
expected = "has been reset."
self.assertContains(response, expected)
self.assertTrue(Project.objects.filter(name=self.project1.name).exists())
self.assertEqual(1, self.project1.runs.count())
def test_scanpipe_views_project_settings_view(self):
url = reverse("project_settings", args=[self.project1.slug])
response = self.client.get(url)
expected_ids = [
"id_name",
"id_notes",
"id_uuid",
"id_work_directory",
"id_ignored_patterns",
"id_attribution_template",
'id="modal-archive"',
'id="modal-reset"',
'id="modal-delete"',
]
for expected in expected_ids:
self.assertContains(response, expected)
# Forcing a validation error
project2 = Project.objects.create(name="p2")
data = {"name": project2.name}
response = self.client.post(url, data)
expected_error = "<li>Project with this Name already exists.</li>"
self.assertContains(response, expected_error)
def test_scanpipe_views_project_settings_view_download_config_file(self):
url = reverse("project_settings", args=[self.project1.slug])
self.project1.settings = {"product_name": "Product"}
self.project1.save()
response = self.client.get(url, data={"download": 1})
self.assertEqual(b"product_name: Product\n", response.getvalue())
self.assertEqual("application/x-yaml", response.headers["Content-Type"])
def test_scanpipe_views_project_views(self):
self.project1.labels.add("label1", "label2")
project2 = Project.objects.create(name="Analysis2")
project2.labels.add("label3", "label4")
url = reverse("project_list")
with self.assertNumQueries(7):
self.client.get(url)
with self.assertNumQueries(15):
self.client.get(self.project1.get_absolute_url())
@mock.patch("scanpipe.models.Run.execute_task_async")
def test_scanpipe_views_execute_pipelines_view(self, mock_execute_task):
run = self.project1.add_pipeline("analyze_docker_image")
url = reverse("project_execute_pipelines", args=[self.project1.slug])
response = self.client.get(url, follow=True)
expected = "Pipelines run started."
self.assertContains(response, expected)
mock_execute_task.assert_called_once()
self.assertRedirects(response, self.project1.get_absolute_url())
run.set_task_queued()
response = self.client.get(url)
self.assertEqual(404, response.status_code)
run.set_task_started(run.pk)
response = self.client.get(url)
self.assertEqual(404, response.status_code)
run.set_task_stopped()
response = self.client.get(url)
self.assertEqual(404, response.status_code)
@mock.patch("scanpipe.models.Run.stop_task")
def test_scanpipe_views_stop_pipeline_view(self, mock_stop_task):
run = self.project1.add_pipeline("analyze_docker_image")
url = reverse("project_stop_pipeline", args=[self.project1.slug, run.uuid])
response = self.client.get(url)
self.assertEqual(404, response.status_code)
run.set_task_started(run.pk)
response = self.client.get(url, follow=True)
expected = f"Pipeline {run.pipeline_name} stopped."
self.assertContains(response, expected)
mock_stop_task.assert_called_once()
@mock.patch("scanpipe.models.Run.delete_task")
def test_scanpipe_views_delete_pipeline_view(self, mock_delete_task):
run = self.project1.add_pipeline("analyze_docker_image")
url = reverse("project_delete_pipeline", args=[self.project1.slug, run.uuid])
response = self.client.get(url, follow=True)
expected = f"Pipeline {run.pipeline_name} deleted."
self.assertContains(response, expected)
mock_delete_task.assert_called_once()
run.set_task_stopped()
response = self.client.get(url)
self.assertEqual(404, response.status_code)
def test_scanpipe_views_delete_webhook_view(self):
webhook = self.project1.add_webhook_subscription(target_url="https://localhost")
url = reverse("project_delete_webhook", args=[self.project1.slug, webhook.uuid])
response = self.client.post(url, follow=True)
expected = "Webhook deleted."
self.assertContains(response, expected)
self.assertEqual(0, self.project1.webhooksubscriptions.count())
response = self.client.get(url)
self.assertEqual(405, response.status_code)
def test_scanpipe_views_run_status_view(self):
run = self.project1.add_pipeline("analyze_docker_image")
url = reverse("run_status", args=[run.uuid])
response = self.client.get(url)
expected = '<span class="tag is-hoverable">Not started</span>'
self.assertContains(response, expected)
run.set_task_queued()
run.refresh_from_db()
response = self.client.get(url)
expected = '<i class="fa-solid fa-clock mr-1"></i>Queued'
self.assertContains(response, expected)
self.assertContains(response, f'hx-get="{url}?current_status={run.status}"')
run.current_step = "1/2 Step A"
run.save()
run.set_task_started(run.pk)
run.refresh_from_db()
response = self.client.get(url)
expected = (
'<i class="fa-solid fa-spinner fa-pulse mr-1" aria-hidden="true"></i>'
"Running"
)
self.assertContains(response, expected)
self.assertContains(response, f'hx-get="{url}?current_status={run.status}"')
response = self.client.get(url, data={"display_current_step": True})
expected = (
f'hx-get="{url}?current_status={run.status}&display_current_step=True"'
)
self.assertContains(response, expected)
self.assertContains(response, "1/2 Step A")
run.set_task_ended(exitcode=1)
response = self.client.get(url)
expected = '<span class="tag is-danger is-hoverable">Failure</span>'
self.assertContains(response, expected)
run.set_task_ended(exitcode=0)
response = self.client.get(url)
expected = '<span class="tag is-success is-hoverable">Success</span>'
self.assertContains(response, expected)
run.set_task_staled()
response = self.client.get(url)
expected = '<span class="tag is-dark is-hoverable">Stale</span>'
self.assertContains(response, expected)
run.set_task_stopped()
response = self.client.get(url)
expected = '<span class="tag is-danger is-hoverable">Stopped</span>'
self.assertContains(response, expected)
def test_scanpipe_views_run_detail_view_results_url(self):
run = self.project1.add_pipeline("find_vulnerabilities")
self.assertTrue(run.results_url)
url = reverse("run_detail", args=[run.uuid])
run.set_task_ended(exitcode=0)
response = self.client.get(url)
self.assertContains(response, "View pipeline results")
self.assertContains(response, run.results_url)
def test_scanpipe_views_project_run_step_selection_view(self):
run = self.project1.add_pipeline("do_nothing")
url = reverse("project_run_step_selection", args=[run.uuid])
response = self.client.get(url)
expected_input1 = (
'<input type="checkbox" name="selected_steps" value="step1" '
'id="id_selected_steps_0" checked>'
)
self.assertContains(response, expected_input1)
expected_input2 = (
'<input type="checkbox" name="selected_steps" value="step2" '
'id="id_selected_steps_1" checked>'
)
self.assertContains(response, expected_input2)
response = self.client.post(url, data={"selected_steps": ["invalid"]})
expected = "Select a valid choice. invalid is not one of the available choices."
self.assertContains(response, expected, html=True)
response = self.client.post(url, data={"selected_steps": ["step1"]})
expected = (
'<div id="run-step-selection-box" class="box has-background-success-light">'
"Steps updated successfully."
"</div>"
)
self.assertContains(response, expected, html=True)
run.refresh_from_db()
self.assertEqual(["step1"], run.selected_steps)
response = self.client.get(url)
self.assertContains(response, expected_input1)
# Not checked anymore in the initial data
expected_input2 = (
'<input type="checkbox" name="selected_steps" value="step2" '
'id="id_selected_steps_1">'
)
self.assertContains(response, expected_input2)
@mock.patch.object(
Project, "license_policies_enabled", new_callable=mock.PropertyMock
)
def test_scanpipe_views_project_compliance_panel_view(
self, mock_license_policies_enabled
):
url = reverse("project_compliance_panel", args=[self.project1.slug])
make_package(
self.project1,