feat(dockerfile): added data structure for --mount=type=ssh

Author: gsilva00

rigel/plugins/core/dockerfile/models.py

@@ -93,6 +93,66 @@ def validate_mode(cls, value: Optional[str]) -> str:
 
         return value
 
+class SSH(BaseModel, extra=Extra.forbid):
+    """Represents an SSH agent or key to be used in the Dockerfile.
+
+    :type id: string
+    :cvar id: ID of the SSH agent or key. Defaults to 'default'.
+    :type target: string
+    :cvar target: The path where the SSH agent socket path in the container. Defaults to /run/buildkit/ssh_agent.{N} if not set.
+    :type required: bool
+    :cvar required: Flag to indicate if the SSH agent or key is required. The RUN instruction errors if the SSH agent or key is unavailable. Defaults to False.
+    :type mode: string
+    :cvar mode: The file mode for the SSH agent socket. Defaults to 0600 (octal).
+    :type uid: int
+    :cvar uid: The user ID for the SSH agent socket. Defaults to 0.
+    :type gid: int
+    :cvar gid: The group ID for the SSH agent socket. Defaults to 0.
+    """
+    # Static field - keep track for unique (DEFAULT) target names
+    # Note: Meaningless if there is only one SSH agent per RUN instruction.
+    # Needs implementation change if we start supporting multiple SSH agents in the same RUN instruction. Depends on how that is done.
+    _counter: int = 0
+
+    # Required fields
+    id: str = 'default'
+    target: Optional[str] = None
+
+    # Optional fields
+    # - Default values
+    DEFAULT_REQUIRED = False
+    DEFAULT_MODE = '0600'
+    DEFAULT_UID = 0
+    DEFAULT_GID = 0
+
+    required: bool = DEFAULT_REQUIRED
+    mode: str = DEFAULT_MODE
+    uid: int = DEFAULT_UID
+    gid: int = DEFAULT_GID
+
+    def __init__(self, **data: Any):
+        if not data.get('target'):
+            data['target'] = f"/run/buildkit/ssh_agent.{SSH._counter}"
+            SSH._counter += 1
+        super().__init__(**data)
+
+    @validator('mode')
+    def validate_mode(cls, value: Optional[str]) -> str:
+        """Ensure that the mode is a valid octal string and within the range of 0000 to 0777.
+
+        :type value: string
+        :param value: The mode to be validated.
+        """
+        try:
+            mode = int(value, 8)
+        except ValueError:
+            raise InvalidValueError('mode', value)
+
+        if not (0 <= mode <= 0o777):
+            raise InvalidValueError('mode', value)
+
+        return value
+
 
 class PluginModel(BaseModel, extra=Extra.forbid):
     """A plugin that creates a ready-to-use Dockerfile for an existing ROS package.
@@ -127,6 +187,7 @@ class PluginModel(BaseModel, extra=Extra.forbid):
     apt: List[str] = []
     ignore: List[str] = []
     secrets: List[Secret] = []
+    ssh: List[SSH] = []
 
     entrypoint: List[str] = []
     env: List[Dict[str, Any]] = []