Change: Rename container_task to import_task and deprecate old API

Author: ozgen

gvm/protocols/gmp/_gmpnext.py

@@ -682,18 +682,29 @@ def create_container_image_task(
             )
         )
 
-    def create_container_task(
+    def create_import_task(
         self, name: str, *, comment: Optional[str] = None
     ) -> T:
-        """Create a new container task
+        """Create a new import task
 
-        A container task is a "meta" task to import and view reports from other
+        An import task is a "meta" task to import and view reports from other
         systems.
 
         Args:
             name: Name of the task
             comment: Comment for the task
         """
+        return self._send_request_and_transform_response(
+            Tasks.create_import_task(name=name, comment=comment)
+        )
+
+    def create_container_task(
+        self, name: str, *, comment: Optional[str] = None
+    ) -> T:
+        """[DEPRECATED] Use create_import_task instead.
+
+        This method will be removed in a future version.
+        """
         return self._send_request_and_transform_response(
             Tasks.create_container_task(name=name, comment=comment)
         )

gvm/protocols/gmp/requests/next/_tasks.py

@@ -7,7 +7,7 @@
 
 from gvm.errors import InvalidArgument, RequiredArgument
 from gvm.protocols.core import Request
-from gvm.utils import SupportsStr, to_bool, to_comma_list
+from gvm.utils import SupportsStr, deprecated, to_bool, to_comma_list
 from gvm.xml import XmlCommand
 
 from .._entity_id import EntityID
@@ -210,12 +210,12 @@ def create_container_image_task(
         return cmd
 
     @classmethod
-    def create_container_task(
+    def create_import_task(
         cls, name: str, *, comment: Optional[str] = None
     ) -> Request:
-        """Create a new container task
+        """Create a new import task
 
-        A container task is a "meta" task to import and view reports from other
+        An import task is a "meta" task to import and view reports from other
         systems.
 
         Args:
@@ -224,7 +224,7 @@ def create_container_task(
         """
         if not name:
             raise RequiredArgument(
-                function=cls.create_container_task.__name__, argument="name"
+                function=cls.create_import_task.__name__, argument="name"
             )
 
         cmd = XmlCommand("create_task")
@@ -236,6 +236,19 @@ def create_container_task(
 
         return cmd
 
+    @classmethod
+    @deprecated(
+        "The function is obsolete. Please use create_import_task instead."
+    )
+    def create_container_task(
+        cls, name: str, *, comment: Optional[str] = None
+    ) -> "Request":
+        """[DEPRECATED] Use create_import_task instead.
+
+        This method will be removed in a future version.
+        """
+        return cls.create_import_task(name=name, comment=comment)
+
     @classmethod
     def create_task(
         cls,

tests/protocols/gmpnext/entities/tasks/__init__.py

@@ -9,6 +9,7 @@
     GmpCreateContainerImageTaskTestMixin,
 )
 from .test_create_container_task import GmpCreateContainerTaskTestMixin
+from .test_create_import_task import GmpCreateImportTaskTestMixin
 from .test_create_task import GmpCreateTaskTestMixin
 from .test_delete_task import GmpDeleteTaskTestMixin
 from .test_get_task import GmpGetTaskTestMixin
@@ -24,6 +25,7 @@
     "GmpCreateAgentGroupTaskTestMixin",
     "GmpCreateContainerImageTaskTestMixin",
     "GmpCreateContainerTaskTestMixin",
+    "GmpCreateImportTaskTestMixin",
     "GmpCreateTaskTestMixin",
     "GmpDeleteTaskTestMixin",
     "GmpGetTaskTestMixin",

tests/protocols/gmpnext/entities/tasks/test_create_container_task.py

@@ -7,8 +7,11 @@
 
 
 class GmpCreateContainerTaskTestMixin:
-    def test_create_task(self):
-        self.gmp.create_container_task(name="foo")
+    def test_create_container_task_emits_deprecation_warning_and_sends_xml(
+        self,
+    ):
+        with self.assertWarns(DeprecationWarning):
+            self.gmp.create_container_task(name="foo")
 
         self.connection.send.has_been_called_with(
             b"<create_task>"
@@ -17,15 +20,16 @@ def test_create_task(self):
             b"</create_task>"
         )
 
-    def test_create_task_missing_name(self):
+    def test_create_container_task_missing_name(self):
         with self.assertRaises(RequiredArgument):
             self.gmp.create_container_task(name=None)
 
         with self.assertRaises(RequiredArgument):
             self.gmp.create_container_task(name="")
 
-    def test_create_task_with_comment(self):
-        self.gmp.create_container_task(name="foo", comment="bar")
+    def test_create_container_task_with_comment_emits_warning(self):
+        with self.assertWarns(DeprecationWarning):
+            self.gmp.create_container_task(name="foo", comment="bar")
 
         self.connection.send.has_been_called_with(
             b"<create_task>"

tests/protocols/gmpnext/entities/tasks/test_create_import_task.py

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2018-2025 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gvm.errors import RequiredArgument
+
+
+class GmpCreateImportTaskTestMixin:
+    def test_create_task(self):
+        self.gmp.create_import_task(name="foo")
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b'<target id="0"/>'
+            b"</create_task>"
+        )
+
+    def test_create_task_missing_name(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_import_task(name=None)
+
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_import_task(name="")
+
+    def test_create_task_with_comment(self):
+        self.gmp.create_import_task(name="foo", comment="bar")
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b'<target id="0"/>'
+            b"<comment>bar</comment>"
+            b"</create_task>"
+        )

tests/protocols/gmpnext/entities/test_tasks.py

@@ -2,13 +2,12 @@
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-
 from ...gmpnext import GMPTestCase
 from ...gmpnext.entities.tasks import (
     GmpCloneTaskTestMixin,
     GmpCreateAgentGroupTaskTestMixin,
     GmpCreateContainerImageTaskTestMixin,
-    GmpCreateContainerTaskTestMixin,
+    GmpCreateImportTaskTestMixin,
     GmpCreateTaskTestMixin,
     GmpDeleteTaskTestMixin,
     GmpGetTasksTestMixin,
@@ -19,6 +18,7 @@
     GmpStartTaskTestMixin,
     GmpStopTaskTestMixin,
 )
+from .tasks import GmpCreateContainerTaskTestMixin
 
 
 class GMPCloneTaskTestCase(GmpCloneTaskTestMixin, GMPTestCase):
@@ -43,6 +43,10 @@ class GMPCreateContainerTaskTestCase(
     pass
 
 
+class GMPCreateImportTaskTestCase(GmpCreateImportTaskTestMixin, GMPTestCase):
+    pass
+
+
 class GMPCreateTaskTestCase(GmpCreateTaskTestMixin, GMPTestCase):
     pass