From a540d5e3e904dcb502eea0d48f640fb441ab05cf Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 10:59:23 +0400 Subject: [PATCH 01/10] Add filter by in_package and compliance_alert in resource list #216 Signed-off-by: Thomas Druez --- scancodeio/settings.py | 4 ++ scanpipe/filters.py | 9 ++-- .../filter_dropdown_choices_field.html | 2 +- .../scanpipe/includes/list_view_thead.html | 43 +++++++++++++------ 4 files changed, 40 insertions(+), 18 deletions(-) diff --git a/scancodeio/settings.py b/scancodeio/settings.py index 43f01efede..0c2b69de6c 100644 --- a/scancodeio/settings.py +++ b/scancodeio/settings.py @@ -160,6 +160,10 @@ DEFAULT_AUTO_FIELD = "django.db.models.AutoField" +# Forms and filters + +FILTERS_EMPTY_CHOICE_LABEL = env.str("FILTERS_EMPTY_CHOICE_LABEL", default="All") + # Templates TEMPLATES = [ diff --git a/scanpipe/filters.py b/scanpipe/filters.py index 1d7d788657..b81db3816a 100644 --- a/scanpipe/filters.py +++ b/scanpipe/filters.py @@ -268,8 +268,8 @@ def filter(self, qs, value): class InPackageFilter(django_filters.ChoiceFilter): def __init__(self, *args, **kwargs): kwargs["choices"] = ( - ("true", "Yes"), - ("false", "No"), + ("true", "In a package"), + ("false", "Not in a package"), ) super().__init__(*args, **kwargs) @@ -340,12 +340,11 @@ class ResourceFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): compliance_alert = django_filters.ChoiceFilter( choices=CodebaseResource.Compliance.choices + [("_EMPTY_", "EMPTY")] ) - in_package = InPackageFilter(label="In a Package") - status = StatusFilter(empty_label="All") + in_package = InPackageFilter(label="In a package") + status = StatusFilter() relation_map_type = RelationMapTypeFilter( label="Relation map type", field_name="related_from__map_type", - empty_label="All", ) class Meta: diff --git a/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html b/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html index a4256a972d..a2d3c29494 100644 --- a/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html +++ b/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html @@ -1,4 +1,4 @@ -
+
diff --git a/scanpipe/templates/scanpipe/includes/list_view_thead.html b/scanpipe/templates/scanpipe/includes/list_view_thead.html index 49887621ff..7ee7fef328 100644 --- a/scanpipe/templates/scanpipe/includes/list_view_thead.html +++ b/scanpipe/templates/scanpipe/includes/list_view_thead.html @@ -2,19 +2,38 @@ {% for column in columns_data %} - {% if column.sort_query %} - {{ column.label }} - {% if column.field_name in filter.data.sort %} - - {% endif %} - {% else %} - {{ column.label }} - {% endif %} - {% if column.field_name == "status" %} -
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.status only %} + +
+
+ {% if column.sort_query %} + {{ column.label }} + {% if column.field_name in filter.data.sort %} + + {% endif %} + {% else %} + {{ column.label }} + {% endif %}
- {% endif %} + + {% if column.field_name == "status" %} +
+ {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.status only %} +
+ {% elif column.field_name == "type" %} +
+ {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.type only %} +
+ {% elif column.field_name == "compliance_alert" %} +
+ {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.compliance_alert is_right=True only %} +
+ {% elif column.field_name == "packages" %} +
+ {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.in_package is_right=True only %} +
+ {% endif %} +
+ {% endfor %} From 4773382f2db61ae6f4cc103f67a6c2e94c718906 Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 15:15:52 +0400 Subject: [PATCH 02/10] Refactor the table headers and filters #216 Signed-off-by: Thomas Druez --- scanpipe/filters.py | 2 +- scanpipe/templates/scanpipe/base.html | 3 +++ .../scanpipe/includes/filter_sort.html | 8 +++--- .../scanpipe/includes/list_view_thead.html | 8 +----- .../templates/scanpipe/relation_list.html | 27 +++---------------- scanpipe/views.py | 26 +++++++++++++++--- 6 files changed, 34 insertions(+), 40 deletions(-) diff --git a/scanpipe/filters.py b/scanpipe/filters.py index b81db3816a..2b98a798a2 100644 --- a/scanpipe/filters.py +++ b/scanpipe/filters.py @@ -338,7 +338,7 @@ class ResourceFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): ], ) compliance_alert = django_filters.ChoiceFilter( - choices=CodebaseResource.Compliance.choices + [("_EMPTY_", "EMPTY")] + choices=[("_EMPTY_", "No values")] + CodebaseResource.Compliance.choices ) in_package = InPackageFilter(label="In a package") status = StatusFilter() diff --git a/scanpipe/templates/scanpipe/base.html b/scanpipe/templates/scanpipe/base.html index a5c6e22758..1a62c745da 100644 --- a/scanpipe/templates/scanpipe/base.html +++ b/scanpipe/templates/scanpipe/base.html @@ -68,6 +68,9 @@ #project-extra-data .is-more {position: relative;} #project-extra-data .is-more-show {bottom: -1.25em; height: 2.5em; left: calc(50% - 4.5em); padding: 0; position: absolute; width: 9em; z-index: 1; background-color: #ff9970; border: none; border-radius: 0.5em!important;} #project-extra-data pre {background-color: initial; color: initial; padding: initial; white-space: pre-wrap; word-break: break-all;} + #codebase-relation-list table {table-layout: fixed;} + #codebase-relation-list th#column-status {width: 110px;} + #codebase-relation-list th#column-related_from__map_type {width: 145px;} {% block extrahead %}{% endblock %} diff --git a/scanpipe/templates/scanpipe/includes/filter_sort.html b/scanpipe/templates/scanpipe/includes/filter_sort.html index 36b63f608d..e8ea66bf42 100644 --- a/scanpipe/templates/scanpipe/includes/filter_sort.html +++ b/scanpipe/templates/scanpipe/includes/filter_sort.html @@ -1,6 +1,6 @@ - - {{ label }} + + {{ column.label }} -{% if field_name in filter.data.sort %} - +{% if column.is_sorted %} + {% endif %} \ No newline at end of file diff --git a/scanpipe/templates/scanpipe/includes/list_view_thead.html b/scanpipe/templates/scanpipe/includes/list_view_thead.html index 7ee7fef328..ec7e43d0b3 100644 --- a/scanpipe/templates/scanpipe/includes/list_view_thead.html +++ b/scanpipe/templates/scanpipe/includes/list_view_thead.html @@ -2,19 +2,14 @@ {% for column in columns_data %} -
{% if column.sort_query %} - {{ column.label }} - {% if column.field_name in filter.data.sort %} - - {% endif %} + {% include 'scanpipe/includes/filter_sort.html' with column=column only %} {% else %} {{ column.label }} {% endif %}
- {% if column.field_name == "status" %}
{% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.status only %} @@ -33,7 +28,6 @@
{% endif %}
- {% endfor %} diff --git a/scanpipe/templates/scanpipe/relation_list.html b/scanpipe/templates/scanpipe/relation_list.html index a8a0315d47..4fe57e9572 100644 --- a/scanpipe/templates/scanpipe/relation_list.html +++ b/scanpipe/templates/scanpipe/relation_list.html @@ -16,30 +16,9 @@
-
- - - - - - - - - +
+
- {% include 'scanpipe/includes/filter_sort.html' with field_name="path" label="To resource" %} - - {% include 'scanpipe/includes/filter_sort.html' with field_name="status" label="Status" %} -
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.status only %} -
- 		- {% include 'scanpipe/includes/filter_sort.html' with field_name="related_from__map_type" label="Map type" %} -
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.relation_map_type only %} -
- 		- {% include 'scanpipe/includes/filter_sort.html' with field_name="related_from__from_resource__path" label="From resource" %} -
+ {% include 'scanpipe/includes/list_view_thead.html' %} {% for resource in object_list %} {% for relation in resource.related_from.all %} diff --git a/scanpipe/views.py b/scanpipe/views.py index d7bd723b82..7ad5f08eb8 100644 --- a/scanpipe/views.py +++ b/scanpipe/views.py @@ -323,12 +323,13 @@ def get_columns_data(self): sort_name = column_data.get("sort_name") or field_name if sort_name in sortable_fields: - sort_direction = "" + is_sorted = sort_name == active_sort.lstrip("-") - if active_sort.endswith(sort_name): - if not active_sort.startswith("-"): - sort_direction = "-" + sort_direction = "" + if is_sorted and not active_sort.startswith("-"): + sort_direction = "-" + column_data["is_sorted"] = is_sorted column_data["sort_direction"] = sort_direction query_dict = self.request.GET.copy() query_dict["sort"] = f"{sort_direction}{sort_name}" @@ -1087,6 +1088,7 @@ class ProjectErrorListView( class CodebaseRelationListView( ConditionalLoginRequired, ProjectRelatedViewMixin, + TableColumnsMixin, ExportXLSXMixin, PaginatedFilterView, ): @@ -1094,6 +1096,22 @@ class CodebaseRelationListView( filterset_class = ResourceFilterSet template_name = "scanpipe/relation_list.html" paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("relation", 100) + table_columns = [ + { + "field_name": "path", + "label": "To resource", + }, + "status", + { + "field_name": "related_from__map_type", + "label": "Map type", + # TODO: filter: relation_map_type + }, + { + "field_name": "related_from__from_resource__path", + "label": "From resource", + }, + ] def get_queryset(self): return ( From 41babe14aab8edf535a1be29cf41bd152a0ceded Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 15:44:59 +0400 Subject: [PATCH 03/10] Fitler are now defined in the table_columns #216 Signed-off-by: Thomas Druez --- scanpipe/filters.py | 2 +- .../filter_dropdown_choices_field.html | 2 +- .../scanpipe/includes/list_view_thead.html | 16 ++--------- scanpipe/views.py | 28 +++++++++++++++---- 4 files changed, 27 insertions(+), 21 deletions(-) diff --git a/scanpipe/filters.py b/scanpipe/filters.py index 2b98a798a2..0db815bdd5 100644 --- a/scanpipe/filters.py +++ b/scanpipe/filters.py @@ -338,7 +338,7 @@ class ResourceFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): ], ) compliance_alert = django_filters.ChoiceFilter( - choices=[("_EMPTY_", "No values")] + CodebaseResource.Compliance.choices + choices=[("_EMPTY_", "Empty value")] + CodebaseResource.Compliance.choices ) in_package = InPackageFilter(label="In a package") status = StatusFilter() diff --git a/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html b/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html index a2d3c29494..e334f9792e 100644 --- a/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html +++ b/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html @@ -1,6 +1,6 @@
- +
diff --git a/scanpipe/templates/scanpipe/includes/list_view_thead.html b/scanpipe/templates/scanpipe/includes/list_view_thead.html index ec7e43d0b3..df3ca28ad9 100644 --- a/scanpipe/templates/scanpipe/includes/list_view_thead.html +++ b/scanpipe/templates/scanpipe/includes/list_view_thead.html @@ -10,21 +10,9 @@ {{ column.label }} {% endif %}
- {% if column.field_name == "status" %} + {% if column.filter %}
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.status only %} -
- {% elif column.field_name == "type" %} -
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.type only %} -
- {% elif column.field_name == "compliance_alert" %} -
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.compliance_alert is_right=True only %} -
- {% elif column.field_name == "packages" %} -
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=filter.form.in_package is_right=True only %} + {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=column.filter is_right=column.filter_is_right only %}
{% endif %} diff --git a/scanpipe/views.py b/scanpipe/views.py index 7ad5f08eb8..b1fc3fcc34 100644 --- a/scanpipe/views.py +++ b/scanpipe/views.py @@ -335,6 +335,9 @@ def get_columns_data(self): query_dict["sort"] = f"{sort_direction}{sort_name}" column_data["sort_query"] = query_dict.urlencode() + if filter_fieldname := column_data.get("filter_fieldname"): + column_data["filter"] = filterset.form[filter_fieldname] + columns_data.append(column_data) return columns_data @@ -989,8 +992,14 @@ class CodebaseResourceListView( prefetch_related = ["discovered_packages"] table_columns = [ "path", - "status", - "type", + { + "field_name": "status", + "filter_fieldname": "status", + }, + { + "field_name": "type", + "filter_fieldname": "type", + }, "size", "name", "extension", @@ -1001,8 +1010,14 @@ class CodebaseResourceListView( { "field_name": "compliance_alert", "condition": scanpipe_app.policies_enabled, + "filter_fieldname": "compliance_alert", + "filter_is_right": True, + }, + { + "field_name": "packages", + "filter_fieldname": "in_package", + "filter_is_right": True, }, - "packages", ] def get_context_data(self, **kwargs): @@ -1101,11 +1116,14 @@ class CodebaseRelationListView( "field_name": "path", "label": "To resource", }, - "status", + { + "field_name": "status", + "filter_fieldname": "status", + }, { "field_name": "related_from__map_type", "label": "Map type", - # TODO: filter: relation_map_type + "filter_fieldname": "relation_map_type", }, { "field_name": "related_from__from_resource__path", From 24d45e2f8c0702e33a83a48799d3b334f024ea5f Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 16:21:37 +0400 Subject: [PATCH 04/10] Use the BulmaDropdownWidget to properly display the filters #216 Signed-off-by: Thomas Druez --- scanpipe/filters.py | 19 ++++++++++++++++--- .../filter_dropdown_choices_field.html | 10 +++------- .../includes/list_actions_dropdown.html | 5 ++++- .../scanpipe/includes/list_view_thead.html | 2 +- scanpipe/views.py | 1 + 5 files changed, 25 insertions(+), 12 deletions(-) diff --git a/scanpipe/filters.py b/scanpipe/filters.py index 0db815bdd5..5f121c28f3 100644 --- a/scanpipe/filters.py +++ b/scanpipe/filters.py @@ -41,10 +41,11 @@ scanpipe_app = apps.get_app_config("scanpipe") PAGE_VAR = "page" +EMPTY_VAR = "_EMPTY_" class FilterSetUtilsMixin: - empty_value = "_EMPTY_" + empty_value = EMPTY_VAR other_value = "_OTHER_" @staticmethod @@ -314,6 +315,14 @@ def filter(self, qs, value): class ResourceFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): + dropdown_widget = [ + "status", + "type", + "compliance_alert", + "in_package", + "relation_map_type", + ] + search = django_filters.CharFilter( label="Search", field_name="path", @@ -338,7 +347,7 @@ class ResourceFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): ], ) compliance_alert = django_filters.ChoiceFilter( - choices=[("_EMPTY_", "Empty value")] + CodebaseResource.Compliance.choices + choices=[(EMPTY_VAR, "Empty value")] + CodebaseResource.Compliance.choices, ) in_package = InPackageFilter(label="In a package") status = StatusFilter() @@ -386,9 +395,13 @@ def __init__(self, *args, **kwargs): if status_filter := self.filters.get("status"): status_filter.extra.update({"choices": self.get_status_choices()}) + # Set the `BulmaDropdownWidget`` widget for defined ``dropdown_widget``. + for field_name in self.dropdown_widget: + self.filters[field_name].extra["widget"] = BulmaDropdownWidget() + def get_status_choices(self): default_choices = [ - ("_EMPTY_", "No status"), + (EMPTY_VAR, "No status"), ("any", "Any status"), ] status_values = ( diff --git a/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html b/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html index e334f9792e..c52876ecb3 100644 --- a/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html +++ b/scanpipe/templates/scanpipe/includes/filter_dropdown_choices_field.html @@ -1,16 +1,12 @@
- +
- \ No newline at end of file diff --git a/scanpipe/templates/scanpipe/includes/list_actions_dropdown.html b/scanpipe/templates/scanpipe/includes/list_actions_dropdown.html index 3a1d6eebea..c301dbf953 100644 --- a/scanpipe/templates/scanpipe/includes/list_actions_dropdown.html +++ b/scanpipe/templates/scanpipe/includes/list_actions_dropdown.html @@ -1,7 +1,10 @@
{% if column.filter %}
- {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter_form_field=column.filter is_right=column.filter_is_right only %} + {% include 'scanpipe/includes/filter_dropdown_choices_field.html' with filter=column.filter is_right=column.filter_is_right only %}
{% endif %}
diff --git a/scanpipe/views.py b/scanpipe/views.py index b1fc3fcc34..1c69f59594 100644 --- a/scanpipe/views.py +++ b/scanpipe/views.py @@ -350,6 +350,7 @@ def get_field_label(field_name): def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) context["columns_data"] = self.get_columns_data() + context["request_query_string"] = self.request.GET.urlencode() return context From df68b1553e9e57c65576161ebc9f3c0eaca739c8 Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 16:30:24 +0400 Subject: [PATCH 05/10] Display message in table row when no results found #216 Signed-off-by: Thomas Druez --- scanpipe/templates/scanpipe/dependency_list.html | 6 ++++++ scanpipe/templates/scanpipe/error_list.html | 6 ++++++ scanpipe/templates/scanpipe/package_list.html | 6 ++++++ scanpipe/templates/scanpipe/relation_list.html | 2 +- scanpipe/templates/scanpipe/resource_list.html | 6 ++++++ 5 files changed, 25 insertions(+), 1 deletion(-) diff --git a/scanpipe/templates/scanpipe/dependency_list.html b/scanpipe/templates/scanpipe/dependency_list.html index 3ba910004b..bb7e863d3a 100644 --- a/scanpipe/templates/scanpipe/dependency_list.html +++ b/scanpipe/templates/scanpipe/dependency_list.html @@ -56,6 +56,12 @@ {{ dependency.datasource_id }} + {% empty %} +
+ + {% endfor %}
+ No Dependencies found. Clear search and filters +
diff --git a/scanpipe/templates/scanpipe/error_list.html b/scanpipe/templates/scanpipe/error_list.html index 40de94e97e..3849f02191 100644 --- a/scanpipe/templates/scanpipe/error_list.html +++ b/scanpipe/templates/scanpipe/error_list.html @@ -52,6 +52,12 @@ 
{{ error.traceback }}
+ {% empty %} + + + No Errors found. Clear search and filters + + {% endfor %} diff --git a/scanpipe/templates/scanpipe/package_list.html b/scanpipe/templates/scanpipe/package_list.html index 9439646fa3..a8378edbdd 100644 --- a/scanpipe/templates/scanpipe/package_list.html +++ b/scanpipe/templates/scanpipe/package_list.html @@ -53,6 +53,12 @@ {% endif %} + {% empty %} + + + No Packages found. Clear search and filters + + {% endfor %} diff --git a/scanpipe/templates/scanpipe/relation_list.html b/scanpipe/templates/scanpipe/relation_list.html index 4fe57e9572..66eb6ef9ca 100644 --- a/scanpipe/templates/scanpipe/relation_list.html +++ b/scanpipe/templates/scanpipe/relation_list.html @@ -59,7 +59,7 @@ {% endfor %} {% empty %} - + No Relations found. Clear search and filters diff --git a/scanpipe/templates/scanpipe/resource_list.html b/scanpipe/templates/scanpipe/resource_list.html index 209aacb4f9..eaf7e4d874 100644 --- a/scanpipe/templates/scanpipe/resource_list.html +++ b/scanpipe/templates/scanpipe/resource_list.html @@ -72,6 +72,12 @@ + {% empty %} + + + No Resources found. Clear search and filters + + {% endfor %} From bcda7a3146cd900905e8af566345166247e5a24c Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 16:53:14 +0400 Subject: [PATCH 06/10] Add changelgo entry #216 Signed-off-by: Thomas Druez --- CHANGELOG.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e60d4fc336..6bf73ea4c0 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,12 @@ Changelog v33.0.0 (unreleased) -------------------- +- Add multiple new filtering option to list views table headers. + Refactored the way to define filters using the table_columns view attribute. + https://github.com/nexB/scancode.io/issues/216 + https://github.com/nexB/scancode.io/issues/580 + https://github.com/nexB/scancode.io/issues/506 + - Update the CycloneDX BOM download file extension from ``.bom.json`` to ``.cdx.json``. https://github.com/nexB/scancode.io/issues/785 From 4ebbe126b7b210e9ae1ad4e7d59081631a5c02d7 Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 16:53:48 +0400 Subject: [PATCH 07/10] Add more quick-filter ability to list table values #216 Signed-off-by: Thomas Druez --- scanpipe/filters.py | 2 ++ scanpipe/templates/scanpipe/dependency_list.html | 10 +++++----- scanpipe/templates/scanpipe/package_list.html | 6 ++++-- scanpipe/templates/scanpipe/relation_list.html | 10 +++++++--- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/scanpipe/filters.py b/scanpipe/filters.py index 5f121c28f3..5e0d2a7c8e 100644 --- a/scanpipe/filters.py +++ b/scanpipe/filters.py @@ -458,7 +458,9 @@ class Meta: "vcs_url", "type", "declared_license_expression", + "declared_license_expression_spdx", "other_license_expression", + "other_license_expression_spdx", "extracted_license_statement", "copyright", ] diff --git a/scanpipe/templates/scanpipe/dependency_list.html b/scanpipe/templates/scanpipe/dependency_list.html index bb7e863d3a..a55403a837 100644 --- a/scanpipe/templates/scanpipe/dependency_list.html +++ b/scanpipe/templates/scanpipe/dependency_list.html @@ -25,22 +25,22 @@ {{ dependency.purl }} - {{ dependency.type }} + {{ dependency.type }} {{ dependency.extracted_requirement }} - {{ dependency.scope }} + {{ dependency.scope }} - {{ dependency.is_runtime }} + {{ dependency.is_runtime }} - {{ dependency.is_optional }} + {{ dependency.is_optional }} - {{ dependency.is_resolved }} + {{ dependency.is_resolved }} {% if dependency.for_package %} diff --git a/scanpipe/templates/scanpipe/package_list.html b/scanpipe/templates/scanpipe/package_list.html index a8378edbdd..226fa524ed 100644 --- a/scanpipe/templates/scanpipe/package_list.html +++ b/scanpipe/templates/scanpipe/package_list.html @@ -30,13 +30,15 @@ {% endif %} - {{ package.declared_license_expression|linebreaksbr }} + + {{ package.declared_license_expression }} + {{ package.copyright|truncatechars:150|linebreaksbr }} - {{ package.primary_language }} + {{ package.primary_language }} {% if package.resources %} diff --git a/scanpipe/templates/scanpipe/relation_list.html b/scanpipe/templates/scanpipe/relation_list.html index 66eb6ef9ca..9e90dfc415 100644 --- a/scanpipe/templates/scanpipe/relation_list.html +++ b/scanpipe/templates/scanpipe/relation_list.html @@ -28,9 +28,11 @@ {{ resource.path }} {% endif %} - {{ resource.status }} - {{ relation.map_type }} + {{ resource.status }} + + + {{ relation.map_type }} {% if relation.extra_data.path_score %} {{ relation.extra_data.path_score }} {% endif %} @@ -52,7 +54,9 @@ {{ resource.path }} - {{ resource.status }} + + {{ resource.status }} + From f440d3f64e93a737da49a661268bae3104246632 Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 17:24:22 +0400 Subject: [PATCH 08/10] Add has_values type filter on license and copyright columns #216 Signed-off-by: Thomas Druez --- scanpipe/filters.py | 29 +++++++++++++++++-- .../templates/scanpipe/resource_list.html | 4 +-- scanpipe/views.py | 15 ++++++++-- 3 files changed, 41 insertions(+), 7 deletions(-) diff --git a/scanpipe/filters.py b/scanpipe/filters.py index 5e0d2a7c8e..81fc4e892e 100644 --- a/scanpipe/filters.py +++ b/scanpipe/filters.py @@ -23,6 +23,7 @@ from django.apps import apps from django.core.validators import EMPTY_VALUES from django.db import models +from django.db.models import Q from django.db.models.fields import BLANK_CHOICE_DASH from django.utils.http import urlencode from django.utils.translation import gettext as _ @@ -42,11 +43,14 @@ PAGE_VAR = "page" EMPTY_VAR = "_EMPTY_" +ANY_VAR = "_ANY_" +OTHER_VAR = "_OTHER_" class FilterSetUtilsMixin: empty_value = EMPTY_VAR - other_value = "_OTHER_" + any_value = ANY_VAR + other_value = OTHER_VAR @staticmethod def remove_field_from_query_dict(query_dict, field_name, remove_value=None): @@ -123,6 +127,8 @@ def filter_queryset(self, queryset): field_name = self.filters[name].field_name if value == self.empty_value: queryset = queryset.filter(**{f"{field_name}__in": EMPTY_VALUES}) + elif value == self.any_value: + queryset = queryset.filter(~Q(**{f"{field_name}__in": EMPTY_VALUES})) elif value == self.other_value and hasattr(queryset, "less_common"): return queryset.less_common(name) else: @@ -171,6 +177,16 @@ class BulmaDropdownWidget(BulmaLinkWidget): extra_css_class = "dropdown-item" +class HasValueDropdownWidget(BulmaDropdownWidget): + def __init__(self, attrs=None, choices=()): + super().__init__(attrs) + self.choices = ( + ("", "All"), + (EMPTY_VAR, "None"), + (ANY_VAR, "Any"), + ) + + class ProjectFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): search = django_filters.CharFilter( label="Search", field_name="name", lookup_expr="icontains" @@ -347,7 +363,7 @@ class ResourceFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): ], ) compliance_alert = django_filters.ChoiceFilter( - choices=[(EMPTY_VAR, "Empty value")] + CodebaseResource.Compliance.choices, + choices=[(EMPTY_VAR, "None")] + CodebaseResource.Compliance.choices, ) in_package = InPackageFilter(label="In a package") status = StatusFilter() @@ -399,6 +415,9 @@ def __init__(self, *args, **kwargs): for field_name in self.dropdown_widget: self.filters[field_name].extra["widget"] = BulmaDropdownWidget() + license_expression_filer = self.filters["detected_license_expression"] + license_expression_filer.extra["widget"] = HasValueDropdownWidget() + def get_status_choices(self): default_choices = [ (EMPTY_VAR, "No status"), @@ -465,6 +484,12 @@ class Meta: "copyright", ] + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + license_expression_filer = self.filters["declared_license_expression"] + license_expression_filer.extra["widget"] = HasValueDropdownWidget() + self.filters["copyright"].extra["widget"] = HasValueDropdownWidget() + class DependencyFilterSet(FilterSetUtilsMixin, django_filters.FilterSet): search = django_filters.CharFilter( diff --git a/scanpipe/templates/scanpipe/resource_list.html b/scanpipe/templates/scanpipe/resource_list.html index eaf7e4d874..84fd11753f 100644 --- a/scanpipe/templates/scanpipe/resource_list.html +++ b/scanpipe/templates/scanpipe/resource_list.html @@ -45,10 +45,10 @@ {{ resource.extension }} - + {{ resource.programming_language }} - + {{ resource.mime_type }} diff --git a/scanpipe/views.py b/scanpipe/views.py index 1c69f59594..6b70b2ab28 100644 --- a/scanpipe/views.py +++ b/scanpipe/views.py @@ -1007,7 +1007,10 @@ class CodebaseResourceListView( "programming_language", "mime_type", "tag", - "detected_license_expression", + { + "field_name": "detected_license_expression", + "filter_fieldname": "detected_license_expression", + }, { "field_name": "compliance_alert", "condition": scanpipe_app.policies_enabled, @@ -1042,8 +1045,14 @@ class DiscoveredPackageListView( prefetch_related = ["codebase_resources"] table_columns = [ "package_url", - "declared_license_expression", - "copyright", + { + "field_name": "declared_license_expression", + "filter_fieldname": "declared_license_expression", + }, + { + "field_name": "copyright", + "filter_fieldname": "copyright", + }, "primary_language", "resources", ] From 5ee48a9a812dc8b00ca72d55f67d43e18e50a525 Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 17:42:02 +0400 Subject: [PATCH 09/10] Fix resource charts section file filters #216 Signed-off-by: Thomas Druez --- scanpipe/templates/scanpipe/includes/file_filter.html | 6 +++--- scanpipe/templates/scanpipe/project_detail.html | 2 +- scanpipe/views.py | 3 ++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/scanpipe/templates/scanpipe/includes/file_filter.html b/scanpipe/templates/scanpipe/includes/file_filter.html index 48da1ec5ce..5929d95bf3 100644 --- a/scanpipe/templates/scanpipe/includes/file_filter.html +++ b/scanpipe/templates/scanpipe/includes/file_filter.html @@ -2,17 +2,17 @@
    - + All Files {{ project.file_count|intcomma }} - + In a Package {{ project.file_in_package_count|intcomma }} - + NOT in a Package {{ project.file_not_in_package_count|intcomma }} diff --git a/scanpipe/templates/scanpipe/project_detail.html b/scanpipe/templates/scanpipe/project_detail.html index 3b3eb3fc41..7b40676535 100644 --- a/scanpipe/templates/scanpipe/project_detail.html +++ b/scanpipe/templates/scanpipe/project_detail.html @@ -124,7 +124,7 @@ {% if project.resource_count or project.package_count %} -
    +
    Loading the charts...
    diff --git a/scanpipe/views.py b/scanpipe/views.py index 6b70b2ab28..20b809a459 100644 --- a/scanpipe/views.py +++ b/scanpipe/views.py @@ -604,6 +604,7 @@ def get_context_data(self, **kwargs): "scan_summary": scan_summary, "pipeline_runs": pipeline_runs, "codebase_root": codebase_root, + "file_filter": self.request.GET.get("file-filter", "all"), } ) @@ -696,7 +697,7 @@ def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) project = self.object - file_filter = self.request.GET.get("file-filter") + file_filter = self.request.GET.get("file-filter", "all") context["file_filter"] = file_filter files = project.codebaseresources.files() From b1d6a6fc1cffe75c0b0fd1dfbccb552fc7346c5a Mon Sep 17 00:00:00 2001 From: Thomas Druez Date: Thu, 29 Jun 2023 17:45:45 +0400 Subject: [PATCH 10/10] Fix failing test #216 Signed-off-by: Thomas Druez --- scanpipe/tests/test_views.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scanpipe/tests/test_views.py b/scanpipe/tests/test_views.py index e71757c77b..03bc7ebb5f 100644 --- a/scanpipe/tests/test_views.py +++ b/scanpipe/tests/test_views.py @@ -138,8 +138,8 @@ def test_scanpipe_views_project_list_filters_exclude_page(self, mock_paginate_by data = {"page": "2"} response = self.client.get(url, data=data) - expected = 'Name' - self.assertContains(response, expected) + expected = 'Name' + self.assertContains(response, expected, html=True) expected = '
  • All
    • ' self.assertContains(response, expected) expected = 'All'