Merge branch 'main' into 235-altcha

Author: tdruez

CHANGELOG.rst

@@ -120,6 +120,9 @@ Release notes
   simplicity, and readability.
   https://github.com/aboutcode-org/dejacode/issues/241
 
+- Refine the way the PURL fragments are handled in searches.
+  https://github.com/aboutcode-org/dejacode/issues/286
+
 ### Version 5.2.1
 
 - Fix the models documentation navigation.

component_catalog/admin.py

@@ -71,6 +71,7 @@
 from dje.templatetags.dje_tags import urlize_target_blank
 from dje.utils import CHANGELIST_LINK_TEMPLATE
 from dje.utils import get_instance_from_referer
+from dje.utils import is_purl_fragment
 from license_library.models import License
 from reporting.filters import ReportingQueryListFilter
 
@@ -774,7 +775,17 @@ class PackageAdmin(
         "get_dataspace",
     )
     list_display_links = ("identifier",)
-    search_fields = ("filename", "download_url", "project")
+    search_fields = (
+        "type",
+        "namespace",
+        "name",
+        "version",
+        "filename",
+        "download_url",
+        "sha1",
+        "md5",
+        "project",
+    )
     ordering = ("-last_modified_date",)
     list_filter = (
         ("component", HierarchyRelatedLookupListFilter),
@@ -912,6 +923,7 @@ def get_queryset(self, request):
         return (
             super()
             .get_queryset(request)
+            .annotate_sortable_identifier()
             .select_related(
                 "usage_policy",
             )
@@ -938,6 +950,16 @@ def get_urls(self):
 
         return urls + super().get_urls()
 
+    def get_search_results(self, request, queryset, search_term):
+        """Add searching on provided PackageURL identifier."""
+        use_distinct = False
+
+        if is_purl_fragment(search_term):
+            if results := queryset.for_package_url(search_term):
+                return results, use_distinct
+
+        return super().get_search_results(request, queryset, search_term)
+
     def changeform_view(self, request, object_id=None, form_url="", extra_context=None):
         """
         Add the `show_save_and_collect_data` in the context.
@@ -1053,6 +1075,10 @@ def inferred_url(self, obj):
             return urlize_target_blank(inferred_url)
         return ""
 
+    @admin.display(ordering="sortable_identifier")
+    def identifier(self, obj):
+        return obj.identifier
+
     def save_formset(self, request, form, formset, change):
         """
         Update the completion_level on the related Component at the end of the saving process.

component_catalog/filters.py

@@ -22,6 +22,7 @@
 from dje.filters import HasRelationFilter
 from dje.filters import MatchOrderedSearchFilter
 from dje.filters import RelatedLookupListFilter
+from dje.utils import is_purl_fragment
 from dje.widgets import BootstrapSelectMultipleWidget
 from dje.widgets import DropDownRightWidget
 from dje.widgets import SortDropDownWidget
@@ -183,9 +184,9 @@ def filter(self, qs, value):
         if not value:
             return qs
 
-        is_purl = "/" in value
-        if is_purl:
-            return qs.for_package_url(value)
+        if is_purl_fragment(value):
+            if results := qs.for_package_url(value):
+                return results
 
         return super().filter(qs, value)
 

component_catalog/tests/test_admin.py

@@ -34,6 +34,7 @@
 from component_catalog.models import Package
 from component_catalog.models import PackageAssignedLicense
 from component_catalog.models import Subcomponent
+from component_catalog.tests import make_package
 from dje.copier import copy_object
 from dje.filters import DataspaceFilter
 from dje.models import Dataspace
@@ -1650,6 +1651,8 @@ def test_package_changelist_advanced_search_on_protocol(self):
         p2 = Package.objects.create(
             filename="p2", download_url="https://url.com/p2.zip", dataspace=self.dataspace1
         )
+        package_url = "pkg:pypi/[email protected]"
+        package3 = make_package(self.dataspace1, package_url)
 
         self.client.login(username="test", password="secret")
         changelist_url = reverse("admin:component_catalog_package_changelist")
@@ -1663,6 +1666,16 @@ def test_package_changelist_advanced_search_on_protocol(self):
         self.assertEqual(1, response.context_data["cl"].result_count)
         self.assertIn(p2, response.context_data["cl"].result_list)
 
+        response = self.client.get(changelist_url + f"?q={package_url}")
+        self.assertEqual(200, response.status_code)
+        self.assertEqual(1, response.context_data["cl"].result_count)
+        self.assertIn(package3, response.context_data["cl"].result_list)
+
+        response = self.client.get(changelist_url + "?q=pypi/django")
+        self.assertEqual(200, response.status_code)
+        self.assertEqual(1, response.context_data["cl"].result_count)
+        self.assertIn(package3, response.context_data["cl"].result_list)
+
     def test_package_changelist_set_policy_action_proper(self):
         self.client.login(username=self.user.username, password="secret")
         p1 = Package.objects.create(filename="p1.zip", dataspace=self.dataspace1)

component_catalog/tests/test_views.py

@@ -642,41 +642,42 @@ def test_component_catalog_list_view_sort_keep_active_filters(self):
         # Sort filter
         self.assertContains(
             response,
-            '<a href="?q=a&amp;licenses=license1&sort=name" class="sort" aria-label="Sort">',
+            '<a href="?q=a&amp;licenses=license1&sort=name" class="sort ms-1" aria-label="Sort">',
         )
         # Sort in the headers
         self.assertContains(
             response,
-            '<a href="?q=a&amp;licenses=license1&sort=name" class="sort" aria-label="Sort">',
+            '<a href="?q=a&amp;licenses=license1&sort=name" class="sort ms-1" aria-label="Sort">',
         )
         self.assertContains(
             response,
-            '<a href="?q=a&amp;licenses=license1&sort=primary_language" class="sort" '
+            '<a href="?q=a&amp;licenses=license1&sort=primary_language" class="sort ms-1" '
             'aria-label="Sort">',
         )
 
         data["sort"] = "name"
         response = self.client.get(url, data=data)
         self.assertContains(
             response,
-            '<a href="?q=a&amp;licenses=license1&sort=-name" class="sort active" '
+            '<a href="?q=a&amp;licenses=license1&sort=-name" class="sort active ms-1" '
             'aria-label="Sort">',
         )
         self.assertContains(
             response,
-            '<a href="?q=a&amp;licenses=license1&sort=primary_language" class="sort" '
+            '<a href="?q=a&amp;licenses=license1&sort=primary_language" class="sort ms-1" '
             'aria-label="Sort">',
         )
 
         data["sort"] = "-name"
         response = self.client.get(url, data=data)
         self.assertContains(
             response,
-            '<a href="?q=a&amp;licenses=license1&sort=name" class="sort active" aria-label="Sort">',
+            '<a href="?q=a&amp;licenses=license1&sort=name" class="sort active ms-1" '
+            'aria-label="Sort">',
         )
         self.assertContains(
             response,
-            '<a href="?q=a&amp;licenses=license1&sort=primary_language" class="sort" '
+            '<a href="?q=a&amp;licenses=license1&sort=primary_language" class="sort ms-1" '
             'aria-label="Sort">',
         )
 

dejacode/static/css/dejacode_bootstrap.css

@@ -426,19 +426,22 @@ table.vulnerabilities-table .column-summary {
 
 /* -- Dependency tab -- */
 #tab_dependencies .column-for_package {
-  width: 250px;
+  min-width: 300px;
 }
 #tab_dependencies .column-resolved_to_package {
-  width: 250px;
+  min-width: 300px;
 }
 #tab_dependencies .column-is_runtime {
-  width: 100px;
+  width: 85px;
+  font-size: 0.75rem;
 }
