api: support filtering patches by hash

This is a feature that the XML-RPC API has, and which is used in
the wild [1], so support it in the REST API.

I tried to version the new filter field, but it's not at all clear
how to do this with django-filters. The best way I could find
requires manually manipulating request.GET, which seems to defeat
the point of django-filters. So document it for 1.2, and have it
work on older versions as an undocumented feature.

[1] https://git.kernel.org/pub/scm/linux/kernel/git/mricon/korg-helpers.git/tree/git-patchwork-bot.py?id=104e7374e1be8458e6d2e82478625a7bf8c822ff

Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Signed-off-by: Daniel Axtens <dja@axtens.net>
Acked-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>

1 files changed, 36 insertions, 0 deletions

diff --git a/patchwork/tests/api/test_patch.py b/patchwork/tests/api/test_patch.py
index edae985..4afc15a 100644
--- a/patchwork/tests/api/test_patch.py
+++ b/patchwork/tests/api/test_patch.py
@@ -22,6 +22,13 @@ from patchwork.tests.utils import create_user
 if settings.ENABLE_REST_API:
     from rest_framework import status
 
+# a diff different from the default, required to test hash filtering
+SAMPLE_DIFF = """--- /dev/null\t2019-01-01 00:00:00.000000000 +0800
++++ a\t2019-01-01 00:00:00.000000000 +0800
+@@ -0,0 +1 @@
++b
+"""
+
 
 @unittest.skipUnless(settings.ENABLE_REST_API, 'requires ENABLE_REST_API')
 class TestPatchAPI(utils.APITestCase):
@@ -152,6 +159,35 @@ class TestPatchAPI(utils.APITestCase):
             'submitter': 'test@example.org'})
         self.assertEqual(0, len(resp.data))
 
+    def test_list_filter_hash(self):
+        """Filter patches by hash."""
+        patch = self._create_patch()
+        patch_new_diff = create_patch(state=patch.state, project=patch.project,
+                                      submitter=patch.submitter,
+                                      diff=SAMPLE_DIFF)
+
+        # check regular filtering
+        resp = self.client.get(self.api_url(), {'hash': patch.hash})
+        self.assertEqual([patch.id], [x['id'] for x in resp.data])
+
+        # 2 patches with identical diffs
+        patch_same_diff = create_patch(state=patch.state,
+                                       project=patch.project,
+                                       submitter=patch.submitter)
+        resp = self.client.get(self.api_url(), {'hash': patch.hash})
+        self.assertEqual([patch.id, patch_same_diff.id],
+                         [x['id'] for x in resp.data])
+
+        # case insensitive matching
+        resp = self.client.get(self.api_url(),
+                               {'hash': patch_new_diff.hash.upper()})
+        self.assertEqual([patch_new_diff.id], [x['id'] for x in resp.data])
+
+        # empty response if nothing matches
+        resp = self.client.get(self.api_url(), {
+            'hash': 'da638d0746a115000bf890fada1f02679aa282e8'})
+        self.assertEqual(0, len(resp.data))
+
     @utils.store_samples('patch-list-1-0')
     def test_list_version_1_0(self):
         """List patches using API v1.0."""