trainml 0.5.5__tar.gz → 0.5.6__tar.gz

{trainml-0.5.5/trainml.egg-info → trainml-0.5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: trainml
-Version: 0.5.5
+Version: 0.5.6
 Summary: trainML client SDK and command line utilities
 Home-page: https://github.com/trainML/trainml-cli
 Author: trainML

{trainml-0.5.5 → trainml-0.5.6}/pyproject.toml

@@ -21,7 +21,7 @@ markers = [
     "nodes: Nodes tests",
     "devices: Devices tests",
     "datastores: Datastores tests",
-    "reservations: Reservations tests",
+    "services: Services tests",
     "device_configs: DeviceConfigs tests",
     "unit: All unit tests (no trainML environment required)",
     "integration: All integration tests (trainML environment required)",

trainml-0.5.6/tests/unit/cli/cloudbender/test_cli_reservation_unit.py

@@ -0,0 +1,34 @@
+import re
+import json
+import click
+from unittest.mock import AsyncMock, patch
+from pytest import mark, fixture, raises
+
+pytestmark = [mark.cli, mark.unit, mark.cloudbender, mark.services]
+
+from trainml.cli.cloudbender import service as specimen
+from trainml.cloudbender.services import Service
+
+
+def test_list(runner, mock_services):
+    with patch("trainml.cli.TrainML", new=AsyncMock) as mock_trainml:
+        mock_trainml.cloudbender = AsyncMock()
+        mock_trainml.cloudbender.services = AsyncMock()
+        mock_trainml.cloudbender.services.list = AsyncMock(return_value=mock_services)
+        result = runner.invoke(
+            specimen,
+            args=["list", "--provider=prov-id-1", "--region=reg-id-1"],
+        )
+        assert result.exit_code == 0
+        mock_trainml.cloudbender.services.list.assert_called_once_with(
+            provider_uuid="prov-id-1", region_uuid="reg-id-1"
+        )
+
+
+def test_list_no_provider(runner, mock_services):
+    with patch("trainml.cli.TrainML", new=AsyncMock) as mock_trainml:
+        mock_trainml.cloudbender = AsyncMock()
+        mock_trainml.cloudbender.services = AsyncMock()
+        mock_trainml.cloudbender.services.list = AsyncMock(return_value=mock_services)
+        result = runner.invoke(specimen, ["list"])
+        assert result.exit_code != 0

{trainml-0.5.5 → trainml-0.5.6}/tests/unit/cli/test_cli_project_unit.py

@@ -23,9 +23,7 @@ def test_list(runner, mock_projects):
 def test_list_datastores(runner, mock_project_datastores):
     with patch("trainml.cli.TrainML", new=AsyncMock) as mock_trainml:
         mock_project = create_autospec(Project)
-        mock_project.list_datastores = AsyncMock(
-            return_value=mock_project_datastores
-        )
+        mock_project.list_datastores = AsyncMock(return_value=mock_project_datastores)
         mock_trainml.projects.get = AsyncMock(return_value=mock_project)
         result = runner.invoke(specimen, ["list-datastores"])
         print(result)
@@ -33,14 +31,12 @@ def test_list_datastores(runner, mock_project_datastores):
         mock_project.list_datastores.assert_called_once()
 
 
-def test_list_reservations(runner, mock_project_reservations):
+def test_list_services(runner, mock_project_services):
     with patch("trainml.cli.TrainML", new=AsyncMock) as mock_trainml:
         mock_project = create_autospec(Project)
-        mock_project.list_reservations = AsyncMock(
-            return_value=mock_project_reservations
-        )
+        mock_project.list_services = AsyncMock(return_value=mock_project_services)
         mock_trainml.projects.get = AsyncMock(return_value=mock_project)
-        result = runner.invoke(specimen, ["list-reservations"])
+        result = runner.invoke(specimen, ["list-services"])
         print(result)
         assert result.exit_code == 0
-        mock_project.list_reservations.assert_called_once()
+        mock_project.list_services.assert_called_once()

trainml-0.5.6/tests/unit/cloudbender/test_services_unit.py

@@ -0,0 +1,161 @@
+import re
+import json
+import logging
+from unittest.mock import AsyncMock, patch
+from pytest import mark, fixture, raises
+from aiohttp import WSMessage, WSMsgType
+
+import trainml.cloudbender.services as specimen
+from trainml.exceptions import (
+    ApiError,
+    SpecificationError,
+    TrainMLException,
+)
+
+pytestmark = [mark.sdk, mark.unit, mark.cloudbender, mark.services]
+
+
+@fixture
+def services(mock_trainml):
+    yield specimen.Services(mock_trainml)
+
+
+@fixture
+def service(mock_trainml):
+    yield specimen.Service(
+        mock_trainml,
+        provider_uuid="1",
+        region_uuid="a",
+        service_id="x",
+        name="On-Prem Service",
+        public=False,
+        hostname="app1.proximl.cloud",
+    )
+
+
+class RegionsTests:
+    @mark.asyncio
+    async def test_get_service(
+        self,
+        services,
+        mock_trainml,
+    ):
+        api_response = dict()
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        await services.get("1234", "5687", "91011")
+        mock_trainml._query.assert_called_once_with(
+            "/provider/1234/region/5687/service/91011", "GET", {}
+        )
+
+    @mark.asyncio
+    async def test_list_services(
+        self,
+        services,
+        mock_trainml,
+    ):
+        api_response = dict()
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        await services.list("1234", "5687")
+        mock_trainml._query.assert_called_once_with(
+            "/provider/1234/region/5687/service", "GET", {}
+        )
+
+    @mark.asyncio
+    async def test_remove_service(
+        self,
+        services,
+        mock_trainml,
+    ):
+        api_response = dict()
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        await services.remove("1234", "4567", "8910")
+        mock_trainml._query.assert_called_once_with(
+            "/provider/1234/region/4567/service/8910", "DELETE", {}
+        )
+
+    @mark.asyncio
+    async def test_create_service(self, services, mock_trainml):
+        requested_config = dict(
+            provider_uuid="provider-id-1",
+            region_uuid="region-id-1",
+            name="On-Prem Service",
+            public=False,
+        )
+        expected_payload = dict(
+            name="On-Prem Service",
+            public=False,
+        )
+        api_response = {
+            "provider_uuid": "provider-id-1",
+            "region_uuid": "region-id-1",
+            "service_id": "service-id-1",
+            "name": "On-Prem Service",
+            "public": False,
+            "hostname": "app1.proximl.cloud",
+            "createdAt": "2020-12-31T23:59:59.000Z",
+        }
+
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        response = await services.create(**requested_config)
+        mock_trainml._query.assert_called_once_with(
+            "/provider/provider-id-1/region/region-id-1/service",
+            "POST",
+            None,
+            expected_payload,
+        )
+        assert response.id == "service-id-1"
+
+
+class serviceTests:
+    def test_service_properties(self, service):
+        assert isinstance(service.id, str)
+        assert isinstance(service.provider_uuid, str)
+        assert isinstance(service.region_uuid, str)
+        assert isinstance(service.public, bool)
+        assert isinstance(service.name, str)
+        assert isinstance(service.hostname, str)
+
+    def test_service_str(self, service):
+        string = str(service)
+        regex = r"^{.*\"service_id\": \"" + service.id + r"\".*}$"
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_service_repr(self, service):
+        string = repr(service)
+        regex = r"^Service\( trainml , \*\*{.*'service_id': '" + service.id + r"'.*}\)$"
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_service_bool(self, service, mock_trainml):
+        empty_service = specimen.Service(mock_trainml)
+        assert bool(service)
+        assert not bool(empty_service)
+
+    @mark.asyncio
+    async def test_service_remove(self, service, mock_trainml):
+        api_response = dict()
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        await service.remove()
+        mock_trainml._query.assert_called_once_with(
+            "/provider/1/region/a/service/x", "DELETE"
+        )
+
+    @mark.asyncio
+    async def test_service_refresh(self, service, mock_trainml):
+        api_response = {
+            "provider_uuid": "provider-id-1",
+            "region_uuid": "region-id-1",
+            "service_id": "service-id-1",
+            "name": "On-Prem Service",
+            "public": False,
+            "hostname": "app1.proximl.cloud",
+            "createdAt": "2020-12-31T23:59:59.000Z",
+        }
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        response = await service.refresh()
+        mock_trainml._query.assert_called_once_with(
+            f"/provider/1/region/a/service/x", "GET"
+        )
+        assert service.id == "service-id-1"
+        assert response.id == "service-id-1"

{trainml-0.5.5 → trainml-0.5.6}/tests/unit/conftest.py

@@ -17,7 +17,7 @@ from trainml.projects import (
     Projects,
     Project,
     ProjectDatastore,
-    ProjectReservation,
+    ProjectService,
 )
 from trainml.cloudbender import Cloudbender
 from trainml.cloudbender.providers import Provider, Providers
@@ -25,7 +25,7 @@ from trainml.cloudbender.regions import Region, Regions
 from trainml.cloudbender.nodes import Node, Nodes
 from trainml.cloudbender.devices import Device, Devices
 from trainml.cloudbender.datastores import Datastore, Datastores
-from trainml.cloudbender.reservations import Reservation, Reservations
+from trainml.cloudbender.services import Service, Services
 from trainml.cloudbender.device_configs import DeviceConfig, DeviceConfigs
 
 
@@ -887,27 +887,27 @@ def mock_project_datastores():
 
 
 @fixture(scope="session")
-def mock_reservations():
+def mock_services():
     trainml = Mock()
     yield [
-        Reservation(
+        Service(
             trainml,
             **{
                 "provider_uuid": "prov-id-1",
                 "region_uuid": "reg-id-1",
-                "reservation_id": "res-id-1",
+                "service_id": "res-id-1",
                 "type": "port",
                 "name": "On-Prem Service A",
                 "resource": "8001",
                 "hostname": "service-a.local",
             },
         ),
-        Reservation(
+        Service(
             trainml,
             **{
                 "provider_uuid": "prov-id-2",
                 "region_uuid": "reg-id-2",
-                "reservation_id": "res-id-2",
+                "service_id": "res-id-2",
                 "type": "port",
                 "name": "Cloud Service B",
                 "resource": "8001",
@@ -918,10 +918,10 @@ def mock_reservations():
 
 
 @fixture(scope="session")
-def mock_project_reservations():
+def mock_project_services():
     trainml = Mock()
     yield [
-        ProjectReservation(
+        ProjectService(
             trainml,
             **{
                 "project_uuid": "proj-id-1",
@@ -933,7 +933,7 @@ def mock_project_reservations():
                 "hostname": "service-a.local",
             },
         ),
-        ProjectReservation(
+        ProjectService(
             trainml,
             **{
                 "project_uuid": "proj-id-1",
@@ -990,7 +990,7 @@ def mock_trainml(
     mock_nodes,
     mock_devices,
     mock_datastores,
-    mock_reservations,
+    mock_services,
     mock_device_configs,
 ):
     trainml = create_autospec(TrainML)
@@ -1028,8 +1028,8 @@ def mock_trainml(
     trainml.cloudbender.devices.list = AsyncMock(return_value=mock_devices)
     trainml.cloudbender.datastores = create_autospec(Datastores)
     trainml.cloudbender.datastores.list = AsyncMock(return_value=mock_datastores)
-    trainml.cloudbender.reservations = create_autospec(Reservations)
-    trainml.cloudbender.reservations.list = AsyncMock(return_value=mock_reservations)
+    trainml.cloudbender.services = create_autospec(Services)
+    trainml.cloudbender.services.list = AsyncMock(return_value=mock_services)
     trainml.cloudbender.device_configs = create_autospec(DeviceConfigs)
     trainml.cloudbender.device_configs.list = AsyncMock(
         return_value=mock_device_configs

{trainml-0.5.5 → trainml-0.5.6}/tests/unit/test_projects_unit.py

@@ -49,11 +49,11 @@ def project_datastore(mock_trainml):
 
 
 @fixture
-def project_reservation(mock_trainml):
-    yield specimen.ProjectReservation(
+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",
@@ -72,9 +72,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 +94,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 +152,36 @@ 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 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.type, str)
+        assert isinstance(project_service.hostname, str)
+        assert isinstance(project_service.resource, str)
+        assert isinstance(project_service.region_uuid, str)
 
-    def test_project_reservation_str(self, project_reservation):
-        string = str(project_reservation)
-        regex = r"^{.*\"id\": \"" + project_reservation.id + r"\".*}$"
+    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 +199,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 +220,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 +249,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 +275,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-0.5.5 → trainml-0.5.6}/trainml/__init__.py

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

{trainml-0.5.5 → trainml-0.5.6}/trainml/cli/cloudbender/__init__.py

@@ -15,4 +15,4 @@ 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.service import service

trainml-0.5.6/trainml/cli/cloudbender/service.py

@@ -0,0 +1,129 @@
+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(
+    "--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, public, name):
+    """
+    Creates a service.
+    """
+    return config.trainml.run(
+        config.trainml.client.cloudbender.services.create(
+            provider_uuid=provider, region_uuid=region, name=name, 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())