mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
Evan Mattson
46f5ea15a2
### Motivation and Context SK Python is tightly coupled to the use of a `.env` file to read all secrets, keys, endpoints, and more. This doesn't scale well for users who wish to be able to use environment variables with their SK Applications. By introducing Pydantic Settings, it is possible to use both environment variables as well as have a fall-back to a `.env` file (via a `env_file_path` parameter), if desired. By introducing Pydantic Settings, we are removing the requirement to have to create Text/Embedding/Chat completion objects with an `api_key` or other previously required information (in the case of AzureChatCompletion that means an `endpoint`, an `api_key`, a `deployment_name`, and an `api_version`). When the AI connector is created, the Pydantic settings are loaded either via env vars or the fall-back `.env` file, and that means the user can create a chat completion object like: ```python chat_completion = OpenAIChatCompletion(service_id="test") ``` or, to optionally override the `ai_model_id` env var: ```python chat_completion = OpenAIChatCompletion(service_id="test", ai_model_id="gpt-4-1106") ``` Note: we have left the ability to specific an `api_key`/`org_id` for `OpenAIChatCompletion` or a `deployment_name`, `endpoint`, `base_url`, and `api_version` for `AzureChatCompletion` as before, but if your settings are configured to use env vars/.env file then there is no need to pass this information. <!-- 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. --> ### Description The PR introduces the use of Pydantic settings and removes the use of the python-dotenv library. - Closes #1779 - Updates notebooks, samples, code and tests to remove the explicit config of api_key or other previous .env files values. - Adds new unit test config using monkeypatch to simulate env variables for testing - All unit and integration tests passing <!-- 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 😄
230 lines
9.2 KiB
YAML
230 lines
9.2 KiB
YAML
#
|
|
# This workflow will run all python integrations tests.
|
|
#
|
|
|
|
name: Python Integration Tests
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
pull_request:
|
|
branches: ["main"]
|
|
merge_group:
|
|
branches: ["main"]
|
|
schedule:
|
|
- cron: "0 0 * * *" # Run at midnight UTC daily
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
paths-filter:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
pythonChanges: ${{ steps.filter.outputs.python}}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: dorny/paths-filter@v2
|
|
id: filter
|
|
with:
|
|
filters: |
|
|
python:
|
|
- 'python/**'
|
|
# run only if 'python' files were changed
|
|
- name: python tests
|
|
if: steps.filter.outputs.python == 'true'
|
|
run: echo "Python file"
|
|
# run only if not 'python' files were changed
|
|
- name: not python tests
|
|
if: steps.filter.outputs.python != 'true'
|
|
run: echo "NOT python file"
|
|
|
|
python-merge-gate:
|
|
name: Python Pre-Merge Integration Tests
|
|
needs: paths-filter
|
|
if: github.event_name != 'pull_request' && github.event_name != 'schedule' && needs.paths-filter.outputs.pythonChanges == 'true'
|
|
runs-on: ${{ matrix.os }}
|
|
strategy:
|
|
max-parallel: 1
|
|
fail-fast: false
|
|
matrix:
|
|
python-version: ["3.11"]
|
|
os: [ubuntu-latest]
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Install poetry
|
|
run: pipx install poetry
|
|
- name: Set up Python ${{ matrix.python-version }}
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
cache: "poetry"
|
|
- name: Install dependencies with hnswlib native disabled
|
|
if: matrix.os == 'macos-latest' && matrix.python-version == '3.11'
|
|
run: |
|
|
export HNSWLIB_NO_NATIVE=1
|
|
python -m pip install --upgrade pip setuptools wheel
|
|
cd python && poetry install --with tests
|
|
- name: Install dependencies with hnswlib native enabled
|
|
if: matrix.os != 'macos-latest' || matrix.python-version != '3.11'
|
|
run: |
|
|
python -m pip install --upgrade pip setuptools wheel
|
|
cd python
|
|
poetry install --with tests
|
|
- name: Run Integration Tests
|
|
id: run_tests
|
|
shell: bash
|
|
env: # Set Azure credentials secret as an input
|
|
HNSWLIB_NO_NATIVE: 1
|
|
Python_Integration_Tests: Python_Integration_Tests
|
|
AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME }} # azure-text-embedding-ada-002
|
|
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
|
|
AZURE_OPENAI_TEXT_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_TEXT_DEPLOYMENT_NAME }}
|
|
AZURE_OPENAI_API_VERSION: ${{ vars.AZURE_OPENAI_API_VERSION }}
|
|
AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT }}
|
|
AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
|
|
BING_API_KEY: ${{ secrets.BING_API_KEY }}
|
|
OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI_CHAT_MODEL_ID }}
|
|
OPENAI_TEXT_MODEL_ID: ${{ vars.OPENAI_TEXT_MODEL_ID }}
|
|
OPENAI_EMBEDDING_MODEL_ID: ${{ vars.OPENAI_EMBEDDING_MODEL_ID }}
|
|
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
|
PINECONE_API_KEY: ${{ secrets.PINECONE__APIKEY }}
|
|
POSTGRES_CONNECTION_STRING: ${{secrets.POSTGRES__CONNECTIONSTR}}
|
|
AZURE_AI_SEARCH_API_KEY: ${{secrets.AZURE_AI_SEARCH_API_KEY}}
|
|
AZURE_AI_SEARCH_ENDPOINT: ${{secrets.AZURE_AI_SEARCH_ENDPOINT}}
|
|
MONGODB_ATLAS_CONNECTION_STRING: ${{secrets.MONGODB_ATLAS_CONNECTION_STRING}}
|
|
run: |
|
|
if ${{ matrix.os == 'ubuntu-latest' }}; then
|
|
docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
|
|
fi
|
|
|
|
cd python
|
|
poetry run pytest ./tests/integration -v
|
|
|
|
python-integration-tests:
|
|
needs: paths-filter
|
|
if: (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') && needs.paths-filter.outputs.pythonChanges == 'true'
|
|
runs-on: ${{ matrix.os }}
|
|
strategy:
|
|
max-parallel: 1
|
|
fail-fast: false
|
|
matrix:
|
|
python-version: ["3.10", "3.11", "3.12"]
|
|
os: [ubuntu-latest, windows-latest, macos-latest]
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Install poetry
|
|
run: pipx install poetry
|
|
- name: Set up Python ${{ matrix.python-version }}
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
cache: "poetry"
|
|
- name: Install dependencies with hnswlib native disabled
|
|
if: matrix.os == 'macos-latest' && matrix.python-version == '3.11'
|
|
run: |
|
|
export HNSWLIB_NO_NATIVE=1
|
|
python -m pip install --upgrade pip setuptools wheel
|
|
cd python && poetry install --with tests
|
|
|
|
- name: Install dependencies with hnswlib native enabled
|
|
if: matrix.os != 'macos-latest' || matrix.python-version != '3.11'
|
|
run: |
|
|
python -m pip install --upgrade pip setuptools wheel
|
|
cd python && poetry install --with tests
|
|
|
|
- name: Run Integration Tests
|
|
id: run_tests
|
|
shell: bash
|
|
env: # Set Azure credentials secret as an input
|
|
HNSWLIB_NO_NATIVE: 1
|
|
Python_Integration_Tests: Python_Integration_Tests
|
|
AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME }} # azure-text-embedding-ada-002
|
|
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
|
|
AZURE_OPENAI_TEXT_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_TEXT_DEPLOYMENT_NAME }}
|
|
AZURE_OPENAI_API_VERSION: ${{ vars.AZURE_OPENAI_API_VERSION }}
|
|
AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT }}
|
|
AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
|
|
BING_API_KEY: ${{ secrets.BING_API_KEY }}
|
|
OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI_CHAT_MODEL_ID }}
|
|
OPENAI_TEXT_MODEL_ID: ${{ vars.OPENAI_TEXT_MODEL_ID }}
|
|
OPENAI_EMBEDDING_MODEL_ID: ${{ vars.OPENAI_EMBEDDING_MODEL_ID }}
|
|
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
|
PINECONE_API_KEY: ${{ secrets.PINECONE__APIKEY }}
|
|
POSTGRES_CONNECTION_STRING: ${{secrets.POSTGRES__CONNECTIONSTR}}
|
|
AZURE_AI_SEARCH_API_KEY: ${{secrets.AZURE_AI_SEARCH_API_KEY}}
|
|
AZURE_AI_SEARCH_ENDPOINT: ${{secrets.AZURE_AI_SEARCH_ENDPOINT}}
|
|
MONGODB_ATLAS_CONNECTION_STRING: ${{secrets.MONGODB_ATLAS_CONNECTION_STRING}}
|
|
run: |
|
|
if ${{ matrix.os == 'ubuntu-latest' }}; then
|
|
docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
|
|
fi
|
|
|
|
cd python
|
|
poetry run pytest ./tests/integration -v
|
|
|
|
# This final job is required to satisfy the merge queue. It must only run (or succeed) if no tests failed
|
|
python-integration-tests-check:
|
|
if: always()
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
max-parallel: 1
|
|
fail-fast: false
|
|
needs: [python-merge-gate, python-integration-tests]
|
|
steps:
|
|
- name: Get Date
|
|
shell: bash
|
|
run: |
|
|
echo "date=$(date +'%m/%d/%Y %H:%M:%S')" >> "$GITHUB_ENV"
|
|
|
|
- name: Run Type is Daily
|
|
if: ${{ github.event_name == 'schedule' }}
|
|
shell: bash
|
|
run: |
|
|
echo "run_type=Daily" >> "$GITHUB_ENV"
|
|
|
|
- name: Run Type is Manual
|
|
if: ${{ github.event_name == 'workflow_dispatch' }}
|
|
shell: bash
|
|
run: |
|
|
echo "run_type=Manual" >> "$GITHUB_ENV"
|
|
|
|
- name: Run Type is ${{ github.event_name }}
|
|
if: ${{ github.event_name != 'schedule' && github.event_name != 'workflow_dispatch'}}
|
|
shell: bash
|
|
run: |
|
|
echo "run_type=${{ github.event_name }}" >> "$GITHUB_ENV"
|
|
|
|
- name: Fail workflow if tests failed
|
|
id: check_tests_failed
|
|
if: contains(join(needs.*.result, ','), 'failure')
|
|
uses: actions/github-script@v6
|
|
with:
|
|
script: core.setFailed('Integration Tests Failed!')
|
|
|
|
- name: Fail workflow if tests cancelled
|
|
id: check_tests_cancelled
|
|
if: contains(join(needs.*.result, ','), 'cancelled')
|
|
uses: actions/github-script@v6
|
|
with:
|
|
script: core.setFailed('Integration Tests Cancelled!')
|
|
|
|
- name: Microsoft Teams Notification
|
|
uses: skitionek/notify-microsoft-teams@master
|
|
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
|
|
with:
|
|
webhook_url: ${{ secrets.MSTEAMS_WEBHOOK }}
|
|
dry_run: ${{ env.run_type != 'Daily' && env.run_type != 'Manual'}}
|
|
job: ${{ toJson(job) }}
|
|
steps: ${{ toJson(steps) }}
|
|
overwrite: "{title: ` ${{ env.run_type }}: ${{ env.date }} `, text: ` ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`}"
|
|
|
|
- name: Microsoft Teams Notification (Dry Run)
|
|
uses: skitionek/notify-microsoft-teams@master
|
|
if: github.ref != 'refs/heads/main'
|
|
with:
|
|
webhook_url: NONE
|
|
dry_run: ${{ env.run_type != 'Daily' && env.run_type != 'Manual'}}
|
|
job: ${{ toJson(job) }}
|
|
steps: ${{ toJson(steps) }}
|
|
overwrite: "{title: ` ${{ env.run_type }}: ${{ env.date }} `, text: ` ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`}"
|