trainml 0.5.5__py3-none-any.whl → 0.5.7__py3-none-any.whl

tests/unit/test_projects_unit.py

@@ -49,16 +49,27 @@ def project_datastore(mock_trainml):
 
 
 @fixture
-def project_reservation(mock_trainml):
-    yield specimen.ProjectReservation(
+def project_data_connector(mock_trainml):
+    yield specimen.ProjectDataConnector(
+        mock_trainml,
+        id="ds-id-1",
+        name="connector 1",
+        project_uuid="proj-id-1",
+        type="custom",
+        region_uuid="reg-id-1",
+    )
+
+
+@fixture
+def project_service(mock_trainml):
+    yield specimen.ProjectService(
         mock_trainml,
         id="res-id-1",
-        name="reservation 1",
+        name="service 1",
         project_uuid="proj-id-1",
         region_uuid="reg-id-1",
-        type="port",
-        resource="8001",
-        hostname="service.local",
+        public=False,
+        hostname="asdf.proximl.cloud",
     )
 
 
@@ -72,9 +83,7 @@ class ProjectsTests:
         api_response = dict()
         mock_trainml._query = AsyncMock(return_value=api_response)
         await projects.get("1234")
-        mock_trainml._query.assert_called_once_with(
-            "/project/1234", "GET", dict()
-        )
+        mock_trainml._query.assert_called_once_with("/project/1234", "GET", dict())
 
     @mark.asyncio
     async def test_list_projects(
@@ -96,9 +105,7 @@ class ProjectsTests:
         api_response = dict()
         mock_trainml._query = AsyncMock(return_value=api_response)
         await projects.remove("4567")
-        mock_trainml._query.assert_called_once_with(
-            "/project/4567", "DELETE", dict()
-        )
+        mock_trainml._query.assert_called_once_with("/project/4567", "DELETE", dict())
 
     @mark.asyncio
     async def test_create_project_simple(self, projects, mock_trainml):
@@ -156,36 +163,65 @@ class ProjectDatastoreTests:
         assert not bool(empty_project_datastore)
 
 
-class ProjectReservationTests:
-    def test_project_reservation_properties(self, project_reservation):
-        assert isinstance(project_reservation.id, str)
-        assert isinstance(project_reservation.name, str)
-        assert isinstance(project_reservation.project_uuid, str)
-        assert isinstance(project_reservation.type, str)
-        assert isinstance(project_reservation.hostname, str)
-        assert isinstance(project_reservation.resource, str)
-        assert isinstance(project_reservation.region_uuid, str)
+class ProjectDataConnectorTests:
+    def test_project_data_connector_properties(self, project_data_connector):
+        assert isinstance(project_data_connector.id, str)
+        assert isinstance(project_data_connector.name, str)
+        assert isinstance(project_data_connector.project_uuid, str)
+        assert isinstance(project_data_connector.type, str)
+        assert isinstance(project_data_connector.region_uuid, str)
+
+    def test_project_data_connector_str(self, project_data_connector):
+        string = str(project_data_connector)
+        regex = r"^{.*\"id\": \"" + project_data_connector.id + r"\".*}$"
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_project_data_connector_repr(self, project_data_connector):
+        string = repr(project_data_connector)
+        regex = (
+            r"^ProjectDataConnector\( trainml , \*\*{.*'id': '"
+            + project_data_connector.id
+            + r"'.*}\)$"
+        )
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_project_data_connector_bool(self, project_data_connector, mock_trainml):
+        empty_project_data_connector = specimen.ProjectDataConnector(mock_trainml)
+        assert bool(project_data_connector)
+        assert not bool(empty_project_data_connector)
 
-    def test_project_reservation_str(self, project_reservation):
-        string = str(project_reservation)
-        regex = r"^{.*\"id\": \"" + project_reservation.id + r"\".*}$"
+
+class ProjectServiceTests:
+    def test_project_service_properties(self, project_service):
+        assert isinstance(project_service.id, str)
+        assert isinstance(project_service.name, str)
+        assert isinstance(project_service.project_uuid, str)
+        assert isinstance(project_service.hostname, str)
+        assert isinstance(project_service.public, bool)
+        assert isinstance(project_service.region_uuid, str)
+
+    def test_project_service_str(self, project_service):
+        string = str(project_service)
+        regex = r"^{.*\"id\": \"" + project_service.id + r"\".*}$"
         assert isinstance(string, str)
         assert re.match(regex, string)
 
-    def test_project_reservation_repr(self, project_reservation):
-        string = repr(project_reservation)
+    def test_project_service_repr(self, project_service):
+        string = repr(project_service)
         regex = (
-            r"^ProjectReservation\( trainml , \*\*{.*'id': '"
-            + project_reservation.id
+            r"^ProjectService\( trainml , \*\*{.*'id': '"
+            + project_service.id
             + r"'.*}\)$"
         )
         assert isinstance(string, str)
         assert re.match(regex, string)
 
-    def test_project_reservation_bool(self, project_reservation, mock_trainml):
-        empty_project_reservation = specimen.ProjectReservation(mock_trainml)
-        assert bool(project_reservation)
-        assert not bool(empty_project_reservation)
+    def test_project_service_bool(self, project_service, mock_trainml):
+        empty_project_service = specimen.ProjectService(mock_trainml)
+        assert bool(project_service)
+        assert not bool(empty_project_service)
 
 
 class ProjectTests:
@@ -203,9 +239,7 @@ class ProjectTests:
 
     def test_project_repr(self, project):
         string = repr(project)
-        regex = (
-            r"^Project\( trainml , \*\*{.*'id': '" + project.id + r"'.*}\)$"
-        )
+        regex = r"^Project\( trainml , \*\*{.*'id': '" + project.id + r"'.*}\)$"
         assert isinstance(string, str)
         assert re.match(regex, string)
 
@@ -226,18 +260,14 @@ class ProjectTests:
         api_response = dict()
         mock_trainml._query = AsyncMock(return_value=api_response)
         await project.refresh_datastores()
-        mock_trainml._query.assert_called_once_with(
-            "/project/1/datastores", "PATCH"
-        )
+        mock_trainml._query.assert_called_once_with("/project/1/datastores", "PATCH")
 
     @mark.asyncio
-    async def test_project_refresh_reservations(self, project, mock_trainml):
+    async def test_project_refresh_services(self, project, mock_trainml):
         api_response = dict()
         mock_trainml._query = AsyncMock(return_value=api_response)
-        await project.refresh_reservations()
-        mock_trainml._query.assert_called_once_with(
-            "/project/1/reservations", "PATCH"
-        )
+        await project.refresh_services()
+        mock_trainml._query.assert_called_once_with("/project/1/services", "PATCH")
 
     @mark.asyncio
     async def test_project_list_datastores(self, project, mock_trainml):
@@ -259,13 +289,11 @@ class ProjectTests:
         ]
         mock_trainml._query = AsyncMock(return_value=api_response)
         resp = await project.list_datastores()
-        mock_trainml._query.assert_called_once_with(
-            "/project/1/datastores", "GET"
-        )
+        mock_trainml._query.assert_called_once_with("/project/1/datastores", "GET")
         assert len(resp) == 2
 
     @mark.asyncio
-    async def test_project_list_reservations(self, project, mock_trainml):
+    async def test_project_list_services(self, project, mock_trainml):
         api_response = [
             {
                 "project_uuid": "proj-id-1",
@@ -287,8 +315,6 @@ class ProjectTests:
             },
         ]
         mock_trainml._query = AsyncMock(return_value=api_response)
-        resp = await project.list_reservations()
-        mock_trainml._query.assert_called_once_with(
-            "/project/1/reservations", "GET"
-        )
+        resp = await project.list_services()
+        mock_trainml._query.assert_called_once_with("/project/1/services", "GET")
         assert len(resp) == 2

trainml/__init__.py

@@ -13,5 +13,5 @@ logging.basicConfig(
 logger = logging.getLogger(__name__)
 
 
-__version__ = "0.5.5"
+__version__ = "0.5.7"
 __all__ = "TrainML"

trainml/checkpoints.py

@@ -23,9 +23,7 @@ class Checkpoints(object):
 
     async def list(self, **kwargs):
         resp = await self.trainml._query(f"/checkpoint", "GET", kwargs)
-        checkpoints = [
-            Checkpoint(self.trainml, **checkpoint) for checkpoint in resp
-        ]
+        checkpoints = [Checkpoint(self.trainml, **checkpoint) for checkpoint in resp]
         return checkpoints
 
     async def list_public(self, **kwargs):
@@ -39,8 +37,7 @@ class Checkpoints(object):
             source_type=source_type,
             source_uri=source_uri,
             source_options=kwargs.get("source_options"),
-            project_uuid=kwargs.get("project_uuid")
-            or self.trainml.active_project,
+            project_uuid=kwargs.get("project_uuid") or self.trainml.active_project,
         )
         payload = {k: v for k, v in data.items() if v is not None}
         logging.info(f"Creating Checkpoint {name}")
@@ -60,9 +57,7 @@ class Checkpoint:
     def __init__(self, trainml, **kwargs):
         self.trainml = trainml
         self._checkpoint = kwargs
-        self._id = self._checkpoint.get(
-            "id", self._checkpoint.get("checkpoint_uuid")
-        )
+        self._id = self._checkpoint.get("id", self._checkpoint.get("checkpoint_uuid"))
         self._status = self._checkpoint.get("status")
         self._name = self._checkpoint.get("name")
         self._size = self._checkpoint.get("size")
@@ -123,15 +118,17 @@ class Checkpoint:
                 entity_type="checkpoint",
                 project_uuid=self._checkpoint.get("project_uuid"),
                 cidr=self._checkpoint.get("vpn").get("cidr"),
-                ssh_port=self._checkpoint.get("vpn")
-                .get("client")
-                .get("ssh_port"),
-                input_path=self._checkpoint.get("source_uri")
-                if self.status in ["new", "downloading"]
-                else None,
-                output_path=self._checkpoint.get("output_uri")
-                if self.status == "exporting"
-                else None,
+                ssh_port=self._checkpoint.get("vpn").get("client").get("ssh_port"),
+                input_path=(
+                    self._checkpoint.get("source_uri")
+                    if self.status in ["new", "downloading"]
+                    else None
+                ),
+                output_path=(
+                    self._checkpoint.get("output_uri")
+                    if self.status == "exporting"
+                    else None
+                ),
             )
         else:
             details = dict()
