proximl 0.5.5__py3-none-any.whl → 0.5.6__py3-none-any.whl

proximl/cli/cloudbender/service.py

@@ -0,0 +1,129 @@
+import click
+from proximl.cli import cli, pass_config, search_by_id_name
+from proximl.cli.cloudbender import cloudbender
+
+
+@cloudbender.group()
+@pass_config
+def service(config):
+    """proxiML 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.proximl.run(
+        config.proximl.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.proximl.run(
+        config.proximl.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.proximl.run(
+        config.proximl.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.proximl.run(found.remove())

proximl/cloudbender/services.py

@@ -0,0 +1,115 @@
+import json
+import logging
+
+
+class Services(object):
+    def __init__(self, proximl):
+        self.proximl = proximl
+
+    async def get(self, provider_uuid, region_uuid, id, **kwargs):
+        resp = await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service/{id}",
+            "GET",
+            kwargs,
+        )
+        return Service(self.proximl, **resp)
+
+    async def list(self, provider_uuid, region_uuid, **kwargs):
+        resp = await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service",
+            "GET",
+            kwargs,
+        )
+        services = [Service(self.proximl, **service) for service in resp]
+        return services
+
+    async def create(
+        self,
+        provider_uuid,
+        region_uuid,
+        name,
+        public,
+        **kwargs,
+    ):
+        logging.info(f"Creating Service {name}")
+        data = dict(
+            name=name,
+            public=public,
+            **kwargs,
+        )
+        payload = {k: v for k, v in data.items() if v is not None}
+        resp = await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service",
+            "POST",
+            None,
+            payload,
+        )
+        service = Service(self.proximl, **resp)
+        logging.info(f"Created Service {name} with id {service.id}")
+        return service
+
+    async def remove(self, provider_uuid, region_uuid, id, **kwargs):
+        await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service/{id}",
+            "DELETE",
+            kwargs,
+        )
+
+
+class Service:
+    def __init__(self, proximl, **kwargs):
+        self.proximl = proximl
+        self._service = kwargs
+        self._id = self._service.get("service_id")
+        self._provider_uuid = self._service.get("provider_uuid")
+        self._region_uuid = self._service.get("region_uuid")
+        self._public = self._service.get("public")
+        self._name = self._service.get("name")
+        self._hostname = self._service.get("hostname")
+
+    @property
+    def id(self) -> str:
+        return self._id
+
+    @property
+    def provider_uuid(self) -> str:
+        return self._provider_uuid
+
+    @property
+    def region_uuid(self) -> str:
+        return self._region_uuid
+
+    @property
+    def public(self) -> bool:
+        return self._public
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def hostname(self) -> str:
+        return self._hostname
+
+    def __str__(self):
+        return json.dumps({k: v for k, v in self._service.items()})
+
+    def __repr__(self):
+        return f"Service( proximl , **{self._service.__repr__()})"
+
+    def __bool__(self):
+        return bool(self._id)
+
+    async def remove(self):
+        await self.proximl._query(
+            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/service/{self._id}",
+            "DELETE",
+        )
+
+    async def refresh(self):
+        resp = await self.proximl._query(
+            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/service/{self._id}",
+            "GET",
+        )
+        self.__init__(self.proximl, **resp)
+        return self

{proximl-0.5.5.dist-info → proximl-0.5.6.dist-info}/METADATA

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

{proximl-0.5.5.dist-info → proximl-0.5.6.dist-info}/RECORD

@@ -32,6 +32,7 @@ proximl/cli/cloudbender/node.py,sha256=xxzj68YvpRey2vZQasgYTnwv3x7TnwpuPSSf8Ma5a
 proximl/cli/cloudbender/provider.py,sha256=qhWbDK1tWi00wQWEYqGw7yGoZx0nEjV40GLHRuuE86c,1726
 proximl/cli/cloudbender/region.py,sha256=WnSkY4dXKRJ-FNaoxMfmoh6iuUx5dXCNJmEFT34Xtao,2892
 proximl/cli/cloudbender/reservation.py,sha256=xzHs5l8BbmYgKUq6kfFU-jEtRQY0j_vYnmRVcL4wwDo,3569
+proximl/cli/cloudbender/service.py,sha256=YimwXQml82-PKKQIqu9Cvggo9wOKLVTJPxMvDf4pgn8,2869
 proximl/cli/job/__init__.py,sha256=s8mU2PvCWDcv4gGT3EmjHn8MIZlXBAoayoZKmnKpXnY,6545
 proximl/cli/job/create.py,sha256=sGvbenY0yxvxHo-FZVbdw8FaZx5D4ekTCjD7P4YHG4g,34288
 proximl/cloudbender/__init__.py,sha256=iE29obtC0_9f0IhRvHQcG5aY58fVhVYipTakpjAhdss,64
@@ -43,6 +44,7 @@ proximl/cloudbender/nodes.py,sha256=QeWUaWW1HNvCune1lhakcve6LJyMzOy7cjCtvyOiaTs,
 proximl/cloudbender/providers.py,sha256=cH5lCew5WCFpXYS93vuoGNWkZyx7T_mdMH6YNWp2QGs,2036
 proximl/cloudbender/regions.py,sha256=Nu1LT6nuLD8Nt-5-7_FLlxDNZoDDAY6QduTdEBqfxJA,3570
 proximl/cloudbender/reservations.py,sha256=14ImJRLWQGG7CXDYhDnOI2W8pnP6CVVG2aVpysQVN0E,3586
+proximl/cloudbender/services.py,sha256=KR0EQ-BUVk1ov9Q195NsnfiSiMb9vOYD8XyxD87RRvw,3222
 tests/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/integration/conftest.py,sha256=zRWpherX-yfbpk7xqZk9bIZCyJ-dwVeszY_7kekn2M4,1134
 tests/integration/test_checkpoints_integration.py,sha256=DUA6ZlX0gsnKCEvFmWCKbKkfJG3dQG6uD8T3fgo7y0M,3230
@@ -94,9 +96,10 @@ tests/unit/cloudbender/test_nodes_unit.py,sha256=ehOHkNroiLKNTR09SbnBPpwELE72GcG
 tests/unit/cloudbender/test_providers_unit.py,sha256=y63VCqHXb4Yu8sh0kW30-ojRvv9aUa5j1jNkmb46KTc,4373
 tests/unit/cloudbender/test_regions_unit.py,sha256=9bvP268gpNyygjh1IEpSSiUt2aP6okv7QOsV1XoaIS0,6299
 tests/unit/cloudbender/test_reservations_unit.py,sha256=ICuFT5sexnLvS7taoC18yQYuDZHpBRrNuCj3Uq_Arwo,5624
-proximl-0.5.5.dist-info/LICENSE,sha256=ADFxLEZDxKY0j4MdyUd5GNuhQ18rnWH5rOz1ZG7yiOA,1069
-proximl-0.5.5.dist-info/METADATA,sha256=ddskyt_dpYJW72fTThnwbbICvztVKb0eFgM2-crCFeg,7344
-proximl-0.5.5.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-proximl-0.5.5.dist-info/entry_points.txt,sha256=HmI311IIabkZReMCXu-nGbvIEW-KfaduAOyfiSqt5SY,63
-proximl-0.5.5.dist-info/top_level.txt,sha256=-TWqc9tAaxmWmW4c7uYsmzPEYUIoh6z02xxqPbv7Kys,23
-proximl-0.5.5.dist-info/RECORD,,
+tests/unit/cloudbender/test_services_unit.py,sha256=iYaQpyCXDg77GQEIhmgiVwKX83jyvIf-4-4oya5WA_o,5043
+proximl-0.5.6.dist-info/LICENSE,sha256=ADFxLEZDxKY0j4MdyUd5GNuhQ18rnWH5rOz1ZG7yiOA,1069
+proximl-0.5.6.dist-info/METADATA,sha256=wS2y66puGjq7ZkG2GsyFIJWCiSjbDiA5uUdA8PzlIqw,7344
+proximl-0.5.6.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+proximl-0.5.6.dist-info/entry_points.txt,sha256=HmI311IIabkZReMCXu-nGbvIEW-KfaduAOyfiSqt5SY,63
+proximl-0.5.6.dist-info/top_level.txt,sha256=-TWqc9tAaxmWmW4c7uYsmzPEYUIoh6z02xxqPbv7Kys,23
+proximl-0.5.6.dist-info/RECORD,,

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 proximl.cloudbender.services as specimen
+from proximl.exceptions import (
+    ApiError,
+    SpecificationError,
+    ProxiMLException,
+)
+
+pytestmark = [mark.sdk, mark.unit, mark.cloudbender, mark.services]
+
+
+@fixture
+def services(mock_proximl):
+    yield specimen.Services(mock_proximl)
+
+
+@fixture
+def service(mock_proximl):
+    yield specimen.Service(
+        mock_proximl,
+        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_proximl,
+    ):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await services.get("1234", "5687", "91011")
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1234/region/5687/service/91011", "GET", {}
+        )
+
+    @mark.asyncio
+    async def test_list_services(
+        self,
+        services,
+        mock_proximl,
+    ):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await services.list("1234", "5687")
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1234/region/5687/service", "GET", {}
+        )
+
+    @mark.asyncio
+    async def test_remove_service(
+        self,
+        services,
+        mock_proximl,
+    ):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await services.remove("1234", "4567", "8910")
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1234/region/4567/service/8910", "DELETE", {}
+        )
+
+    @mark.asyncio
+    async def test_create_service(self, services, mock_proximl):
+        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_proximl._query = AsyncMock(return_value=api_response)
+        response = await services.create(**requested_config)
+        mock_proximl._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\( proximl , \*\*{.*'service_id': '" + service.id + r"'.*}\)$"
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_service_bool(self, service, mock_proximl):
+        empty_service = specimen.Service(mock_proximl)
+        assert bool(service)
+        assert not bool(empty_service)
+
+    @mark.asyncio
+    async def test_service_remove(self, service, mock_proximl):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await service.remove()
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1/region/a/service/x", "DELETE"
+        )
+
+    @mark.asyncio
+    async def test_service_refresh(self, service, mock_proximl):
+        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_proximl._query = AsyncMock(return_value=api_response)
+        response = await service.refresh()
+        mock_proximl._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"