proximl 0.5.11__py3-none-any.whl → 0.5.12__py3-none-any.whl

proximl/cli/project/credential.py

@@ -0,0 +1,128 @@
+import click
+import os
+import json
+import base64
+from pathlib import Path
+from proximl.cli import pass_config
+from proximl.cli.project import project
+
+
+@project.group()
+@pass_config
+def credential(config):
+    """proxiML project credential commands."""
+    pass
+
+
+@credential.command()
+@pass_config
+def list(config):
+    """List credentials."""
+    data = [
+        ["TYPE", "KEY ID", "UPDATED AT"],
+        [
+            "-" * 80,
+            "-" * 80,
+            "-" * 80,
+        ],
+    ]
+    project = config.proximl.run(config.proximl.client.projects.get_current())
+    credentials = config.proximl.run(project.credentials.list())
+
+    for credential in credentials:
+        data.append(
+            [
+                credential.type,
+                credential.key_id,
+                credential.updated_at.isoformat(timespec="seconds"),
+            ]
+        )
+
+    for row in data:
+        click.echo(
+            "{: >13.11} {: >37.35} {: >28.26}" "".format(*row),
+            file=config.stdout,
+        )
+
+
+@credential.command()
+@click.argument(
+    "type",
+    type=click.Choice(
+        [
+            "aws",
+            "azure",
+            "docker",
+            "gcp",
+            "huggingface",
+            "kaggle",
+            "ngc",
+            "wasabi",
+        ],
+        case_sensitive=False,
+    ),
+)
+@pass_config
+def put(config, type):
+    """
+    Set a credential.
+
+    A credential is uploaded.
+    """
+    project = config.proximl.run(config.proximl.client.projects.get_current())
+
+    tenant = None
+
+    if type in ["aws", "wasabi"]:
+        credential_id = click.prompt(
+            "Enter the credential ID", type=str, hide_input=False
+        )
+        secret = click.prompt("Enter the secret credential", type=str, hide_input=True)
+    elif type == "azure":
+        credential_id = click.prompt(
+            "Enter the Application (client) ID", type=str, hide_input=False
+        )
+        tenant = click.prompt(
+            "Enter the Directory (tenant) ley", type=str, hide_input=False
+        )
+        secret = click.prompt("Enter the client secret", type=str, hide_input=True)
+    elif type in ["docker", "huggingface"]:
+        credential_id = click.prompt("Enter the username", type=str, hide_input=False)
+        secret = click.prompt("Enter the access token", type=str, hide_input=True)
+    elif type in ["gcp", "kaggle"]:
+        file_name = click.prompt(
+            "Enter the path of the credentials file",
+            type=click.Path(
+                exists=True, file_okay=True, dir_okay=False, resolve_path=True
+            ),
+            hide_input=False,
+        )
+        credential_id = os.path.basename(file_name)
+        with open(file_name) as f:
+            secret = json.load(f)
+        secret = json.dumps(secret)
+    elif type == "ngc":
+        credential_id = "$oauthtoken"
+        secret = click.prompt("Enter the access token", type=str, hide_input=True)
+    else:
+        raise click.UsageError("Unsupported credential type")
+
+    return config.proximl.run(
+        project.credentials.put(
+            type=type, credential_id=credential_id, secret=secret, tenant=tenant
+        )
+    )
+
+
+@credential.command()
+@click.argument("name", type=click.STRING)
+@pass_config
+def remove(config, name):
+    """
+    Remove a credential.
+
+
+    """
+    project = config.proximl.run(config.proximl.client.projects.get_current())
+
+    return config.proximl.run(project.credential.remove(name))

proximl/projects/credentials.py

