Skip to content

Commit

Permalink
[#5880] feat(python): support OSSSecretKeyCredential for python client (
Browse files Browse the repository at this point in the history
#5890)

### What changes were proposed in this pull request?

It adds support for OSSSecretKeyCredential for the Python client by
implementing it, updating CredentialFactory to create instances of it,
and adding corresponding unit tests in TestCredentialFactory.

### Why are the changes needed?

These changes are necessary to support authentication using OSS
credentials and to allow the CredentialFactory to generate OSS
credentials correctly. It ensures proper functionality and integration.


Fix: #5880 

### Does this PR introduce _any_ user-facing change?
No


### How was this patch tested?

Unit tests were created to test the new OSSSecretKeyCredential class,
verifying its functionality and integration with the CredentialFactory.
  • Loading branch information
deeshantk authored Dec 17, 2024
1 parent cb66b9b commit 4daf9d1
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

from abc import ABC
from typing import Dict

from gravitino.api.credential.credential import Credential
from gravitino.utils.precondition import Precondition


class OSSSecretKeyCredential(Credential, ABC):
"""Represents OSS secret key credential."""

OSS_SECRET_KEY_CREDENTIAL_TYPE: str = "oss-secret-key"
_GRAVITINO_OSS_STATIC_ACCESS_KEY_ID: str = "oss-access-key-id"
_GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY: str = "oss-secret-access-key"

def __init__(self, credential_info: Dict[str, str], expire_time_in_ms: int):
self._access_key_id = credential_info[self._GRAVITINO_OSS_STATIC_ACCESS_KEY_ID]
self._secret_access_key = credential_info[
self._GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY
]
Precondition.check_string_not_empty(
self._access_key_id, "The OSS access key ID should not be empty"
)
Precondition.check_string_not_empty(
self._secret_access_key, "The OSS secret access key should not be empty"
)
Precondition.check_argument(
expire_time_in_ms == 0,
"The expiration time of OSS secret key credential should be 0",
)

def credential_type(self) -> str:
"""Returns the type of the credential.
Returns:
The type of the credential.
"""
return self.OSS_SECRET_KEY_CREDENTIAL_TYPE

def expire_time_in_ms(self) -> int:
"""Returns the expiration time of the credential in milliseconds since
the epoch, 0 means it will never expire.
Returns:
The expiration time of the credential.
"""
return 0

def credential_info(self) -> Dict[str, str]:
"""The credential information.
Returns:
The credential information.
"""
return {
self._GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY: self._secret_access_key,
self._GRAVITINO_OSS_STATIC_ACCESS_KEY_ID: self._access_key_id,
}

def access_key_id(self) -> str:
"""The OSS access key ID.
Returns:
The OSS access key ID.
"""
return self._access_key_id

def secret_access_key(self) -> str:
"""The OSS secret access key.
Returns:
The OSS secret access key.
"""
return self._secret_access_key
3 changes: 3 additions & 0 deletions clients/client-python/gravitino/utils/credential_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
from gravitino.api.credential.oss_token_credential import OSSTokenCredential
from gravitino.api.credential.s3_secret_key_credential import S3SecretKeyCredential
from gravitino.api.credential.s3_token_credential import S3TokenCredential
from gravitino.api.credential.oss_secret_key_credential import OSSSecretKeyCredential


class CredentialFactory:
Expand All @@ -36,4 +37,6 @@ def create(
return GCSTokenCredential(credential_info, expire_time_in_ms)
if credential_type == OSSTokenCredential.OSS_TOKEN_CREDENTIAL_TYPE:
return OSSTokenCredential(credential_info, expire_time_in_ms)
if credential_type == OSSSecretKeyCredential.OSS_SECRET_KEY_CREDENTIAL_TYPE:
return OSSSecretKeyCredential(credential_info, expire_time_in_ms)
raise NotImplementedError(f"Credential type {credential_type} is not supported")
17 changes: 17 additions & 0 deletions clients/client-python/tests/unittests/test_credential_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
from gravitino.api.credential.s3_secret_key_credential import S3SecretKeyCredential
from gravitino.api.credential.s3_token_credential import S3TokenCredential
from gravitino.utils.credential_factory import CredentialFactory
from gravitino.api.credential.oss_secret_key_credential import OSSSecretKeyCredential


class TestCredentialFactory(unittest.TestCase):
Expand Down Expand Up @@ -99,3 +100,19 @@ def test_oss_token_credential(self):
self.assertEqual("access_id", check_credential.access_key_id())
self.assertEqual("secret_key", check_credential.secret_access_key())
self.assertEqual(1000, check_credential.expire_time_in_ms())

def test_oss_secret_key_credential(self):
oss_credential_info = {
OSSSecretKeyCredential._GRAVITINO_OSS_STATIC_ACCESS_KEY_ID: "access_key",
OSSSecretKeyCredential._GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY: "secret_key",
}
oss_credential = OSSSecretKeyCredential(oss_credential_info, 0)
credential_info = oss_credential.credential_info()
expire_time = oss_credential.expire_time_in_ms()

check_credential = CredentialFactory.create(
oss_credential.OSS_SECRET_KEY_CREDENTIAL_TYPE, credential_info, expire_time
)
self.assertEqual("access_key", check_credential.access_key_id())
self.assertEqual("secret_key", check_credential.secret_access_key())
self.assertEqual(0, check_credential.expire_time_in_ms())

0 comments on commit 4daf9d1

Please sign in to comment.