trainml 0.5.11__tar.gz → 0.5.13__tar.gz

{trainml-0.5.11 → trainml-0.5.13}/PKG-INFO

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

{trainml-0.5.11 → trainml-0.5.13}/tests/integration/projects/conftest.py

@@ -4,7 +4,7 @@ from pytest import fixture
 @fixture(scope="module")
 async def project(trainml):
     project = await trainml.projects.create(
-        name="New Project", copy_keys=False, copy_secrets=False
+        name="New Project", copy_credentials=False, copy_secrets=False
     )
     yield project
     await project.remove()

trainml-0.5.13/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\( trainml , \*\*{.*'type': '"
+            + project_credential.type
+            + r"'.*}\)$"
+        )
+        assert isinstance(string, str)
+        assert re.match(regex, string)

{trainml-0.5.11 → trainml-0.5.13}/tests/integration/projects/test_projects_secrets_integration.py

@@ -17,7 +17,7 @@ class ProjectSecretsTests:
         yield project_secret
         await project.secrets.remove(name="secret_value")
 
-    async def test_list_project_keys(self, project, project_secret):
+    async def test_list_project_secrets(self, project, project_secret):
         secrets = await project.secrets.list()
         assert len(secrets) > 0
 

{trainml-0.5.11 → trainml-0.5.13}/tests/integration/test_jobs_integration.py

@@ -175,7 +175,7 @@ class JobAPIResourceValidationTests:
                 disk_size=10,
             )
         assert (
-            "Invalid Request - None (CPU Only) may be not be combined with other GPU Types"
+            "Invalid Request - CPU Only may be not be combined with other GPU Types"
             in error.value.message
         )
 

trainml-0.5.11/tests/unit/cli/projects/test_cli_project_key_unit.py → trainml-0.5.13/tests/unit/cli/projects/test_cli_project_credential_unit.py

@@ -6,21 +6,21 @@ from pytest import mark, fixture, raises
 
 pytestmark = [mark.cli, mark.unit, mark.projects]
 
-from trainml.cli.project import key as specimen
+from trainml.cli.project import credential as specimen
 from trainml.projects import (
     Project,
 )
 
 
-def test_list_keys(runner, mock_project_keys):
+def test_list_credentials(runner, mock_project_credentials):
     with patch("trainml.cli.TrainML", new=AsyncMock) as mock_trainml:
         project = create_autospec(Project)
         mock_trainml.projects = AsyncMock()
         mock_trainml.projects.get = AsyncMock(return_value=project)
         mock_trainml.projects.get_current = AsyncMock(return_value=project)
-        project.keys = AsyncMock()
-        project.keys.list = AsyncMock(return_value=mock_project_keys)
+        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.keys.list.assert_called_once()
+        project.credentials.list.assert_called_once()

{trainml-0.5.11 → trainml-0.5.13}/tests/unit/conftest.py

@@ -20,7 +20,7 @@ from trainml.projects import (
 from trainml.projects.datastores import ProjectDatastores, ProjectDatastore
 from trainml.projects.services import ProjectServices, ProjectService
 from trainml.projects.data_connectors import ProjectDataConnectors, ProjectDataConnector
-from trainml.projects.keys import ProjectKeys, ProjectKey
+from trainml.projects.credentials import ProjectCredentials, ProjectCredential
 from trainml.projects.secrets import ProjectSecrets, ProjectSecret
 
 from trainml.cloudbender import Cloudbender
@@ -532,7 +532,7 @@ def mock_jobs():
                         {"value": "env1val", "key": "env1"},
                         {"value": "env2val", "key": "env2"},
                     ],