@@ -0,0 +1,71 @@
+import json
+import logging
+from datetime import datetime
+from dateutil import parser, tz
+
+
+class ProjectCredentials(object):
+    def __init__(self, proximl, project_id):
+        self.proximl = proximl
+        self.project_id = project_id
+
+    async def list(self, **kwargs):
+        resp = await self.proximl._query(
+            f"/project/{self.project_id}/credentials", "GET", kwargs
+        )
+        credentials = [ProjectCredential(self.proximl, **service) for service in resp]
+        return credentials
+
+    async def put(self, type, key_id, secret, tenant=None, **kwargs):
+        data = dict(key_id=key_id, secret=secret, tenant=tenant)
+        payload = {k: v for k, v in data.items() if v is not None}
+        logging.info(f"Creating Project Credential {type}")
+        resp = await self.proximl._query(
+            f"/project/{self.project_id}/credential/{type}", "PUT", None, payload
+        )
+        credential = ProjectCredential(self.proximl, **resp)
+        logging.info(f"Created Project Credential {type} in project {self.project_id}")
+
+        return credential
+
+    async def remove(self, type, **kwargs):
+        await self.proximl._query(
+            f"/project/{self.project_id}/credential/{type}", "DELETE", kwargs
+        )
+
+
+class ProjectCredential:
+    def __init__(self, proximl, **kwargs):
+        self.proximl = proximl
+        self._entity = kwargs
+        self._type = self._entity.get("type")
+        self._project_uuid = self._entity.get("project_uuid")
+        self._key_id = self._entity.get("key_id")
+        self._updated_at = self._entity.get("updatedAt")
+
+    @property
+    def type(self) -> str:
+        return self._type
+
+    @property
+    def project_uuid(self) -> str:
+        return self._project_uuid
+
+    @property
+    def key_id(self) -> str:
+        return self._key_id
+
+    @property
+    def updated_at(self) -> datetime:
+        timestamp = parser.isoparse(self._updated_at)
+        timezone = tz.tzlocal()
+        return timestamp.astimezone(timezone)
+
+    def __str__(self):
+        return json.dumps({k: v for k, v in self._entity.items()})
+
+    def __repr__(self):
+        return f"ProjectCredential( proximl , **{self._entity.__repr__()})"
+
+    def __bool__(self):
+        return bool(self._type)

{proximl-0.5.11.dist-info → proximl-0.5.12.dist-info}/METADATA

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

{proximl-0.5.11.dist-info → proximl-0.5.12.dist-info}/RECORD

@@ -34,6 +34,7 @@ proximl/cli/cloudbender/service.py,sha256=6NuwlFULJLtOmMy9OFA8GkW4MLvNemAcd_KitQ
 proximl/cli/job/__init__.py,sha256=s8mU2PvCWDcv4gGT3EmjHn8MIZlXBAoayoZKmnKpXnY,6545
 proximl/cli/job/create.py,sha256=sGvbenY0yxvxHo-FZVbdw8FaZx5D4ekTCjD7P4YHG4g,34288
 proximl/cli/project/__init__.py,sha256=nSU_qBNVPezVA_Uu54ha37PAfCmTsIclXptEvIwiRME,1904
+proximl/cli/project/credential.py,sha256=5vPI6VBIo_YyvAzfUa9ARmz-LUnkdIVW0zbko9t0Q38,3443
 proximl/cli/project/data_connector.py,sha256=CKF4snfrzDmeDXb4au8nV2W9jTweRMDZ89U2GAlBedQ,1411
 proximl/cli/project/datastore.py,sha256=YusrUTKY_qIwEOBN2gXOUoKCUp2qbWTKzquKc0DcUsE,1336
 proximl/cli/project/key.py,sha256=23ugcWOAxNJvC8VzG3FsEUWJ1_FZANnhq66cO04ZEVY,3203
@@ -50,6 +51,7 @@ proximl/cloudbender/providers.py,sha256=KLO4Pc8yeW8TpSDICgTw3NxN44_0s4HptVsR2hHc
 proximl/cloudbender/regions.py,sha256=6doBdfMXIQI-uexzvwmNg2ATDzruatw-ixviZSMjonU,5157
 proximl/cloudbender/services.py,sha256=km3KcIgaRRVb3iuZEIn6ONIekuyXhBgk_brAFJcMMl4,5126
 proximl/projects/__init__.py,sha256=6NKCcHtQMeGB1IyU-djANphfnDX6MEkrXUM5Fyq9fWg,75
