gitlab-runner-tart-driver 0.1.2__tar.gz → 0.1.3__tar.gz

{gitlab-runner-tart-driver-0.1.2 → gitlab-runner-tart-driver-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-runner-tart-driver
-Version: 0.1.2
+Version: 0.1.3
 Home-page: https://gitlab.com/schmieder.matthias/gitlab-runner-tart-driver
 Author: Matthias Schmieder
 Author-email: schmieder.matthias@gmail.com
@@ -114,15 +114,18 @@ The `config.toml` should be located at `~/.gitlab-runner/config.toml`. Open it a
 [runners.custom]
     config_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     config_args = [ "config", '-x', '/opt/homebrew/bin/tart' ]
+    config_exec_timeout = 200
 
     prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     prepare_args = [ "prepare", '-x', '/opt/homebrew/bin/tart' ]
+    prepare_exec_timeout = 200
 
     run_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     run_args = [ "run", '-x', '/opt/homebrew/bin/tart' ]
 
     cleanup_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     cleanup_args = [ "cleanup", '-x', '/opt/homebrew/bin/tart' ]
+    cleanup_exec_timeout = 200
 ```
 
 Now restart the gitlab-runner with `gitlab-runner restart`
@@ -276,6 +279,22 @@ prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
 prepare_args = [ "prepare", '-x', '/opt/homebrew/bin/tart', '--concurrency', '2', '--auto-resources', '--cache-dir', '/Users/gitlab/gitlab-runner/cache', '--builds-dir', '/Users/gitlab/gitlab-runner/builds']
 ```
 
+### Volume Mounts
+
+Just like with `docker` the `gitlab-runner-tart-driver` allows you to mount any arbitrary host path into your VM. This can be especially useful if you have to mount runner-local resources like shared test-data or additional caches into the executor. You can follow the standard docker syntax for *volume mounts* `--volume /my/local/dir:/opt/remote/dir`. Additionally you can also pass the `ro` flag to make the mount *read-only* i.e.  `--volume /my/local/dir:/opt/remote/dir:ro`.
+
+```ini
+[runners.custom]
+  config_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
+  config_args = [ "config" ]
+
+  prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
+  prepare_args = [ "prepare",
+    '-x', '/opt/homebrew/bin/tart',
+    '--concurrency', '2',
+    '--auto-resources',
+    '--volume /data/models/:/opt/data/models:ro']
+```
 ### Auto Host Resource Distribution
 
 `tart` images come with a pre-defined number of CPUs and Memory allocation. Typical numbers for default images are `cpu_count=4` and `memory=8192`. With the concurrency limitation of two VMs/images running at the same time this might not utilize your host system completely.
@@ -356,8 +375,10 @@ Options:
   --builds-dir TEXT               Path to the builds directory.
   --timeout INTEGER               Timeout in seconds for the VM to be
                                   reachable via SSH.
+  --volume TEXT                   Volume mount definition with docker syntax.
+                                  <host_dir>:<vm_dir>[:ro]
   -x, --tart-executable TEXT      Path to the tart executable.
-  --help                          Show this message and exit.
+  --help                          Show this message and exit.                      Show this message and exit.
 ```
 
 ### Command `run`

{gitlab-runner-tart-driver-0.1.2 → gitlab-runner-tart-driver-0.1.3}/README.md

@@ -99,15 +99,18 @@ The `config.toml` should be located at `~/.gitlab-runner/config.toml`. Open it a
 [runners.custom]
     config_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     config_args = [ "config", '-x', '/opt/homebrew/bin/tart' ]
+    config_exec_timeout = 200
 
     prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     prepare_args = [ "prepare", '-x', '/opt/homebrew/bin/tart' ]
+    prepare_exec_timeout = 200
 
     run_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     run_args = [ "run", '-x', '/opt/homebrew/bin/tart' ]
 
     cleanup_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     cleanup_args = [ "cleanup", '-x', '/opt/homebrew/bin/tart' ]
+    cleanup_exec_timeout = 200
 ```
 
 Now restart the gitlab-runner with `gitlab-runner restart`
@@ -261,6 +264,22 @@ prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
 prepare_args = [ "prepare", '-x', '/opt/homebrew/bin/tart', '--concurrency', '2', '--auto-resources', '--cache-dir', '/Users/gitlab/gitlab-runner/cache', '--builds-dir', '/Users/gitlab/gitlab-runner/builds']
 ```
 
+### Volume Mounts
+
+Just like with `docker` the `gitlab-runner-tart-driver` allows you to mount any arbitrary host path into your VM. This can be especially useful if you have to mount runner-local resources like shared test-data or additional caches into the executor. You can follow the standard docker syntax for *volume mounts* `--volume /my/local/dir:/opt/remote/dir`. Additionally you can also pass the `ro` flag to make the mount *read-only* i.e.  `--volume /my/local/dir:/opt/remote/dir:ro`.
+
+```ini
+[runners.custom]
+  config_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
+  config_args = [ "config" ]
+
+  prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
+  prepare_args = [ "prepare",
+    '-x', '/opt/homebrew/bin/tart',
+    '--concurrency', '2',
+    '--auto-resources',
+    '--volume /data/models/:/opt/data/models:ro']
+```
 ### Auto Host Resource Distribution
 
 `tart` images come with a pre-defined number of CPUs and Memory allocation. Typical numbers for default images are `cpu_count=4` and `memory=8192`. With the concurrency limitation of two VMs/images running at the same time this might not utilize your host system completely.
@@ -341,8 +360,10 @@ Options:
   --builds-dir TEXT               Path to the builds directory.
   --timeout INTEGER               Timeout in seconds for the VM to be
                                   reachable via SSH.
+  --volume TEXT                   Volume mount definition with docker syntax.
+                                  <host_dir>:<vm_dir>[:ro]
   -x, --tart-executable TEXT      Path to the tart executable.
-  --help                          Show this message and exit.
+  --help                          Show this message and exit.                      Show this message and exit.
 ```
 
 ### Command `run`

gitlab-runner-tart-driver-0.1.3/gitlab_runner_tart_driver/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.3"

{gitlab-runner-tart-driver-0.1.2 → gitlab-runner-tart-driver-0.1.3}/gitlab_runner_tart_driver/commands/prepare.py

@@ -5,7 +5,7 @@ import click
 
 from gitlab_runner_tart_driver.modules.gitlab_custom_command_config import GitLabCustomCommandConfig
 from gitlab_runner_tart_driver.modules.tart import Tart
-from gitlab_runner_tart_driver.modules.tart import TartMount
+from gitlab_runner_tart_driver.modules.tart import TartVolume
 from gitlab_runner_tart_driver.modules.utils import get_host_spec
 from gitlab_runner_tart_driver.modules.utils import print_host_spec
 
@@ -71,6 +71,15 @@ from gitlab_runner_tart_driver.modules.utils import print_host_spec
     type=int,
     help="Timeout in seconds for the VM to be reachable via SSH.",
 )