@@ -195,9 +192,7 @@ class Checkpoint:
                 if msg_handler:
                     msg_handler(data)
                 else:
-                    timestamp = datetime.fromtimestamp(
-                        int(data.get("time")) / 1000
-                    )
+                    timestamp = datetime.fromtimestamp(int(data.get("time")) / 1000)
                     print(
                         f"{timestamp.strftime('%m/%d/%Y, %H:%M:%S')}: {data.get('msg').rstrip()}"
                     )
@@ -224,19 +219,24 @@ class Checkpoint:
         return self
 
     async def wait_for(self, status, timeout=300):
+        if self.status == status:
+            return
         valid_statuses = ["downloading", "ready", "archived"]
         if not status in valid_statuses:
             raise SpecificationError(
                 "status",
                 f"Invalid wait_for status {status}.  Valid statuses are: {valid_statuses}",
             )
-        if self.status == status:
-            return
+
+        MAX_TIMEOUT = 24 * 60 * 60
+        if timeout > MAX_TIMEOUT:
+            raise SpecificationError(
+                "timeout",
+                f"timeout must be less than {MAX_TIMEOUT} seconds.",
+            )
         POLL_INTERVAL_MIN = 5
         POLL_INTERVAL_MAX = 60
-        POLL_INTERVAL = max(
-            min(timeout / 60, POLL_INTERVAL_MAX), POLL_INTERVAL_MIN
-        )
+        POLL_INTERVAL = max(min(timeout / 60, POLL_INTERVAL_MAX), POLL_INTERVAL_MIN)
         retry_count = math.ceil(timeout / POLL_INTERVAL)
         count = 0
         while count < retry_count:

