Skip to content

Allow for async refresh_api_key_hook methods. #359

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Allow for async refresh_api_key_hook methods. #359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions kubernetes_asyncio/client/api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ async def __call_api(
post_params.extend(self.files_parameters(files))

# auth setting
self.update_params_for_auth(
await self.update_params_for_auth(
header_params, query_params, auth_settings,
request_auth=_request_auth)

Expand Down Expand Up @@ -548,7 +548,7 @@ def select_header_content_type(self, content_types, method=None, body=None):
else:
return content_types[0]

def update_params_for_auth(self, headers, queries, auth_settings,
async def update_params_for_auth(self, headers, queries, auth_settings,
request_auth=None):
"""Updates header and query params based on authentication setting.

Expand All @@ -566,7 +566,7 @@ def update_params_for_auth(self, headers, queries, auth_settings,
return

for auth in auth_settings:
auth_setting = self.configuration.auth_settings().get(auth)
auth_setting = (await self.configuration.auth_settings()).get(auth)
if auth_setting:
self._apply_auth_params(headers, queries, auth_setting)

Expand Down
11 changes: 7 additions & 4 deletions kubernetes_asyncio/client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

from __future__ import absolute_import

import asyncio
import copy
import logging
import sys
Expand Down Expand Up @@ -370,15 +371,17 @@ def logger_format(self, value):
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)

def get_api_key_with_prefix(self, identifier, alias=None):
async def get_api_key_with_prefix(self, identifier, alias=None):
"""Gets API key (with prefix if set).

:param identifier: The identifier of apiKey.
:param alias: The alternative identifier of apiKey.
:return: The token for api key authentication.
"""
if self.refresh_api_key_hook is not None:
self.refresh_api_key_hook(self)
result = self.refresh_api_key_hook(self)
if asyncio.iscoroutine(result):
await result
key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
if key:
prefix = self.api_key_prefix.get(identifier)
Expand All @@ -402,7 +405,7 @@ def get_basic_auth_token(self):
basic_auth=username + ':' + password
).get('authorization')

def auth_settings(self):
async def auth_settings(self):
"""Gets Auth Settings dict for api client.

:return: The Auth Settings information dict.
Expand All @@ -413,7 +416,7 @@ def auth_settings(self):
'type': 'api_key',
'in': 'header',
'key': 'authorization',
'value': self.get_api_key_with_prefix(
'value': await self.get_api_key_with_prefix(
'BearerToken',
),
}
Expand Down
16 changes: 8 additions & 8 deletions kubernetes_asyncio/config/incluster_config_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,29 +99,29 @@ def test_load_config(self):
self.assertEqual(cert_filename, loader.ssl_ca_cert)
self.assertEqual('Bearer ' + _TEST_TOKEN, loader.token)

def test_refresh_token(self):
async def test_refresh_token(self):
loader = self.get_test_loader()
config = Configuration()
loader.load_and_set(config)

self.assertEqual('Bearer ' + _TEST_TOKEN,
config.get_api_key_with_prefix('BearerToken'))
await config.get_api_key_with_prefix('BearerToken'))
self.assertEqual('Bearer ' + _TEST_TOKEN, loader.token)
self.assertIsNotNone(loader.token_expires_at)

old_token_expires_at = loader.token_expires_at
loader._token_filename = self._create_file_with_temp_content(
_TEST_NEW_TOKEN)
self.assertEqual('Bearer ' + _TEST_TOKEN,
config.get_api_key_with_prefix('BearerToken'))
await config.get_api_key_with_prefix('BearerToken'))

loader.token_expires_at = datetime.datetime.now()
self.assertEqual('Bearer ' + _TEST_NEW_TOKEN,
config.get_api_key_with_prefix('BearerToken'))
await config.get_api_key_with_prefix('BearerToken'))
self.assertEqual('Bearer ' + _TEST_NEW_TOKEN, loader.token)
self.assertGreater(loader.token_expires_at, old_token_expires_at)

def test_refresh_token_default_config_with_copies(self):
async def test_refresh_token_default_config_with_copies(self):
loader = self.get_test_loader()
loader.load_and_set()

Expand All @@ -132,7 +132,7 @@ def test_refresh_token_default_config_with_copies(self):

for config in configs:
self.assertEqual('Bearer ' + _TEST_TOKEN,
config.get_api_key_with_prefix('BearerToken'))
await config.get_api_key_with_prefix('BearerToken'))
self.assertEqual('Bearer ' + _TEST_TOKEN, loader.token)
self.assertIsNotNone(loader.token_expires_at)

Expand All @@ -142,13 +142,13 @@ def test_refresh_token_default_config_with_copies(self):

for config in configs:
self.assertEqual('Bearer ' + _TEST_TOKEN,
config.get_api_key_with_prefix('BearerToken'))
await config.get_api_key_with_prefix('BearerToken'))

loader.token_expires_at = datetime.datetime.now()

for config in configs:
self.assertEqual('Bearer ' + _TEST_NEW_TOKEN,
config.get_api_key_with_prefix('BearerToken'))
await config.get_api_key_with_prefix('BearerToken'))

self.assertEqual('Bearer ' + _TEST_NEW_TOKEN, loader.token)
self.assertGreater(loader.token_expires_at, old_token_expires_at)
Expand Down