-                    "worker_key_types": ["aws", "gcp"],
+                    "credentials": ["aws", "gcp"],
                     "status": "new",
                 },
                 "vpn": {
@@ -609,7 +609,7 @@ def mock_jobs():
                     "type": "DEEPLEARNING_PY37",
                     "image_size": 39656398629,
                     "env": [],
-                    "worker_key_types": [],
+                    "credentials": [],
                     "status": "ready",
                 },
                 "vpn": {
@@ -1043,10 +1043,10 @@ def mock_device_configs():
 @fixture(
     scope="session",
 )
-def mock_project_keys():
+def mock_project_credentials():
     trainml = Mock()
     yield [
-        ProjectKey(
+        ProjectCredential(
             trainml,
             **{
                 "project_uuid": "proj-id-1",
@@ -1055,7 +1055,7 @@ def mock_project_keys():
                 "updatedAt": "2023-06-02T21:22:40.084Z",
             },
         ),
-        ProjectKey(
+        ProjectCredential(
             trainml,
             **{
                 "project_uuid": "proj-id-1",
@@ -1117,7 +1117,7 @@ def mock_trainml(
     mock_project_datastores,
     mock_project_services,
     mock_project_data_connectors,
-    mock_project_keys,
+    mock_project_credentials,
     mock_project_secrets,
 ):
     trainml = create_autospec(TrainML)
@@ -1150,8 +1150,8 @@ def mock_trainml(
     trainml.projects.data_connectors.list = AsyncMock(
         return_value=mock_project_data_connectors
     )
-    trainml.projects.keys = create_autospec(ProjectKeys)
-    trainml.projects.keys.list = AsyncMock(return_value=mock_project_keys)
+    trainml.projects.credentials = create_autospec(ProjectCredentials)
+    trainml.projects.credentials.list = AsyncMock(return_value=mock_project_credentials)
     trainml.projects.secrets = create_autospec(ProjectSecrets)
     trainml.projects.secrets.list = AsyncMock(return_value=mock_project_secrets)
 

trainml-0.5.13/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 trainml.projects.credentials as specimen
+from trainml.exceptions import (
+    ApiError,
+    SpecificationError,
+    TrainMLException,
+)
+
+pytestmark = [mark.sdk, mark.unit, mark.projects]
+
+
+@fixture
+def project_credentials(mock_trainml):
+    yield specimen.ProjectCredentials(mock_trainml, project_id="1")
+
+
+@fixture
+def project_credential(mock_trainml):
+    yield specimen.ProjectCredential(
+        mock_trainml, project_uuid="proj-id-1", type="aws", key_id="AIYHGFSDLK"
+    )
+
+
+class ProjectCredentialsTests:
+    @mark.asyncio
+    async def test_project_credentials_list(self, project_credentials, mock_trainml):
+        api_response = [
+            {"project_uuid": "proj-id-1", "type": "aws", "key_id": "AIYHGFSDLK"},
+            {"project_uuid": "proj-id-1", "type": "gcp", "key_id": "credentials.json"},
+        ]
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        resp = await project_credentials.list()
+        mock_trainml._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_trainml,
+    ):
+        api_response = dict()
+        mock_trainml._query = AsyncMock(return_value=api_response)
+        await project_credentials.remove("aws")
+        mock_trainml._query.assert_called_once_with(
+            "/project/1/credential/aws", "DELETE", dict()
+        )
+
+    @mark.asyncio
+    async def test_put_project_credential(self, project_credentials, mock_trainml):
+        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_trainml._query = AsyncMock(return_value=api_response)
+        response = await project_credentials.put(**requested_config)
+        mock_trainml._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\( trainml , \*\*{.*'type': '"
+            + project_credential.type
+            + r"'.*}\)$"
+        )
+        assert isinstance(string, str)
+        assert re.match(regex, string)
+
+    def test_project_credential_bool(self, project_credential, mock_trainml):
+        empty_project_credential = specimen.ProjectCredential(mock_trainml)
+        assert bool(project_credential)
+        assert not bool(empty_project_credential)

{trainml-0.5.11 → trainml-0.5.13}/tests/unit/projects/test_projects_unit.py

@@ -75,7 +75,7 @@ class ProjectsTests:
         requested_config = dict(
             name="new project",
         )
-        expected_payload = dict(name="new project", copy_keys=False, copy_secrets=False)
+        expected_payload = dict(name="new project", copy_credentials=False)
         api_response = {
             "id": "project-id-1",
             "name": "new project",

{trainml-0.5.11 → trainml-0.5.13}/trainml/__init__.py

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

{trainml-0.5.11 → trainml-0.5.13}/trainml/cli/job/create.py

@@ -172,12 +172,12 @@ def create(config):
     help="Conda packages to install as a comma separated list 'p1,\"p2=v2\",p3'",
 )
 @click.option(
-    "--key",
+    "--credential",
     type=click.Choice(
         ["aws", "gcp", "kaggle", "azure", "wasabi"],
         case_sensitive=False,
     ),
-    help="Third Party Keys to add to the job environment",
+    help="Third Party Credentials to add to the job environment",
     multiple=True,
 )
 @click.option(
@@ -221,7 +221,7 @@ def notebook(
     environment,
     custom_image,
     env,
-    key,
+    credential,
     apt_packages,
     pip_packages,
     conda_packages,
@@ -254,7 +254,7 @@ def notebook(
         data=dict(datasets=datasets),
         model=dict(checkpoints=checkpoints),
         environment=dict(
-            worker_key_types=[k for k in key],
+            credentials=[k for k in credential],
         ),
     )
 
@@ -500,12 +500,12 @@ def notebook(
     multiple=True,
 )
 @click.option(
-    "--key",
+    "--credential",
     type=click.Choice(
         ["aws", "gcp", "kaggle", "azure", "wasabi"],
         case_sensitive=False,
     ),
-    help="Third Party Keys to add to the job environment",
+    help="Third Party Credentials to add to the job environment",
     multiple=True,
 )
 @click.option(
@@ -563,7 +563,7 @@ def training(
     environment,
     custom_image,
     env,
-    key,
+    credential,
     apt_packages,
     pip_packages,
     conda_packages,
@@ -596,7 +596,7 @@ def training(
         data=dict(datasets=datasets),
         model=dict(checkpoints=checkpoints),
         environment=dict(
-            worker_key_types=[k for k in key],
+            credentials=[k for k in credential],
         ),
     )
 
@@ -844,12 +844,12 @@ def training(
     multiple=True,
 )
 @click.option(
-    "--key",
+    "--credential",
     type=click.Choice(
         ["aws", "gcp", "kaggle", "azure", "wasabi"],
         case_sensitive=False,
     ),
-    help="Third Party Keys to add to the job environment",
+    help="Third Party Credentials to add to the job environment",
     multiple=True,
 )
 @click.option(
@@ -907,7 +907,7 @@ def inference(
     environment,
     custom_image,
     env,
-    key,
+    credential,
     apt_packages,
     pip_packages,
     conda_packages,
@@ -933,7 +933,7 @@ def inference(
         data=dict(datasets=[]),
         model=dict(checkpoints=checkpoints),
         environment=dict(
-            worker_key_types=[k for k in key],
+            credentials=[k for k in credential],
         ),
     )
 
@@ -1163,12 +1163,12 @@ def from_json(config, attach, connect, file):
     multiple=True,
 )
 @click.option(
-    "--key",
+    "--credential",
     type=click.Choice(
         ["aws", "gcp", "kaggle", "azure", "wasabi"],
         case_sensitive=False,
     ),
-    help="Third Party Keys to add to the job environment",
+    help="Third Party Credentials to add to the job environment",
     multiple=True,
 )
 @click.option(
@@ -1230,7 +1230,7 @@ def endpoint(
     environment,
     custom_image,
     env,
-    key,
+    credential,
     apt_packages,
     pip_packages,
     conda_packages,
@@ -1257,7 +1257,7 @@ def endpoint(
         max_price=max_price,
         model=dict(checkpoints=checkpoints),
         environment=dict(
-            worker_key_types=[k for k in key],
+            credentials=[k for k in credential],
         ),
     )
 

{trainml-0.5.11 → trainml-0.5.13}/trainml/cli/project/__init__.py

@@ -78,7 +78,7 @@ def remove(config, project):
 
 
 from trainml.cli.project.secret import secret
-from trainml.cli.project.key import key
+from trainml.cli.project.credential import credential
 from trainml.cli.project.data_connector import data_connector
 from trainml.cli.project.datastore import datastore
 from trainml.cli.project.service import service

trainml-0.5.11/trainml/cli/project/key.py → trainml-0.5.13/trainml/cli/project/credential.py

@@ -9,15 +9,15 @@ from trainml.cli.project import project
 
 @project.group()
 @pass_config
-def key(config):
-    """trainML project key commands."""
+def credential(config):
+    """trainML project credential commands."""
     pass
 
 
-@key.command()
+@credential.command()
 @pass_config
 def list(config):
-    """List keys."""
+    """List credentials."""
     data = [
         ["TYPE", "KEY ID", "UPDATED AT"],
         [
@@ -27,14 +27,14 @@ def list(config):
         ],
     ]
     project = config.trainml.run(config.trainml.client.projects.get_current())
-    keys = config.trainml.run(project.keys.list())
+    credentials = config.trainml.run(project.credentials.list())
 
-    for key in keys:
+    for credential in credentials:
         data.append(
             [
-                key.type,
-                key.key_id,
-                key.updated_at.isoformat(timespec="seconds"),
+                credential.type,
+                credential.key_id,
+                credential.updated_at.isoformat(timespec="seconds"),
             ]
         )
 
@@ -45,7 +45,7 @@ def list(config):
         )
 
 
-@key.command()
+@credential.command()
 @click.argument(
     "type",
     type=click.Choice(
@@ -65,19 +65,21 @@ def list(config):
 @pass_config
 def put(config, type):
     """
-    Set a key.
+    Set a credential.
 
-    A key is uploaded.
+    A credential is uploaded.
     """
     project = config.trainml.run(config.trainml.client.projects.get_current())
 
     tenant = None
 
     if type in ["aws", "wasabi"]:
-        key_id = click.prompt("Enter the key ID", type=str, hide_input=False)
-        secret = click.prompt("Enter the secret key", type=str, hide_input=True)
+        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":
-        key_id = click.prompt(
+        credential_id = click.prompt(
             "Enter the Application (client) ID", type=str, hide_input=False
         )
         tenant = click.prompt(
@@ -85,7 +87,7 @@ def put(config, type):
         )
         secret = click.prompt("Enter the client secret", type=str, hide_input=True)
     elif type in ["docker", "huggingface"]:
-        key_id = click.prompt("Enter the username", type=str, hide_input=False)
+        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(
@@ -95,30 +97,32 @@ def put(config, type):
             ),
             hide_input=False,
         )
-        key_id = os.path.basename(file_name)
+        credential_id = os.path.basename(file_name)
         with open(file_name) as f:
             secret = json.load(f)
         secret = json.dumps(secret)
     elif type == "ngc":
-        key_id = "$oauthtoken"
+        credential_id = "$oauthtoken"
         secret = click.prompt("Enter the access token", type=str, hide_input=True)
     else:
-        raise click.UsageError("Unsupported key type")
+        raise click.UsageError("Unsupported credential type")
 
     return config.trainml.run(
-        project.keys.put(type=type, key_id=key_id, secret=secret, tenant=tenant)
+        project.credentials.put(
+            type=type, credential_id=credential_id, secret=secret, tenant=tenant
+        )
     )
 
 
-@key.command()
+@credential.command()
 @click.argument("name", type=click.STRING)
 @pass_config
 def remove(config, name):
     """
-    Remove a key.
+    Remove a credential.
 
 
     """
     project = config.trainml.run(config.trainml.client.projects.get_current())
 
-    return config.trainml.run(project.key.remove(name))
+    return config.trainml.run(project.credential.remove(name))

{trainml-0.5.11 → trainml-0.5.13}/trainml/cli/project/secret.py

@@ -1,4 +1,5 @@
 import click
+import os
 from trainml.cli import pass_config
 from trainml.cli.project import project
 
@@ -42,17 +43,25 @@ def list(config):
 
 
 @secret.command()
+@click.option(
+    "--file",
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True),
+    help="Load the secret value from the file at the provided path",
+)
 @click.argument("name", type=click.STRING)
 @pass_config
-def put(config, name):
+def put(config, file, name):
     """
     Set a secret value.
 
     Secret is created with the specified NAME.
     """
     project = config.trainml.run(config.trainml.client.projects.get_current())
-
-    value = click.prompt("Enter the secret value", type=str, hide_input=True)
+    if file:
+        with open(os.path.expanduser(file)) as f:
+            value = f.read()
+    else:
+        value = click.prompt("Enter the secret value", type=str, hide_input=True)
 
     return config.trainml.run(project.secrets.put(name=name, value=value))
 

trainml-0.5.11/trainml/projects/keys.py → trainml-0.5.13/trainml/projects/credentials.py

@@ -4,37 +4,37 @@ from datetime import datetime
 from dateutil import parser, tz
 
 
-class ProjectKeys(object):
+class ProjectCredentials(object):
     def __init__(self, trainml, project_id):
         self.trainml = trainml
         self.project_id = project_id
 
     async def list(self, **kwargs):
         resp = await self.trainml._query(
-            f"/project/{self.project_id}/keys", "GET", kwargs
+            f"/project/{self.project_id}/credentials", "GET", kwargs
         )
-        keys = [ProjectKey(self.trainml, **service) for service in resp]
-        return keys
+        credentials = [ProjectCredential(self.trainml, **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 Key {type}")
+        logging.info(f"Creating Project Credential {type}")
         resp = await self.trainml._query(
-            f"/project/{self.project_id}/key/{type}", "PUT", None, payload
+            f"/project/{self.project_id}/credential/{type}", "PUT", None, payload
         )
-        key = ProjectKey(self.trainml, **resp)
-        logging.info(f"Created Project Key {type} in project {self.project_id}")
+        credential = ProjectCredential(self.trainml, **resp)
+        logging.info(f"Created Project Credential {type} in project {self.project_id}")
 
-        return key
+        return credential
 
     async def remove(self, type, **kwargs):
         await self.trainml._query(
-            f"/project/{self.project_id}/key/{type}", "DELETE", kwargs
+            f"/project/{self.project_id}/credential/{type}", "DELETE", kwargs
         )
 
 
-class ProjectKey:
+class ProjectCredential:
     def __init__(self, trainml, **kwargs):
         self.trainml = trainml
         self._entity = kwargs
@@ -65,7 +65,7 @@ class ProjectKey:
         return json.dumps({k: v for k, v in self._entity.items()})
 
     def __repr__(self):
-        return f"ProjectKey( trainml , **{self._entity.__repr__()})"
+        return f"ProjectCredential( trainml , **{self._entity.__repr__()})"
 
     def __bool__(self):
         return bool(self._type)