Merge pull request #54 from DistributedTaskScheduling/implementation-job

Implementation of Job class

Author: ammen99

src/ja/common/docker_context.py

@@ -4,11 +4,11 @@
 and hardware constraints.
 """
 from abc import ABC, abstractmethod
-from typing import List, Dict
+from typing import List, Dict, cast
 from ja.common.message.base import Serializable
 
 
-class MountPoint:
+class MountPoint(Serializable):
     """!
     A mount point consists of:
     1. A directory to be mounted(@source_path).
@@ -21,18 +21,38 @@ def __init__(self, source_path: str, mount_path: str):
         @param source_path The host directory to be mounted.
         @param mount_path The target path in the container to mount at.
         """
+        self._source_path = source_path
+        self._mount_path = mount_path
+
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, MountPoint):
+            return self.source_path == other.source_path and self.mount_path == other.mount_path
+        else:
+            return False
 
     @property
     def source_path(self) -> str:
         """!
         @return The directory to be mounted.
         """
+        return self._source_path
 
     @property
     def mount_path(self) -> str:
         """!
         @return The path where the directory should be mounted.
         """
+        return self._mount_path
+
+    def to_dict(self) -> Dict[str, object]:
+        return {"source_path": self.source_path, "mount_path": self.mount_path}
+
+    @classmethod
+    def from_dict(cls, property_dict: Dict[str, object]) -> "MountPoint":
+        source_path = cls._get_str_from_dict(property_dict=property_dict, key="source_path")
+        mount_path = cls._get_str_from_dict(property_dict=property_dict, key="mount_path")
+        cls._assert_all_properties_used(property_dict)
+        return MountPoint(source_path=source_path, mount_path=mount_path)
 
 
 class IDockerContext(Serializable, ABC):
@@ -41,19 +61,83 @@ class IDockerContext(Serializable, ABC):
     run a job in.
     """
 
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, IDockerContext):
+            return self.dockerfile_source == other.dockerfile_source and self.mount_points == other.mount_points
+        else:
+            return False
+
+    @property
     @abstractmethod
-    def get_dockerfile_source(self) -> str:
+    def dockerfile_source(self) -> str:
         """!
         @return The string contents of a Dockerfile which can be used to build
         the docker image.
         """
 
+    @property
     @abstractmethod
-    def get_mount_points(self) -> List[MountPoint]:
+    def mount_points(self) -> List[MountPoint]:
         """!
         @return A list of all mount points for the job.
         """
 
+    @classmethod
+    @abstractmethod
+    def from_dict(cls, property_dict: Dict[str, object]) -> "IDockerContext":
+        pass
+
+
+class DockerContext(IDockerContext):
+    """
+    An implementation of the IDockerContext interface
+    """
+    def __init__(self, dockerfile_source: str, mount_points: List[MountPoint]):
+        """
+        @param dockerfile_source: The string contents of a Dockerfile which can be used to build the docker image.
+        @param mount_points: A list of all mount points for the job.
+        """
+        self._dockerfile_source = dockerfile_source
+        self._mount_points = mount_points
+
+    @property
+    def dockerfile_source(self) -> str:
+        return self._dockerfile_source
+
+    @property
+    def mount_points(self) -> List[MountPoint]:
+        return self._mount_points
+
+    def to_dict(self) -> Dict[str, object]:
+        return_dict: Dict[str, object] = dict()
+        return_dict["dockerfile_source"] = self.dockerfile_source
+        return_dict["mount_points"] = [_mount_point.to_dict() for _mount_point in self.mount_points]
+        return return_dict
+
+    @classmethod
+    def from_dict(cls, property_dict: Dict[str, object]) -> IDockerContext:
+        dockerfile_source = cls._get_str_from_dict(property_dict=property_dict, key="dockerfile_source")
+
+        prop: object = cls._get_from_dict(property_dict=property_dict, key="mount_points")
+        if not isinstance(prop, list):
+            cls._raise_error_wrong_type(
+                key="mount_points", expected_type="List[MountPoint]",
+                actual_type=prop.__class__.__name__
+            )
+        object_list = cast(List[object], prop)
+        mount_point_list: List[MountPoint] = []
+        for _object in object_list:
+            if not isinstance(_object, dict):
+                cls._raise_error_wrong_type(
+                    key="mount_points", expected_type="List[MountPoint]",
+                    actual_type="List[object]"
+                )
+            mount_point_list.append(MountPoint.from_dict(
+                cast(Dict[str, object], _object)
+            ))
+        cls._assert_all_properties_used(property_dict)
+        return DockerContext(dockerfile_source=dockerfile_source, mount_points=mount_point_list)
+
 
 class DockerConstraints(Serializable):
     """
@@ -62,9 +146,21 @@ class DockerConstraints(Serializable):
     def __init__(self, cpu_threads: int = -1, memory: int = 1):
         """!
         Create a new set of Docker constraints.
-        @param cpu_threads Initial value of @cpu_threads.
-        @param memory The value of @memory.
+        @param cpu_threads Initial value of @cpu_threads. -1 if unknown. Must be > 0 if set to exact number.
+        @param memory The value of @memory, must be > 0.
         """
+        self._cpu_threads = -1
+        if cpu_threads != -1:
+            self.cpu_threads = cpu_threads
+        if memory < 1:
+            raise ValueError("Cannot set memory to %s because this value is < 1." % memory)
+        self._memory = memory
+
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, DockerConstraints):
+            return self.cpu_threads == other.cpu_threads and self.memory == other.memory
+        else:
+            return False
 
     @property
     def cpu_threads(self) -> int:
@@ -73,6 +169,7 @@ def cpu_threads(self) -> int:
         -1 means that the amount of threads is not set, in which case the
         number of threads will be determined when scheduling the job.
         """
+        return self._cpu_threads
 
     @cpu_threads.setter
     def cpu_threads(self, count_threads: int) -> None:
@@ -81,16 +178,29 @@ def cpu_threads(self, count_threads: int) -> None:
         If the number of cpu threads is already set(i.e it is not equal to -1),
         this will raise a RuntimeError.
         """
+        if self._cpu_threads != -1:
+            raise RuntimeError("cpu_threads can only be set once.")
+        elif count_threads < 1:
+            raise ValueError("Cannot set cpu_threads to %s because this value is < 1." % count_threads)
+        else:
+            self._cpu_threads = count_threads
 
     @property
     def memory(self) -> int:
         """!
         @return The maximum amount of RAM in MB to allocate for this container.
         """
+        return self._memory
 
     def to_dict(self) -> Dict[str, object]:
-        pass
+        return_dict: Dict[str, object] = dict()
+        return_dict["cpu_threads"] = self.cpu_threads
+        return_dict["memory"] = self.memory
+        return return_dict
 
     @classmethod
     def from_dict(cls, property_dict: Dict[str, object]) -> "DockerConstraints":
-        pass
+        cpu_threads = cls._get_int_from_dict(property_dict=property_dict, key="cpu_threads")
+        memory = cls._get_int_from_dict(property_dict=property_dict, key="memory")
+        cls._assert_all_properties_used(property_dict)
+        return DockerConstraints(cpu_threads=cpu_threads, memory=memory)