gitlab-runner-tart-driver 0.3.2__py3-none-any.whl → 0.3.4__py3-none-any.whl

gitlab_runner_tart_driver/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.2"
+__version__ = "0.3.4"

gitlab_runner_tart_driver/commands/prepare.py

@@ -115,6 +115,12 @@ def prepare(
     if not p.tart_executor_timeout:
         p.tart_executor_timeout = timeout
 
+    # retrieve the SYSTEM_FAILURE_EXIT_CODE from the environment
+    system_failure_exit_code = os.getenv("SYSTEM_FAILURE_EXIT_CODE", None)
+    if not system_failure_exit_code:
+        click.secho("[WARNING] SYSTEM_FAILURE_EXIT_CODE not set, defaulting to '1'", fg="red")
+        system_failure_exit_code = 1
+
     tart = Tart(exec_path=tart_executable)
     tart_images = tart.list()
     tart_vm_map = {}
@@ -157,7 +163,7 @@ def prepare(
             tart.pull(p.ci_job_image)
         except:
             click.secho(f"[ERROR] Failed to pull image '{p.ci_job_image}'", fg="red")
-            sys.exit(1)
+            sys.exit(system_failure_exit_code)
     else:
         click.echo(f"[INFO] Skipping '{p.ci_job_image}' [pull_policy={p.pull_policy}]")
 
@@ -182,14 +188,14 @@ def prepare(
         click.secho(
             f"[ERROR] The limit of running VMs [{p.tart_max_vm_count}] is exceeded [{len(list_running_vms)}].", fg="red"
         )
-        sys.exit(1)
+        sys.exit(system_failure_exit_code)
 
     click.echo(f"[INFO] Cloning VM instance '{tart_vm_name}' from '{p.ci_job_image}'")
     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)
+        sys.exit(system_failure_exit_code)
 
     if cpu or memory or p.display:
         click.echo(f"[INFO] Configuring instance '{tart_vm_name}' from '{p.ci_job_image}'")
@@ -232,17 +238,17 @@ def prepare(
         tart.run(tart_vm_name, volume_mounts, no_graphics=p.headless, softnet=p.softnet_enabled)
     except:
         click.secho(f"[ERROR] Failed to start VM '{tart_vm_name}'", fg="red")
-        sys.exit(1)
+        sys.exit(system_failure_exit_code)
 
     try:
         ip = tart.ip(tart_vm_name, timeout=p.timeout)
     except:
         click.secho(f"[ERROR] Failed to get IP of VM '{tart_vm_name}'", fg="red")
-        sys.exit(1)
+        sys.exit(system_failure_exit_code)
 
     if not ip:
         click.echo(f"[ERROR] Error, VM was not reacheable after '{p.timeout}' seconds")
-        sys.exit(1)
+        sys.exit(system_failure_exit_code)
 
     try:
         ssh_session = tart.ssh_session(name=p.vm_name(), username=p.ssh_username, password=p.ssh_password)
@@ -268,7 +274,7 @@ def prepare(
             )
     except:
         click.secho(f"[ERROR] Failed so prepare VM '{tart_vm_name}'", fg="red")
-        sys.exit(1)
+        sys.exit(system_failure_exit_code)
 
     if p.install_gitlab_runner:
         click.echo(
@@ -278,7 +284,7 @@ def prepare(
             tart.install_gitlab_runner(name=tart_vm_name, username=p.ssh_username, password=p.ssh_password)
         except:
             click.secho(f"[ERROR] Failed to install GitLab Runner '{gitlab_runner_version}'", fg="red")
-            sys.exit(1)
+            sys.exit(system_failure_exit_code)
 
     tart.print_spec(tart_vm_name)
 

gitlab_runner_tart_driver/commands/run.py

@@ -32,6 +32,18 @@ def run(ssh_timeout, tart_executable, shell, script, stage):
     """Run commands."""
     p = GitLabCustomCommandConfig()
 
+    # retrieve the BUILD_FAILURE_EXIT_CODE from the environment
+    build_failure_exit_code = os.getenv("BUILD_FAILURE_EXIT_CODE", None)
+    if not build_failure_exit_code:
+        click.secho("[WARNING] BUILD_FAILURE_EXIT_CODE not set, defaulting to '1'", fg="red")
+        build_failure_exit_code = 1
+
+    # retrieve the SYSTEM_FAILURE_EXIT_CODE from the environment
+    system_failure_exit_code = os.getenv("SYSTEM_FAILURE_EXIT_CODE", None)
+    if not system_failure_exit_code:
+        click.secho("[WARNING] SYSTEM_FAILURE_EXIT_CODE not set, defaulting to '1'", fg="red")
+        system_failure_exit_code = 1
+
     if not p.tart_executor_shell:
         p.tart_executor_shell = shell
     ######################################################################
@@ -48,13 +60,13 @@ def run(ssh_timeout, tart_executable, shell, script, stage):
             f"[{stage}][ERROR] Could not establish SSH conntection to '{tart_vm_name}' after '{ssh_timeout}' seconds.",
             fg="red",
         )
-        sys.exit(1)
+        sys.exit(system_failure_exit_code)
 
     try:
         ssh_session = tart.ssh_session(name=p.vm_name(), username=p.ssh_username, password=p.ssh_password)
     except:
         click.secho(f"[{stage}][ERROR] Could not establish SSH session with '{p.ssh_username}@{tart_ip}'", fg="red")
-        sys.exit(1)
+        sys.exit(system_failure_exit_code)
 
     remote_temp_dir = "/opt/temp"
     script_name = os.path.basename(script)
@@ -67,4 +79,8 @@ def run(ssh_timeout, tart_executable, shell, script, stage):
     # ssh_session.exec_ssh_command(f"cd {remote_build_dir}")
     script_exit_code = ssh_session.exec_ssh_command(f"{p.shell} -l {remote_script_path}", get_pty=True)
 
-    sys.exit(script_exit_code)
+    if script_exit_code != 0:
+        click.secho(f"[{stage}][ERROR] Script '{script}' failed with exit code '{script_exit_code}'", fg="red")
+        sys.exit(build_failure_exit_code)
+
+    sys.exit(0)

gitlab_runner_tart_driver/modules/tart.py

@@ -28,6 +28,8 @@ class TartVmSpec(BaseModel):
     display: str
     running: bool
     ip_address: str
+    os: str
+    size: str
 
 
 class TartVolume(BaseModel):
@@ -126,43 +128,53 @@ class Tart(object):
         # 'spec' will look like this:
         #
         # tart version < 2.7
-        #    CPU Memory Disk Display  Running
-        #    4   8192   46   1024x768 true
+        # CPU Memory Disk Display  Running
+        # 4   8192   46   1024x768 true
         #
         # tart version > 2.6
         # CPU Memory Disk Size   Display  State
         # 4   8192   50   20.794 1024x768 running
+        #
+        # tart version > 2.8
+        # OS     CPU Memory Disk Size   Display  State
+        # darwin 4   8192   50   22.294 1024x768 stopped
+
+        # Read headers
+        headers = specs.split("\n")[0]
+        header_elements = headers.split(" ")
+        header_elements = [s.strip().lower() for s in header_elements if s]
 
-        spec_line = specs.split("\n")[1]
-        spec_elements = spec_line.split(" ")
+        spec = specs.split("\n")[1]
+        spec_elements = spec.split(" ")
         spec_elements = [s.strip() for s in spec_elements if s]
 
-        # old version
-        if len(spec_elements) == 5:
-            spec = TartVmSpec(
-                cpu_count=int(spec_elements[0]),
-                memory=int(spec_elements[1]),
-                disk=int(spec_elements[2]),
-                display=spec_elements[3],
-                running=True if spec_elements[4].lower() == "true" else False,
-                ip_address="n/a",
-            )
-        elif len(spec_elements) == 6:
-            spec = TartVmSpec(
-                cpu_count=int(spec_elements[0]),
-                memory=int(spec_elements[1]),
-                disk=int(spec_elements[2]),
-                display=spec_elements[4],
-                running=True if spec_elements[5].lower() == "running" else False,
-                ip_address="n/a",
-            )
+        specs = {}
+        for i, spec_element in enumerate(spec_elements):
+            specs[header_elements[i]] = spec_element
+
+        # check the state of the machine
+        vm_state = specs.get("state", "n/a")
+        running = True
+        if vm_state == "running" or vm_state == "true":
+            running = True
         else:
-            raise ValueError("cloud not determine vm specs")
+            running = False
+
+        vm_spec = TartVmSpec(
+            cpu_count=int(specs.get("cpu", 0)),
+            memory=int(specs.get("memory", 0)),
+            disk=int(specs.get("disk", 0)),
+            display=specs.get("display", "n/a"),
+            running=running,
+            ip_address="n/a",
+            os=specs.get("os", "n/a"),
+            size=specs.get("size", "n/a"),
+        )
 
-        if spec.running:
-            spec.ip_address = self.ip(name)
+        if vm_spec.running:
+            vm_spec.ip_address = self.ip(name)
 
-        return spec
+        return vm_spec
 
     def print_spec(self, name, tablefmt="fancy_grid"):
         spec = self.get(name)

{gitlab_runner_tart_driver-0.3.2.dist-info → gitlab_runner_tart_driver-0.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-runner-tart-driver
-Version: 0.3.2
+Version: 0.3.4
 Home-page: https://gitlab.com/schmieder.matthias/gitlab-runner-tart-driver
 Author: Matthias Schmieder
 Author-email: schmieder.matthias@gmail.com
@@ -13,7 +13,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: click
-Requires-Dist: pydantic >=2.0.0
+Requires-Dist: pydantic>=2.0.0
 Requires-Dist: pydantic-settings
 Requires-Dist: paramiko
 Requires-Dist: psutil

{gitlab_runner_tart_driver-0.3.2.dist-info → gitlab_runner_tart_driver-0.3.4.dist-info}/RECORD

@@ -1,20 +1,20 @@
-gitlab_runner_tart_driver/__init__.py,sha256=vNiWJ14r_cw5t_7UDqDQIVZvladKFGyHH2avsLpN7Vg,22
+gitlab_runner_tart_driver/__init__.py,sha256=oYLGMpySamd16KLiaBTfRyrAS7_oyp-TOEHmzmeumwg,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=nFe7TGdxsVSXNR9onm-3iCjmUo6SzujV5LrA_y439fs,1422
 gitlab_runner_tart_driver/commands/config.py,sha256=cacJ9ms5r3nZGZ_sS2d21Uoz7S-bMjB__lORUmeXZ-4,760
-gitlab_runner_tart_driver/commands/prepare.py,sha256=FCINFtBakV8hiKbHGba3ZWwyNwICp6UV5mKZVCyP8h4,10487
-gitlab_runner_tart_driver/commands/run.py,sha256=2grP79TARRL0xzmppRITbSpIH0WL4YPxlxq1fYQZxlM,2235
+gitlab_runner_tart_driver/commands/prepare.py,sha256=zCfeqbmmDH0IxuFC9XqJ2uVWDuyJSzjq_uvBhfNX-og,10981
+gitlab_runner_tart_driver/commands/run.py,sha256=kXQxi8nxv6QQRFzGrlqifLtFtbjXAYgjCiMVqXkb2_A,3065
 gitlab_runner_tart_driver/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gitlab_runner_tart_driver/modules/gitlab_custom_command_config.py,sha256=XvE83QmQUcqtVMYZY3okGOgO86DBX6Y7xhXNenmKxFY,3086
 gitlab_runner_tart_driver/modules/gitlab_custom_driver_config.py,sha256=ujxlzP1ZbfsZyLIsghID5c_jLPSt-1pDazE2B5CPORY,447
-gitlab_runner_tart_driver/modules/tart.py,sha256=bXwUTtR60oIdI_o-lDNakVQ_FL-12a6qykmeFlEl3VY,9677
+gitlab_runner_tart_driver/modules/tart.py,sha256=rD6IPtpz57dwsPGVBWaeKeVoqI1MoBvdtkqozXgmAxA,9914
 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.3.2.dist-info/LICENSE.txt,sha256=TiYXQpEfbzcPBNGb7k1NslUngq_un-5cxGyT4W1S_f4,3303
-gitlab_runner_tart_driver-0.3.2.dist-info/METADATA,sha256=Ns7pOOlS-y1GeZlM0T6-Xf3jsX3F1hWNewRbRqOi0ek,20706
-gitlab_runner_tart_driver-0.3.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-gitlab_runner_tart_driver-0.3.2.dist-info/entry_points.txt,sha256=xmvpGQf1wvFPy5wqDWXu8k5FD_k9KkCNCkpuworTsr0,82
-gitlab_runner_tart_driver-0.3.2.dist-info/top_level.txt,sha256=JjRzCs2sr24xG4SV_5tIBPpNC1Tec7I4AbK4IKMDqOc,26
-gitlab_runner_tart_driver-0.3.2.dist-info/RECORD,,
+gitlab_runner_tart_driver-0.3.4.dist-info/LICENSE.txt,sha256=TiYXQpEfbzcPBNGb7k1NslUngq_un-5cxGyT4W1S_f4,3303
+gitlab_runner_tart_driver-0.3.4.dist-info/METADATA,sha256=Ana3GfNPOS4BJuAFBQ5G2nHv6moeoIVc5YHIhervFrk,20705
+gitlab_runner_tart_driver-0.3.4.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+gitlab_runner_tart_driver-0.3.4.dist-info/entry_points.txt,sha256=xmvpGQf1wvFPy5wqDWXu8k5FD_k9KkCNCkpuworTsr0,82
+gitlab_runner_tart_driver-0.3.4.dist-info/top_level.txt,sha256=JjRzCs2sr24xG4SV_5tIBPpNC1Tec7I4AbK4IKMDqOc,26
+gitlab_runner_tart_driver-0.3.4.dist-info/RECORD,,

{gitlab_runner_tart_driver-0.3.2.dist-info → gitlab_runner_tart_driver-0.3.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: bdist_wheel (0.45.1)
 Root-Is-Purelib: true
 Tag: py3-none-any