Move the user id from project name to a label #387

Signed-off-by: tdruez <[email protected]>

Author: tdruez

component_catalog/tests/test_scancodeio.py

@@ -76,32 +76,31 @@ def test_scancodeio_submit_scan_task(self, mock_submit_scan, mock_request_head):
     @mock.patch("requests.sessions.Session.get")
     def test_scancodeio_fetch_scan_list(self, mock_session_get):
         scancodeio = ScanCodeIO(self.dataspace)
-        self.assertIsNone(scancodeio.fetch_scan_list())
-        self.assertFalse(mock_session_get.called)
+        dataspace_uid = get_hash_uid(self.dataspace.uuid)
+        user_uid = get_hash_uid(self.basic_user.uuid)
 
-        scancodeio.fetch_scan_list(user=self.basic_user)
+        scancodeio.fetch_scan_list()
         params = mock_session_get.call_args.kwargs["params"]
-        expected = {"format": "json", "name__endswith": get_hash_uid(self.basic_user.uuid)}
+        expected = {
+            "format": "json",
+            "name__contains": dataspace_uid,
+        }
         self.assertEqual(expected, params)
 
-        scancodeio.fetch_scan_list(dataspace=self.basic_user.dataspace)
+        scancodeio.fetch_scan_list(user=self.basic_user)
         params = mock_session_get.call_args.kwargs["params"]
         expected = {
             "format": "json",
-            "name__contains": get_hash_uid(self.basic_user.dataspace.uuid),
+            "name__contains": dataspace_uid,
+            "label": user_uid,
         }
         self.assertEqual(expected, params)
 
-        scancodeio.fetch_scan_list(
-            user=self.basic_user,
-            dataspace=self.basic_user.dataspace,
-            extra_params="extra",
-        )
+        scancodeio.fetch_scan_list(extra_params="extra")
         params = mock_session_get.call_args.kwargs["params"]
         expected = {
             "format": "json",
-            "name__contains": get_hash_uid(self.basic_user.dataspace.uuid),
-            "name__endswith": get_hash_uid(self.basic_user.uuid),
+            "name__contains": get_hash_uid(self.dataspace.uuid),
             "extra_params": "extra",
         }
         self.assertEqual(expected, params)
@@ -115,16 +114,11 @@ def test_scancodeio_fetch_scan_info(self, mock_session_get):
         params = mock_session_get.call_args.kwargs["params"]
         expected = {
             "name__startswith": get_hash_uid(uri),
-            "name__contains": get_hash_uid(self.basic_user.dataspace.uuid),
+            "name__contains": get_hash_uid(self.dataspace.uuid),
             "format": "json",
         }
         self.assertEqual(expected, params)
 
-        scancodeio.fetch_scan_info(uri=uri, user=self.basic_user)
-        params = mock_session_get.call_args.kwargs["params"]
-        expected["name__endswith"] = get_hash_uid(self.basic_user.uuid)
-        self.assertEqual(expected, params)
-
     @mock.patch("dejacode_toolkit.scancodeio.ScanCodeIO.request_get")
     def test_scancodeio_find_project(self, mock_request_get):
         scancodeio = ScanCodeIO(self.dataspace)

component_catalog/views.py

@@ -1742,7 +1742,6 @@ def get_queryset(self):
         scancodeio = ScanCodeIO(dataspace)
         self.list_data = (
             scancodeio.fetch_scan_list(
-                dataspace=dataspace,
                 user=user if self.request.GET.get("created_by_me") else None,
                 **filters,
             )

dejacode_toolkit/scancodeio.py

@@ -62,16 +62,21 @@ def get_project_info(self, download_url):
         return scan_info.get("results")[0]
 
     def submit_scan(self, uri, user_uuid, dataspace_uuid):
+        """
+        Submit package scan request to ScanCode.io.
+        An unique ID for the user is set as a project label, available for filtering.
+        """
+        webhook_url = get_webhook_url("notifications:send_scan_notification", user_uuid)
+
         data = {
-            "name": get_project_name(uri, user_uuid, dataspace_uuid),
+            "name": get_project_name(uri, dataspace_uuid),
             "input_urls": uri,
             "pipeline": "scan_single_package",
             "execute_now": True,
+            "webhook_url": webhook_url,
+            "labels": [get_hash_uid(user_uuid)],
         }
 
-        webhook_url = get_webhook_url("notifications:send_scan_notification", user_uuid)
-        data["webhook_url"] = webhook_url
-
         logger.debug(f'{self.label}: submit scan uri="{uri}" webhook_url="{webhook_url}"')
         return self.request_post(url=self.project_api_url, json=data)
 
@@ -102,14 +107,11 @@ def start_pipeline(self, run_url):
         start_pipeline_url = run_url + "start_pipeline/"
         return self.request_post(url=start_pipeline_url)
 
-    def fetch_scan_list(self, user=None, dataspace=None, **extra_payload):
-        payload = {}
-
-        if dataspace:
-            payload["name__contains"] = get_hash_uid(dataspace.uuid)
+    def fetch_scan_list(self, user=None, **extra_payload):
+        payload = {"name__contains": get_hash_uid(self.dataspace.uuid)}
 
         if user:
-            payload["name__endswith"] = get_hash_uid(user.uuid)
+            payload["label"] = get_hash_uid(user.uuid)
 
         payload.update(extra_payload)
         if not payload:
@@ -131,15 +133,11 @@ def find_project(self, **kwargs):
             if response.get("count") == 1:
                 return response.get("results")[0]
 
-    def fetch_scan_info(self, uri, user=None):
+    def fetch_scan_info(self, uri):
         payload = {
             "name__startswith": get_hash_uid(uri),
             "name__contains": get_hash_uid(self.dataspace.uuid),
         }
-
-        if user:
-            payload["name__endswith"] = get_hash_uid(user.uuid)
-
         logger.debug(f'{self.label}: fetch scan info uri="{uri}"')
         return self.request_get(url=self.project_api_url, params=payload)
 
@@ -491,18 +489,16 @@ def get_hash_uid(value):
     return md5(str(value).encode("utf-8"), usedforsecurity=False).hexdigest()[:10]
 
 
-def get_project_name(uri, user_uuid, dataspace_uuid):
+def get_project_name(uri, dataspace_uuid):
     """
     Return a project name based on a hash of the provided `uri` combined with a hash
-    of the `user_uuid` and `dataspace_uuid`.
+    of the `dataspace_uuid`.
 
-    project_name = "uri_hash.dataspace_uuid_hash.user_uuid_hash"
+    project_name = "uri_hash.dataspace_uuid_hash"
     """
     uri_hash = get_hash_uid(uri)
     dataspace_hash = get_hash_uid(dataspace_uuid)
-    user_hash = get_hash_uid(user_uuid)
-
-    return f"{uri_hash}.{dataspace_hash}.{user_hash}"
+    return f"{uri_hash}.{dataspace_hash}"
 
 
 def get_webhook_url(view_name, user_uuid):