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

proximl/cli/cloudbender/data_connector.py

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

proximl/cloudbender/data_connectors.py

@@ -0,0 +1,112 @@
+import json
+import logging
+
+
+class DataConnectors(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}/data_connector/{id}",
+            "GET",
+            kwargs,
+        )
+        return DataConnector(self.proximl, **resp)
+
+    async def list(self, provider_uuid, region_uuid, **kwargs):
+        resp = await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/data_connector",
+            "GET",
+            kwargs,
+        )
+        data_connectors = [
+            DataConnector(self.proximl, **data_connector) for data_connector in resp
+        ]
+        return data_connectors
+
+    async def create(
+        self,
+        provider_uuid,
+        region_uuid,
+        name,
+        type,
+        **kwargs,
+    ):
+        logging.info(f"Creating Data Connector {name}")
+        data = dict(
+            name=name,
+            type=type,
+            **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}/data_connector",
+            "POST",
+            None,
+            payload,
+        )
+        data_connector = DataConnector(self.proximl, **resp)
+        logging.info(f"Created Data Connector {name} with id {data_connector.id}")
+        return data_connector
+
+    async def remove(self, provider_uuid, region_uuid, id, **kwargs):
+        await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/data_connector/{id}",
+            "DELETE",
+            kwargs,
+        )
+
+
+class DataConnector:
+    def __init__(self, proximl, **kwargs):
+        self.proximl = proximl
+        self._data_connector = kwargs
+        self._id = self._data_connector.get("connector_id")
+        self._provider_uuid = self._data_connector.get("provider_uuid")
+        self._region_uuid = self._data_connector.get("region_uuid")
+        self._type = self._data_connector.get("type")
+        self._name = self._data_connector.get("name")
+
+    @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 type(self) -> str:
+        return self._type
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    def __str__(self):
+        return json.dumps({k: v for k, v in self._data_connector.items()})
+
+    def __repr__(self):
+        return f"DataConnector( proximl , **{self._data_connector.__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}/data_connector/{self._id}",
+            "DELETE",
+        )
+
+    async def refresh(self):
+        resp = await self.proximl._query(
+            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/data_connector/{self._id}",
+            "GET",
+        )
+        self.__init__(self.proximl, **resp)
+        return self

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

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

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

@@ -26,6 +26,7 @@ proximl/cli/model.py,sha256=xdjveIaRPK7MdfrnFygPEuwYRJRW9VqheZ-11XnXDcE,6111
 proximl/cli/project.py,sha256=Er1twSiWQSAKir-hBIT9fRo2fc_UGqFoIJOwwjQGmlo,3522
 proximl/cli/volume.py,sha256=uyIrKov4zwCjyLyZrEJYoEbIkS0zdU3xSyWZk2BM1kA,6246
 proximl/cli/cloudbender/__init__.py,sha256=vxj62MyM3sC9h8M4ii3szH4s9JvEhicOQ0D0m7eNwPA,534
+proximl/cli/cloudbender/data_connector.py,sha256=D5xbUzpUGpn_NN-NZQ9vSxOZY610c1LsoBC40DkPwkw,3606
 proximl/cli/cloudbender/datastore.py,sha256=_vQOj-NfrL_nj4HfxNJL63TJZjLgfDyztRLyaRU58v8,3478
 proximl/cli/cloudbender/device.py,sha256=FdQZPESP6YBfUSzXq1Byu7eNMKi59qSOICONK-TEljI,3453
 proximl/cli/cloudbender/node.py,sha256=xxzj68YvpRey2vZQasgYTnwv3x7TnwpuPSSf8Ma5a54,3843
@@ -37,6 +38,7 @@ proximl/cli/job/__init__.py,sha256=s8mU2PvCWDcv4gGT3EmjHn8MIZlXBAoayoZKmnKpXnY,6
 proximl/cli/job/create.py,sha256=sGvbenY0yxvxHo-FZVbdw8FaZx5D4ekTCjD7P4YHG4g,34288
 proximl/cloudbender/__init__.py,sha256=iE29obtC0_9f0IhRvHQcG5aY58fVhVYipTakpjAhdss,64
 proximl/cloudbender/cloudbender.py,sha256=E1_MyOhl-Fq5gr6vitCdI34_f24Pa5cg9YrFXIXPwg8,634