-#tab_dependencies .column-column-is_optional {
-  width: 100px;
+#tab_dependencies .column-is_optional {
+  width: 85px;
+  font-size: 0.75rem;
 }
-#tab_dependencies .column-column-is_pinned {
-  width: 88px;
+#tab_dependencies .column-is_pinned {
+  width: 80px;
+  font-size: 0.75rem;
 }
 
 /* -- Package Details -- */
@@ -661,7 +664,6 @@ td.sub-header {
 .table thead tr th a.sort:hover {
   color: #ccc;
   text-decoration: none;
-  margin-left: 0;
 }
 .table thead tr th a.sort.active {
   color: var(--bs-body-color);

dje/admin.py

@@ -429,6 +429,11 @@ def set_reference_link(self, request):
                 params = f"?{DataspaceFilter.parameter_name}={reference_dataspace.id}"
                 self.reference_params = params
 
+    def get_search_fields_for_hint_display(self):
+        if not self.search_fields:
+            return []
+        return tuple(set(field.split("__")[0] for field in self.search_fields))
+
 
 class DataspacedAdmin(
     DataspacedFKMixin,

dje/dashboard.py

@@ -15,6 +15,14 @@
 
 
 class DejaCodeDashboard(Dashboard):
+    short_description = (
+        "The Administration section of DejaCode is intended primarily for application "
+        "administrators (superusers) to maintain the data that supports organization "
+        "policies and to configure the experience of the general user.\n"
+        "Most of the routine activities regarding products, packages, components, "
+        "licenses and owners can be performed in the User View section of DejaCode."
+    )
+
     def init_with_context(self, context):
         user = context["request"].user
         dataspace = user.dataspace

dje/templates/admin/change_list_extended.html

@@ -96,8 +96,8 @@ <h1>Browse {{ cl.opts.verbose_name_plural|capfirst }}</h1>
                 {% if cl.search_fields %}
                     $("#grp-changelist-search-form")
                         .attr("style", "width: 90%;")
-                        .attr("data-hint", "Search fields: {{ cl.search_fields|join:', ' }}")
-                        .addClass("hint--bottom");
+                        .attr("data-hint", "Search fields: {{ cl.get_search_fields_for_hint_display|join:', ' }}")
+                        .addClass("hint--bottom hint--large");
                 {% endif %}
 
                 // Opens actions listed in `target_blank_actions` in a new tab.

dje/templates/grappelli/dashboard/dashboard.html

@@ -0,0 +1,37 @@
+{% load i18n grp_dashboard_tags %}
+
+{{ dashboard.media }}
+
+{# DJE CUSTOM #}
+{% if dashboard.short_description %}
+    <div id="short_description" class="g-d-c" style="margin-bottom:10px;">
+        <p style="padding-right:10px;">
+            {{ dashboard.short_description|linebreaksbr }}
+        </p>
+    </div>
+{% endif %}
+{# /DJE CUSTOM #}
+
+<div class="g-d-c">
+    <div class="g-d-12 g-d-f" id="column_1">
+        {% for module in dashboard.children %}
+            {% if module.column == 1 %}
+                {% grp_render_dashboard_module module forloop.counter %}
+            {% endif %}
+        {% endfor %}
+    </div>
+    <div class="g-d-6" id="column_2">
+        {% for module in dashboard.children %}
+            {% if module.column == 2 %}
+                {% grp_render_dashboard_module module forloop.counter %}
+            {% endif %}
+        {% endfor %}
+    </div>
+    <div class="g-d-6 g-d-l" id="column_3">
+        {% for module in dashboard.children %}
+            {% if module.column == 3 %}
+                {% grp_render_dashboard_module module forloop.counter %}
+            {% endif %}
+        {% endfor %}
+    </div>
+</div>