Gsoc25 refactor analyzer tests

.github/pull_request_template.md

@@ -26,8 +26,8 @@ Please delete options that are not relevant.
     - [ ] Check if it could make sense to add that analyzer/connector to other [freely available playbooks](https://intelowlproject.github.io/docs/IntelOwl/usage/#list-of-pre-built-playbooks).
     - [ ] I have provided the resulting raw JSON of a finished analysis and a screenshot of the results.
     - [ ] If the plugin interacts with an external service, I have created an attribute called precisely `url` that contains this information. This is required for Health Checks (HEAD HTTP requests). 
-    - [ ] If the plugin requires mocked testing, `_monkeypatch()` was used in its class to apply the necessary decorators.
-    - [ ] I have added that raw JSON sample to the `MockUpResponse` of the `_monkeypatch()` method. This serves us to provide a valid sample for testing.
+    - [ ] If a new analyzer has beed added, I have created a unittest for it in the appropriate dir. I have also mocked all the external calls, so that no real calls are being made while testing.
+    - [ ] I have added that raw JSON sample to the `get_mocker_response()` method of the unittest class. This serves us to provide a valid sample for testing. 
     - [ ] I have created the corresponding `DataModel` for the new analyzer following the [documentation](https://intelowlproject.github.io/docs/IntelOwl/contribute/#how-to-create-a-datamodel)
 - [ ] I have inserted the copyright banner at the start of the file: ```# This file is a part of IntelOwl https://github.com/intelowlproject/IntelOwl # See the file 'LICENSE' for copying permission.```
 - [ ] Please avoid adding new libraries as requirements whenever it is possible. Use new libraries only if strictly needed to solve the issue you are working for. In case of doubt, ask a maintainer permission to use a specific library.

.github/workflows/pull_request_automation.yml

@@ -115,6 +115,9 @@ jobs:
       - name: Run test
         run: |
           docker exec intelowl_uwsgi coverage run manage.py test --keepdb tests
+      - name: Run async tests
+        run: |
+          docker exec intelowl_uwsgi coverage run manage.py test --keepdb async_tests
 
   frontend-tests:
     runs-on: ubuntu-latest

api_app/analyzers_manager/classes.py

@@ -12,7 +12,6 @@
 from django.conf import settings
 
 from certego_saas.apps.user.models import User
-from tests.mock_utils import MockUpResponse, if_mock_connections, patch
 
 from ..choices import Classification, PythonModuleBasePaths
 from ..classes import Plugin
@@ -487,43 +486,6 @@ def _docker_get(self):
             raise AssertionError
         return resp
 
-    @staticmethod
-    def mocked_docker_analyzer_get(*args, **kwargs):
-        return MockUpResponse(
-            {"key": "test", "returncode": 0, "report": {"test": "This is a test."}}, 200
-        )
-
-    @staticmethod
-    def mocked_docker_analyzer_post(*args, **kwargs):
-        return MockUpResponse({"key": "test", "status": "running"}, 202)
-
-    def _monkeypatch(self, patches: list = None):
-        """
-        Here, `_monkeypatch` is an instance method and not a class method.
-        This is because when defined with `@classmethod`, we were getting the error
-        ```
-        '_patch' object has no attribute 'is_local'
-        ```
-        whenever multiple analyzers with same parent class were being called.
-        """
-        if patches is None:
-            patches = []
-        # no need to sleep during tests
-        self.poll_distance = 0
-        patches.append(
-            if_mock_connections(
-                patch(
-                    "requests.get",
-                    side_effect=self.mocked_docker_analyzer_get,
-                ),
-                patch(
-                    "requests.post",
-                    side_effect=self.mocked_docker_analyzer_post,
-                ),
-            )
-        )
-        return super()._monkeypatch(patches)
-
     def health_check(self, user: User = None) -> bool:
         """
         basic health check: if instance is up or not (timeout - 10s)

api_app/analyzers_manager/file_analyzers/artifacts.py

@@ -1,7 +1,6 @@
 import logging
 
 from api_app.analyzers_manager.classes import DockerBasedAnalyzer, FileAnalyzer
-from tests.mock_utils import MockUpResponse
 
 logger = logging.getLogger(__name__)
 
@@ -28,47 +27,3 @@ def run(self):
         )
         result = self._docker_run(req_data, req_files, analyzer_name=self.analyzer_name)
         return result
-
-    # flake8: noqa
-    @staticmethod
-    def mocked_docker_analyzer_get(*args, **kwargs):
-        return MockUpResponse(
-            {
-                "report": {
-                    "name": "APK_Artifacts",
-                    "process_time": 5.07,
-                    "status": "SUCCESS",
-                    "end_time": "2024-08-27T10:03:15.563886Z",
-                    "parameters": {},
-                    "type": "analyzer",
-                    "id": 72,
-                    "report": {
-                        "dex": ["classes.dex"],
-                        "md5": "8a05a189e58ccd7275f7ffdf88c2c191",
-                        "root": [],
-                        "family": {
-                            "name": "CryCrypto",
-                            "match": 11.11,
-                            "value": {
-                                "intent": 33.33,
-                                "permission": 0.0,
-                                "application": 0.0,
-                            },
-                        },
-                        "string": {"known": [], "base64": [], "telegram_id": []},
-                        "library": [],
-                        "network": {"ip": [], "url": [], "param": []},
-                        "sandbox": [
-                            "https://tria.ge/s?q=8a05a189e58ccd7275f7ffdf88c2c191",
-                            "https://www.joesandbox.com/analysis/search?q=8a05a189e58ccd7275f7ffdf88c2c191",
-                            "https://www.virustotal.com/gui/search/8a05a189e58ccd7275f7ffdf88c2c191",
-                            "https://bazaar.abuse.ch/browse.php?search=md5:8a05a189e58ccd7275f7ffdf88c2c191",
-                            "https://koodous.com/apks?search=8a05a189e58ccd7275f7ffdf88c2c191",
-                        ],
-                        "version": "1.1.1",
-                        "elapsed_time": 0.02,
-                    },
-                }
-            },
-            200,
-        )

api_app/analyzers_manager/file_analyzers/boxjs_scan.py

@@ -67,7 +67,3 @@ def run(self):
         report["uris"] = list(set(report["uris"]))  # uniq
 
         return report
-
-    # disable mockup connections for this class
-    @classmethod
-    def _monkeypatch(cls, patches: list = None) -> None: ...  # noqa: E704

api_app/analyzers_manager/file_analyzers/cape_sandbox.py

@@ -11,7 +11,6 @@
 
 from api_app.analyzers_manager.classes import FileAnalyzer
 from api_app.analyzers_manager.exceptions import AnalyzerRunException
-from tests.mock_utils import MockUpResponse, if_mock_connections, patch
 
 logger = logging.getLogger(__name__)
 
@@ -335,31 +334,3 @@ def __poll_for_result(
             )
 
         return results
-
-    @classmethod
-    def _monkeypatch(cls):
-        patches = [
-            if_mock_connections(
-                patch(
-                    "requests.Session.get",
-                    return_value=MockUpResponse(
-                        {"error": False, "data": "completed"}, 200
-                    ),
-                ),
-                patch(
-                    "requests.Session.post",
-                    return_value=MockUpResponse(
-                        {
-                            "error": False,
-                            "data": {
-                                "task_ids": [1234],
-                            },
-                            "errors": [],
-                            "url": ["http://fake_url.com/submit/status/1234/"],
-                        },
-                        200,
-                    ),
-                ),
-            )
-        ]
-        return super()._monkeypatch(patches=patches)

api_app/analyzers_manager/file_analyzers/clamav.py

@@ -4,7 +4,6 @@
 import logging
 
 from api_app.analyzers_manager.classes import DockerBasedAnalyzer, FileAnalyzer
-from tests.mock_utils import MockUpResponse
 
 logger = logging.getLogger(__name__)
 
@@ -46,9 +45,3 @@ def run(self):
                 logger.error(f"no detections extracted? {self.job_id}")
 
         return {"detections": list(set(detections)), "raw_report": report}
-
-    @staticmethod
-    def mocked_docker_analyzer_get(*args, **kwargs):
-        return MockUpResponse(
-            {"key": "test", "returncode": 0, "report": "OK real_signature\n"}, 200
-        )

api_app/analyzers_manager/file_analyzers/cuckoo_scan.py

@@ -10,7 +10,6 @@
 
 from api_app.analyzers_manager.classes import FileAnalyzer
 from api_app.analyzers_manager.exceptions import AnalyzerRunException
-from tests.mock_utils import MockUpResponse, if_mock_connections, patch
 
 logger = logging.getLogger(__name__)
 
@@ -261,19 +260,3 @@ def __cuckoo_retrieve_and_create_report(self):
         logger.info(f"report generated for ({self.filename},{self.md5})")
 
         return result
-
-    @classmethod
-    def _monkeypatch(cls):
-        patches = [
-            if_mock_connections(
-                patch(
-                    "requests.Session.get",
-                    return_value=MockUpResponse({"task": {"status": "reported"}}, 200),
-                ),
-                patch(
-                    "requests.Session.post",
-                    return_value=MockUpResponse({}, 200),
-                ),
-            )
-        ]
-        return super()._monkeypatch(patches=patches)