+proximl/cloudbender/data_connectors.py,sha256=urhmaAi4TBR-6L1CD2qS7SG3Dcwo9hOi8Gx613MzKVU,3297
 proximl/cloudbender/datastores.py,sha256=RzwJnoVs8gn_WpUJxF6MZ1dTQogUVX0B25ALQ26QOmE,3506
 proximl/cloudbender/device_configs.py,sha256=VkiF8MXHfsEWEwdgNeioT8dnEAXkY3_Z1r3L3UlZK_E,3399
 proximl/cloudbender/devices.py,sha256=vHooaOw2k2Tf99FJHnVZTgggqCTYJg7rq46aUPW0k8M,5660
@@ -88,7 +90,9 @@ tests/unit/cli/cloudbender/test_cli_node_unit.py,sha256=uh1Nt0ewk0v81iN5wCyBPzSX
 tests/unit/cli/cloudbender/test_cli_provider_unit.py,sha256=jCnFnqZuLzuDx9u3kLyjT83nBDWKn7LDCz6ErzCce1g,781
 tests/unit/cli/cloudbender/test_cli_region_unit.py,sha256=mEAU0z_gKDM-e5J_V8igXmiU4qjrOfzJJRtKRNWdeBs,1262
 tests/unit/cli/cloudbender/test_cli_reservation_unit.py,sha256=Lcr-xeNVAtVLHllQnjyFOs9CI62iOseu2vVFGynnLks,1407
+tests/unit/cli/cloudbender/test_cli_service_unit.py,sha256=7gFaD-Ox22Gevvk6Sn8zGNp_k3jemwgDX3Yqx8yYN3I,1311
 tests/unit/cloudbender/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/unit/cloudbender/test_data_connectors_unit.py,sha256=ZCnI9Gr2RAcpHiPZ5t2kakjzJhhF5_S7XkBCPGyYd8k,5783
 tests/unit/cloudbender/test_datastores_unit.py,sha256=pZPLwfWl1ZDR1WYaRjDYflv5UfHhTxOvLzXJ-LdG_as,5398
 tests/unit/cloudbender/test_device_configs_unit.py,sha256=wBDnTfrP6yl0K_jWcNU2ADR6iHoe1sRzMpvNfs_dwXs,5714
 tests/unit/cloudbender/test_devices_unit.py,sha256=C2YTnfIpHlxdidgfbTnlzl72r5O7kqKStQUhWcTTXDg,9103
@@ -97,9 +101,9 @@ tests/unit/cloudbender/test_providers_unit.py,sha256=y63VCqHXb4Yu8sh0kW30-ojRvv9
 tests/unit/cloudbender/test_regions_unit.py,sha256=9bvP268gpNyygjh1IEpSSiUt2aP6okv7QOsV1XoaIS0,6299
 tests/unit/cloudbender/test_reservations_unit.py,sha256=ICuFT5sexnLvS7taoC18yQYuDZHpBRrNuCj3Uq_Arwo,5624
 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,,
+proximl-0.5.7.dist-info/LICENSE,sha256=ADFxLEZDxKY0j4MdyUd5GNuhQ18rnWH5rOz1ZG7yiOA,1069
+proximl-0.5.7.dist-info/METADATA,sha256=PK4Sh7VrHGIj1QOJWKHtkpXFguLXrKfOgFk8gW80PYw,7344
+proximl-0.5.7.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+proximl-0.5.7.dist-info/entry_points.txt,sha256=HmI311IIabkZReMCXu-nGbvIEW-KfaduAOyfiSqt5SY,63
+proximl-0.5.7.dist-info/top_level.txt,sha256=-TWqc9tAaxmWmW4c7uYsmzPEYUIoh6z02xxqPbv7Kys,23
+proximl-0.5.7.dist-info/RECORD,,

tests/unit/cli/cloudbender/test_cli_service_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 proximl.cli.cloudbender import service as specimen
+from proximl.cloudbender.services import Service
+
+
+def test_list(runner, mock_services):
+    with patch("proximl.cli.ProxiML", new=AsyncMock) as mock_proximl:
+        mock_proximl.cloudbender = AsyncMock()
+        mock_proximl.cloudbender.services = AsyncMock()
+        mock_proximl.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_proximl.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("proximl.cli.ProxiML", new=AsyncMock) as mock_proximl:
+        mock_proximl.cloudbender = AsyncMock()
+        mock_proximl.cloudbender.services = AsyncMock()
+        mock_proximl.cloudbender.services.list = AsyncMock(return_value=mock_services)
+        result = runner.invoke(specimen, ["list"])
+        assert result.exit_code != 0

tests/unit/cloudbender/test_data_connectors_unit.py

