Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Package API to accept multi-filter #61 #67

Merged
merged 1 commit into from
Apr 13, 2023
Merged

Update Package API to accept multi-filter #61 #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions packagedb/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@
from django_filters.rest_framework import FilterSet
from django_filters.filters import Filter
from django_filters.filters import OrderingFilter
import django_filters

from packageurl.contrib.django.utils import purl_to_lookups
from rest_framework import viewsets
from rest_framework.decorators import action
from rest_framework.response import Response

from matchcode.api import MultipleCharFilter
from packagedb.models import Package
from packagedb.models import Resource
from packagedb.serializers import PackageAPISerializer
Expand Down Expand Up @@ -107,6 +109,27 @@ def filter(self, qs, value):


class PackageFilter(FilterSet):
type = django_filters.CharFilter(
lookup_expr="iexact",
help_text="Exact type. (case-insensitive)",
)
namespace = django_filters.CharFilter(
lookup_expr="iexact",
help_text="Exact namespace. (case-insensitive)",
)
name = MultipleCharFilter(
lookup_expr="iexact",
help_text="Exact name. Multi-value supported. (case-insensitive)",
)
version = MultipleCharFilter(
help_text="Exact version. Multi-value supported.",
)
md5 = MultipleCharFilter(
help_text="Exact MD5. Multi-value supported.",
)
sha1 = MultipleCharFilter(
help_text="Exact SHA1. Multi-value supported.",
)
purl = MultiplePackageURLFilter(label='Package URL')
search = PackageSearchFilter(label='Search')

Expand Down
65 changes: 56 additions & 9 deletions packagedb/tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,19 +190,19 @@ def test_api_resource_list_endpoint_filters_by_package2_purl(self):
class PackageApiTestCase(TestCase):

def setUp(self):

self.package_data = {
'type': 'generic',
'namespace': 'generic',
'name': 'Foo',
'version': '12.34',
'qualifiers': 'testqual',
'subpath': 'testsub',
'qualifiers': 'test_quals',
'subpath': 'test_subpath',
'download_url': 'http://example.com',
'filename': 'Foo.zip',
'sha1': 'testsha1',
'md5': 'testmd5',
'size': 100,
'extra_data': json.dumps({'test2': 'data2'})
'size': 101,
}

self.package = Package.objects.create(**self.package_data)
Expand All @@ -211,14 +211,46 @@ def setUp(self):
self.package.append_to_history('test-message')
self.package.save()

self.package_data2 = {
'type': 'npm',
'namespace': 'example',
'name': 'Bar',
'version': '56.78',
'qualifiers': '',
'subpath': '',
'download_url': 'http://somethingelse.org',
'filename': 'Bar.zip',
'sha1': 'testsha1-2',
'md5': 'testmd5-2',
'size': 100,
}
self.package2 = Package.objects.create(**self.package_data2)
self.package2.refresh_from_db()

self.package_data3 = {
'type': 'jar',
'namespace': 'sample',
'name': 'Baz',
'version': '90.12',
'qualifiers': '',
'subpath': '',
'download_url': 'http://anotherexample.com',
'filename': 'Baz.zip',
'sha1': 'testsha1-3',
'md5': 'testmd5-3',
'size': 100,
}
self.package3 = Package.objects.create(**self.package_data3)
self.package3.refresh_from_db()

self.test_url = 'http://testserver/api/packages/{}/'

self.client = APIClient()

def test_package_api_list_endpoint(self):
response = self.client.get('/api/packages/')
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(1, response.data.get('count'))
self.assertEqual(3, response.data.get('count'))

def test_package_api_list_endpoint_filter(self):
for key, value in self.package_data.items():
Expand All @@ -229,15 +261,14 @@ def test_package_api_list_endpoint_filter(self):
def test_package_api_list_endpoint_filter_by_purl_fields_ignores_case(self):
for key, value in self.package_data.items():
# Skip non-purl fields
if key not in ['type', 'namespace', 'name', 'version', 'qualifiers', 'subpath',
'download_url', 'filename']:
if key not in ['type', 'namespace', 'name', 'version', 'qualifiers', 'subpath']:
continue

response = self.client.get('/api/packages/?{}__iexact={}'.format(key, value.lower()))
response = self.client.get('/api/packages/?{}={}'.format(key, value.lower()))
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(1, response.data.get('count'))

response = self.client.get('/api/packages/?{}__iexact={}'.format(key, value.upper()))
response = self.client.get('/api/packages/?{}={}'.format(key, value.upper()))
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(1, response.data.get('count'))

Expand Down Expand Up @@ -313,6 +344,22 @@ def test_api_package_resources_action(self):
for result, i in zip(response.data, range(0, 10)):
self.assertEqual(result.get('path'), 'path{}/'.format(i))

def test_api_package_list_endpoint_multiple_char_filters(self):
filters = f'?md5={self.package.md5}&md5={self.package2.md5}'
response = self.client.get(f'/api/packages/{filters}')
self.assertEqual(2, response.data['count'])
purls = [result.get('purl') for result in response.data['results']]
self.assertIn(self.package.purl, purls)
self.assertIn(self.package2.purl, purls)
self.assertNotIn(self.package3.purl, purls)

filters = f'?sha1={self.package2.sha1}&sha1={self.package3.sha1}'
response = self.client.get(f'/api/packages/{filters}')
self.assertEqual(2, response.data["count"])
purls = [result.get('purl') for result in response.data['results']]
self.assertIn(self.package2.purl, purls)
self.assertIn(self.package3.purl, purls)
self.assertNotIn(self.package.purl, purls)

class PackageApiPurlFilterTestCase(TestCase):

Expand Down