primitive 0.1.88__tar.gz → 0.1.90__tar.gz

{primitive-0.1.88 → primitive-0.1.90}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: primitive
-Version: 0.1.88
+Version: 0.1.90
 Project-URL: Documentation, https://github.com//primitivecorp/primitive-cli#readme
 Project-URL: Issues, https://github.com//primitivecorp/primitive-cli/issues
 Project-URL: Source, https://github.com//primitivecorp/primitive-cli
@@ -24,6 +24,7 @@ Requires-Dist: loguru
 Requires-Dist: paramiko[invoke]
 Requires-Dist: primitive-pal==0.1.4
 Requires-Dist: pyyaml
+Requires-Dist: rich>=13.9.4
 Requires-Dist: speedtest-cli
 Description-Content-Type: text/markdown
 

{primitive-0.1.88 → primitive-0.1.90}/pyproject.toml

@@ -34,6 +34,7 @@ dependencies = [
   "primitive-pal == 0.1.4",
   "paramiko[invoke]",
   "speedtest-cli",
+  "rich>=13.9.4",
 ]
 
 [tool.uv]

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present Dylan Stein <dylan@primitive.tech>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.1.88"
+__version__ = "0.1.90"

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/agent/actions.py

@@ -28,7 +28,12 @@ class Agent(BaseAction):
 
         # self.primitive.hardware.update_hardware_system_info()
         try:
-            self.primitive.hardware.check_in_http(is_available=True, is_online=True)
+            # hey stupid:
+            # do not set is_available to True here, it will mess up the reservation logic
+            # only set is_available after we've checked that no active reservation is present
+            # setting is_available of the parent also effects the children,
+            # which may have active reservations as well
+            self.primitive.hardware.check_in_http(is_online=True)
         except Exception as ex:
             logger.error(f"Error checking in hardware: {ex}")
             sys.exit(1)

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/agent/runner.py

@@ -193,7 +193,9 @@ class AgentRunner:
 
                 returncode = proc.wait()
 
-                logger.debug(f"Process {step['name']} finished with return code {returncode}")
+                logger.debug(
+                    f"Process {step['name']} finished with return code {returncode}"
+                )
 
                 if proc.errors > 0 and self.failure_level >= FailureLevel.ERROR:
                     fail_level_detected = True
@@ -212,7 +214,9 @@ class AgentRunner:
                 self.primitive.jobs.job_run_update(
                     self.job_id, status="request_completed", conclusion="failure"
                 )
-                logger.error(f"Step {step['name']} failed with return code {returncode}")
+                logger.error(
+                    f"Step {step['name']} failed with return code {returncode}"
+                )
                 return
 
         if fail_level_detected and self.parse_logs:

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/exec/actions.py

@@ -6,6 +6,7 @@ if typing.TYPE_CHECKING:
     pass
 
 
+from loguru import logger
 from paramiko import SSHClient
 
 from primitive.utils.actions import BaseAction
@@ -16,6 +17,15 @@ class Exec(BaseAction):
         super().__init__(*args, **kwargs)
 
     def execute_command(self, hardware_identifier: str, command: str) -> None:
+        child_hardware = None
+        if "." in hardware_identifier:
+            hardware_slugs = hardware_identifier.split(".")
+            hardware_identifier = hardware_slugs[0]
+            child_hardware_identifier = hardware_slugs[-1]
+            child_hardware = self.primitive.hardware.get_hardware_from_slug_or_id(
+                hardware_identifier=child_hardware_identifier
+            )
+
         hardware = self.primitive.hardware.get_hardware_from_slug_or_id(
             hardware_identifier=hardware_identifier
         )
@@ -37,14 +47,23 @@ class Exec(BaseAction):
             reservation_result = self.primitive.reservations.create_reservation(
                 requested_hardware_ids=[hardware["id"]],
                 reason="Executing command from Primitive CLI",
+                wait=False,
             )
             reservation = reservation_result.data["reservationCreate"]
             created_reservation_on_behalf_of_user = True
 
-        reservation = self.primitive.reservations.wait_for_reservation_status(
+        reservation_result = self.primitive.reservations.wait_for_reservation_status(
             reservation_id=reservation["id"], desired_status="in_progress"
         )
 
+        reservation = reservation_result.data["reservation"]
+        if reservation.get("status") != "in_progress":
+            logger.enable("primitive")
+            logger.info(
+                f"Reservation {reservation.get('id')} is in status {reservation.get('status')}, cannot execute command at this time."
+            )
+            return
+
         ssh_hostname = hardware["hostname"]
         ssh_username = hardware["sshUsername"]
 
@@ -57,11 +76,29 @@ class Exec(BaseAction):
         )
 
         if command:
-            formatted_command = " ".join(command)
+            if child_hardware:
+                # if the child hardware has ssh credentials, format the proxy command
+                if child_hardware.get("systemInfo").get("os_family"):
+                    formatted_command = (
+                        f"adb -s {child_hardware.get('slug')} shell {command}"
+                    )
+            else:
+                # happy path!
+                formatted_command = " ".join(command)
+
             stdin, stdout, stderr = ssh_client.exec_command(formatted_command)
-            print(stdout.read())
+
+            stdout_string = stdout.read().decode("utf-8").rstrip("\n")
+            stderr_string = stderr.read().decode("utf-8").rstrip("\n")
+            if stdout_string != b"":
+                print(stdout_string)
+            if stderr.read() != b"":
+                print(stderr_string)
+
             ssh_client.close()
         else:
+            # if the child hardware has ssh credentials, format the proxy jump
+
             channel = ssh_client.get_transport().open_session()
             channel.get_pty()
             channel.invoke_shell()

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/git/actions.py

@@ -38,9 +38,7 @@ class Git(BaseAction):
         source_dir = Path(destination).joinpath(git_repo_full_name.split("/")[-1])
 
         try:
-            run(
-                ["git", "clone", url, source_dir, "--no-checkout"], check=True
-            )
+            run(["git", "clone", url, source_dir, "--no-checkout"], check=True)
         except CalledProcessError:
             raise Exception("Failed to download repository")
 

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/hardware/actions.py

@@ -20,15 +20,23 @@ from ..utils.config import update_config_file
 from .graphql.mutations import (
     hardware_checkin_mutation,
     hardware_update_mutation,
+    register_child_hardware_mutation,
     register_hardware_mutation,
+    unregister_hardware_mutation,
+)
+from .graphql.queries import (
+    hardware_details,
+    hardware_list,
+    nested_children_hardware_list,
 )
-from .graphql.queries import hardware_list
 
 if typing.TYPE_CHECKING:
     pass
 
 
+from primitive.hardware.android import AndroidDevice, list_devices
 from primitive.utils.actions import BaseAction
+from primitive.utils.shell import does_executable_exist
 
 
 class Hardware(BaseAction):
@@ -40,6 +48,7 @@ class Hardware(BaseAction):
             "isAvailable": False,
             "isOnline": False,
         }