@@ -0,0 +1,176 @@
+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.data_connectors as specimen
+from proximl.exceptions import (
+    ApiError,
+    SpecificationError,
+    ProxiMLException,
+)
+
+pytestmark = [mark.sdk, mark.unit, mark.cloudbender, mark.data_connectors]
+
+
+@fixture
+def data_connectors(mock_proximl):
+    yield specimen.DataConnectors(mock_proximl)
+
+
+@fixture
+def data_connector(mock_proximl):
+    yield specimen.DataConnector(
+        mock_proximl,
+        provider_uuid="1",
+        region_uuid="a",
+        connector_id="x",
+        name="On-Prem Data Connector",
+        type="custom",
+        cidr="192.168.0.50/32",
+        port="443",
+        protocol="tcp",
+    )
+
+
+class RegionsTests:
+    @mark.asyncio
+    async def test_get_data_connector(
+        self,
+        data_connectors,
+        mock_proximl,
+    ):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await data_connectors.get("1234", "5687", "91011")
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1234/region/5687/data_connector/91011", "GET", {}
+        )
+
+    @mark.asyncio
+    async def test_list_data_connectors(
+        self,
+        data_connectors,
+        mock_proximl,
+    ):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await data_connectors.list("1234", "5687")
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1234/region/5687/data_connector", "GET", {}
+        )
+
+    @mark.asyncio
+    async def test_remove_data_connector(
+        self,
+        data_connectors,
+        mock_proximl,
+    ):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await data_connectors.remove("1234", "4567", "8910")
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1234/region/4567/data_connector/8910", "DELETE", {}
+        )
+
+    @mark.asyncio
+    async def test_create_data_connector(self, data_connectors, mock_proximl):
+        requested_config = dict(
+            provider_uuid="provider-id-1",
+            region_uuid="region-id-1",
+            name="On-Prem DataConnector",
+            type="custom",
+            cidr="192.168.0.50/32",
+            port="443",
+            protocol="tcp",
+        )
+        expected_payload = dict(
+            name="On-Prem DataConnector",
+            type="custom",
+            cidr="192.168.0.50/32",
+            port="443",
+            protocol="tcp",
+        )
+        api_response = {
+            "provider_uuid": "provider-id-1",
+            "region_uuid": "region-id-1",
+            "connector_id": "connector-id-1",
+            "name": "On-Prem DataConnector",
+            "type": "custom",
+            "cidr": "192.168.0.50/32",
+            "port": "443",
+            "protocol": "tcp",
+            "createdAt": "2020-12-31T23:59:59.000Z",
+        }
+
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        response = await data_connectors.create(**requested_config)
+        mock_proximl._query.assert_called_once_with(
+            "/provider/provider-id-1/region/region-id-1/data_connector",
+            "POST",
+            None,
+            expected_payload,
+        )
+        assert response.id == "connector-id-1"
+
+
+class DataConnectorTests:
+    def test_data_connector_properties(self, data_connector):
+        assert isinstance(data_connector.id, str)
+        assert isinstance(data_connector.provider_uuid, str)
+        assert isinstance(data_connector.region_uuid, str)
+        assert isinstance(data_connector.type, str)
+        assert isinstance(data_connector.name, str)
+
+    def test_data_connector_str(self, data_connector):
+        string = str(data_connector)
+        regex = r"^{.*\"connector_id\": \"" + data_connector.id + r"\".*}$"
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_data_connector_repr(self, data_connector):
+        string = repr(data_connector)
+        regex = (
+            r"^DataConnector\( proximl , \*\*{.*'connector_id': '"
+            + data_connector.id
+            + r"'.*}\)$"
+        )
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_data_connector_bool(self, data_connector, mock_proximl):
+        empty_data_connector = specimen.DataConnector(mock_proximl)
+        assert bool(data_connector)
+        assert not bool(empty_data_connector)
+
+    @mark.asyncio
+    async def test_data_connector_remove(self, data_connector, mock_proximl):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await data_connector.remove()
+        mock_proximl._query.assert_called_once_with(
+            "/provider/1/region/a/data_connector/x", "DELETE"
+        )
+
+    @mark.asyncio
+    async def test_data_connector_refresh(self, data_connector, mock_proximl):
+        api_response = {
+            "provider_uuid": "provider-id-1",
+            "region_uuid": "region-id-1",
+            "connector_id": "connector-id-1",
+            "name": "On-Prem DataConnector",
+            "type": "custom",
+            "cidr": "192.168.0.50/32",
+            "port": "443",
+            "protocol": "tcp",
+            "createdAt": "2020-12-31T23:59:59.000Z",
+        }
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        response = await data_connector.refresh()
+        mock_proximl._query.assert_called_once_with(
+            f"/provider/1/region/a/data_connector/x", "GET"
+        )
+        assert data_connector.id == "connector-id-1"
+        assert response.id == "connector-id-1"