Implemented timeout

Author: mikicz

arca/backend/base.py

@@ -8,7 +8,7 @@
 from git import Repo
 
 import arca
-from arca.exceptions import BuildError
+from arca.exceptions import BuildError, BuildTimeoutError
 from arca.result import Result
 from arca.task import Task
 from arca.utils import NOT_SET, LazySettingProperty, logger
@@ -161,7 +161,7 @@ def run(self, repo: str, branch: str, task: Task, git_repo: Repo, repo_path: Pat
                                        stderr=subprocess.PIPE,
                                        cwd=cwd)
 
-            out_stream, err_stream = process.communicate()
+            out_stream, err_stream = process.communicate(timeout=task.timeout)
 
             out_output = out_stream.decode("utf-8")
             err_output = err_stream.decode("utf-8")
@@ -170,6 +170,8 @@ def run(self, repo: str, branch: str, task: Task, git_repo: Repo, repo_path: Pat
             logger.debug(out_output)
 
             return Result(out_output)
+        except subprocess.TimeoutExpired:
+            raise BuildTimeoutError(f"The task timeouted after {task.timeout} seconds.")
         except BuildError:  # can be raised by  :meth:`Result.__init__`
             raise
         except Exception as e:

arca/backend/docker.py

@@ -19,7 +19,7 @@
 from requests.exceptions import ConnectionError
 
 import arca
-from arca.exceptions import ArcaMisconfigured, BuildError, PushToRegistryError
+from arca.exceptions import ArcaMisconfigured, BuildError, PushToRegistryError, BuildTimeoutError
 from arca.result import Result
 from arca.task import Task
 from arca.utils import logger, LazySettingProperty
@@ -744,11 +744,16 @@ def run(self, repo: str, branch: str, task: Task, git_repo: Repo, repo_path: Pat
         res = None
 
         try:
-            res = container.exec_run(["python",
+            res = container.exec_run(["timeout",
+                                      str(task.timeout),
+                                      "python",
                                       "/srv/scripts/runner.py",
                                       f"/srv/scripts/{task_filename}"],
                                      tty=True)
 
+            if res.exit_code == 124:
+                raise BuildTimeoutError(f"The task timeouted after {task.timeout} seconds.")
+
             return Result(res.output)
         except BuildError:  # can be raised by  :meth:`Result.__init__`
             raise

arca/backend/vagrant.py

@@ -1,13 +1,15 @@
+import math
 import re
 import shutil
 import subprocess
 from pathlib import Path
 from textwrap import dedent
 from uuid import uuid4
 
+from fabric.exceptions import CommandTimeout
 from git import Repo
 
-from arca.exceptions import ArcaMisconfigured, BuildError
+from arca.exceptions import ArcaMisconfigured, BuildError, BuildTimeoutError
 from arca.result import Result
 from arca.task import Task
 from arca.utils import LazySettingProperty, logger
@@ -150,7 +152,7 @@ def fabric_task(self):
         from fabric import api
 
         @api.task
-        def run_script(container_name, definition_filename, image_name, image_tag, repository):
+        def run_script(container_name, definition_filename, image_name, image_tag, repository, timeout):
             """ Sequence to run inside the VM.
                 Starts up the container if the container is not running
                 (and copies over the data and the runner script)
@@ -184,9 +186,11 @@ def run_script(container_name, definition_filename, image_name, image_tag, repos
             api.run(f"docker cp /vagrant/{definition_filename} {container_name}:/srv/scripts/")
 
             output = api.run(" ".join([
-                "docker", "exec", container_name,
-                "python", "/srv/scripts/runner.py", f"/srv/scripts/{definition_filename}",
-            ]))
+                    "docker", "exec", container_name,
+                    "python", "/srv/scripts/runner.py", f"/srv/scripts/{definition_filename}",
+                ]),
+                timeout=math.ceil(timeout)
+            )
 
             if not self.keep_container_running:
                 api.run(f"docker kill {container_name}")
@@ -261,9 +265,12 @@ def run(self, repo: str, branch: str, task: Task, git_repo: Repo, repo_path: Pat
                               definition_filename=task_filename,
                               image_name=image_name,
                               image_tag=image_tag,
-                              repository=str(repo_path.relative_to(Path(self._arca.base_dir).resolve() / 'repos')))
+                              repository=str(repo_path.relative_to(Path(self._arca.base_dir).resolve() / 'repos')),
+                              timeout=task.timeout)
 
             return Result(res[self.vagrant.user_hostname_port()].stdout)
+        except CommandTimeout:
+            raise BuildTimeoutError(f"The task timeouted after {task.timeout} seconds.")
         except BuildError:  # can be raised by  :meth:`Result.__init__`
             raise
         except Exception as e:

arca/exceptions.py

@@ -43,6 +43,11 @@ def __str__(self):
         )
 
 
+class BuildTimeoutError(BuildError):
+    """ Raised if the task takes too long.
+    """
+
+
 class PushToRegistryError(ArcaException):
     """ Raised if pushing of images to Docker registry in :class:`DockerBackend` fails.
     """

arca/task.py

@@ -31,6 +31,7 @@ def ret_argument(value="Value"):
     """
 
     def __init__(self, entry_point: str, *,
+                 timeout: int=5,
                  args: Optional[Iterable[Any]]=None,
                  kwargs: Optional[Dict[str, Any]]=None) -> None:
 
@@ -42,6 +43,11 @@ def __init__(self, entry_point: str, *,
         if self._entry_point.object_name is None:
             raise TaskMisconfigured("Task entry point must be an object, not a module.")
 
+        try:
+            self._timeout = int(timeout)
+        except ValueError:
+            raise TaskMisconfigured("Provided timeout could not be converted to int.")
+
         try:
             self._args = list(args or [])
             self._kwargs = dict(kwargs or {})
@@ -68,6 +74,10 @@ def args(self):
     def kwargs(self):
         return self._kwargs
 
+    @property
+    def timeout(self):
+        return self._timeout
+
     def __repr__(self):
         return f"Task({self.entry_point})"
 

tests/common.py

@@ -56,3 +56,11 @@ def return_alsaaudio_installed():
 def return_platform():
     return platform.dist()[0]
 """
+
+WAITING_FUNCTION = """
+import time
+
+def return_str_function():
+    time.sleep(2)
+    return "Some string"
+"""

tests/test_backends.py

@@ -5,7 +5,8 @@
 
 from arca import Arca, VenvBackend, DockerBackend, Task, CurrentEnvironmentBackend
 from common import BASE_DIR, RETURN_COLORAMA_VERSION_FUNCTION, SECOND_RETURN_STR_FUNCTION, \
-    TEST_UNICODE, ARG_STR_FUNCTION, KWARG_STR_FUNCTION
+    TEST_UNICODE, ARG_STR_FUNCTION, KWARG_STR_FUNCTION, WAITING_FUNCTION
+from arca.exceptions import BuildTimeoutError
 
 
 @pytest.mark.parametrize(
@@ -48,7 +49,7 @@ def test_backends(temp_repo_func, backend, requirements_location, file_location)
         temp_repo_func.repo.index.add([str(filepath)])
         temp_repo_func.repo.index.commit("Initial")
 
-    task = Task("test_file:return_str_function",)
+    task = Task("test_file:return_str_function")
 
     assert arca.run(temp_repo_func.url, temp_repo_func.branch, task).output == "Some string"
 
@@ -103,6 +104,18 @@ def test_backends(temp_repo_func, backend, requirements_location, file_location)
         kwargs={"kwarg": TEST_UNICODE}
     )).output == TEST_UNICODE[::-1]
 
+    filepath.write_text(WAITING_FUNCTION)
+    temp_repo_func.repo.index.add([str(filepath)])
+    temp_repo_func.repo.index.commit("Waiting function")
+
+    task_1_second = Task("test_file:return_str_function", timeout=1)
+    task_3_seconds = Task("test_file:return_str_function", timeout=3)
+
+    with pytest.raises(BuildTimeoutError):
+        assert arca.run(temp_repo_func.url, temp_repo_func.branch, task_1_second).output == "Some string"
+
+    assert arca.run(temp_repo_func.url, temp_repo_func.branch, task_3_seconds).output == "Some string"
+
     if isinstance(backend, CurrentEnvironmentBackend):
         backend._uninstall("colorama")
 

tests/test_vagrant.py

@@ -5,8 +5,9 @@
 from vagrant import Vagrant
 
 from arca import VagrantBackend, Arca, Task
-from arca.exceptions import ArcaMisconfigured
-from common import BASE_DIR, RETURN_COLORAMA_VERSION_FUNCTION, SECOND_RETURN_STR_FUNCTION, TEST_UNICODE
+from arca.exceptions import ArcaMisconfigured, BuildTimeoutError
+from common import BASE_DIR, RETURN_COLORAMA_VERSION_FUNCTION, SECOND_RETURN_STR_FUNCTION, TEST_UNICODE, \
+    WAITING_FUNCTION
 
 
 def test_validation():
@@ -100,6 +101,20 @@ def test_vagrant(temp_repo_func, destroy=False):
     assert arca.run(temp_repo_func.url, temp_repo_func.branch, task).output == "0.3.9"
     assert arca.run(temp_repo_func.url, "branch", task).output == TEST_UNICODE
 
+    # test timeout
+    temp_repo_func.repo.branches.master.checkout()
+    temp_repo_func.file_path.write_text(WAITING_FUNCTION)
+    temp_repo_func.repo.index.add([str(temp_repo_func.file_path)])
+    temp_repo_func.repo.index.commit("Waiting function")
+
+    task_1_second = Task("test_file:return_str_function", timeout=1)
+    task_3_seconds = Task("test_file:return_str_function", timeout=3)
+
+    with pytest.raises(BuildTimeoutError):
+        assert arca.run(temp_repo_func.url, temp_repo_func.branch, task_1_second).output == "Some string"
+
+    assert arca.run(temp_repo_func.url, temp_repo_func.branch, task_3_seconds).output == "Some string"
+
     backend.stop_vm()
 
     if destroy: