gitlab-runner-tart-driver 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

gitlab_runner_tart_driver/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.4"
+__version__ = "0.1.6"

gitlab_runner_tart_driver/commands/cleanup.py

@@ -1,3 +1,5 @@
+import re
+
 import click
 
 from gitlab_runner_tart_driver.modules.gitlab_custom_command_config import GitLabCustomCommandConfig
@@ -13,16 +15,36 @@ def cleanup(tart_executable):
     tart = Tart(exec_path=tart_executable)
     tart_vm_name = p.vm_name()
 
+    # remove specific VM that we started
+    _remove_vm(tart, tart_vm_name)
+
+    # cleanup leftovers from previous runs
+    _remove_vm(tart, f"{p.vm_name_prefix}-.*", stopped_only=True)
+
+
+def _remove_vm(tart, pattern, stopped_only=False):
     tart_images = tart.list()
     tart_vm_map = dict()
     # create map from images
     for i in tart_images:
         tart_vm_map[i.name] = i
 
-    if tart_vm_name in tart_vm_map:
-        click.echo(f"[INFO] '{tart_vm_name}' found.")
-        if tart_vm_map[tart_vm_name].running:
-            click.echo(f"[INFO] stopping '{tart_vm_name}'")
-            tart.stop(tart_vm_name)
-        click.echo(f"[INFO] deleting '{tart_vm_name}'")
-        tart.delete(tart_vm_name)
+    for vm_name, vm in tart_vm_map.items():
+        m = re.match(pattern, vm_name)
+        if not m:
+            break
+
+        try:
+            if not vm.running and stopped_only:
+                click.echo(f"[INFO] deleting '{vm_name}'")
+                tart.delete(vm.name)
+            elif vm.running and not stopped_only:
+                click.echo(f"[INFO] stopping '{vm_name}'")
+                tart.stop(vm.name)
+                click.echo(f"[INFO] deleting '{vm_name}'")
+                tart.delete(vm.name)
+            elif not vm.running:
+                click.echo(f"[INFO] deleting '{vm_name}'")
+                tart.delete(vm.name)
+        except:
+            click.secho(f"[ERROR] failed to delete '{vm_name}'", fg="red")

gitlab_runner_tart_driver/commands/prepare.py

@@ -194,8 +194,22 @@ def prepare(
         click.echo(f"[INFO] Found VM '{tart_vm_name}'. Going to delete it...")
         tart.delete(tart_vm_name)
 
+    # verfiy that the limit of running VMs is not exceeded
+    list_running_vms = []
+    for vm in tart.list():
+        if vm.running:
+            list_running_vms.append(vm)
+
+    if len(list_running_vms) >= p.tart_max_vm_count:
+        click.secho("[ERROR] The limit of running VMs is exceeded.", fg="red")
+        sys.exit(1)
+
     click.echo(f"[INFO] Cloning VM instance '{tart_vm_name}' from '{p.ci_job_image}'")
-    tart.clone(p.ci_job_image, tart_vm_name)
+    try:
+        tart.clone(p.ci_job_image, tart_vm_name)
+    except:
+        click.secho(f"[ERROR] failed to clone image f'{p.ci_job_image}'", fg="red")
+        sys.exit(1)
 
     if cpu or memory or display:
         click.echo(f"[INFO] Configuring instance '{tart_vm_name}' from '{p.ci_job_image}'")
@@ -234,39 +248,57 @@ def prepare(
     for v in volumes:
         volume_mounts.append(TartVolume.from_string(v))
 
-    tart.run(tart_vm_name, volume_mounts)
-    ip = tart.ip(tart_vm_name, timeout=timeout)
+    try:
+        tart.run(tart_vm_name, volume_mounts)
+    except:
+        click.secho(f"[ERROR] Failed to start VM '{tart_vm_name}'", fg="red")
+        sys.exit(1)
+
+    try:
+        ip = tart.ip(tart_vm_name, timeout=timeout)
+    except:
+        click.secho(f"[ERROR] Failed to get IP of VM '{tart_vm_name}'", fg="red")
+        sys.exit(1)
+
     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)
-    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}",
-    )
-
-    for volume in volume_mounts:
-        click.echo("[INFO] Setting up volume mount '{volume.name}'")
+    try:
+        ssh_session = tart.ssh_session(name=p.vm_name(), username=p.tart_ssh_username, password=p.tart_ssh_password)
         ssh_session.exec_ssh_command(
-            f"sudo mkdir -p $(dirname {volume.dest}); sudo ln -sf '/Volumes/My Shared Files/{volume.name}' {volume.dest}",
+            f"sudo mkdir -p {remote_script_dir} && sudo chown {p.tart_ssh_username}:{p.tart_ssh_username} {remote_script_dir}",
         )
 
-    # 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}",
-        )
+        for volume in volume_mounts:
+            click.echo(f"[INFO] Setting up volume mount '{volume.name}'")
+            ssh_session.exec_ssh_command(
+                f"sudo mkdir -p $(dirname {volume.dest}); sudo ln -sf '/Volumes/My Shared Files/{volume.name}' {volume.dest}",
+            )
 
-    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}",
-        )
+        # 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 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}",
+            )
+    except:
+        click.secho(f"[ERROR] Failed so prepare VM '{tart_vm_name}'", fg="red")
+        sys.exit(1)
 
     if install_gitlab_runner:
         click.echo(
             f"[INFO] Installing GitLab Runner '{gitlab_runner_version}' [force: '{force_install_gitlab_runner}']"
         )
-        tart.install_gitlab_runner(name=tart_vm_name, username=p.tart_ssh_username, password=p.tart_ssh_password)
+        try:
+            tart.install_gitlab_runner(name=tart_vm_name, username=p.tart_ssh_username, password=p.tart_ssh_password)
+        except:
+            click.secho(f"[ERROR] Failed to install GitLab Runner '{gitlab_runner_version}'", fg="red")
+            sys.exit(1)
 
     tart.print_spec(tart_vm_name)
 

gitlab_runner_tart_driver/commands/run.py

@@ -14,6 +14,9 @@ from gitlab_runner_tart_driver.modules.tart import Tart
 @click.option(
     "--default-ssh-password", default="admin", required=False, type=str, help="password to login to a tart vm"
 )
+@click.option(
+    "--timeout", "ssh_timeout", default=60, required=False, type=int, help="SSH connection timeout in seconds"
+)
 @click.option(
     "-x",
     "--tart-executable",
@@ -31,7 +34,7 @@ from gitlab_runner_tart_driver.modules.tart import Tart
 )
 @click.argument("script")
 @click.argument("stage")
-def run(default_ssh_username, default_ssh_password, tart_executable, shell, script, stage):
+def run(default_ssh_username, default_ssh_password, ssh_timeout, tart_executable, shell, script, stage):
     """Run commands."""
     p = GitLabCustomCommandConfig()
 
@@ -45,10 +48,21 @@ def run(default_ssh_username, default_ssh_password, tart_executable, shell, scri
     ######################################################################
     tart = Tart(exec_path=tart_executable)
     tart_vm_name = p.vm_name()
-    tart_ip = tart.ip(tart_vm_name, timeout=30)
-    click.echo(f"[INFO] Establishing SSH conntection to '{p.tart_ssh_username}@{tart_ip}'")
 
-    ssh_session = tart.ssh_session(name=p.vm_name(), username=p.tart_ssh_username, password=p.tart_ssh_password)
+    try:
+        tart_ip = tart.ip(tart_vm_name, timeout=ssh_timeout)
+        click.echo(f"[INFO] Establishing SSH conntection to '{p.tart_ssh_username}@{tart_ip}'")
+    except:
+        click.secho(
+            f"[ERROR] Could not establish SSH conntection to '{tart_vm_name}' after '{ssh_timeout}' seconds.", fg="red"
+        )
+        sys.exit(1)
+
+    try:
+        ssh_session = tart.ssh_session(name=p.vm_name(), username=p.tart_ssh_username, password=p.tart_ssh_password)
+    except:
+        click.secho(f"[ERROR] Could not establish SSH session with '{p.tart_ssh_username}@{tart_ip}'", fg="red")
+        sys.exit(1)
 
     click.echo("[INFO] Preparing workspace")
     remote_temp_dir = "/opt/temp"

gitlab_runner_tart_driver/modules/gitlab_custom_command_config.py

@@ -1,6 +1,7 @@
 from typing import Optional
 
 from pydantic import BaseSettings
+from pydantic import Field
 
 
 class GitLabCustomCommandConfig(BaseSettings):
@@ -13,9 +14,9 @@ class GitLabCustomCommandConfig(BaseSettings):
     ci_concurrent_project_id: str
     ci_runner_short_token: str
     ci_project_name: str
-    ci_registry: str
-    ci_registry_user: str
-    ci_registry_password: str
+    ci_registry: Optional[str]
+    ci_registry_user: Optional[str]
+    ci_registry_password: Optional[str]
 
     tart_registry_username: Optional[str]
     tart_registry_password: Optional[str]
@@ -24,6 +25,8 @@ class GitLabCustomCommandConfig(BaseSettings):
     tart_ssh_username: Optional[str]
     tart_ssh_password: Optional[str]
 
+    tart_max_vm_count: Optional[int] = Field(default=2)
+
     class Config:
         """Define the prefix used by GitLab for all environment variables passed to a custom driver.
         see https://docs.gitlab.com/runner/executors/custom.html#stages
@@ -33,4 +36,8 @@ class GitLabCustomCommandConfig(BaseSettings):
 
     def vm_name(self):
         """Creates a unique name for a VM"""
-        return f"{self.ci_project_name}-{self.ci_pipeline_id}-{self.ci_job_id}-{self.ci_concurrent_id}"
+        return f"{self.vm_name_prefix}-{self.ci_project_name}-{self.ci_pipeline_id}-{self.ci_job_id}-{self.ci_concurrent_id}"
+
+    @property
+    def vm_name_prefix(self):
+        return "grtd"

{gitlab_runner_tart_driver-0.1.4.dist-info → gitlab_runner_tart_driver-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-runner-tart-driver
-Version: 0.1.4
+Version: 0.1.6
 Home-page: https://gitlab.com/schmieder.matthias/gitlab-runner-tart-driver
 Author: Matthias Schmieder
 Author-email: schmieder.matthias@gmail.com
@@ -442,6 +442,7 @@ Usage: gitlab-runner-tart-driver run [OPTIONS] SCRIPT STAGE
 Options:
   --default-ssh-username TEXT  username to login to a tart vm
   --default-ssh-password TEXT  password to login to a tart vm
+  --timeout INTEGER            SSH connection timeout in seconds
   -x, --tart-executable TEXT   Path to the tart executable.
   --shell TEXT                 Path to the shell to be used for commands over
                                ssh.

{gitlab_runner_tart_driver-0.1.4.dist-info → gitlab_runner_tart_driver-0.1.6.dist-info}/RECORD

@@ -1,20 +1,20 @@
-gitlab_runner_tart_driver/__init__.py,sha256=Wzf5T3NBDfhQoTnhnRNHSlAsE0XMqbclXG-M81Vas70,22
+gitlab_runner_tart_driver/__init__.py,sha256=n3oM6B_EMz93NsTI18NNZd-jKFcUPzUkbIKj5VFK5ok,22
 gitlab_runner_tart_driver/__main__.py,sha256=FiyMv64vDC-R8i3CGEP9QP48djZFHm7utyChwZJWCeY,107
 gitlab_runner_tart_driver/cli.py,sha256=1eFi9m8L4zcBO5eE4g4EP8phtE1znF54qt-xAigPsOE,596
 gitlab_runner_tart_driver/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gitlab_runner_tart_driver/commands/cleanup.py,sha256=sE70MYNIa2HjIwjOj_j7_yxNQfSrF3JZKu8MkOks69w,952
+gitlab_runner_tart_driver/commands/cleanup.py,sha256=3o2qijQ_okIHJKUWz_k40NhK2pIzkTLyFMKPJToBbVQ,1617
 gitlab_runner_tart_driver/commands/config.py,sha256=cacJ9ms5r3nZGZ_sS2d21Uoz7S-bMjB__lORUmeXZ-4,760
-gitlab_runner_tart_driver/commands/prepare.py,sha256=3Zf6fM7NDU39cI9wfwK3ch43VuMQqhSBy6hFwFFi-Vg,10205
-gitlab_runner_tart_driver/commands/run.py,sha256=knCLkQBCtlxtY0yzL4WGcpDSHf4Gkc7lxc3DpmTskRA,2145
+gitlab_runner_tart_driver/commands/prepare.py,sha256=mx8n4vCfYXGW_ZwtY2PRdgcJPXBy2_BpoeZn9ct7Nqo,11270
+gitlab_runner_tart_driver/commands/run.py,sha256=n8x4FXQ9iO3TfCybUZM_u6HMs9rEDG-5lqAb_76-LcI,2654
 gitlab_runner_tart_driver/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gitlab_runner_tart_driver/modules/gitlab_custom_command_config.py,sha256=2kVBtAST0oUBUqdToJhSNQr4b5XFqjOV_c6lJSW2fqo,1061
+gitlab_runner_tart_driver/modules/gitlab_custom_command_config.py,sha256=jD1kKXBFP-4MZQl1zu7jiNpGNVuDtdSPtqIiSQKKi6Q,1264
 gitlab_runner_tart_driver/modules/gitlab_custom_driver_config.py,sha256=PD7I45PhX1WmZHWUL_Hjr4M0S3vXzqyiwv9UMTEnRy0,405
 gitlab_runner_tart_driver/modules/tart.py,sha256=gSo1NDwaAnulov8qijhn2TdXsaWI5Vqsuzxy-oakvjQ,8703
 gitlab_runner_tart_driver/modules/utils.py,sha256=7ipKjy_5tC5iW67Na_A9XhF4o2lKcAqO8LRTTSJKNd0,923
 gitlab_runner_tart_driver/scripts/install-gitlab-runner.sh.j2,sha256=-rBzxZ92w7lMrTCVcjMHhlZgqPIK1RJKVoOc2wjZvck,2533
-gitlab_runner_tart_driver-0.1.4.dist-info/LICENSE.txt,sha256=TiYXQpEfbzcPBNGb7k1NslUngq_un-5cxGyT4W1S_f4,3303
-gitlab_runner_tart_driver-0.1.4.dist-info/METADATA,sha256=HtaNvFqcBecBhS-xk3evmtxhyZZLDBQgPlLcvqfCquU,18520
-gitlab_runner_tart_driver-0.1.4.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-gitlab_runner_tart_driver-0.1.4.dist-info/entry_points.txt,sha256=xmvpGQf1wvFPy5wqDWXu8k5FD_k9KkCNCkpuworTsr0,82
-gitlab_runner_tart_driver-0.1.4.dist-info/top_level.txt,sha256=JjRzCs2sr24xG4SV_5tIBPpNC1Tec7I4AbK4IKMDqOc,26
-gitlab_runner_tart_driver-0.1.4.dist-info/RECORD,,
+gitlab_runner_tart_driver-0.1.6.dist-info/LICENSE.txt,sha256=TiYXQpEfbzcPBNGb7k1NslUngq_un-5cxGyT4W1S_f4,3303
+gitlab_runner_tart_driver-0.1.6.dist-info/METADATA,sha256=-UebsWklpOD3DHKEQ6P77nkCxC9VCzDke8YY6jpORX4,18585
+gitlab_runner_tart_driver-0.1.6.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+gitlab_runner_tart_driver-0.1.6.dist-info/entry_points.txt,sha256=xmvpGQf1wvFPy5wqDWXu8k5FD_k9KkCNCkpuworTsr0,82
+gitlab_runner_tart_driver-0.1.6.dist-info/top_level.txt,sha256=JjRzCs2sr24xG4SV_5tIBPpNC1Tec7I4AbK4IKMDqOc,26
+gitlab_runner_tart_driver-0.1.6.dist-info/RECORD,,