Skip to content
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

Support Python codegen for the OpenAPI backend #21316

Merged
merged 21 commits into from
Dec 22, 2024
+1,188 −25
Merged

Support Python codegen for the OpenAPI backend #21316

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
e0dd5dd
Copy openapi java stuff
grihabor Aug 10, 2024
14a9762
Implement python codegen
grihabor Aug 11, 2024
4343919
Change package structure
grihabor Aug 17, 2024
f5a3caa
Implement package_mapper
grihabor Aug 17, 2024
22d4f6a
One test works
grihabor Aug 17, 2024
581a51c
Some tests works
grihabor Aug 17, 2024
dc0a03a
Tests pass
grihabor Aug 17, 2024
b9973a3
pants fix
grihabor Aug 17, 2024
4d6eb01
Fix mypy
grihabor Aug 17, 2024
b854cc1
pants fix
grihabor Aug 18, 2024
5899574
Add notes
grihabor Aug 18, 2024
12730a0
Set 2024
grihabor Aug 18, 2024
6006a84
Use itertools.product
grihabor Aug 18, 2024
4e9904e
Update notes
grihabor Aug 18, 2024
ee0a9bc
Update year
grihabor Aug 18, 2024
cc480a7
Revert notes
grihabor Dec 21, 2024
350d3fd
Merge branch 'main' into openapi-python
grihabor Dec 21, 2024
47228fe
Add a test for python-fastapi generator
grihabor Dec 21, 2024
e25726d
Add test_openapi_generator_name_validation
grihabor Dec 21, 2024
3e882ed
Add notes
grihabor Dec 21, 2024
2ec8ea2
Merge branch 'main' into openapi-python
alonsodomin Dec 21, 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
Prev Previous commit
Next Next commit
Tests pass
  • Loading branch information
