Skip to content

fix docs tests gateway endpoint #475

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

Merged
saiatmakuri merged 3 commits into from
Mar 20, 2024
Merged

fix docs tests gateway endpoint #475

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
903a385
fix docs tests gateway endpoint
saiatmakuri Mar 20, 2024
ffb3808
update comments
saiatmakuri Mar 20, 2024
583ca09
delete docs endpoints after test
saiatmakuri Mar 20, 2024
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
35 changes: 30 additions & 5 deletions integration_tests/test_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,16 @@
import pytest
from _pytest.assertion.rewrite import AssertionRewritingHook

from .rest_api_utils import (
BASE_PATH,
SERVICE_IDENTIFIER,
delete_existing_endpoints,
ensure_gateway_ready,
)

ROOT_DIR = Path(__file__).parent.parent

TEST_SKIP_MAGIC_STRING = "# test='skip'"
SERVICE_IDENTIFIER = os.environ.get("SERVICE_IDENTIFIER", "")


@pytest.fixture
Expand Down Expand Up @@ -56,11 +62,17 @@ def integration_test_user_id() -> str:


def modify_source(source: str) -> str:
# Adds some custom logic to update code from docs to comply with some requirements.
source = re.sub(r"('team'|\"team\"): ('\w+'|\"\w+\")", r"'team': 'infra'", source)
"""Modify the source code from docs to be compatible with the integration tests."""

# Ensure the correct base path is used
source = re.sub(
r"('product'|\"product\"): ('\w+'|\"\w+\")",
r"'product': 'launch-integration-test'",
r"get_launch_client\((.*)\)\n",
rf'get_launch_client(\g<1>, gateway_endpoint="{BASE_PATH}")\n',
source,
)
source = re.sub(
r"LaunchClient\((.*)\)\n",
rf'LaunchClient(\g<1>, endpoint="{BASE_PATH}")\n',
source,
)

Expand All @@ -81,6 +93,15 @@ def modify_source(source: str) -> str:
source,
)

# Set particular tag values for cost tracking
source = re.sub(r"('team'|\"team\"): ('\w+'|\"\w+\")", r"'team': 'infra'", source)
source = re.sub(
r"('product'|\"product\"): ('\w+'|\"\w+\")",
r"'product': 'launch-integration-test'",
source,
)

# Fill in empty values in docs
source = re.sub(r'"repository": "..."', '"repository": "launch_rearch"', source)
source = re.sub(
r'"tag": "..."', '"tag": "11d9d42047cc9a0c6435b19e5e91bc7e0ad31efc-cpu"', source
Expand Down Expand Up @@ -203,7 +224,11 @@ def test_docs_examples(

env("LAUNCH_API_KEY", os.getenv("LAUNCH_TEST_API_KEY", integration_test_user_id))

ensure_gateway_ready()

try:
import_execute(module_name, source_code, True)
except Exception:
raise
finally:
delete_existing_endpoints()