+proximl/projects/credentials.py,sha256=hWz6EUEAgltkAQMDjQVsFlVvfWUbZfY3KoWpldnCrXY,2255
 proximl/projects/data_connectors.py,sha256=559yJ-9qmva2JcNReuCyUQxdrSRIEROcGX5BDVr8ySs,1662
 proximl/projects/datastores.py,sha256=zAmKX9CibeS7PSXVvExk0SVrEo9Zq83kz6CQw0GoHck,1560
 proximl/projects/keys.py,sha256=yT5pgv1mGm50CaORf-HnsbDULad69G9I_QpVMN0zcuE,2157
@@ -69,6 +71,7 @@ tests/integration/cloudbender/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 tests/integration/cloudbender/test_providers_integration.py,sha256=gFqPQom-Cn1iZC50_ChQ2us2_f4tIPATQSAUcWdf7ss,1473
 tests/integration/projects/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/integration/projects/conftest.py,sha256=o7rBOFGvcmZ3q0fy7jCIm2CBqn_ULojPP1XFBBUPEVQ,242
+tests/integration/projects/test_projects_credentials_integration.py,sha256=_JqE2sGN09gZpvhtMRFjBPXumJ-PqKl8iXOgcYHlvSY,1636
 tests/integration/projects/test_projects_data_connectors_integration.py,sha256=ag6w2FFQYNlAdV83rOqat0FVZnP4JFhDunCvRwMJdzo,1630
 tests/integration/projects/test_projects_datastores_integration.py,sha256=DCHFnCYguhtrZvfTeWgKpPxlkeAXxVfE3IWkM4KjgAc,1469
 tests/integration/projects/test_projects_integration.py,sha256=wlRLxZkMnJZHlNPaeRFjAeyUlMfbgdrrFEI2eMBcoUI,1241
@@ -105,6 +108,7 @@ tests/unit/cli/cloudbender/test_cli_provider_unit.py,sha256=jCnFnqZuLzuDx9u3kLyj
 tests/unit/cli/cloudbender/test_cli_region_unit.py,sha256=mEAU0z_gKDM-e5J_V8igXmiU4qjrOfzJJRtKRNWdeBs,1262
 tests/unit/cli/cloudbender/test_cli_service_unit.py,sha256=7gFaD-Ox22Gevvk6Sn8zGNp_k3jemwgDX3Yqx8yYN3I,1311
 tests/unit/cli/projects/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/unit/cli/projects/test_cli_project_credential_unit.py,sha256=wehwquMGwUzwc8iH0bWletS3-kwIXKshoOuXHhJxRUc,943
 tests/unit/cli/projects/test_cli_project_data_connector_unit.py,sha256=RlqgHOUkFv3bmc19pUtGNVD0W1UWBJSDfaI_lzN0ZEA,993
 tests/unit/cli/projects/test_cli_project_datastore_unit.py,sha256=6UMgFwqxBtH65VeWTzXzaXhVfCRoG3Tef6aflqcDlV4,936
 tests/unit/cli/projects/test_cli_project_key_unit.py,sha256=Xb-O4cltVMNvHpSoPtIdfY4hmXUiMv-z5ixY49FKKyM,894
@@ -121,15 +125,16 @@ tests/unit/cloudbender/test_providers_unit.py,sha256=y63VCqHXb4Yu8sh0kW30-ojRvv9
 tests/unit/cloudbender/test_regions_unit.py,sha256=9bvP268gpNyygjh1IEpSSiUt2aP6okv7QOsV1XoaIS0,6299
 tests/unit/cloudbender/test_services_unit.py,sha256=V1JHfqNcLjz7d3qtVxPBCKzd5_lcL5iwhvWqQ0kw0J0,5220
 tests/unit/projects/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/unit/projects/test_project_credentials_unit.py,sha256=y528DyvIm7uc5mFuwiUPjOMO1dkVcMEeYQqzMmKLOuk,3480
 tests/unit/projects/test_project_data_connectors_unit.py,sha256=Yx2yCUgcuN_KfTKynZxse0Nx8jRrSlMygI7R8a-NjE4,3385
 tests/unit/projects/test_project_datastores_unit.py,sha256=WZMKkhpEg2dcevJqT7k6QRcYJF6FJfq177BDk2GWOBk,3129
 tests/unit/projects/test_project_keys_unit.py,sha256=n5Y2rKaenHA6JQFlViE1_dZ00FZ0PhM3C7rQtkuiRGM,3161
 tests/unit/projects/test_project_secrets_unit.py,sha256=VE9L91FJodcwVGizfF65WYMiHZaF0s2AdW1aiJ3z7xA,3276
 tests/unit/projects/test_project_services_unit.py,sha256=PzeNuJRuAG7RkrPWX0FfgFTt6-63FviecrDY06rLQ6A,3331
 tests/unit/projects/test_projects_unit.py,sha256=lTGdKOCN2bjzGORhaDVVlnzJBuEItUDGN36MsyQjDo4,3823