@grihabor
grihabor committed Aug 17, 2024
commit dc0a03af74cf5d9056fc341248979127f9a79c9a
223 changes: 114 additions & 109 deletions src/python/pants/backend/openapi/codegen/python/generate_integration_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from pants.backend.python.register import rules as python_backend_rules
from pants.engine.addresses import Address, Addresses
from pants.engine.target import (
Dependencies,
DependenciesRequest,
GeneratedSources,
HydratedSources,
Expand Down Expand Up @@ -110,32 +111,37 @@ def assert_gen(address: Address, expected: Iterable[str]) -> None:
assert not runtime_dependencies


def test_generate_python_sources(rule_runner: RuleRunner) -> None:
@pytest.fixture
def requirements_text() -> str:
return dedent("""\
python_requirement(
name="urllib3",
requirements=["urllib3"],
)
python_requirement(
name="python-dateutil",
requirements=["python-dateutil"],
)
python_requirement(
name="setuptools",
requirements=["setuptools"],
)
""")


def test_generate_python_sources(rule_runner: RuleRunner, requirements_text: str) -> None:
rule_runner.write_files(
{
"3rdparty/python/default.lock": resources.files(__package__)
.joinpath("openapi.test.lock")
.read_text(),
"3rdparty/python/BUILD": dedent("""\
python_requirement(
name="urllib3",
requirements=["urllib3"],
)
python_requirement(
name="python-dateutil",
requirements=["python-dateutil"],
)
python_requirement(
name="setuptools",
requirements=["setuptools"],
)
"""),
"3rdparty/python/BUILD": requirements_text,
"src/openapi/BUILD": dedent("""\
openapi_document(
name="petstore",
source="petstore_spec.yaml",
python_generator_name="python",
)
openapi_document(
name="petstore",
source="petstore_spec.yaml",
python_generator_name="python",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we are giving freedom to the end user to choose the generator, may be worth having an additional test in which the generator being used is python-pydantic-v1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a test for python-fastapi

)
"""),
"src/openapi/petstore_spec.yaml": PETSTORE_SAMPLE_SPEC,
}
Expand All @@ -150,6 +156,8 @@ def assert_gen(address: Address, expected: Iterable[str]) -> None:
assert_gen(
tgt_address,
[
# The list might change because it depends on openapi template.
# TODO Vendor template?
"src/openapi/openapi_client/__init__.py",
"src/openapi/openapi_client/api/__init__.py",
"src/openapi/openapi_client/api/pets_api.py",
Expand Down Expand Up @@ -180,92 +188,89 @@ def assert_gen(address: Address, expected: Iterable[str]) -> None:
assert runtime_dependencies


# def test_generate_python_sources_using_custom_model_package(
# rule_runner: RuleRunner, openapi_lockfile: PythonLockfileFixture
# ) -> None:
# rule_runner.write_files(
# {
# "3rdparty/python/default.lock": openapi_lockfile.serialized_lockfile,
# "3rdparty/python/BUILD": openapi_lockfile.requirements_as_python_artifact_targets(),
# "src/openapi/BUILD": "openapi_document(name='petstore', source='petstore_spec.yaml', python_model_package='org.mycompany')",
# "src/openapi/petstore_spec.yaml": PETSTORE_SAMPLE_SPEC,
# }
# )
#
# def assert_gen(address: Address, expected: Iterable[str]) -> None:
# _assert_generated_files(
# rule_runner, address, source_roots=["src/openapi"], expected_files=expected
# )
#
# assert_gen(
# Address("src/openapi", target_name="petstore"),
# [
# "src/openapi/org/mycompany/Pet.python",
# "src/openapi/org/mycompany/Error.python",
# ],
# )
#
#
# def test_generate_python_sources_using_custom_api_package(
# rule_runner: RuleRunner, openapi_lockfile: PythonLockfileFixture
# ) -> None:
# rule_runner.write_files(
# {
# "3rdparty/python/default.lock": openapi_lockfile.serialized_lockfile,
# "3rdparty/python/BUILD": openapi_lockfile.requirements_as_python_artifact_targets(),
# "src/openapi/BUILD": "openapi_document(name='petstore', source='petstore_spec.yaml', python_api_package='org.mycompany')",
# "src/openapi/petstore_spec.yaml": PETSTORE_SAMPLE_SPEC,
# }
# )
#
# def assert_gen(address: Address, expected: Iterable[str]) -> None:
# _assert_generated_files(
# rule_runner, address, source_roots=["src/openapi"], expected_files=expected
# )
#
# assert_gen(
# Address("src/openapi", target_name="petstore"),
# [
# "src/openapi/org/mycompany/PetsApi.python",
# ],
# )
#
#
# def test_python_dependency_inference(
# rule_runner: RuleRunner, openapi_lockfile: PythonLockfileFixture
# ) -> None:
# rule_runner.write_files(
# {
# "3rdparty/python/default.lock": openapi_lockfile.serialized_lockfile,
# "3rdparty/python/BUILD": openapi_lockfile.requirements_as_python_artifact_targets(),
# "src/openapi/BUILD": dedent(
# """\
# openapi_document(
# name="petstore",
# source="petstore_spec.yaml",
# python_api_package="org.mycompany.api",
# python_model_package="org.mycompany.model",
# )
# """
# ),
# "src/openapi/petstore_spec.yaml": PETSTORE_SAMPLE_SPEC,
# "src/python/BUILD": "python_sources()",
# "src/python/Example.python": dedent(
# """\
# package org.pantsbuild.python.example;
#
# import org.mycompany.api.PetsApi;
# import org.mycompany.model.Pet;
#
# public class Example {
# PetsApi api;
# Pet pet;
# }
# """
# ),
# }
# )
#
# tgt = rule_runner.get_target(Address("src/python", relative_file_path="Example.python"))
# dependencies = rule_runner.request(Addresses, [DependenciesRequest(tgt[Dependencies])])
# assert Address("src/openapi", target_name="petstore") in dependencies
def test_generate_python_sources_using_custom_package_name(
rule_runner: RuleRunner,
requirements_text: str,
) -> None:
rule_runner.write_files(
{
"3rdparty/python/default.lock": resources.files(__package__)
.joinpath("openapi.test.lock")
.read_text(),
"3rdparty/python/BUILD": requirements_text,
"src/openapi/BUILD": dedent("""\
openapi_document(
name="petstore",
source="petstore_spec.yaml",
python_generator_name="python",
python_additional_properties={
"packageName": "petstore_client",
},
)
"""),
"src/openapi/petstore_spec.yaml": PETSTORE_SAMPLE_SPEC,
}
)

def assert_gen(address: Address, expected: Iterable[str]) -> None:
_assert_generated_files(
rule_runner, address, source_roots=["src/openapi"], expected_files=expected
)

assert_gen(
Address("src/openapi", target_name="petstore"),
[
# The list might change because it depends on openapi template.
# TODO Vendor template?
"src/openapi/petstore_client/__init__.py",
"src/openapi/petstore_client/api/__init__.py",
"src/openapi/petstore_client/api/pets_api.py",
"src/openapi/petstore_client/api_client.py",
"src/openapi/petstore_client/apis/__init__.py",
"src/openapi/petstore_client/configuration.py",
"src/openapi/petstore_client/exceptions.py",
"src/openapi/petstore_client/model/__init__.py",
"src/openapi/petstore_client/model/error.py",
"src/openapi/petstore_client/model/pet.py",
"src/openapi/petstore_client/model/pets.py",
"src/openapi/petstore_client/model_utils.py",
"src/openapi/petstore_client/models/__init__.py",
"src/openapi/petstore_client/rest.py",
"src/openapi/setup.py",
"src/openapi/test/__init__.py",
"src/openapi/test/test_error.py",
"src/openapi/test/test_pet.py",
"src/openapi/test/test_pets.py",
"src/openapi/test/test_pets_api.py",
],
)


def test_python_dependency_inference(rule_runner: RuleRunner, requirements_text: str) -> None:
rule_runner.write_files(
{
"3rdparty/python/default.lock": resources.files(__package__)
.joinpath("openapi.test.lock")
.read_text(),
"3rdparty/python/BUILD": requirements_text,
"src/openapi/BUILD": dedent("""\
openapi_document(
name="petstore",
source="petstore_spec.yaml",
python_generator_name="python",
python_additional_properties={
"packageName": "petstore_client",
},
)
"""),
"src/openapi/petstore_spec.yaml": PETSTORE_SAMPLE_SPEC,
"src/python/BUILD": "python_sources()",
"src/python/example.py": dedent("""\
from petstore_client.api_client import ApiClient
"""),
}
)

tgt = rule_runner.get_target(Address("src/python", relative_file_path="example.py"))
dependencies = rule_runner.request(Addresses, [DependenciesRequest(tgt[Dependencies])])
assert Address("src/openapi", target_name="petstore") in dependencies