+        self.children = []
 
     def _get_darwin_system_profiler_values(self) -> Dict[str, str]:
         system_profiler_hardware_data_type = subprocess.check_output(
@@ -276,10 +285,12 @@ class Hardware(BaseAction):
         return system_info
 
     @guard
-    def register(self):
+    def register(self, organization_id: Optional[str] = None):
         system_info = self.get_system_info()
         mutation = gql(register_hardware_mutation)
         input = {"systemInfo": system_info}
+        if organization_id:
+            input["organizationId"] = organization_id
         variables = {"input": input}
         result = self.primitive.session.execute(
             mutation, variable_values=variables, get_execution_result=True
@@ -303,6 +314,30 @@ class Hardware(BaseAction):
         # and headers are set correctly
         self.primitive.get_host_config()
         self.check_in_http(is_healthy=True)
+        for child in self._list_local_children():
+            self.register_child(child=child)
+        return result
+
+    @guard
+    def unregister(self, organization_id: Optional[str] = None):
+        mutation = gql(unregister_hardware_mutation)
+        input = {
+            "fingerprint": self.primitive.host_config.get("fingerprint"),
+        }
+        variables = {"input": input}
+        result = self.primitive.session.execute(
+            mutation, variable_values=variables, get_execution_result=True
+        )
+
+        if messages := result.data.get("unregisterHardware").get("messages"):
+            for message in messages:
+                logger.enable("primitive")
+                if message.get("kind") == "ERROR":
+                    logger.error(message.get("message"))
+                else:
+                    logger.debug(message.get("message"))
+            return False
+
         return result
 
     @guard
@@ -355,6 +390,7 @@ class Hardware(BaseAction):
         is_online: bool = True,
     ):
         fingerprint = self.primitive.host_config.get("fingerprint", None)
+
         if not fingerprint:
             message = (
                 "No fingerprint found. Please register: primitive hardware register"
@@ -417,15 +453,50 @@ class Hardware(BaseAction):
 
     @guard
     def get_hardware_list(
-        self, fingerprint: Optional[str] = None, slug: Optional[str] = None
+        self,
+        fingerprint: Optional[str] = None,
+        id: Optional[str] = None,
+        slug: Optional[str] = None,
+        nested_children: Optional[bool] = False,
     ):
-        query = gql(hardware_list)
+        query = gql(nested_children_hardware_list if nested_children else hardware_list)
+
+        filters = {
+            "isRegistered": {"exact": True},
+        }
+        if fingerprint:
+            filters["fingerprint"] = {"exact": fingerprint}
+        if slug:
+            filters["slug"] = {"exact": slug}
+        if id:
+            filters["id"] = {"exact": id}
+        if nested_children:
+            filters["hasParent"] = {"exact": False}
+
+        variables = {
+            "filters": filters,
+        }
+        result = self.primitive.session.execute(
+            query, variable_values=variables, get_execution_result=True
+        )
+        return result
+
+    @guard
+    def get_hardware_details(
+        self,
+        fingerprint: Optional[str] = None,
+        id: Optional[str] = None,
+        slug: Optional[str] = None,
+    ):
+        query = gql(hardware_details)
 
         filters = {}
         if fingerprint:
             filters["fingerprint"] = {"exact": fingerprint}
         if slug:
             filters["slug"] = {"exact": slug}
+        if id:
+            filters["id"] = {"exact": id}
 
         variables = {
             "first": 1,
@@ -434,7 +505,10 @@ class Hardware(BaseAction):
         result = self.primitive.session.execute(
             query, variable_values=variables, get_execution_result=True
         )
-        return result
+        if edges := result.data["hardwareList"]["edges"]:
+            return edges[0]["node"]
+        else:
+            raise Exception(f"No hardware found with {filters}")
 
     def get_own_hardware_details(self):
         hardware_list_result = self.get_hardware_list(
@@ -448,6 +522,7 @@ class Hardware(BaseAction):
     def get_hardware_from_slug_or_id(self, hardware_identifier: str):
         is_id = False
         is_slug = False
+        id = None
         # first check if the hardware_identifier is a slug or ID
         try:
             type_name, id = from_base64(hardware_identifier)
@@ -466,16 +541,45 @@ class Hardware(BaseAction):
         hardware = None
 
         if is_id and is_hardware_type:
-            hardware_list_result = self.get_hardware_list(slug=hardware_identifier)
-            if edges := hardware_list_result.data["hardwareList"]["edges"]:
-                hardware = edges[0]["node"]
-            else:
-                raise Exception(f"No hardware found with slug {hardware_identifier}")
+            hardware = self.get_hardware_details(id=id)
         elif is_slug:
-            hardware_list_result = self.get_hardware_list(slug=hardware_identifier)
-            if edges := hardware_list_result.data["hardwareList"]["edges"]:
-                hardware = edges[0]["node"]
-            else:
-                raise Exception(f"No hardware found with slug {hardware_identifier}")
+            hardware = self.get_hardware_details(slug=hardware_identifier)
 
         return hardware
+
+    @guard
+    def register_child(self, child: AndroidDevice):
+        system_info = child.system_info
+        mutation = gql(register_child_hardware_mutation)
+        input = {"childSystemInfo": system_info}
+        variables = {"input": input}
+        result = self.primitive.session.execute(
+            mutation, variable_values=variables, get_execution_result=True
+        )
+
+        if messages := result.data.get("registerChildHardware").get("messages"):
+            for message in messages:
+                logger.enable("primitive")
+                if message.get("kind") == "ERROR":
+                    logger.error(message.get("message"))
+                else:
+                    logger.debug(message.get("message"))
+            return False
+        return result
+
+    def _list_local_children(self) -> List[AndroidDevice]:
+        if does_executable_exist("adb"):
+            self.children: List[AndroidDevice] = list_devices()
+        return self.children
+
+    @guard
+    def _remove_child(self):
+        pass
+
+    @guard
+    def _sync_children(self):
+        # get the existing children if any from the hardware details
+        # get the latest children from the node
+        # compare the two and update the node with the latest children
+        # remove any children from remote that are not in the latest children
+        pass

primitive-0.1.90/src/primitive/hardware/android.py

@@ -0,0 +1,75 @@
+from dataclasses import dataclass, field
+from subprocess import PIPE, Popen
+from typing import Dict
+
+
+@dataclass
+class AndroidDevice:
+    serial: str
+    usb: str
+    product: str
+    model: str
+    device: str
+    transport_id: str
+    system_info: Dict = field(default_factory=lambda: {})
+
+    def _get_android_values(self):
+        """Get the values of the Android device."""
+
+        # example line:
+        # System name | Network (domain) name | Kernel Release number | Kernel Version | Machine (hardware) name
+        # Linux localhost 6.1.75-android14-11-g48b922851ac5-ab12039954 #1 SMP PREEMPT Tue Jul  2 09:33:34 UTC 2024 aarch64 Toybox
+        uname_output = execute_command(serial=self.serial, command="uname -a")
+        self.system_info["name"] = self.serial
+        self.system_info["os_family"] = "Android"
+        self.system_info["os_release"] = uname_output[2]
+        self.system_info["os_version"] = uname_output[3]
+        self.system_info["platform"] = ""
+        self.system_info["processor"] = ""
+        self.system_info["machine"] = uname_output[13]
+        self.system_info["architecture"] = "64bit"
+        return self.system_info
+
+
+def list_devices():
+    """List all connected Android devices."""
+    devices = []
+
+    with Popen(["adb", "devices", "-l"], stdout=PIPE) as process:
+        for line in process.stdout.read().decode("utf-8").split("\n"):
+            if line == "":
+                continue
+
+            if "List of devices attached" in line:
+                continue
+
+            device_details_array = [
+                detail for detail in line.split(" ") if detail != ""
+            ]
+
+            android_device = AndroidDevice(
+                serial=device_details_array[0],
+                usb=device_details_array[1],
+                product=device_details_array[2],
+                model=device_details_array[3],
+                device=device_details_array[4],
+                transport_id=device_details_array[5],
+            )
+            android_device._get_android_values()
+            devices.append(android_device)
+
+    return devices
+
+
+def execute_command(serial: str, command: str):
+    """Execute a command on an Android device."""
+    with Popen(
+        ["adb", "-s", serial, "shell", *command.split(" ")], stdin=PIPE, stdout=PIPE
+    ) as process:
+        return process.stdout.read().decode("utf-8")
+
+
+def create_interactive_shell(serial: str, command: str):
+    """Create an interactive shell to an Android device."""
+    with Popen(["adb", "-s", serial, "shell"], stdin=PIPE, stdout=PIPE) as process:
+        return process.stdout.read().decode("utf-8")

primitive-0.1.90/src/primitive/hardware/commands.py

@@ -0,0 +1,155 @@
+import typing
+
+import click
+
+from ..utils.printer import print_result
+
+if typing.TYPE_CHECKING:
+    from ..client import Primitive
+
+from rich.console import Console
+from rich.table import Table
+
+
+@click.group()
+@click.pass_context
+def cli(context):
+    """Hardware"""
+    pass
+
+
+@cli.command("systeminfo")
+@click.pass_context
+def systeminfo_command(context):
+    """Get System Info"""
+    primitive: Primitive = context.obj.get("PRIMITIVE")
+    message = primitive.hardware.get_system_info()
+    print_result(message=message, context=context)
+
+
+@cli.command("register")
+@click.pass_context
+def register_command(context):
+    """Register Hardware with Primitive"""
+    primitive: Primitive = context.obj.get("PRIMITIVE")
+    result = primitive.hardware.register()
+    color = "green" if result else "red"
+    if result.data.get("registerHardware"):
+        message = "Hardware registered successfully"
+    else:
+        message = (
+            "There was an error registering this device. Please review the above logs."
+        )
+    print_result(message=message, context=context, fg=color)
+
+
+@cli.command("unregister")
+@click.pass_context
+def unregister_command(context):
+    """Unregister Hardware with Primitive"""
+    primitive: Primitive = context.obj.get("PRIMITIVE")
+    result = primitive.hardware.unregister()
+    color = "green" if result else "red"
+    if not result:
+        message = "There was an error unregistering this device. Please review the above logs."
+        return
+    elif result.data.get("unregisterHardware"):
+        message = "Hardware unregistered successfully"
+    print_result(message=message, context=context, fg=color)
+
+
+@cli.command("checkin")
+@click.pass_context
+def checkin_command(context):
+    """Checkin Hardware with Primitive"""
+    primitive: Primitive = context.obj.get("PRIMITIVE")
+    check_in_http_result = primitive.hardware.check_in_http()
+    if messages := check_in_http_result.data.get("checkIn").get("messages"):
+        print_result(message=messages, context=context, fg="yellow")
+    else:
+        message = "Hardware checked in successfully"
+        print_result(message=message, context=context, fg="green")
+
+
+def hardware_status_string(hardware):
+    if activeReservation := hardware.get("activeReservation"):
+        if activeReservation.get("status", None) == "in_progress":
+            return "Reserved"
+    if hardware.get("isQuarantined"):
+        return "Quarantined"
+    if not hardware.get("isOnline"):
+        return "Offline"
+    if not hardware.get("isHealthy"):
+        return "Not healthy"
+    if not hardware.get("isAvailable"):
+        return "Not available"
+    else:
+        return "Available"
+
+
+@cli.command("list")
+@click.pass_context
+def list_command(context):
+    """List Hardware"""
+    primitive: Primitive = context.obj.get("PRIMITIVE")
+    get_hardware_list_result = primitive.hardware.get_hardware_list(
+        nested_children=True
+    )
+    message = get_hardware_list_result.data
+
+    hardware_list = [
+        hardware.get("node")
+        for hardware in get_hardware_list_result.data.get("hardwareList").get("edges")
+    ]
+
+    message = hardware_list
+    if context.obj["JSON"]:
+        print_result(message=message, context=context)
+        return
+
+    console = Console()
+
+    table = Table(show_header=True, header_style="bold magenta")
+    table.add_column("Organization")
+    table.add_column("Name | Slug")
+    table.add_column("Status")
+    table.add_column("Reservation")
+
+    for hardware in hardware_list:
+        name = hardware.get("name")
+        slug = hardware.get("slug")
+        print_name = name
+        if name != slug:
+            print_name = f"{name} | {slug}"
+        child_table = Table(show_header=False, header_style="bold magenta")
+        child_table.add_column("Organization")
+        child_table.add_column("Name | Slug")
+        child_table.add_column("Status")
+        child_table.add_column("Reservation", justify="right")
+
+        table.add_row(
+            hardware.get("organization").get("name"),
+            print_name,
+            hardware_status_string(hardware),
+            f"{hardware.get('activeReservation').get('createdBy').get('username')} | {hardware.get('activeReservation').get('status')}"
+            if hardware.get("activeReservation", None)
+            else "",
+        )
+
+        if len(hardware.get("children")) > 0:
+            for child in hardware.get("children"):
+                name = child.get("name")
+                slug = child.get("slug")
+                print_name = name
+                if name != slug:
+                    print_name = f"└── {name} | {slug}"
+                table.add_row(
+                    hardware.get("organization").get("name"),
+                    print_name,
+                    hardware_status_string(hardware),
+                    f"{hardware.get('activeReservation').get('createdBy').get('username')} | {hardware.get('activeReservation').get('status')}"
+                    if hardware.get("activeReservation", None)
+                    else "",
+                )
+
+    console.print(table)

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/hardware/graphql/fragments.py

@@ -10,15 +10,26 @@ fragment HardwareFragment on Hardware {
   isOnline
   isQuarantined
   isHealthy
+  systemInfo
   hostname
   sshUsername
   capabilities {
     id
     pk
   }
+  organization {
+    id
+    pk
+    name
+    slug
+  }
   activeReservation {
     id
     pk
+    status
+    createdBy {
+      username
+    }
   }
 }
 """

{primitive-0.1.88 → primitive-0.1.90}/src/primitive/hardware/graphql/mutations.py

@@ -14,6 +14,35 @@ mutation registerHardware($input: RegisterHardwareInput!) {
 """
 )
 
+register_child_hardware_mutation = (
+    operation_info_fragment
+    + """
+mutation registerChildHardware($input: RegisterChildHardwareInput!) {
+    registerChildHardware(input: $input) {
+        ... on Hardware {
+            fingerprint
+        }
+        ...OperationInfoFragment
+    }
+}
+"""
+)
+
+unregister_hardware_mutation = (
+    operation_info_fragment
+    + """
+mutation unregisterHardware($input: UnregisterHardwareInput!) {
+    unregisterHardware(input: $input) {
+        ... on Hardware {
+            fingerprint
+        }
+        ...OperationInfoFragment
+    }
+}
+"""
+)
+
+
 hardware_update_mutation = (
     operation_info_fragment
     + """