-proximl-0.5.11.dist-info/LICENSE,sha256=ADFxLEZDxKY0j4MdyUd5GNuhQ18rnWH5rOz1ZG7yiOA,1069
-proximl-0.5.11.dist-info/METADATA,sha256=mc59YfzmMo_-ejBfTKF9HZjOFKyDo2E3G0zV1uCE84M,7345
-proximl-0.5.11.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-proximl-0.5.11.dist-info/entry_points.txt,sha256=HmI311IIabkZReMCXu-nGbvIEW-KfaduAOyfiSqt5SY,63
-proximl-0.5.11.dist-info/top_level.txt,sha256=-TWqc9tAaxmWmW4c7uYsmzPEYUIoh6z02xxqPbv7Kys,23
-proximl-0.5.11.dist-info/RECORD,,
+proximl-0.5.12.dist-info/LICENSE,sha256=ADFxLEZDxKY0j4MdyUd5GNuhQ18rnWH5rOz1ZG7yiOA,1069
+proximl-0.5.12.dist-info/METADATA,sha256=4s3w6gTC6i3GAVUnj4Hw_7NEyO1AH6E4YqkqXo1heXM,7345
+proximl-0.5.12.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+proximl-0.5.12.dist-info/entry_points.txt,sha256=HmI311IIabkZReMCXu-nGbvIEW-KfaduAOyfiSqt5SY,63
+proximl-0.5.12.dist-info/top_level.txt,sha256=-TWqc9tAaxmWmW4c7uYsmzPEYUIoh6z02xxqPbv7Kys,23
+proximl-0.5.12.dist-info/RECORD,,

tests/integration/projects/test_projects_credentials_integration.py

@@ -0,0 +1,45 @@
+import re
+import sys
+import asyncio
+from pytest import mark, fixture
+
+pytestmark = [mark.sdk, mark.integration, mark.projects]
+
+
+@mark.create
+@mark.asyncio
+class ProjectCredentialsTests:
+    @fixture(scope="class")
+    async def project_credential(self, project):
+        project_credential = await project.credentials.put(
+            type="aws", key_id="ASFHALKF", secret="IUHKLHKAHF"
+        )
+        yield project_credential
+        await project.credentials.remove(type="aws")
+
+    async def test_list_project_credentials(self, project, project_credential):
+        credentials = await project.credentials.list()
+        assert len(credentials) > 0
+
+    async def test_project_credential_properties(self, project, project_credential):
+        assert isinstance(project_credential.project_uuid, str)
+        assert isinstance(project_credential.type, str)
+        assert isinstance(project_credential.key_id, str)
+        assert project_credential.type == "aws"
+        assert project.id == project_credential.project_uuid
+
+    async def test_project_credential_str(self, project_credential):
+        string = str(project_credential)
+        regex = r"^{.*\"type\": \"" + project_credential.type + r"\".*}$"
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    async def test_project_credential_repr(self, project_credential):
+        string = repr(project_credential)
+        regex = (
+            r"^ProjectCredential\( proximl , \*\*{.*'type': '"
+            + project_credential.type
+            + r"'.*}\)$"
+        )
+        assert isinstance(string, str)
+        assert re.match(regex, string)

tests/unit/cli/projects/test_cli_project_credential_unit.py

