mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 11:19:56 +00:00
Eduard van Valkenburg
3bab8486f5
### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> added unit tests to up the test coverage across the data folder Also redoes exceptions for everything vector. This does introduce some breaking changes on the exceptions returned by the different methods for vector stores, they are still marked experimental and this will go a long way in moving towards release. Closes #9485 ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [x] The code builds clean without any errors or warnings - [x] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [x] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄
82 lines
3.0 KiB
Python
82 lines
3.0 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
import asyncio
|
|
import logging
|
|
import os
|
|
import platform
|
|
from collections.abc import Awaitable, Callable
|
|
from typing import Any
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
async def retry(
|
|
func: Callable[..., Awaitable[Any]],
|
|
retries: int = 20,
|
|
reset: Callable[..., None] | None = None,
|
|
name: str | None = None,
|
|
):
|
|
"""Retry the function if it raises an exception.
|
|
|
|
Args:
|
|
func (function): The function to retry.
|
|
retries (int): Number of retries.
|
|
reset (function): Function to reset the state of any variables used in the function
|
|
|
|
"""
|
|
logger.info(f"Running {retries} retries with func: {name or func.__module__}")
|
|
for i in range(retries):
|
|
logger.info(f" Try {i + 1} for {name or func.__module__}")
|
|
try:
|
|
if reset:
|
|
reset()
|
|
return await func()
|
|
except Exception as e:
|
|
logger.warning(f" On try {i + 1} got this error: {e}")
|
|
if i == retries - 1: # Last retry
|
|
raise
|
|
# Binary exponential backoff
|
|
backoff = 2**i
|
|
logger.info(f" Sleeping for {backoff} seconds before retrying")
|
|
await asyncio.sleep(backoff)
|
|
return None
|
|
|
|
|
|
def is_service_setup_for_testing(env_var_names: list[str], raise_if_not_set: bool | None = None) -> bool:
|
|
"""Check if the environment variables are set and not empty.
|
|
|
|
Returns True if all the environment variables in the list are set and not empty. Otherwise, returns False.
|
|
This method can also be configured to raise an exception if the environment variables are not set.
|
|
|
|
By default, this function does not raise an exception if the environment variables in the list are not set.
|
|
To raise an exception, set the environment variable `INTEGRATION_TEST_SERVICE_SETUP_EXCEPTION` to `true`,
|
|
or set the `raise_if_not_set` parameter to `True`.
|
|
|
|
On local testing, not raising an exception is useful to avoid the need to set up all services.
|
|
On CI, the environment variables should be set, and the tests should fail if they are not set.
|
|
|
|
Args:
|
|
env_var_names (list[str]): Environment variable names.
|
|
raise_if_not_set (bool | None): Raise an exception if the environment variables are not set.
|
|
"""
|
|
if raise_if_not_set is None:
|
|
raise_if_not_set = os.getenv("INTEGRATION_TEST_SERVICE_SETUP_EXCEPTION", "false").lower() == "true"
|
|
|
|
def does_env_var_exist(env_var_name):
|
|
exist = os.getenv(env_var_name, False)
|
|
if not exist and raise_if_not_set:
|
|
raise KeyError(f"Environment variable {env_var_name} is not set.")
|
|
return exist
|
|
|
|
return all([does_env_var_exist(name) for name in env_var_names])
|
|
|
|
|
|
def is_test_running_on_supported_platforms(platforms: list[str]) -> bool:
|
|
"""Check if the test is running on supported platforms.
|
|
|
|
Args:
|
|
platforms (list[str]): List of supported platforms.
|
|
"""
|
|
|
|
return platform.system() in platforms
|