Move http package into protocols

Author: timopollmeier

docs/api/api.rst

@@ -16,6 +16,5 @@ utilities and xml helpers.
     connections
     transforms
     protocols
-    http
     errors
     other

docs/api/http.rst

@@ -3,7 +3,7 @@
 HTTP APIs
 ---------
 
-.. automodule:: gvm.http
+.. automodule:: gvm.protocols.http
 
 .. toctree::
     :maxdepth: 1

docs/api/httpcore.rst

@@ -6,23 +6,23 @@ HTTP core classes
 Connector
 #########
 
-.. automodule:: gvm.http.core.connector
+.. automodule:: gvm.protocols.http.core.connector
 
 .. autoclass:: HttpApiConnector
     :members:
 
 Headers
 #######
 
-.. automodule:: gvm.http.core.headers
+.. automodule:: gvm.protocols.http.core.headers
 
 .. autoclass:: ContentType
     :members:
 
 Response
 ########
 
-.. automodule:: gvm.http.core.response
+.. automodule:: gvm.protocols.http.core.response
 
 .. autoclass:: HttpResponse
     :members:

docs/api/openvasdv1.rst

@@ -3,7 +3,7 @@
 openvasd v1
 ^^^^^^^^^^^
 
-.. automodule:: gvm.http.openvasd.openvasd1
+.. automodule:: gvm.protocols.http.openvasd.openvasd1
 
 .. autoclass:: OpenvasdHttpApiV1
     :members:

docs/api/protocols.rst

@@ -8,6 +8,7 @@ Protocols
 .. toctree::
     :maxdepth: 1
 
+    http
     gmp
     ospv1
 

gvm/http/__init__.py renamed to gvm/protocols/http/__init__.py

@@ -8,7 +8,7 @@
 
 from typing import Optional
 
-from gvm.http.core.connector import HttpApiConnector
+from gvm.protocols.http.core.connector import HttpApiConnector
 
 
 class GvmHttpApi:

gvm/http/core/__init__.py renamed to gvm/protocols/http/core/__init__.py

@@ -11,7 +11,7 @@
 
 from httpx import Client
 
-from gvm.http.core.response import HttpResponse
+from gvm.protocols.http.core.response import HttpResponse
 
 
 class HttpApiConnector:

gvm/http/core/_api.py renamed to gvm/protocols/http/core/_api.py

@@ -11,7 +11,7 @@
 
 from httpx import Response
 
-from gvm.http.core.headers import ContentType
+from gvm.protocols.http.core.headers import ContentType
 
 Self = TypeVar("Self", bound="HttpResponse")
 

gvm/http/core/connector.py renamed to gvm/protocols/http/core/connector.py

@@ -10,9 +10,9 @@
 from typing import Any, Optional, Union
 
 from gvm.errors import InvalidArgumentType
-from gvm.http.core._api import GvmHttpApi
-from gvm.http.core.connector import HttpApiConnector
-from gvm.http.core.response import HttpResponse
+from gvm.protocols.http.core._api import GvmHttpApi
+from gvm.protocols.http.core.connector import HttpApiConnector
+from gvm.protocols.http.core.response import HttpResponse
 
 
 class OpenvasdHttpApiV1(GvmHttpApi):

gvm/http/core/headers.py renamed to gvm/protocols/http/core/headers.py

@@ -5,7 +5,7 @@
 import unittest
 from unittest.mock import MagicMock, patch
 
-from gvm.http.core._api import GvmHttpApi
+from gvm.protocols.http.core._api import GvmHttpApi
 
 
 class GvmHttpApiTestCase(unittest.TestCase):

gvm/http/core/response.py renamed to gvm/protocols/http/core/response.py

@@ -11,8 +11,8 @@
 import httpx
 from httpx import HTTPError
 