@@ -0,0 +1,26 @@
+import re
+import json
+import click
+from unittest.mock import AsyncMock, patch, create_autospec
+from pytest import mark, fixture, raises
+
+pytestmark = [mark.cli, mark.unit, mark.projects]
+
+from proximl.cli.project import credential as specimen
+from proximl.projects import (
+    Project,
+)
+
+
+def test_list_credentials(runner, mock_project_credentials):
+    with patch("proximl.cli.ProxiML", new=AsyncMock) as mock_proximl:
+        project = create_autospec(Project)
+        mock_proximl.projects = AsyncMock()
+        mock_proximl.projects.get = AsyncMock(return_value=project)
+        mock_proximl.projects.get_current = AsyncMock(return_value=project)
+        project.credentials = AsyncMock()
+        project.credentials.list = AsyncMock(return_value=mock_project_credentials)
+        result = runner.invoke(specimen, ["list"])
+        print(result)
+        assert result.exit_code == 0
+        project.credentials.list.assert_called_once()

tests/unit/projects/test_project_credentials_unit.py

@@ -0,0 +1,100 @@
+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.projects.credentials as specimen
+from proximl.exceptions import (
+    ApiError,
+    SpecificationError,
+    ProxiMLException,
+)
+
+pytestmark = [mark.sdk, mark.unit, mark.projects]
+
+
+@fixture
+def project_credentials(mock_proximl):
+    yield specimen.ProjectCredentials(mock_proximl, project_id="1")
+
+
+@fixture
+def project_credential(mock_proximl):
+    yield specimen.ProjectCredential(
+        mock_proximl, project_uuid="proj-id-1", type="aws", key_id="AIYHGFSDLK"
+    )
+
+
+class ProjectCredentialsTests:
+    @mark.asyncio
+    async def test_project_credentials_list(self, project_credentials, mock_proximl):
+        api_response = [
+            {"project_uuid": "proj-id-1", "type": "aws", "key_id": "AIYHGFSDLK"},
+            {"project_uuid": "proj-id-1", "type": "gcp", "key_id": "credentials.json"},
+        ]
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        resp = await project_credentials.list()
+        mock_proximl._query.assert_called_once_with(
+            "/project/1/credentials", "GET", dict()
+        )
+        assert len(resp) == 2
+
+    @mark.asyncio
+    async def test_remove_project_credential(
+        self,
+        project_credentials,
+        mock_proximl,
+    ):
+        api_response = dict()
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        await project_credentials.remove("aws")
+        mock_proximl._query.assert_called_once_with(
+            "/project/1/credential/aws", "DELETE", dict()
+        )
+
+    @mark.asyncio
+    async def test_put_project_credential(self, project_credentials, mock_proximl):
+        requested_config = dict(type="aws", key_id="AIUDHADA", secret="ASKHJSLKF")
+        expected_payload = dict(key_id="AIUDHADA", secret="ASKHJSLKF")
+        api_response = {
+            "project_uuid": "project-id-1",
+            "type": "aws",
+            "key_id": "AIUDHADA",
+        }
+
+        mock_proximl._query = AsyncMock(return_value=api_response)
+        response = await project_credentials.put(**requested_config)
+        mock_proximl._query.assert_called_once_with(
+            "/project/1/credential/aws", "PUT", None, expected_payload
+        )
+        assert response.type == "aws"
+
+
+class ProjectCredentialTests:
+    def test_project_credential_properties(self, project_credential):
+        assert isinstance(project_credential.type, str)
+        assert isinstance(project_credential.key_id, str)
+        assert isinstance(project_credential.project_uuid, str)
+
+    def test_project_credential_str(self, project_credential):
+        string = str(project_credential)
+        regex = r"^{.*\"type\": \"" + project_credential.type + r"\".*}$"
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_project_credential_repr(self, project_credential):
+        string = repr(project_credential)
+        regex = (
+            r"^ProjectCredential\( proximl , \*\*{.*'type': '"
+            + project_credential.type
+            + r"'.*}\)$"
+        )
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_project_credential_bool(self, project_credential, mock_proximl):
+        empty_project_credential = specimen.ProjectCredential(mock_proximl)
+        assert bool(project_credential)
+        assert not bool(empty_project_credential)