Skip to content

added get and set secrets endpoints for python client #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 22, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
added get and set secrets endpoints for python client
  • Loading branch information
zeryx committed Jul 22, 2022
commit 735a817bc30b9a2b41842a3c70d92caeb97cebe0
37 changes: 37 additions & 0 deletions Algorithmia/algorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,43 @@ def set_options(self, timeout=300, stdout=False, output=OutputType.default, **qu
self.query_parameters.update(query_parameters)
return self

def get_algorithm_id(self):
url = "/v1/algorithms/" + self.username + "/" + self.algoname
api_response = self.client.getJsonHelper(url)
if 'id' in api_response:
return api_response['id']
else:
raise Exception("field 'id' not found in response: ", api_response)


def get_secrets(self):
algorithm_id = self.get_algorithm_id()
url = "/v1/algorithms/" + algorithm_id + "/secrets"
api_response = self.client.getJsonHelper(url)
return api_response


def set_secret(self, short_name, secret_key, secret_value, description=None):
algorithm_id = self.get_algorithm_id()
url = "/v1/algorithms/" + algorithm_id + "/secrets"
secret_providers = self.client.get_secret_providers()
provider_id = secret_providers[0]['id']

create_parameters = {
"owner_type": "algorithm",
"owner_id": algorithm_id,
"short_name": short_name,
"provider_id": provider_id,
"secret_key": secret_key,
"secret_value": secret_value,
}
if description:
create_parameters['description'] = description
api_response = self.client.postJsonHelper(url, create_parameters, parse_response_as_json=True)
return api_response



# Create a new algorithm
def create(self, details, settings, version_info=None, source=None, scmsCredentials=None):
url = "/v1/algorithms/" + self.username
Expand Down
5 changes: 5 additions & 0 deletions Algorithmia/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,11 @@ def get_supported_languages(self):
response = self.getHelper(url)
return response.json()

def get_secret_providers(self):
url = "/v1/secret-provider"
api_response = self.getJsonHelper(url)
return api_response

def get_organization_errors(self, org_name):
"""Gets the errors for the organization.

Expand Down
96 changes: 96 additions & 0 deletions Test/api/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -444,3 +444,99 @@ async def get_environments_by_lang(language):
}
]
}


@regular_app.get("/v1/secret-provider")
async def get_service_providers():
return [
{
"id": "dee00b6c-05c4-4de7-98d8-e4a3816ed75f",
"name": "algorithmia_internal_secret_provider",
"description": "Internal Secret Provider",
"moduleName": "module",
"factoryClassName": "com.algorithmia.plugin.sqlsecretprovider.InternalSecretProviderFactory",
"interfaceVersion": "1.0",
"isEnabled": True,
"isDefault": True,
"created": "2021-03-11T20:42:23Z",
"modified": "2021-03-11T20:42:23Z"
}
]


@regular_app.get("/v1/algorithms/{algorithm_id}/secrets")
async def get_secrets_for_algorithm(algorithm_id):
return {
"secrets": [
{
"id": "45e97c47-3ae6-46be-87ee-8ab23746706b",
"short_name": "MLOPS_SERVICE_URL",
"description": "",
"secret_key": "MLOPS_SERVICE_URL",
"owner_type": "algorithm",
"owner_id": "fa2cd80b-d22a-4548-b16a-45dbad2d3499",
"provider_id": "dee00b6c-05c4-4de7-98d8-e4a3816ed75f",
"created": "2022-07-22T14:36:01Z",
"modified": "2022-07-22T14:36:01Z"
},
{
"id": "50dca60e-317f-4582-8854-5b83b4d182d0",
"short_name": "deploy_id",
"description": "",
"secret_key": "DEPLOYMENT_ID",
"owner_type": "algorithm",
"owner_id": "fa2cd80b-d22a-4548-b16a-45dbad2d3499",
"provider_id": "dee00b6c-05c4-4de7-98d8-e4a3816ed75f",
"created": "2022-07-21T19:04:31Z",
"modified": "2022-07-21T19:04:31Z"
},
{
"id": "5a75cdc8-ecc8-4715-8c4b-8038991f1608",
"short_name": "model_path",
"description": "",
"secret_key": "MODEL_PATH",
"owner_type": "algorithm",
"owner_id": "fa2cd80b-d22a-4548-b16a-45dbad2d3499",
"provider_id": "dee00b6c-05c4-4de7-98d8-e4a3816ed75f",
"created": "2022-07-21T19:04:31Z",
"modified": "2022-07-21T19:04:31Z"
},
{
"id": "80e51ed3-f6db-419d-9349-f59f4bbfdcbb",
"short_name": "model_id",
"description": "",
"secret_key": "MODEL_ID",
"owner_type": "algorithm",
"owner_id": "fa2cd80b-d22a-4548-b16a-45dbad2d3499",
"provider_id": "dee00b6c-05c4-4de7-98d8-e4a3816ed75f",
"created": "2022-07-21T19:04:30Z",
"modified": "2022-07-21T19:04:30Z"
},
{
"id": "8773c654-ea2f-4ac5-9ade-55dfc47fec9d",
"short_name": "datarobot_api_token",
"description": "",
"secret_key": "DATAROBOT_MLOPS_API_TOKEN",
"owner_type": "algorithm",
"owner_id": "fa2cd80b-d22a-4548-b16a-45dbad2d3499",
"provider_id": "dee00b6c-05c4-4de7-98d8-e4a3816ed75f",
"created": "2022-07-21T19:04:31Z",
"modified": "2022-07-21T19:04:31Z"
}
]
}


@regular_app.post("/v1/algorithms/{algorithm_id}/secrets")
async def set_algorithm_secret(algorithm_id):
return {
"id":"959af771-7cd8-4981-91c4-70def15bbcdc",
"short_name":"tst",
"description":"",
"secret_key":"test",
"owner_type":"algorithm",
"owner_id":"fa2cd80b-d22a-4548-b16a-45dbad2d3499",
"provider_id":"dee00b6c-05c4-4de7-98d8-e4a3816ed75f",
"created":"2022-07-22T18:28:42Z",
"modified":"2022-07-22T18:28:42Z"
}
15 changes: 15 additions & 0 deletions Test/regular/algo_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ def test_call_customCert(self):
self.assertEquals('binary', result.metadata.content_type)
self.assertEquals(bytearray('foo', 'utf-8'), result.result)



def test_normal_call(self):
result = self.client.algo('quality/echo').pipe("foo")
self.assertEquals("text", result.metadata.content_type)
Expand Down Expand Up @@ -175,6 +177,19 @@ def test_algorithm_programmatic_create_process(self):

self.assertEqual(response['version_info']['semantic_version'], "0.1.0", "information is incorrect")

def test_get_secrets(self):
response = self.client.algo("quality/echo").get_secrets()
self.assertEquals(len(response['secrets']), 5)

def test_set_secret(self):
short_name = "tst"
secret_key = "test_key"
secret_value = "test_value"
description = "loreum epsum"
response = self.client.algo("quality/echo").set_secret(short_name, secret_key, secret_value, description)
self.assertEqual(response['id'], "959af771-7cd8-4981-91c4-70def15bbcdc", "invalid ID for created secret")


else:
class AlgoTest(unittest.TestCase):
def setUp(self):
Expand Down