-from gvm.http.core.connector import HttpApiConnector
-from gvm.http.core.headers import ContentType
+from gvm.protocols.http.core.connector import HttpApiConnector
+from gvm.protocols.http.core import ContentType
 
 TEST_JSON_HEADERS = {
     "content-type": "application/json;charset=utf-8",

gvm/http/openvasd/__init__.py renamed to gvm/protocols/http/openvasd/__init__.py

@@ -4,7 +4,7 @@
 
 import unittest
 
-from gvm.http.core.headers import ContentType
+from gvm.protocols.http.core import ContentType
 
 
 class ContentTypeTestCase(unittest.TestCase):

gvm/http/openvasd/openvasd1.py renamed to gvm/protocols/http/openvasd/openvasd1.py

@@ -7,7 +7,7 @@
 
 import requests as requests_lib
 
-from gvm.http.core.response import HttpResponse
+from gvm.protocols.http.core.response import HttpResponse
 
 
 class HttpResponseFromRequestsLibTestCase(unittest.TestCase):

tests/http/__init__.py renamed to tests/protocols/http/__init__.py

@@ -8,9 +8,9 @@
 from unittest.mock import Mock, patch
 
 from gvm.errors import InvalidArgumentType
-from gvm.http.core.headers import ContentType
-from gvm.http.core.response import HttpResponse
-from gvm.http.openvasd.openvasd1 import OpenvasdHttpApiV1
+from gvm.protocols.http.core.headers import ContentType
+from gvm.protocols.http.core.response import HttpResponse
+from gvm.protocols.http.openvasd.openvasd1 import OpenvasdHttpApiV1
 
 
 def new_mock_empty_response(
@@ -29,21 +29,21 @@ def new_mock_empty_response(
 
 class OpenvasdHttpApiV1TestCase(unittest.TestCase):
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_init(self, mock_connector: Mock):
         api = OpenvasdHttpApiV1(mock_connector)
         mock_connector.update_headers.assert_not_called()
         self.assertIsNotNone(api)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_init_with_api_key(self, mock_connector: Mock):
         api = OpenvasdHttpApiV1(mock_connector, api_key="my-API-key")
         mock_connector.update_headers.assert_called_once_with(
             {"X-API-KEY": "my-API-key"}
         )
         self.assertIsNotNone(api)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_health_alive(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -55,7 +55,7 @@ def test_get_health_alive(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_health_ready(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -67,7 +67,7 @@ def test_get_health_ready(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_health_started(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -79,7 +79,7 @@ def test_get_health_started(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_notus_os_list(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -91,7 +91,7 @@ def test_get_notus_os_list(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_run_notus_scan(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.post_json.return_value = expected_response
@@ -105,7 +105,7 @@ def test_run_notus_scan(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scan_preferences(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -117,7 +117,7 @@ def test_get_scan_preferences(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_create_scan(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.post_json.return_value = expected_response
@@ -156,7 +156,7 @@ def test_create_scan(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_delete_scan(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.delete.return_value = expected_response
@@ -168,7 +168,7 @@ def test_delete_scan(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scans(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -180,7 +180,7 @@ def test_get_scans(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scan(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -192,7 +192,7 @@ def test_get_scan(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scan_results(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -204,7 +204,7 @@ def test_get_scan_results(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scan_results_with_ranges(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -239,7 +239,7 @@ def test_get_scan_results_with_ranges(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scan_results_with_invalid_ranges(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -263,7 +263,7 @@ def test_get_scan_results_with_invalid_ranges(self, mock_connector: Mock):
             range_end="invalid",
         )
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scan_result(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -275,7 +275,7 @@ def test_get_scan_result(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_scan_status(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -287,7 +287,7 @@ def test_get_scan_status(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_run_scan_action(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.post_json.return_value = expected_response
@@ -301,7 +301,7 @@ def test_run_scan_action(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_start_scan(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.post_json.return_value = expected_response
@@ -313,7 +313,7 @@ def test_start_scan(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_stop_scan(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.post_json.return_value = expected_response
@@ -325,7 +325,7 @@ def test_stop_scan(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_vts(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response
@@ -337,7 +337,7 @@ def test_get_vts(self, mock_connector: Mock):
         )
         self.assertEqual(expected_response, response)
 
-    @patch("gvm.http.core.connector.HttpApiConnector", autospec=True)
+    @patch("gvm.protocols.http.core.connector.HttpApiConnector", autospec=True)
     def test_get_vt(self, mock_connector: Mock):
         expected_response = new_mock_empty_response()
         mock_connector.get.return_value = expected_response