+@click.option(
+    "--volume",
+    "volumes",
+    required=False,
+    default=[],
+    type=str,
+    multiple=True,
+    help="Volume mount definition with docker syntax. <host_dir>:<vm_dir>[:ro]",
+)
 @click.option("-x", "--tart-executable", required=False, default="tart", type=str, help="Path to the tart executable.")
 def prepare(
     default_ssh_username,
@@ -87,6 +96,7 @@ def prepare(
     cache_dir,
     builds_dir,
     timeout,
+    volumes,
     tart_executable,
 ):
     """Prepare the environment and start the tart VM."""
@@ -117,7 +127,6 @@ def prepare(
         tart.login(username=p.ci_registry_user, password=p.ci_registry_password, host=p.ci_registry)
     except:
         click.secho(f"[ERROR] Failed to login to '{p.ci_registry}'", fg="red")
-        sys.exit(1)
 
     if registry_username and registry_password and registry:
         click.echo(f"[INFO] Logging into OCI Registry '{registry}'")
@@ -125,7 +134,6 @@ def prepare(
             tart.login(username=registry_username, password=registry_password, host=registry)
         except:
             click.secho(f"[ERROR] Failed to login to '{registry}'", fg="red")
-            sys.exit(1)
 
     if p.tart_registry_username and p.tart_registry_password and p.tart_registry:
         click.echo(f"[INFO] Logging into custom OCI Registry '{p.tart_registry}'")
@@ -133,7 +141,6 @@ def prepare(
             tart.login(username=p.tart_registry_username, password=p.tart_registry_password, host=p.tart_registry)
         except:
             click.secho(f"[ERROR] Failed to login to '{p.tart_registry}'", fg="red")
-            sys.exit(1)
 
     ######################################################################
     # PULL
@@ -179,12 +186,16 @@ def prepare(
 
     click.echo(f"[INFO] Starting VM instance '{tart_vm_name}'")
 
-    mount_dirs = []
+    remote_build_dir = "/opt/builds"
+    remote_script_dir = "/opt/temp"
+    remote_cache_dir = "/opt/cache"
+
+    volume_mounts = []
     if cache_dir:
         cache_dir = os.path.abspath(os.path.expanduser(cache_dir))
         os.makedirs(cache_dir, exist_ok=True)
         click.echo(f"[INFO] Cache directory set to '{cache_dir}'")
-        mount_dirs.append(TartMount(source=cache_dir, dest="cache"))
+        volume_mounts.append(TartVolume(source=cache_dir, dest=remote_cache_dir, name="cache", ro=False))
     if builds_dir:
         # Concurrency compatible builds directory
         # see https://docs.gitlab.com/runner/executors/shell.html#run-scripts-as-a-privileged-user
@@ -194,40 +205,35 @@ def prepare(
         )
         os.makedirs(builds_dir, exist_ok=True)
         click.echo(f"[INFO] Builds directory set to '{builds_dir}'")
-        mount_dirs.append(TartMount(source=builds_dir, dest="builds"))
+        volume_mounts.append(TartVolume(source=builds_dir, dest=remote_build_dir, name="builds", ro=False))
+
+    for v in volumes:
+        volume_mounts.append(TartVolume.from_string(v))
 
-    tart.run(tart_vm_name, mount_dirs)
+    tart.run(tart_vm_name, volume_mounts)
     ip = tart.ip(tart_vm_name, timeout=timeout)
     if not ip:
         click.echo(f"[ERROR] Error, VM was not reacheable after '{timeout}' seconds")
         sys.exit(1)
 
     ssh_session = tart.ssh_session(name=p.vm_name(), username=p.tart_ssh_username, password=p.tart_ssh_password)
-
-    remote_build_dir = "/opt/builds"
-    remote_script_dir = "/opt/temp"
-    remote_cache_dir = "/opt/cache"
-
     ssh_session.exec_ssh_command(
         f"sudo mkdir -p {remote_script_dir} && sudo chown {p.tart_ssh_username}:{p.tart_ssh_username} {remote_script_dir}",
     )
 
-    if cache_dir:
-        click.echo("[INFO] Bootstrapping cache directory")
+    for volume in volume_mounts:
+        click.echo("[INFO] Setting up volume mount '{volume.name}'")
         ssh_session.exec_ssh_command(
-            f"sudo ln -sf '/Volumes/My Shared Files/cache' {remote_cache_dir}",
+            f"sudo mkdir -p $(dirname {volume.dest}); sudo ln -sf '/Volumes/My Shared Files/{volume.name}' {volume.dest}",
         )
-    else:
+
+    # if cache and builds volumes are not mounted, make sure to create them locally inside the VM
+    if not cache_dir:
         ssh_session.exec_ssh_command(
             f"sudo mkdir -p {remote_cache_dir} && sudo chown {p.tart_ssh_username}:{p.tart_ssh_username} {remote_cache_dir}",
         )
 
-    if builds_dir:
-        click.echo("[INFO] Bootstrapping builds directory")
-        ssh_session.exec_ssh_command(
-            f"sudo ln -sf '/Volumes/My Shared Files/builds' {remote_build_dir}",
-        )
-    else:
+    if not builds_dir:
         ssh_session.exec_ssh_command(
             f"sudo mkdir -p {remote_build_dir} && sudo chown {p.tart_ssh_username}:{p.tart_ssh_username} {remote_build_dir}",
         )

{gitlab-runner-tart-driver-0.1.2 → gitlab-runner-tart-driver-0.1.3}/gitlab_runner_tart_driver/modules/tart.py

@@ -26,9 +26,29 @@ class TartVmSpec(BaseModel):
     ip_address: str
 
 
-class TartMount(BaseModel):
+class TartVolume(BaseModel):
+    name: str
     source: str
     dest: str
+    ro: bool = Field(default=False)
+
+    @classmethod
+    def from_string(cls, value):
+        components = value.split(":")
+        if len(components) < 2:
+            raise ValueError(f"'{value}' is not a valid volume mount definition")
+
+        source = os.path.abspath(os.path.expanduser(components[0])).rstrip("/")
+        dest = components[1].rstrip("/")
+        name = dest.strip("/").replace("/", "__")
+        ro = False
+        if len(components) > 2:
+            if "ro" == components[2]:
+                ro = True
+            else:
+                raise ValueError(f"'{components[2]}' flag unknown")
+
+        return cls(name=name, source=source, dest=dest, ro=ro)
 
 
 class TartSshSession:
@@ -130,16 +150,18 @@ class Tart(object):
         """stops a given tart VM"""
         self.exec(["stop", name])
 
-    def run(self, name: str, dirs: list[TartMount] = [], no_graphics=True) -> None:
+    def run(self, name: str, volumes: list[TartVolume] = [], no_graphics=True) -> None:
         """starts a given tart VM"""
         args = ["run", name]
         if no_graphics:
             args.append("--no-graphics")
 
-        if dirs:
-            for d in dirs:
-                args.extend(["--dir", f"{d.dest}:{os.path.abspath(os.path.expanduser(d.source))}"])
-
+        if volumes:
+            for d in volumes:
+                source_path = os.path.abspath(os.path.expanduser(d.source))
+                if d.ro:
+                    source_path = f"{source_path}:ro"
+                args.extend(["--dir", f"{d.name}:{source_path}"])
         try:
             self.spawn_exec(args)
         except Exception as e:

{gitlab-runner-tart-driver-0.1.2 → gitlab-runner-tart-driver-0.1.3}/gitlab_runner_tart_driver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-runner-tart-driver
-Version: 0.1.2
+Version: 0.1.3
 Home-page: https://gitlab.com/schmieder.matthias/gitlab-runner-tart-driver
 Author: Matthias Schmieder
 Author-email: schmieder.matthias@gmail.com
@@ -114,15 +114,18 @@ The `config.toml` should be located at `~/.gitlab-runner/config.toml`. Open it a
 [runners.custom]
     config_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     config_args = [ "config", '-x', '/opt/homebrew/bin/tart' ]
+    config_exec_timeout = 200
 
     prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     prepare_args = [ "prepare", '-x', '/opt/homebrew/bin/tart' ]
+    prepare_exec_timeout = 200
 
     run_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     run_args = [ "run", '-x', '/opt/homebrew/bin/tart' ]
 
     cleanup_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
     cleanup_args = [ "cleanup", '-x', '/opt/homebrew/bin/tart' ]
+    cleanup_exec_timeout = 200
 ```
 
 Now restart the gitlab-runner with `gitlab-runner restart`
@@ -276,6 +279,22 @@ prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
 prepare_args = [ "prepare", '-x', '/opt/homebrew/bin/tart', '--concurrency', '2', '--auto-resources', '--cache-dir', '/Users/gitlab/gitlab-runner/cache', '--builds-dir', '/Users/gitlab/gitlab-runner/builds']
 ```
 
+### Volume Mounts
+
+Just like with `docker` the `gitlab-runner-tart-driver` allows you to mount any arbitrary host path into your VM. This can be especially useful if you have to mount runner-local resources like shared test-data or additional caches into the executor. You can follow the standard docker syntax for *volume mounts* `--volume /my/local/dir:/opt/remote/dir`. Additionally you can also pass the `ro` flag to make the mount *read-only* i.e.  `--volume /my/local/dir:/opt/remote/dir:ro`.
+
+```ini
+[runners.custom]
+  config_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
+  config_args = [ "config" ]
+
+  prepare_exec = "/opt/homebrew/bin/gitlab-runner-tart-driver"
+  prepare_args = [ "prepare",
+    '-x', '/opt/homebrew/bin/tart',
+    '--concurrency', '2',
+    '--auto-resources',
+    '--volume /data/models/:/opt/data/models:ro']
+```
 ### Auto Host Resource Distribution
 
 `tart` images come with a pre-defined number of CPUs and Memory allocation. Typical numbers for default images are `cpu_count=4` and `memory=8192`. With the concurrency limitation of two VMs/images running at the same time this might not utilize your host system completely.
@@ -356,8 +375,10 @@ Options:
   --builds-dir TEXT               Path to the builds directory.
   --timeout INTEGER               Timeout in seconds for the VM to be
                                   reachable via SSH.
+  --volume TEXT                   Volume mount definition with docker syntax.
+                                  <host_dir>:<vm_dir>[:ro]
   -x, --tart-executable TEXT      Path to the tart executable.
-  --help                          Show this message and exit.
+  --help                          Show this message and exit.                      Show this message and exit.
 ```
 
 ### Command `run`

{gitlab-runner-tart-driver-0.1.2 → gitlab-runner-tart-driver-0.1.3}/setup.py

@@ -10,7 +10,7 @@ this_directory = os.path.abspath(os.path.dirname(__file__))
 with open(os.path.join(this_directory, "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
-version = "0.1.2"
+version = "0.1.3"
 
 version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX','')}"
 

gitlab-runner-tart-driver-0.1.2/gitlab_runner_tart_driver/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.2"