gitlab-runner-tart-driver 0.1.7__tar.gz → 0.2.0__tar.gz

{gitlab-runner-tart-driver-0.1.7/gitlab_runner_tart_driver.egg-info → gitlab-runner-tart-driver-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-runner-tart-driver
-Version: 0.1.7
+Version: 0.2.0
 Home-page: https://gitlab.com/schmieder.matthias/gitlab-runner-tart-driver
 Author: Matthias Schmieder
 Author-email: schmieder.matthias@gmail.com
@@ -20,6 +20,7 @@ License-File: LICENSE.txt
   - [Setup](#setup)
     - [GitLab Runner Configuration](#gitlab-runner-configuration)
   - [GitLab CI](#gitlab-ci)
+    - [Supported Environment Variables](#supported-environment-variables)
     - [Private OCI Registries](#private-oci-registries)
     - [Configuring the SSH Credentials](#configuring-the-ssh-credentials)
   - [Advanced Configuration](#advanced-configuration)
@@ -177,6 +178,24 @@ run-on-tart:
       - artifact.txt
 ```
 
+### Supported Environment Variables
+
+| **Name**                              | **Default**    | **Description**                                                                                               |
+| ------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------- |
+| `TART_REGISTRY_USERNAME`              |                | Username to login to private OCI registry                                                                     |
+| `TART_REGISTRY_PASSWORD`              |                | Password to login to private OCI registry                                                                     |
+| `TART_REGISTRY`                       |                | Private OCI registry                                                                                          |
+| `TART_PULL_POLICY`                    | if-not-present | define how runners pull tart images from registries. Options are `always`,`if-not-present`,`never`            |
+| `TART_SSH_USERNAME`                   | admin          | Username to use to login to VM                                                                                |
+| `TART_SSH_PASSWORD`                   | admin          | Password to use to login to VM                                                                                |
+| `TART_EXECUTOR_HEADLESS`              | true           | Don't open a UI window.                                                                                       |
+| `TART_EXECUTOR_SOFTNET_ENABLED`       | false          | Use software networking instead of the default shared (NAT) networking                                        |
+| `TART_EXECUTOR_VNC_ENABLED`           | false          | Use screen sharing instead of the built-in UI. Note that Remote Login option should be enabled inside the VM. |
+| `TART_EXECUTOR_INSTALL_GITLAB_RUNNER` | false          | Install a GitLabRunner into the VM to ensure full CI/CD functionality                                         |
+| `TART_EXECUTOR_SHELL`                 | /bin/zsh       | The shell that should be used when running commands                                                           |
+| `TART_EXECUTOR_TIMEOUT`               | 60             | Timeout for `tart ip` to respond with a valid IP                                                              |
+| `TART_EXECUTOR_DISPLAY`               | 1920x1200      | Display resolution in format `WxH`                                                                            |
+
 ### Private OCI Registries
 
 Oftentimes you might want to provide your own OCI-compliant images created with [Packer](https://www.packer.io) and the official [Tart Builder](https://developer.hashicorp.com/packer/plugins/builders/tart). If you push your images to a private registry you will need to provide the credentials for the `gitlab-runner-tart-driver` to login there first.
@@ -346,9 +365,7 @@ see **Command `run`**
 
 ### Custom `pull_policy`
 
-You can use a custom `pull_policy`. The default policy is `if-not-present`
-
-see **Command `prepare`**
+You can use a custom `pull_policy`. The default policy is `if-not-present`. Use `TART_PULL_POLICY` to override the default pull policy
 
 ## CLI
 
@@ -391,14 +408,6 @@ Usage: gitlab-runner-tart-driver prepare [OPTIONS]
   Prepare the environment and start the tart VM.
 
 Options:
-  --default-ssh-username TEXT     username to login to a tart vm
-  --default-ssh-password TEXT     password to login to a tart vm
-  --pull-policy [always|if-not-present|never]
-                                  define how runners pull tart images from
-                                  registries
-  --registry-username TEXT        username to login to a oci registry
-  --registry-password TEXT        password to login to a oci registry
-  --registry TEXT                 username to login to a oci registry
   --cpu INTEGER                   Number of CPUs associated to VM
   --memory INTEGER                VM memory size in megabytes associated to VM
   --display TEXT                  VM display resolution in a format of
@@ -434,8 +443,6 @@ Usage: gitlab-runner-tart-driver run [OPTIONS] SCRIPT STAGE
   Run commands.
 
 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

{gitlab-runner-tart-driver-0.1.7 → gitlab-runner-tart-driver-0.2.0}/README.md

@@ -5,6 +5,7 @@
   - [Setup](#setup)
     - [GitLab Runner Configuration](#gitlab-runner-configuration)
   - [GitLab CI](#gitlab-ci)
+    - [Supported Environment Variables](#supported-environment-variables)
     - [Private OCI Registries](#private-oci-registries)
     - [Configuring the SSH Credentials](#configuring-the-ssh-credentials)
   - [Advanced Configuration](#advanced-configuration)
@@ -162,6 +163,24 @@ run-on-tart:
       - artifact.txt
 ```
 
+### Supported Environment Variables
+
+| **Name**                              | **Default**    | **Description**                                                                                               |
+| ------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------- |
+| `TART_REGISTRY_USERNAME`              |                | Username to login to private OCI registry                                                                     |
+| `TART_REGISTRY_PASSWORD`              |                | Password to login to private OCI registry                                                                     |
+| `TART_REGISTRY`                       |                | Private OCI registry                                                                                          |
+| `TART_PULL_POLICY`                    | if-not-present | define how runners pull tart images from registries. Options are `always`,`if-not-present`,`never`            |
+| `TART_SSH_USERNAME`                   | admin          | Username to use to login to VM                                                                                |
+| `TART_SSH_PASSWORD`                   | admin          | Password to use to login to VM                                                                                |
+| `TART_EXECUTOR_HEADLESS`              | true           | Don't open a UI window.                                                                                       |
+| `TART_EXECUTOR_SOFTNET_ENABLED`       | false          | Use software networking instead of the default shared (NAT) networking                                        |
+| `TART_EXECUTOR_VNC_ENABLED`           | false          | Use screen sharing instead of the built-in UI. Note that Remote Login option should be enabled inside the VM. |
+| `TART_EXECUTOR_INSTALL_GITLAB_RUNNER` | false          | Install a GitLabRunner into the VM to ensure full CI/CD functionality                                         |
+| `TART_EXECUTOR_SHELL`                 | /bin/zsh       | The shell that should be used when running commands                                                           |
+| `TART_EXECUTOR_TIMEOUT`               | 60             | Timeout for `tart ip` to respond with a valid IP                                                              |
+| `TART_EXECUTOR_DISPLAY`               | 1920x1200      | Display resolution in format `WxH`                                                                            |
+
 ### Private OCI Registries
 
 Oftentimes you might want to provide your own OCI-compliant images created with [Packer](https://www.packer.io) and the official [Tart Builder](https://developer.hashicorp.com/packer/plugins/builders/tart). If you push your images to a private registry you will need to provide the credentials for the `gitlab-runner-tart-driver` to login there first.
@@ -331,9 +350,7 @@ see **Command `run`**
 
 ### Custom `pull_policy`
 
-You can use a custom `pull_policy`. The default policy is `if-not-present`
-
-see **Command `prepare`**
+You can use a custom `pull_policy`. The default policy is `if-not-present`. Use `TART_PULL_POLICY` to override the default pull policy
 
 ## CLI
 
@@ -376,14 +393,6 @@ Usage: gitlab-runner-tart-driver prepare [OPTIONS]
   Prepare the environment and start the tart VM.
 
 Options:
-  --default-ssh-username TEXT     username to login to a tart vm
-  --default-ssh-password TEXT     password to login to a tart vm
-  --pull-policy [always|if-not-present|never]
-                                  define how runners pull tart images from
-                                  registries
-  --registry-username TEXT        username to login to a oci registry
-  --registry-password TEXT        password to login to a oci registry
-  --registry TEXT                 username to login to a oci registry
   --cpu INTEGER                   Number of CPUs associated to VM
   --memory INTEGER                VM memory size in megabytes associated to VM
   --display TEXT                  VM display resolution in a format of
@@ -419,8 +428,6 @@ Usage: gitlab-runner-tart-driver run [OPTIONS] SCRIPT STAGE
   Run commands.
 
 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

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

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

{gitlab-runner-tart-driver-0.1.7 → gitlab-runner-tart-driver-0.2.0}/gitlab_runner_tart_driver/commands/prepare.py

@@ -11,21 +11,6 @@ from gitlab_runner_tart_driver.modules.utils import print_host_spec
 
 
 @click.command()
-@click.option(
-    "--default-ssh-username", default="admin", required=False, type=str, help="username to login to a tart vm"
-)
-@click.option(
-    "--default-ssh-password", default="admin", required=False, type=str, help="password to login to a tart vm"
-)
-@click.option(
-    "--pull-policy",
-    default="if-not-present",
-    type=click.Choice(["always", "if-not-present", "never"]),
-    help="define how runners pull tart images from registries",
-)
-@click.option("--registry-username", required=False, default=None, type=str, help="username to login to a oci registry")
-@click.option("--registry-password", required=False, default=None, type=str, help="password to login to a oci registry")
-@click.option("--registry", required=False, default=None, type=str, help="username to login to a oci registry")
 @click.option("--cpu", required=False, default=None, type=int, help="Number of CPUs associated to VM")
 @click.option("--memory", required=False, default=None, type=int, help="VM memory size in megabytes associated to VM")
 @click.option(
@@ -103,15 +88,9 @@ from gitlab_runner_tart_driver.modules.utils import print_host_spec
 )
 @click.option("-x", "--tart-executable", required=False, default="tart", type=str, help="Path to the tart executable.")
 def prepare(
-    default_ssh_username,
-    default_ssh_password,
-    registry_username,
-    registry_password,
-    registry,
     cpu,
     memory,
     display,
-    pull_policy,
     auto_resources,
     concurrency,
     cache_dir,
@@ -129,10 +108,12 @@ def prepare(
 
     p = GitLabCustomCommandConfig()
 
-    if not p.tart_ssh_username:
-        p.tart_ssh_username = default_ssh_username
-    if not p.tart_ssh_password:
-        p.tart_ssh_password = default_ssh_password
+    if not p.tart_executor_display:
+        p.tart_executor_display = display
+    if not p.tart_executor_install_gitlab_runner:
+        p.tart_executor_install_gitlab_runner = install_gitlab_runner
+    if not p.tart_executor_timeout:
+        p.tart_executor_timeout = timeout
 
     tart = Tart(exec_path=tart_executable)
     tart_images = tart.list()
@@ -140,9 +121,6 @@ def prepare(
     for i in tart_images:
         tart_vm_map[i.name] = i
 
-    # for k,v in os.environ.items():
-    #     click.echo(f'{k}={v}')
-
     ######################################################################
     # OCI LOGIN
     ######################################################################
@@ -152,12 +130,12 @@ def prepare(
     except:
         click.secho(f"[ERROR] Failed to login to '{p.ci_registry}'", fg="red")
 
-    if registry_username and registry_password and registry:
-        click.echo(f"[INFO] Logging into OCI Registry '{registry}'")
+    if p.registry_username and p.registry_password and p.registry:
+        click.echo(f"[INFO] Logging into OCI Registry '{p.registry}'")
         try:
-            tart.login(username=registry_username, password=registry_password, host=registry)
+            tart.login(username=p.registry_username, password=p.registry_password, host=p.registry)
         except:
-            click.secho(f"[ERROR] Failed to login to '{registry}'", fg="red")
+            click.secho(f"[ERROR] Failed to login to '{p.registry}'", fg="red")
 
     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}'")
@@ -170,18 +148,18 @@ def prepare(
     # PULL
     ######################################################################
     if (
-        (pull_policy == "always")
-        or (p.ci_job_image not in tart_vm_map and pull_policy != "never")
-        or (p.ci_job_image not in tart_vm_map and pull_policy == "if-not-present")
+        (p.pull_policy == "always")
+        or (p.ci_job_image not in tart_vm_map and p.pull_policy != "never")
+        or (p.ci_job_image not in tart_vm_map and p.pull_policy == "if-not-present")
     ):
-        click.echo(f"[INFO] Pulling '{p.ci_job_image}' [pull_policy={pull_policy}]")
+        click.echo(f"[INFO] Pulling '{p.ci_job_image}' [pull_policy={p.pull_policy}]")
         try:
             tart.pull(p.ci_job_image)
         except:
             click.secho(f"[ERROR] Failed to pull image '{p.ci_job_image}'", fg="red")
             sys.exit(1)
     else:
-        click.echo(f"[INFO] Skipping '{p.ci_job_image}' [pull_policy={pull_policy}]")
+        click.echo(f"[INFO] Skipping '{p.ci_job_image}' [pull_policy={p.pull_policy}]")
 
     ######################################################################
     # Create VM
@@ -211,10 +189,10 @@ def prepare(
         click.secho(f"[ERROR] failed to clone image f'{p.ci_job_image}'", fg="red")
         sys.exit(1)
 
-    if cpu or memory or display:
+    if cpu or memory or p.display:
         click.echo(f"[INFO] Configuring instance '{tart_vm_name}' from '{p.ci_job_image}'")
         click.echo(
-            f"[INFO] {tart_vm_name} [cpu={cpu if cpu else 'default'}, memory={memory if memory else 'default'}, display={display if display else 'default'}]"
+            f"[INFO] {tart_vm_name} [cpu={cpu if cpu else 'default'}, memory={memory if memory else 'default'}, display={p.display if p.display else 'default'}]"
         )
         tart.set(tart_vm_name, cpu=cpu, memory=memory, display=display)
     elif auto_resources:
@@ -249,25 +227,25 @@ def prepare(
         volume_mounts.append(TartVolume.from_string(v))
 
     try:
-        tart.run(tart_vm_name, volume_mounts)
+        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)
 
     try:
-        ip = tart.ip(tart_vm_name, timeout=timeout)
+        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)
 
     if not ip:
-        click.echo(f"[ERROR] Error, VM was not reacheable after '{timeout}' seconds")
+        click.echo(f"[ERROR] Error, VM was not reacheable after '{p.timeout}' seconds")
         sys.exit(1)
 
     try:
-        ssh_session = tart.ssh_session(name=p.vm_name(), username=p.tart_ssh_username, password=p.tart_ssh_password)
+        ssh_session = tart.ssh_session(name=p.vm_name(), username=p.ssh_username, password=p.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}",
+            f"sudo mkdir -p {remote_script_dir} && sudo chown {p.ssh_username}:{p.ssh_username} {remote_script_dir}",
         )
 
         for volume in volume_mounts:
@@ -279,23 +257,23 @@ def prepare(
         # 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}",
+                f"sudo mkdir -p {remote_cache_dir} && sudo chown {p.ssh_username}:{p.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}",
+                f"sudo mkdir -p {remote_build_dir} && sudo chown {p.ssh_username}:{p.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:
+    if p.install_gitlab_runner:
         click.echo(
             f"[INFO] Installing GitLab Runner '{gitlab_runner_version}' [force: '{force_install_gitlab_runner}']"
         )
         try:
-            tart.install_gitlab_runner(name=tart_vm_name, username=p.tart_ssh_username, password=p.tart_ssh_password)
+            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)

{gitlab-runner-tart-driver-0.1.7 → gitlab-runner-tart-driver-0.2.0}/gitlab_runner_tart_driver/commands/run.py

@@ -8,12 +8,6 @@ from gitlab_runner_tart_driver.modules.tart import Tart
 
 
 @click.command()
-@click.option(
-    "--default-ssh-username", default="admin", required=False, type=str, help="username to login to a tart vm"
-)
-@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"
 )
@@ -34,15 +28,12 @@ from gitlab_runner_tart_driver.modules.tart import Tart
 )
 @click.argument("script")
 @click.argument("stage")
-def run(default_ssh_username, default_ssh_password, ssh_timeout, tart_executable, shell, script, stage):
+def run(ssh_timeout, tart_executable, shell, script, stage):
     """Run commands."""
     p = GitLabCustomCommandConfig()
 
-    if not p.tart_ssh_username:
-        p.tart_ssh_username = default_ssh_username
-    if not p.tart_ssh_password:
-        p.tart_ssh_password = default_ssh_password
-
+    if not p.tart_executor_shell:
+        p.tart_executor_shell = shell
     ######################################################################
     # Connect to VM
     ######################################################################
@@ -51,22 +42,21 @@ def run(default_ssh_username, default_ssh_password, ssh_timeout, tart_executable
 
     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}'")
+        click.echo(f"[{stage}][INFO] Establishing SSH conntection to '{p.ssh_username}@{tart_ip}'")
     except:
         click.secho(
-            f"[ERROR] Could not establish SSH conntection to '{tart_vm_name}' after '{ssh_timeout}' seconds.", fg="red"
+            f"[{stage}][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)
+        ssh_session = tart.ssh_session(name=p.vm_name(), username=p.ssh_username, password=p.ssh_password)
     except:
-        click.secho(f"[ERROR] Could not establish SSH session with '{p.tart_ssh_username}@{tart_ip}'", fg="red")
+        click.secho(f"[{stage}][ERROR] Could not establish SSH session with '{p.ssh_username}@{tart_ip}'", fg="red")
         sys.exit(1)
 
-    click.echo("[INFO] Preparing workspace")
     remote_temp_dir = "/opt/temp"
-
     script_name = os.path.basename(script)
     remote_script_path = os.path.join(remote_temp_dir, stage + "-" + script_name)
 
@@ -75,6 +65,6 @@ def run(default_ssh_username, default_ssh_password, ssh_timeout, tart_executable
     sftp.close()
 
     # ssh_session.exec_ssh_command(f"cd {remote_build_dir}")
-    script_exit_code = ssh_session.exec_ssh_command(f"{shell} -l {remote_script_path}", get_pty=True)
+    script_exit_code = ssh_session.exec_ssh_command(f"{p.shell} -l {remote_script_path}", get_pty=True)
 
     sys.exit(script_exit_code)

gitlab-runner-tart-driver-0.2.0/gitlab_runner_tart_driver/modules/gitlab_custom_command_config.py

@@ -0,0 +1,102 @@
+from typing import Optional
+
+from pydantic import BaseSettings
+from pydantic import Field
+
+
+class GitLabCustomCommandConfig(BaseSettings):
+    """Config parameters needed throughout the process read from the environment"""
+
+    ci_job_image: str
+    ci_pipeline_id: str
+    ci_job_id: str
+    ci_concurrent_id: str
+    ci_concurrent_project_id: str
+    ci_runner_short_token: str
+    ci_project_name: 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]
+    tart_registry: Optional[str]
+
+    tart_ssh_username: Optional[str] = Field(default="admin")
+    tart_ssh_password: Optional[str] = Field(default="admin")
+    tart_max_vm_count: Optional[int] = Field(default=2)
+    tart_pull_policy: Optional[str] = Field(default="if-not-present")
+    tart_executor_softnet_enabled: Optional[str] = Field(default="false")
+    tart_executor_headless: Optional[str] = Field(default="true")
+    tart_executor_vnc_enabled: Optional[str] = Field(default="false")
+    tart_executor_install_gitlab_runner: Optional[str] = Field(default="false")
+    tart_executor_shell: Optional[str] = Field(default="/bin/zsh")
+    tart_executor_timeout: Optional[int] = Field(default=60)
+    tart_executor_display: Optional[str] = Field(default="1920x1200")
+
+    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
+        """
+
+        env_prefix = "CUSTOM_ENV_"
+
+    def vm_name(self):
+        """Creates a unique name for a VM"""
+        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"
+
+    @property
+    def softnet_enabled(self) -> bool:
+        return self.tart_executor_softnet_enabled.lower() == "true"
+
+    @property
+    def vnc_enabled(self) -> bool:
+        return self.tart_executor_vnc_enabled.lower() == "true"
+
+    @property
+    def headless(self) -> bool:
+        return self.tart_executor_headless.lower() == "true"
+
+    @property
+    def shell(self) -> Optional[str]:
+        return self.tart_executor_shell
+
+    @property
+    def display(self) -> Optional[str]:
+        return self.tart_executor_display
+
+    @property
+    def install_gitlab_runner(self) -> bool:
+        return self.tart_executor_install_gitlab_runner.lower() == "true"
+
+    @property
+    def timeout(self) -> Optional[int]:
+        return self.tart_executor_timeout
+
+    @property
+    def ssh_username(self) -> Optional[str]:
+        return self.tart_ssh_username
+
+    @property
+    def ssh_password(self) -> Optional[str]:
+        return self.tart_ssh_password
+
+    @property
+    def pull_policy(self) -> Optional[str]:
+        return self.tart_pull_policy
+
+    @property
+    def registry_username(self) -> Optional[str]:
+        return self.tart_registry_username
+
+    @property
+    def registry_password(self) -> Optional[str]:
+        return self.tart_registry_password
+
+    @property
+    def registry(self) -> Optional[str]:
+        return self.tart_registry

{gitlab-runner-tart-driver-0.1.7 → gitlab-runner-tart-driver-0.2.0}/gitlab_runner_tart_driver/modules/tart.py

@@ -153,11 +153,15 @@ class Tart(object):
         """stops a given tart VM"""
         self.exec(["stop", name])
 
-    def run(self, name: str, volumes: list[TartVolume] = [], no_graphics=True) -> None:
+    def run(self, name: str, volumes: list[TartVolume] = [], no_graphics=True, softnet=False, vnc=False) -> None:
         """starts a given tart VM"""
         args = ["run", name]
         if no_graphics:
             args.append("--no-graphics")
+        if softnet:
+            args.append("--net-softnet")
+        if vnc:
+            args.append("--vnc")
 
         if volumes:
             for d in volumes:
@@ -166,6 +170,8 @@ class Tart(object):
                     source_path = f"{source_path}:ro"
                 args.extend(["--dir", f"{d.name}:{source_path}"])
         try:
+            print(f"Starting VM '{name}'")
+            print(f"Command: 'tart {' '.join(args)}'")
             self.spawn_exec(args)
         except Exception as e:
             print(f"Error when running VM {name}")

{gitlab-runner-tart-driver-0.1.7 → gitlab-runner-tart-driver-0.2.0/gitlab_runner_tart_driver.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-runner-tart-driver
-Version: 0.1.7
+Version: 0.2.0
 Home-page: https://gitlab.com/schmieder.matthias/gitlab-runner-tart-driver
 Author: Matthias Schmieder
 Author-email: schmieder.matthias@gmail.com
@@ -20,6 +20,7 @@ License-File: LICENSE.txt
   - [Setup](#setup)
     - [GitLab Runner Configuration](#gitlab-runner-configuration)
   - [GitLab CI](#gitlab-ci)
+    - [Supported Environment Variables](#supported-environment-variables)
     - [Private OCI Registries](#private-oci-registries)
     - [Configuring the SSH Credentials](#configuring-the-ssh-credentials)
   - [Advanced Configuration](#advanced-configuration)
@@ -177,6 +178,24 @@ run-on-tart:
       - artifact.txt
 ```
 
+### Supported Environment Variables
+
+| **Name**                              | **Default**    | **Description**                                                                                               |
+| ------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------- |
+| `TART_REGISTRY_USERNAME`              |                | Username to login to private OCI registry                                                                     |
+| `TART_REGISTRY_PASSWORD`              |                | Password to login to private OCI registry                                                                     |
+| `TART_REGISTRY`                       |                | Private OCI registry                                                                                          |
+| `TART_PULL_POLICY`                    | if-not-present | define how runners pull tart images from registries. Options are `always`,`if-not-present`,`never`            |
+| `TART_SSH_USERNAME`                   | admin          | Username to use to login to VM                                                                                |
+| `TART_SSH_PASSWORD`                   | admin          | Password to use to login to VM                                                                                |
+| `TART_EXECUTOR_HEADLESS`              | true           | Don't open a UI window.                                                                                       |
+| `TART_EXECUTOR_SOFTNET_ENABLED`       | false          | Use software networking instead of the default shared (NAT) networking                                        |
+| `TART_EXECUTOR_VNC_ENABLED`           | false          | Use screen sharing instead of the built-in UI. Note that Remote Login option should be enabled inside the VM. |
+| `TART_EXECUTOR_INSTALL_GITLAB_RUNNER` | false          | Install a GitLabRunner into the VM to ensure full CI/CD functionality                                         |
+| `TART_EXECUTOR_SHELL`                 | /bin/zsh       | The shell that should be used when running commands                                                           |
+| `TART_EXECUTOR_TIMEOUT`               | 60             | Timeout for `tart ip` to respond with a valid IP                                                              |
+| `TART_EXECUTOR_DISPLAY`               | 1920x1200      | Display resolution in format `WxH`                                                                            |
+
 ### Private OCI Registries
 
 Oftentimes you might want to provide your own OCI-compliant images created with [Packer](https://www.packer.io) and the official [Tart Builder](https://developer.hashicorp.com/packer/plugins/builders/tart). If you push your images to a private registry you will need to provide the credentials for the `gitlab-runner-tart-driver` to login there first.
@@ -346,9 +365,7 @@ see **Command `run`**
 
 ### Custom `pull_policy`
 
-You can use a custom `pull_policy`. The default policy is `if-not-present`
-
-see **Command `prepare`**
+You can use a custom `pull_policy`. The default policy is `if-not-present`. Use `TART_PULL_POLICY` to override the default pull policy
 
 ## CLI
 
@@ -391,14 +408,6 @@ Usage: gitlab-runner-tart-driver prepare [OPTIONS]
   Prepare the environment and start the tart VM.
 
 Options:
-  --default-ssh-username TEXT     username to login to a tart vm
-  --default-ssh-password TEXT     password to login to a tart vm
-  --pull-policy [always|if-not-present|never]
-                                  define how runners pull tart images from
-                                  registries
-  --registry-username TEXT        username to login to a oci registry
-  --registry-password TEXT        password to login to a oci registry
-  --registry TEXT                 username to login to a oci registry
   --cpu INTEGER                   Number of CPUs associated to VM
   --memory INTEGER                VM memory size in megabytes associated to VM
   --display TEXT                  VM display resolution in a format of
@@ -434,8 +443,6 @@ Usage: gitlab-runner-tart-driver run [OPTIONS] SCRIPT STAGE
   Run commands.
 
 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

{gitlab-runner-tart-driver-0.1.7 → gitlab-runner-tart-driver-0.2.0}/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.7"
+version = "0.2.0"
 
 version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX','')}"
 

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

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

gitlab-runner-tart-driver-0.1.7/gitlab_runner_tart_driver/modules/gitlab_custom_command_config.py

@@ -1,43 +0,0 @@
-from typing import Optional
-
-from pydantic import BaseSettings
-from pydantic import Field
-
-
-class GitLabCustomCommandConfig(BaseSettings):
-    """Config parameters needed throughout the process read from the environment"""
-
-    ci_job_image: str
-    ci_pipeline_id: str
-    ci_job_id: str
-    ci_concurrent_id: str
-    ci_concurrent_project_id: str
-    ci_runner_short_token: str
-    ci_project_name: 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]
-    tart_registry: Optional[str]
-
-    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
-        """
-
-        env_prefix = "CUSTOM_ENV_"
-
-    def vm_name(self):
-        """Creates a unique name for a VM"""
-        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"