mirror of
https://github.com/apache/airflow.git
synced 2026-11-04 07:12:48 +00:00
Kaxil Naik
5ac251bd53
Pydantic contract models validate every JSON payload the registry
produces (providers catalog, modules, parameters, connections,
version metadata, provider versions). Validation runs at generation
time — no separate jsonschema layer needed.
An OpenAPI 3.1 spec is generated from these contracts at build time
and powers an interactive API Explorer at /api-explorer/, using
swagger-ui vendored from node_modules (Apache Infra blocks external
CDN via CSP). The explorer shares the site layout (header, nav,
footer) and uses swagger-ui's native dark-mode class for theme sync.
Also adds a /api/providers/{id}/versions.json endpoint used by CI
to publish new provider versions without a full site rebuild.
104 lines
4.0 KiB
Python
104 lines
4.0 KiB
Python
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
"""Unit tests for dev/registry/registry_contract_models.py."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
from pydantic import ValidationError
|
|
from registry_contract_models import (
|
|
build_openapi_document,
|
|
validate_provider_parameters,
|
|
validate_provider_version_metadata,
|
|
validate_provider_versions,
|
|
)
|
|
|
|
|
|
def test_build_openapi_document_produces_valid_spec():
|
|
doc = build_openapi_document()
|
|
assert doc["openapi"] == "3.1.0"
|
|
assert "/api/providers.json" in doc["paths"]
|
|
assert "/api/providers/{providerId}/versions.json" in doc["paths"]
|
|
# Every endpoint $ref should resolve to a component schema
|
|
for path_item in doc["paths"].values():
|
|
ref = path_item["get"]["responses"]["200"]["content"]["application/json"]["schema"]["$ref"]
|
|
schema_name = ref.split("/")[-1]
|
|
assert schema_name in doc["components"]["schemas"], f"{ref} not in component schemas"
|
|
|
|
|
|
def test_validate_provider_versions_requires_latest_in_versions():
|
|
with pytest.raises(ValidationError):
|
|
validate_provider_versions({"latest": "2.0.0", "versions": ["1.0.0"]})
|
|
|
|
|
|
def test_validate_provider_parameters_preserves_mro_alias():
|
|
payload = {
|
|
"provider_id": "test",
|
|
"provider_name": "Test",
|
|
"version": "1.0.0",
|
|
"generated_at": "2026-02-18T00:00:00+00:00",
|
|
"classes": {
|
|
"airflow.providers.test.mod.Example": {
|
|
"name": "Example",
|
|
"type": "operator",
|
|
"mro": ["airflow.providers.test.mod.Example"],
|
|
"parameters": [
|
|
{
|
|
"name": "value",
|
|
"type": "str",
|
|
"default": None,
|
|
"required": True,
|
|
"origin": "airflow.providers.test.mod.Example",
|
|
"description": None,
|
|
}
|
|
],
|
|
}
|
|
},
|
|
}
|
|
validated = validate_provider_parameters(payload)
|
|
class_entry = validated["classes"]["airflow.providers.test.mod.Example"]
|
|
assert "mro" in class_entry
|
|
assert "mro_chain" not in class_entry
|
|
|
|
|
|
def test_validate_version_metadata_accepts_legacy_version_modules_without_ids():
|
|
payload = {
|
|
"provider_id": "test",
|
|
"version": "0.9.0",
|
|
"generated_at": "2026-02-18T00:00:00+00:00",
|
|
"requires_python": ">=3.10",
|
|
"dependencies": [],
|
|
"optional_extras": {},
|
|
"connection_types": [{"conn_type": "test", "hook_class": "x.y.Hook"}],
|
|
"module_counts": {"operator": 1},
|
|
"modules": [
|
|
{
|
|
"name": "LegacyOperator",
|
|
"type": "operator",
|
|
"import_path": "airflow.providers.test.operators.legacy.LegacyOperator",
|
|
"short_description": "Legacy module shape from older backfills.",
|
|
"docs_url": "https://example.invalid/docs",
|
|
"source_url": "https://example.invalid/source",
|
|
"category": "test",
|
|
}
|
|
],
|
|
}
|
|
validated = validate_provider_version_metadata(payload)
|
|
assert "id" not in validated["modules"][0]
|
|
assert "provider_id" not in validated["modules"][0]
|
|
assert "provider_name" not in validated["modules"][0]
|