- Codebase +
+ Codebase + + Tree view + {% if current_dir and current_dir != "." %} {% for dir_name, full_path in codebase_breadcrumbs.items %} diff --git a/scanpipe/templates/scanpipe/panels/resource_table_panel.html b/scanpipe/templates/scanpipe/panels/resource_table_panel.html new file mode 100644 index 0000000000..df3b14fcd1 --- /dev/null +++ b/scanpipe/templates/scanpipe/panels/resource_table_panel.html @@ -0,0 +1,104 @@ +{% load humanize %} + +{% if resources %} + + + + Path + Status + Type + Size + Name + Extension + Language + MIME Type + Tag + License + Alert + Packages + + + + {% for resource in resources %} + + + {% if resource.is_dir %} + {{ resource.path }} + {% else %} + {{ resource.path }} + {% endif %} + + + {{ resource.status }} + + + {{ resource.type }} + + + {% if resource.is_file %} + {{ resource.size|filesizeformat|default_if_none:"" }} + {% endif %} + + + {{ resource.name }} + + + {{ resource.extension }} + + + {{ resource.programming_language }} + + + {{ resource.mime_type }} + + + {{ resource.tag }} + + + {{ resource.detected_license_expression }} + + + {{ resource.compliance_alert }} + + + {% if resource.discovered_packages.all %} + {% for package in resource.discovered_packages.all|slice:":3" %} + {{ package }}{% if not forloop.last %}, {% endif %} + {% endfor %} + {% if resource.discovered_packages.all|length > 3 %} + +{{ resource.discovered_packages.all|length|add:"-3" }} more + {% endif %} + {% endif %} + + + {% endfor %} + + + + {% if is_paginated %} + + {% if page_obj.has_previous %} + Previous + {% endif %} + {% if page_obj.has_next %} + Next page + {% endif %} + + Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }} + + + {% endif %} +{% else %} + + + + + + {% if path %} + No resources found in this directory. + {% else %} + Select a file or folder from the tree to view its contents. + {% endif %} + + +{% endif %} \ No newline at end of file diff --git a/scanpipe/templates/scanpipe/resource_tree.html b/scanpipe/templates/scanpipe/resource_tree.html new file mode 100644 index 0000000000..56bef05c35 --- /dev/null +++ b/scanpipe/templates/scanpipe/resource_tree.html @@ -0,0 +1,216 @@ +{% extends "scanpipe/base.html" %} +{% load static humanize %} +{% block title %}ScanCode.io: {{ project.name }} - Resource Tree{% endblock %} + +{% block extrahead %} + +{% endblock %} + +{% block content %} + + {% include 'scanpipe/includes/navbar_header.html' %} + + + {% include 'scanpipe/includes/breadcrumb.html' with linked_project=True current="Resource Tree" %} + + + + + + + + {% include "scanpipe/panels/codebase_tree_panel.html" with children=children path=path %} + + + + + + {% include "scanpipe/panels/resource_table_panel.html" %} + + + +{% endblock %} + +{% block scripts %} + +{% endblock %} \ No newline at end of file diff --git a/scanpipe/tests/test_models.py b/scanpipe/tests/test_models.py index 59977b100b..affc8c7588 100644 --- a/scanpipe/tests/test_models.py +++ b/scanpipe/tests/test_models.py @@ -3214,6 +3214,24 @@ def test_scanpipe_discovered_package_model_unique_package_uid_in_project(self): self.assertTrue(package3.package_uid) self.assertNotEqual(package.package_uid, package3.package_uid) + def test_scanpipe_codebase_resource_queryset_with_has_children(self): + project1 = make_project("Analysis") + + make_resource_directory(project1, "parent") + make_resource_file(project1, "parent/child.txt") + make_resource_directory(project1, "empty") + + qs = CodebaseResource.objects.filter(project=project1).with_has_children() + + resource1 = qs.get(path="parent") + self.assertTrue(resource1.has_children) + + resource2 = qs.get(path="parent/child.txt") + self.assertFalse(resource2.has_children) + + resource3 = qs.get(path="empty") + self.assertFalse(resource3.has_children) + @skipIf(connection.vendor == "sqlite", "No max_length constraints on SQLite.") def test_scanpipe_codebase_resource_create_and_add_package_warnings(self): project1 = make_project("Analysis") diff --git a/scanpipe/tests/test_views.py b/scanpipe/tests/test_views.py index e7f33091fa..19829e4ad1 100644 --- a/scanpipe/tests/test_views.py +++ b/scanpipe/tests/test_views.py @@ -54,6 +54,7 @@ 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 @@ -1630,3 +1631,132 @@ def test_project_codebase_resources_export_json(self): for field in expected_fields: self.assertIn(field, json_data[0]) + + def test_scanpipe_views_resource_tree_root_path(self): + make_resource_file(self.project1, path="child1.txt") + make_resource_file(self.project1, path="dir1") + + url = reverse("codebase_resource_tree", kwargs={"slug": self.project1.slug}) + response = self.client.get(url) + children = response.context["children"] + child1 = children[0] + dir1 = children[1] + + self.assertEqual(child1.path, "child1.txt") + self.assertEqual(dir1.path, "dir1") + + def test_scanpipe_views_resource_tree_children_path(self): + make_resource_file(self.project1, path="parent/child1.txt") + make_resource_file(self.project1, path="parent/dir1") + make_resource_file(self.project1, path="parent/dir1/child2.txt") + + url = reverse("codebase_resource_tree", kwargs={"slug": self.project1.slug}) + response = self.client.get(url + "?path=parent&tree_panel=true") + children = response.context["children"] + + child1 = children[0] + dir1 = children[1] + + self.assertEqual(child1.path, "parent/child1.txt") + self.assertEqual(dir1.path, "parent/dir1") + + self.assertFalse(child1.has_children) + self.assertTrue(dir1.has_children) + + def test_scanpipe_views_codebase_resource_table_view_with_path_directory(self): + make_resource_directory(self.project1, path="parent") + make_resource_file(self.project1, path="parent/child1.txt") + make_resource_file(self.project1, path="parent/child2.py") + + url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug}) + response = self.client.get(url + "?path=parent") + + self.assertEqual(200, response.status_code) + self.assertEqual("parent", response.context["path"]) + resources = list(response.context["resources"]) + self.assertEqual(2, len(resources)) + + resource_paths = [r.path for r in resources] + self.assertEqual(["parent/child1.txt", "parent/child2.py"], resource_paths) + + def test_scanpipe_views_codebase_resource_table_view_with_path_file(self): + make_resource_file(self.project1, path="specific_file.txt") + + url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug}) + response = self.client.get(url + "?path=specific_file.txt") + + self.assertEqual(200, response.status_code) + self.assertEqual("specific_file.txt", response.context["path"]) + resources = list(response.context["resources"]) + self.assertEqual(1, len(resources)) + self.assertEqual("specific_file.txt", resources[0].path) + + def test_scanpipe_views_codebase_resource_table_view_empty_directory(self): + make_resource_directory(self.project1, path="empty_dir") + + url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug}) + response = self.client.get(url + "?path=empty_dir") + + self.assertEqual(200, response.status_code) + self.assertEqual("empty_dir", response.context["path"]) + resources = list(response.context["resources"]) + self.assertEqual(0, len(resources)) + + def test_scanpipe_views_codebase_resource_table_view_with_packages(self): + resource1 = make_resource_file(self.project1, path="file_with_package.txt") + package1 = DiscoveredPackage.create_from_data(self.project1, package_data1) + package1.add_resources([resource1]) + + url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug}) + response = self.client.get(url + "?path=file_with_package.txt") + + self.assertEqual(200, response.status_code) + resources = list(response.context["resources"]) + self.assertEqual(1, len(resources)) + + resource = resources[0] + self.assertTrue(resource.discovered_packages.exists()) + + @mock.patch("scanpipe.views.CodebaseResourceTableView.paginate_by", 2) + def test_scanpipe_views_codebase_resource_table_view_pagination(self): + make_resource_directory(self.project1, path="parent") + make_resource_file(self.project1, path="parent/file1.txt", parent_path="parent") + make_resource_file(self.project1, path="parent/file2.txt", parent_path="parent") + make_resource_file(self.project1, path="parent/file3.txt", parent_path="parent") + + url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug}) + + response = self.client.get(url + "?path=parent") + self.assertEqual(200, response.status_code) + self.assertTrue(response.context["is_paginated"]) + self.assertEqual(1, response.context["page_obj"].number) + self.assertTrue(response.context["page_obj"].has_next()) + self.assertFalse(response.context["page_obj"].has_previous()) + + response = self.client.get(url + "?path=parent&page=2") + self.assertEqual(200, response.status_code) + self.assertEqual(2, response.context["page_obj"].number) + self.assertFalse(response.context["page_obj"].has_next()) + self.assertTrue(response.context["page_obj"].has_previous()) + + def test_scanpipe_views_codebase_resource_table_view_field_selection(self): + resource = make_resource_file( + self.project1, + path="test_file.py", + programming_language="Python", + mime_type="text/x-python", + detected_license_expression="MIT", + ) + + url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug}) + response = self.client.get(url + "?path=test_file.py") + + self.assertEqual(200, response.status_code) + resources = list(response.context["resources"]) + self.assertEqual(1, len(resources)) + + resource = resources[0] + self.assertEqual("test_file.py", resource.path) + self.assertEqual("Python", resource.programming_language) + self.assertEqual("text/x-python", resource.mime_type) + self.assertEqual("MIT", resource.detected_license_expression) diff --git a/scanpipe/urls.py b/scanpipe/urls.py index 5efe6fdd76..67a457f94d 100644 --- a/scanpipe/urls.py +++ b/scanpipe/urls.py @@ -131,6 +131,16 @@ views.ProjectCodebaseView.as_view(), name="project_codebase", ), + path( + "project//codebase_tree/", + views.CodebaseResourceTreeView.as_view(), + name="codebase_resource_tree", + ), + path( + "project//resource_table/", + views.CodebaseResourceTableView.as_view(), + name="codebase_resource_table", + ), path( "run//", views.run_detail_view, diff --git a/scanpipe/views.py b/scanpipe/views.py index d52eafcaa2..60e85ab549 100644 --- a/scanpipe/views.py +++ b/scanpipe/views.py @@ -2756,3 +2756,88 @@ def get_node(self, package): "children": children, } return node + + +class CodebaseResourceTreeView(ConditionalLoginRequired, generic.DetailView): + template_name = "scanpipe/resource_tree.html" + + def get(self, request, *args, **kwargs): + slug = self.kwargs.get("slug") + project = get_object_or_404(Project, slug=slug) + path = request.GET.get("path", "") + + children = ( + project.codebaseresources.filter(parent_path=path) + .with_has_children() + .only("id", "project_id", "path", "name", "type") + .order_by("path") + ) + + context = { + "project": project, + "path": path, + "children": children, + } + + if request.GET.get("tree_panel") == "true": + return render(request, "scanpipe/panels/codebase_tree_panel.html", context) + return render(request, self.template_name, context) + + +class CodebaseResourceTableView( + ConditionalLoginRequired, + ProjectRelatedViewMixin, + generic.ListView, +): + model = CodebaseResource + template_name = "scanpipe/panels/resource_table_panel.html" + paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("resource", 100) + context_object_name = "resources" + + def get_queryset(self): + path = self.request.GET.get("path", "") + + qs = super().get_queryset().filter(path=path) + if qs.exists() and not qs.first().is_dir: + return qs.only( + "path", + "status", + "type", + "size", + "name", + "extension", + "programming_language", + "mime_type", + "tag", + "detected_license_expression", + "compliance_alert", + "package_data", + ).prefetch_related("discovered_packages") + + return ( + super() + .get_queryset() + .filter(parent_path=path) + .with_has_children() + .only( + "path", + "status", + "type", + "size", + "name", + "extension", + "programming_language", + "mime_type", + "tag", + "detected_license_expression", + "compliance_alert", + "package_data", + ) + .prefetch_related("discovered_packages") + .order_by("path") + ) + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context["path"] = self.request.GET.get("path", "") + return context
+ {% if path %} + No resources found in this directory. + {% else %} + Select a file or folder from the tree to view its contents. + {% endif %} +