trainml/cli/cloudbender/__init__.py

@@ -15,4 +15,5 @@ from trainml.cli.cloudbender.region import region
 from trainml.cli.cloudbender.node import node
 from trainml.cli.cloudbender.device import device
 from trainml.cli.cloudbender.datastore import datastore
-from trainml.cli.cloudbender.reservation import reservation
+from trainml.cli.cloudbender.data_connector import data_connector
+from trainml.cli.cloudbender.service import service

trainml/cli/cloudbender/data_connector.py

@@ -0,0 +1,159 @@
+import click
+from trainml.cli import cli, pass_config, search_by_id_name
+from trainml.cli.cloudbender import cloudbender
+
+
+@cloudbender.group()
+@pass_config
+def data_connector(config):
+    """trainML CloudBender data connector commands."""
+    pass
+
+
+@data_connector.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to list data connectors for.",
+)
+@pass_config
+def list(config, provider, region):
+    """List data connectors."""
+    data = [
+        ["ID", "NAME", "TYPE"],
+        [
+            "-" * 80,
+            "-" * 80,
+            "-" * 80,
+        ],
+    ]
+
+    data_connectors = config.trainml.run(
+        config.trainml.client.cloudbender.data_connectors.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    for data_connector in data_connectors:
+        data.append(
+            [
+                data_connector.id,
+                data_connector.name,
+                data_connector.type,
+            ]
+        )
+
+    for row in data:
+        click.echo(
+            "{: >37.36} {: >29.28} {: >9.8}" "".format(*row),
+            file=config.stdout,
+        )
+
+
+@data_connector.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to create the data_connector in.",
+)
+@click.option(
+    "--type",
+    "-t",
+    type=click.Choice(
+        [
+            "custom",
+        ],
+        case_sensitive=False,
+    ),
+    required=True,
+    help="The type of data connector to create.",
+)
+@click.option(
+    "--protocol",
+    "-r",
+    type=click.STRING,
+    help="The transport protocol of the data connector",
+)
+@click.option(
+    "--port-range",
+    "-p",
+    type=click.STRING,
+    help="The port range of the data connector",
+)
+@click.option(
+    "--cidr",
+    "-i",
+    type=click.STRING,
+    help="The IP range to allow in CIDR notation",
+)
+@click.argument("name", type=click.STRING, required=True)
+@pass_config
+def create(config, provider, region, type, protocol, port_range, cidr, name):
+    """
+    Creates a data_connector.
+    """
+    return config.trainml.run(
+        config.trainml.client.cloudbender.data_connectors.create(
+            provider_uuid=provider,
+            region_uuid=region,
+            name=name,
+            type=type,
+            protocol=protocol,
+            port_range=port_range,
+            cidr=cidr,
+        )
+    )
+
+
+@data_connector.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to remove the data_connector from.",
+)
+@click.argument("data_connector", type=click.STRING)
+@pass_config
+def remove(config, provider, region, data_connector):
+    """
+    Remove a data_connector.
+
+    DATASTORE may be specified by name or ID, but ID is preferred.
+    """
+    data_connectors = config.trainml.run(
+        config.trainml.client.cloudbender.data_connectors.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    found = search_by_id_name(data_connector, data_connectors)
+    if None is found:
+        raise click.UsageError("Cannot find specified data_connector.")
+
+    return config.trainml.run(found.remove())

trainml/cli/cloudbender/service.py

@@ -0,0 +1,146 @@
+import click
+from trainml.cli import cli, pass_config, search_by_id_name
+from trainml.cli.cloudbender import cloudbender
+
+
+@cloudbender.group()
+@pass_config
+def service(config):
+    """trainML CloudBender service commands."""
+    pass
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to list services for.",
+)
+@pass_config
+def list(config, provider, region):
+    """List services."""
+    data = [
+        ["ID", "NAME", "HOSTNAME"],
+        [
+            "-" * 80,
+            "-" * 80,
+            "-" * 80,
+        ],
+    ]
+
+    services = config.trainml.run(
+        config.trainml.client.cloudbender.services.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    for service in services:
+        data.append(
+            [
+                service.id,
+                service.name,
+                service.hostname,
+            ]
+        )
+
+    for row in data:
+        click.echo(
+            "{: >25.24} {: >29.28} {: >40.39}" "".format(*row),
+            file=config.stdout,
+        )
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to create the service in.",
+)
+@click.option(
+    "--type",
+    "-t",
+    type=click.Choice(
+        [
+            "https",
+            "tcp",
+            "udp",
+        ],
+    ),
+    required=True,
+    help="The type of regional service.",
+)
+@click.option(
+    "--public/--no-public",
+    default=True,
+    show_default=True,
+    help="Service should be accessible from the public internet.",
+)
+@click.argument("name", type=click.STRING, required=True)
+@pass_config
+def create(config, provider, region, type, public, name):
+    """
+    Creates a service.
+    """
+    return config.trainml.run(
+        config.trainml.client.cloudbender.services.create(
+            provider_uuid=provider,
+            region_uuid=region,
+            name=name,
+            type=type,
+            public=public,
+        )
+    )
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to remove the service from.",
+)
+@click.argument("service", type=click.STRING)
+@pass_config
+def remove(config, provider, region, service):
+    """
+    Remove a service.
+
+    RESERVATION may be specified by name or ID, but ID is preferred.
+    """
+    services = config.trainml.run(
+        config.trainml.client.cloudbender.services.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    found = search_by_id_name(service, services)
+    if None is found:
+        raise click.UsageError("Cannot find specified service.")
+
+    return config.trainml.run(found.remove())

trainml/cli/project.py

@@ -115,40 +115,35 @@ def list_datastores(config):
 
 @project.command()
 @pass_config
-def list_reservations(config):
-    """List project reservations."""
+def list_services(config):
+    """List project services."""
     data = [
-        ["ID", "NAME", "TYPE", "RESOURCE", "HOSTNAME", "REGION_UUID"],
+        ["ID", "NAME", "HOSTNAME", "REGION_UUID"],
         [
             "-" * 80,
             "-" * 80,
             "-" * 80,
             "-" * 80,
-            "-" * 80,
-            "-" * 80,
         ],
     ]
     project = config.trainml.run(
         config.trainml.client.projects.get(config.trainml.client.project)
     )
 
-    reservations = config.trainml.run(project.list_reservations())
+    services = config.trainml.run(project.list_services())
 
-    for reservation in reservations:
+    for service in services:
         data.append(
             [
-                reservation.id,
-                reservation.name,
-                reservation.type,
-                reservation.resource,
-                reservation.hostname,
-                reservation.region_uuid,
+                service.id,
+                service.name,
+                service.hostname,
+                service.region_uuid,
             ]
         )
 
     for row in data:
         click.echo(
-            "{: >38.36} {: >30.28} {: >8.6} {: >15.13} {: >30.28} {: >38.36}"
-            "".format(*row),
+            "{: >38.36} {: >30.28} {: >30.28} {: >38.36}" "".format(*row),
             file=config.stdout,
         )

trainml/cloudbender/cloudbender.py

@@ -3,7 +3,8 @@ from .regions import Regions
 from .nodes import Nodes
 from .devices import Devices
 from .datastores import Datastores
-from .reservations import Reservations
+from .data_connectors import DataConnectors
+from .services import Services
 from .device_configs import DeviceConfigs
 
 
@@ -15,5 +16,6 @@ class Cloudbender(object):
         self.nodes = Nodes(trainml)
         self.devices = Devices(trainml)
         self.datastores = Datastores(trainml)
-        self.reservations = Reservations(trainml)
+        self.data_connectors = DataConnectors(trainml)
+        self.services = Services(trainml)
         self.device_configs = DeviceConfigs(trainml)